2 Unix SMB/CIFS implementation.
3 Samba internal messaging functions
4 Copyright (C) Andrew Tridgell 2000
5 Copyright (C) 2001 by Martin Pool
6 Copyright (C) 2002 by Jeremy Allison
7 Copyright (C) 2007 by Volker Lendecke
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 @defgroup messages Internal messaging framework
28 @brief Module for internal messaging between Samba daemons.
30 The idea is that if a part of Samba wants to do communication with
31 another Samba process then it will do a message_register() of a
32 dispatch function, and use message_send_pid() to send messages to
35 The dispatch function is given the pid of the sender, and it can
36 use that to reply by message_send_pid(). See ping_message() for a
39 @caution Dispatch functions must be able to cope with incoming
40 messages on an *odd* byte boundary.
42 This system doesn't have any inherent size limitations but is not
43 very efficient for large messages or when messages are sent in very
49 #include "lib/util/server_id.h"
50 #include "dbwrap/dbwrap.h"
53 #include "lib/util/tevent_unix.h"
54 #include "lib/background.h"
55 #include "lib/messages_dgm.h"
56 #include "lib/util/iov_buf.h"
57 #include "lib/util/server_id_db.h"
58 #include "lib/messages_dgm_ref.h"
59 #include "lib/messages_ctdb.h"
60 #include "lib/messages_ctdb_ref.h"
61 #include "lib/messages_util.h"
62 #include "cluster_support.h"
63 #include "ctdbd_conn.h"
64 #include "ctdb_srvids.h"
66 #ifdef CLUSTER_SUPPORT
67 #include "ctdb_protocol.h"
70 struct messaging_callback {
71 struct messaging_callback *prev, *next;
73 void (*fn)(struct messaging_context *msg, void *private_data,
75 struct server_id server_id, DATA_BLOB *data);
79 struct messaging_registered_ev {
80 struct tevent_context *ev;
81 struct tevent_immediate *im;
85 struct messaging_context {
87 struct tevent_context *event_ctx;
88 struct messaging_callback *callbacks;
90 struct messaging_rec *posted_msgs;
92 struct messaging_registered_ev *event_contexts;
94 struct tevent_req **new_waiters;
95 size_t num_new_waiters;
97 struct tevent_req **waiters;
103 struct server_id_db *names_db;
106 static struct messaging_rec *messaging_rec_dup(TALLOC_CTX *mem_ctx,
107 struct messaging_rec *rec);
108 static bool messaging_dispatch_classic(struct messaging_context *msg_ctx,
109 struct messaging_rec *rec);
110 static bool messaging_dispatch_waiters(struct messaging_context *msg_ctx,
111 struct tevent_context *ev,
112 struct messaging_rec *rec);
113 static void messaging_dispatch_rec(struct messaging_context *msg_ctx,
114 struct tevent_context *ev,
115 struct messaging_rec *rec);
117 /****************************************************************************
118 A useful function for testing the message system.
119 ****************************************************************************/
121 static void ping_message(struct messaging_context *msg_ctx,
124 struct server_id src,
127 struct server_id_buf idbuf;
129 DEBUG(1, ("INFO: Received PING message from PID %s [%.*s]\n",
130 server_id_str_buf(src, &idbuf), (int)data->length,
131 data->data ? (char *)data->data : ""));
133 messaging_send(msg_ctx, src, MSG_PONG, data);
136 struct messaging_rec *messaging_rec_create(
137 TALLOC_CTX *mem_ctx, struct server_id src, struct server_id dst,
138 uint32_t msg_type, const struct iovec *iov, int iovlen,
139 const int *fds, size_t num_fds)
143 struct messaging_rec *result;
145 if (num_fds > INT8_MAX) {
149 buflen = iov_buflen(iov, iovlen);
153 buf = talloc_array(mem_ctx, uint8_t, buflen);
157 iov_buf(iov, iovlen, buf, buflen);
160 struct messaging_rec rec;
161 int64_t fds64[num_fds];
164 for (i=0; i<num_fds; i++) {
168 rec = (struct messaging_rec) {
169 .msg_version = MESSAGE_VERSION, .msg_type = msg_type,
170 .src = src, .dest = dst,
171 .buf.data = buf, .buf.length = buflen,
172 .num_fds = num_fds, .fds = fds64,
175 result = messaging_rec_dup(mem_ctx, &rec);
183 static bool messaging_register_event_context(struct messaging_context *ctx,
184 struct tevent_context *ev)
186 size_t i, num_event_contexts;
187 struct messaging_registered_ev *free_reg = NULL;
188 struct messaging_registered_ev *tmp;
190 num_event_contexts = talloc_array_length(ctx->event_contexts);
192 for (i=0; i<num_event_contexts; i++) {
193 struct messaging_registered_ev *reg = &ctx->event_contexts[i];
195 if (reg->refcount == 0) {
196 if (reg->ev != NULL) {
201 * We continue here and may find another
202 * free_req, but the important thing is
203 * that we continue to search for an
204 * existing registration in the loop.
215 if (free_reg == NULL) {
216 tmp = talloc_realloc(ctx, ctx->event_contexts,
217 struct messaging_registered_ev,
218 num_event_contexts+1);
222 ctx->event_contexts = tmp;
224 free_reg = &ctx->event_contexts[num_event_contexts];
227 *free_reg = (struct messaging_registered_ev) { .ev = ev, .refcount = 1 };
232 static bool messaging_deregister_event_context(struct messaging_context *ctx,
233 struct tevent_context *ev)
235 size_t i, num_event_contexts;
237 num_event_contexts = talloc_array_length(ctx->event_contexts);
239 for (i=0; i<num_event_contexts; i++) {
240 struct messaging_registered_ev *reg = &ctx->event_contexts[i];
242 if (reg->refcount == 0) {
249 if (reg->refcount == 0) {
251 * Not strictly necessary, just
257 * Do not talloc_free(reg->im),
258 * recycle immediates events.
267 static void messaging_post_main_event_context(struct tevent_context *ev,
268 struct tevent_immediate *im,
271 struct messaging_context *ctx = talloc_get_type_abort(
272 private_data, struct messaging_context);
274 while (ctx->posted_msgs != NULL) {
275 struct messaging_rec *rec = ctx->posted_msgs;
278 DLIST_REMOVE(ctx->posted_msgs, rec);
280 consumed = messaging_dispatch_classic(ctx, rec);
282 consumed = messaging_dispatch_waiters(
283 ctx, ctx->event_ctx, rec);
289 for (i=0; i<rec->num_fds; i++) {
298 static void messaging_post_sub_event_context(struct tevent_context *ev,
299 struct tevent_immediate *im,
302 struct messaging_context *ctx = talloc_get_type_abort(
303 private_data, struct messaging_context);
304 struct messaging_rec *rec, *next;
306 for (rec = ctx->posted_msgs; rec != NULL; rec = next) {
311 consumed = messaging_dispatch_waiters(ctx, ev, rec);
313 DLIST_REMOVE(ctx->posted_msgs, rec);
319 static bool messaging_alert_event_contexts(struct messaging_context *ctx)
321 size_t i, num_event_contexts;
323 num_event_contexts = talloc_array_length(ctx->event_contexts);
325 for (i=0; i<num_event_contexts; i++) {
326 struct messaging_registered_ev *reg = &ctx->event_contexts[i];
328 if (reg->refcount == 0) {
332 if (reg->im == NULL) {
333 reg->im = tevent_create_immediate(
334 ctx->event_contexts);
336 if (reg->im == NULL) {
337 DBG_WARNING("Could not create immediate\n");
342 * We depend on schedule_immediate to work
343 * multiple times. Might be a bit inefficient,
344 * but this needs to be proven in tests. The
345 * alternatively would be to track whether the
346 * immediate has already been scheduled. For
347 * now, avoid that complexity here.
350 if (reg->ev == ctx->event_ctx) {
351 tevent_schedule_immediate(
353 messaging_post_main_event_context,
356 tevent_schedule_immediate(
358 messaging_post_sub_event_context,
366 static void messaging_recv_cb(struct tevent_context *ev,
367 const uint8_t *msg, size_t msg_len,
368 int *fds, size_t num_fds,
371 struct messaging_context *msg_ctx = talloc_get_type_abort(
372 private_data, struct messaging_context);
373 struct server_id_buf idbuf;
374 struct messaging_rec rec;
375 int64_t fds64[MIN(num_fds, INT8_MAX)];
378 if (msg_len < MESSAGE_HDR_LENGTH) {
379 DBG_WARNING("message too short: %zu\n", msg_len);
383 if (num_fds > INT8_MAX) {
384 DBG_WARNING("too many fds: %zu\n", num_fds);
389 * "consume" the fds by copying them and setting
390 * the original variable to -1
392 for (i=0; i < num_fds; i++) {
397 rec = (struct messaging_rec) {
398 .msg_version = MESSAGE_VERSION,
399 .buf.data = discard_const_p(uint8_t, msg) + MESSAGE_HDR_LENGTH,
400 .buf.length = msg_len - MESSAGE_HDR_LENGTH,
405 message_hdr_get(&rec.msg_type, &rec.src, &rec.dest, msg);
407 DBG_DEBUG("Received message 0x%x len %zu (num_fds:%zu) from %s\n",
408 (unsigned)rec.msg_type, rec.buf.length, num_fds,
409 server_id_str_buf(rec.src, &idbuf));
411 if (server_id_same_process(&rec.src, &msg_ctx->id)) {
412 DBG_DEBUG("Ignoring self-send\n");
416 messaging_dispatch_rec(msg_ctx, ev, &rec);
420 for (i=0; i < num_fds; i++) {
425 static int messaging_context_destructor(struct messaging_context *ctx)
429 for (i=0; i<ctx->num_new_waiters; i++) {
430 if (ctx->new_waiters[i] != NULL) {
431 tevent_req_set_cleanup_fn(ctx->new_waiters[i], NULL);
432 ctx->new_waiters[i] = NULL;
435 for (i=0; i<ctx->num_waiters; i++) {
436 if (ctx->waiters[i] != NULL) {
437 tevent_req_set_cleanup_fn(ctx->waiters[i], NULL);
438 ctx->waiters[i] = NULL;
443 * The immediates from messaging_alert_event_contexts
444 * reference "ctx". Don't let them outlive the
445 * messaging_context we're destroying here.
447 TALLOC_FREE(ctx->event_contexts);
452 static const char *private_path(const char *name)
454 return talloc_asprintf(talloc_tos(), "%s/%s", lp_private_dir(), name);
457 static NTSTATUS messaging_init_internal(TALLOC_CTX *mem_ctx,
458 struct tevent_context *ev,
459 struct messaging_context **pmsg_ctx)
462 struct messaging_context *ctx;
463 NTSTATUS status = NT_STATUS_UNSUCCESSFUL;
465 const char *lck_path;
466 const char *priv_path;
470 * sec_init() *must* be called before any other
471 * functions that use sec_XXX(). e.g. sec_initial_uid().
476 lck_path = lock_path("msg.lock");
477 if (lck_path == NULL) {
478 return NT_STATUS_NO_MEMORY;
481 ok = directory_create_or_exist_strict(lck_path,
485 DBG_DEBUG("Could not create lock directory: %s\n",
487 return NT_STATUS_ACCESS_DENIED;
490 priv_path = private_path("msg.sock");
491 if (priv_path == NULL) {
492 return NT_STATUS_NO_MEMORY;
495 ok = directory_create_or_exist_strict(priv_path, sec_initial_uid(),
498 DBG_DEBUG("Could not create msg directory: %s\n",
500 return NT_STATUS_ACCESS_DENIED;
503 frame = talloc_stackframe();
505 return NT_STATUS_NO_MEMORY;
508 ctx = talloc_zero(frame, struct messaging_context);
510 status = NT_STATUS_NO_MEMORY;
514 ctx->id = (struct server_id) {
515 .pid = getpid(), .vnn = NONCLUSTER_VNN
520 ok = messaging_register_event_context(ctx, ev);
522 status = NT_STATUS_NO_MEMORY;
526 ctx->msg_dgm_ref = messaging_dgm_ref(ctx,
534 if (ctx->msg_dgm_ref == NULL) {
535 DEBUG(2, ("messaging_dgm_ref failed: %s\n", strerror(ret)));
536 status = map_nt_error_from_unix(ret);
539 talloc_set_destructor(ctx, messaging_context_destructor);
541 #ifdef CLUSTER_SUPPORT
542 if (lp_clustering()) {
543 ctx->msg_ctdb_ref = messaging_ctdb_ref(
545 lp_ctdbd_socket(), lp_ctdb_timeout(),
546 ctx->id.unique_id, messaging_recv_cb, ctx, &ret);
547 if (ctx->msg_ctdb_ref == NULL) {
548 DBG_NOTICE("messaging_ctdb_ref failed: %s\n",
550 status = map_nt_error_from_unix(ret);
556 ctx->id.vnn = get_my_vnn();
558 ctx->names_db = server_id_db_init(ctx,
562 TDB_INCOMPATIBLE_HASH|TDB_CLEAR_IF_FIRST);
563 if (ctx->names_db == NULL) {
564 DBG_DEBUG("server_id_db_init failed\n");
565 status = NT_STATUS_NO_MEMORY;
569 messaging_register(ctx, NULL, MSG_PING, ping_message);
571 /* Register some debugging related messages */
573 register_msg_pool_usage(ctx);
574 register_dmalloc_msgs(ctx);
575 debug_register_msgs(ctx);
578 struct server_id_buf tmp;
579 DBG_DEBUG("my id: %s\n", server_id_str_buf(ctx->id, &tmp));
582 *pmsg_ctx = talloc_steal(mem_ctx, ctx);
584 status = NT_STATUS_OK;
591 struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx,
592 struct tevent_context *ev)
594 struct messaging_context *ctx = NULL;
597 status = messaging_init_internal(mem_ctx,
600 if (!NT_STATUS_IS_OK(status)) {
607 NTSTATUS messaging_init_client(TALLOC_CTX *mem_ctx,
608 struct tevent_context *ev,
609 struct messaging_context **pmsg_ctx)
611 return messaging_init_internal(mem_ctx,
616 struct server_id messaging_server_id(const struct messaging_context *msg_ctx)
622 * re-init after a fork
624 NTSTATUS messaging_reinit(struct messaging_context *msg_ctx)
629 TALLOC_FREE(msg_ctx->msg_dgm_ref);
630 TALLOC_FREE(msg_ctx->msg_ctdb_ref);
632 msg_ctx->id = (struct server_id) {
633 .pid = getpid(), .vnn = msg_ctx->id.vnn
636 lck_path = lock_path("msg.lock");
637 if (lck_path == NULL) {
638 return NT_STATUS_NO_MEMORY;
641 msg_ctx->msg_dgm_ref = messaging_dgm_ref(
642 msg_ctx, msg_ctx->event_ctx, &msg_ctx->id.unique_id,
643 private_path("msg.sock"), lck_path,
644 messaging_recv_cb, msg_ctx, &ret);
646 if (msg_ctx->msg_dgm_ref == NULL) {
647 DEBUG(2, ("messaging_dgm_ref failed: %s\n", strerror(ret)));
648 return map_nt_error_from_unix(ret);
651 if (lp_clustering()) {
652 msg_ctx->msg_ctdb_ref = messaging_ctdb_ref(
653 msg_ctx, msg_ctx->event_ctx,
654 lp_ctdbd_socket(), lp_ctdb_timeout(),
655 msg_ctx->id.unique_id, messaging_recv_cb, msg_ctx,
657 if (msg_ctx->msg_ctdb_ref == NULL) {
658 DBG_NOTICE("messaging_ctdb_ref failed: %s\n",
660 return map_nt_error_from_unix(ret);
664 server_id_db_reinit(msg_ctx->names_db, msg_ctx->id);
671 * Register a dispatch function for a particular message type. Allow multiple
674 NTSTATUS messaging_register(struct messaging_context *msg_ctx,
677 void (*fn)(struct messaging_context *msg,
680 struct server_id server_id,
683 struct messaging_callback *cb;
685 DEBUG(5, ("Registering messaging pointer for type %u - "
687 (unsigned)msg_type, private_data));
690 * Only one callback per type
693 for (cb = msg_ctx->callbacks; cb != NULL; cb = cb->next) {
694 /* we allow a second registration of the same message
695 type if it has a different private pointer. This is
696 needed in, for example, the internal notify code,
697 which creates a new notify context for each tree
698 connect, and expects to receive messages to each of
700 if (cb->msg_type == msg_type && private_data == cb->private_data) {
701 DEBUG(5,("Overriding messaging pointer for type %u - private_data=%p\n",
702 (unsigned)msg_type, private_data));
704 cb->private_data = private_data;
709 if (!(cb = talloc(msg_ctx, struct messaging_callback))) {
710 return NT_STATUS_NO_MEMORY;
713 cb->msg_type = msg_type;
715 cb->private_data = private_data;
717 DLIST_ADD(msg_ctx->callbacks, cb);
722 De-register the function for a particular message type.
724 void messaging_deregister(struct messaging_context *ctx, uint32_t msg_type,
727 struct messaging_callback *cb, *next;
729 for (cb = ctx->callbacks; cb; cb = next) {
731 if ((cb->msg_type == msg_type)
732 && (cb->private_data == private_data)) {
733 DEBUG(5,("Deregistering messaging pointer for type %u - private_data=%p\n",
734 (unsigned)msg_type, private_data));
735 DLIST_REMOVE(ctx->callbacks, cb);
742 Send a message to a particular server
744 NTSTATUS messaging_send(struct messaging_context *msg_ctx,
745 struct server_id server, uint32_t msg_type,
746 const DATA_BLOB *data)
748 struct iovec iov = {0};
751 iov.iov_base = data->data;
752 iov.iov_len = data->length;
755 return messaging_send_iov(msg_ctx, server, msg_type, &iov, 1, NULL, 0);
758 NTSTATUS messaging_send_buf(struct messaging_context *msg_ctx,
759 struct server_id server, uint32_t msg_type,
760 const uint8_t *buf, size_t len)
762 DATA_BLOB blob = data_blob_const(buf, len);
763 return messaging_send(msg_ctx, server, msg_type, &blob);
766 static int messaging_post_self(struct messaging_context *msg_ctx,
767 struct server_id src, struct server_id dst,
769 const struct iovec *iov, int iovlen,
770 const int *fds, size_t num_fds)
772 struct messaging_rec *rec;
775 rec = messaging_rec_create(
776 msg_ctx, src, dst, msg_type, iov, iovlen, fds, num_fds);
781 ok = messaging_alert_event_contexts(msg_ctx);
787 DLIST_ADD_END(msg_ctx->posted_msgs, rec);
792 int messaging_send_iov_from(struct messaging_context *msg_ctx,
793 struct server_id src, struct server_id dst,
795 const struct iovec *iov, int iovlen,
796 const int *fds, size_t num_fds)
799 uint8_t hdr[MESSAGE_HDR_LENGTH];
800 struct iovec iov2[iovlen+1];
802 if (server_id_is_disconnected(&dst)) {
806 if (num_fds > INT8_MAX) {
810 if (server_id_equal(&dst, &msg_ctx->id)) {
811 ret = messaging_post_self(msg_ctx, src, dst, msg_type,
812 iov, iovlen, fds, num_fds);
816 message_hdr_put(hdr, msg_type, src, dst);
817 iov2[0] = (struct iovec){ .iov_base = hdr, .iov_len = sizeof(hdr) };
818 memcpy(&iov2[1], iov, iovlen * sizeof(*iov));
820 if (dst.vnn != msg_ctx->id.vnn) {
825 ret = messaging_ctdb_send(dst.vnn, dst.pid, iov2, iovlen+1);
829 ret = messaging_dgm_send(dst.pid, iov2, iovlen+1, fds, num_fds);
833 ret = messaging_dgm_send(dst.pid, iov2, iovlen+1,
838 if (ret == ECONNREFUSED) {
840 * Linux returns this when a socket exists in the file
841 * system without a listening process. This is not
842 * documented in susv4 or the linux manpages, but it's
843 * easily testable. For the higher levels this is the
844 * same as "destination does not exist"
852 NTSTATUS messaging_send_iov(struct messaging_context *msg_ctx,
853 struct server_id dst, uint32_t msg_type,
854 const struct iovec *iov, int iovlen,
855 const int *fds, size_t num_fds)
859 ret = messaging_send_iov_from(msg_ctx, msg_ctx->id, dst, msg_type,
860 iov, iovlen, fds, num_fds);
862 return map_nt_error_from_unix(ret);
867 struct send_all_state {
868 struct messaging_context *msg_ctx;
874 static int send_all_fn(pid_t pid, void *private_data)
876 struct send_all_state *state = private_data;
879 if (pid == getpid()) {
880 DBG_DEBUG("Skip ourselves in messaging_send_all\n");
884 status = messaging_send_buf(state->msg_ctx, pid_to_procid(pid),
885 state->msg_type, state->buf, state->len);
886 if (!NT_STATUS_IS_OK(status)) {
887 DBG_WARNING("messaging_send_buf to %ju failed: %s\n",
888 (uintmax_t)pid, nt_errstr(status));
894 void messaging_send_all(struct messaging_context *msg_ctx,
895 int msg_type, const void *buf, size_t len)
897 struct send_all_state state = {
898 .msg_ctx = msg_ctx, .msg_type = msg_type,
899 .buf = buf, .len = len
903 #ifdef CLUSTER_SUPPORT
904 if (lp_clustering()) {
905 struct ctdbd_connection *conn = messaging_ctdb_connection();
906 uint8_t msghdr[MESSAGE_HDR_LENGTH];
907 struct iovec iov[] = {
908 { .iov_base = msghdr,
909 .iov_len = sizeof(msghdr) },
910 { .iov_base = discard_const_p(void, buf),
914 message_hdr_put(msghdr, msg_type, messaging_server_id(msg_ctx),
915 (struct server_id) {0});
917 ret = ctdbd_messaging_send_iov(
918 conn, CTDB_BROADCAST_CONNECTED,
919 CTDB_SRVID_SAMBA_PROCESS,
920 iov, ARRAY_SIZE(iov));
922 DBG_WARNING("ctdbd_messaging_send_iov failed: %s\n",
930 ret = messaging_dgm_forall(send_all_fn, &state);
932 DBG_WARNING("messaging_dgm_forall failed: %s\n",
937 static struct messaging_rec *messaging_rec_dup(TALLOC_CTX *mem_ctx,
938 struct messaging_rec *rec)
940 struct messaging_rec *result;
941 size_t fds_size = sizeof(int64_t) * rec->num_fds;
944 payload_len = rec->buf.length + fds_size;
945 if (payload_len < rec->buf.length) {
950 result = talloc_pooled_object(mem_ctx, struct messaging_rec, 2,
952 if (result == NULL) {
957 /* Doesn't fail, see talloc_pooled_object */
959 result->buf.data = talloc_memdup(result, rec->buf.data,
963 if (result->num_fds > 0) {
964 result->fds = talloc_memdup(result, rec->fds, fds_size);
970 struct messaging_filtered_read_state {
971 struct tevent_context *ev;
972 struct messaging_context *msg_ctx;
973 struct messaging_dgm_fde *fde;
974 struct messaging_ctdb_fde *cluster_fde;
976 bool (*filter)(struct messaging_rec *rec, void *private_data);
979 struct messaging_rec *rec;
982 static void messaging_filtered_read_cleanup(struct tevent_req *req,
983 enum tevent_req_state req_state);
985 struct tevent_req *messaging_filtered_read_send(
986 TALLOC_CTX *mem_ctx, struct tevent_context *ev,
987 struct messaging_context *msg_ctx,
988 bool (*filter)(struct messaging_rec *rec, void *private_data),
991 struct tevent_req *req;
992 struct messaging_filtered_read_state *state;
993 size_t new_waiters_len;
996 req = tevent_req_create(mem_ctx, &state,
997 struct messaging_filtered_read_state);
1002 state->msg_ctx = msg_ctx;
1003 state->filter = filter;
1004 state->private_data = private_data;
1007 * We have to defer the callback here, as we might be called from
1008 * within a different tevent_context than state->ev
1010 tevent_req_defer_callback(req, state->ev);
1012 state->fde = messaging_dgm_register_tevent_context(state, ev);
1013 if (tevent_req_nomem(state->fde, req)) {
1014 return tevent_req_post(req, ev);
1017 if (lp_clustering()) {
1018 state->cluster_fde =
1019 messaging_ctdb_register_tevent_context(state, ev);
1020 if (tevent_req_nomem(state->cluster_fde, req)) {
1021 return tevent_req_post(req, ev);
1026 * We add ourselves to the "new_waiters" array, not the "waiters"
1027 * array. If we are called from within messaging_read_done,
1028 * messaging_dispatch_rec will be in an active for-loop on
1029 * "waiters". We must be careful not to mess with this array, because
1030 * it could mean that a single event is being delivered twice.
1033 new_waiters_len = talloc_array_length(msg_ctx->new_waiters);
1035 if (new_waiters_len == msg_ctx->num_new_waiters) {
1036 struct tevent_req **tmp;
1038 tmp = talloc_realloc(msg_ctx, msg_ctx->new_waiters,
1039 struct tevent_req *, new_waiters_len+1);
1040 if (tevent_req_nomem(tmp, req)) {
1041 return tevent_req_post(req, ev);
1043 msg_ctx->new_waiters = tmp;
1046 msg_ctx->new_waiters[msg_ctx->num_new_waiters] = req;
1047 msg_ctx->num_new_waiters += 1;
1048 tevent_req_set_cleanup_fn(req, messaging_filtered_read_cleanup);
1050 ok = messaging_register_event_context(msg_ctx, ev);
1052 tevent_req_oom(req);
1053 return tevent_req_post(req, ev);
1059 static void messaging_filtered_read_cleanup(struct tevent_req *req,
1060 enum tevent_req_state req_state)
1062 struct messaging_filtered_read_state *state = tevent_req_data(
1063 req, struct messaging_filtered_read_state);
1064 struct messaging_context *msg_ctx = state->msg_ctx;
1068 tevent_req_set_cleanup_fn(req, NULL);
1070 TALLOC_FREE(state->fde);
1071 TALLOC_FREE(state->cluster_fde);
1073 ok = messaging_deregister_event_context(msg_ctx, state->ev);
1079 * Just set the [new_]waiters entry to NULL, be careful not to mess
1080 * with the other "waiters" array contents. We are often called from
1081 * within "messaging_dispatch_rec", which loops over
1082 * "waiters". Messing with the "waiters" array will mess up that
1086 for (i=0; i<msg_ctx->num_waiters; i++) {
1087 if (msg_ctx->waiters[i] == req) {
1088 msg_ctx->waiters[i] = NULL;
1093 for (i=0; i<msg_ctx->num_new_waiters; i++) {
1094 if (msg_ctx->new_waiters[i] == req) {
1095 msg_ctx->new_waiters[i] = NULL;
1101 static void messaging_filtered_read_done(struct tevent_req *req,
1102 struct messaging_rec *rec)
1104 struct messaging_filtered_read_state *state = tevent_req_data(
1105 req, struct messaging_filtered_read_state);
1107 state->rec = messaging_rec_dup(state, rec);
1108 if (tevent_req_nomem(state->rec, req)) {
1111 tevent_req_done(req);
1114 int messaging_filtered_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
1115 struct messaging_rec **presult)
1117 struct messaging_filtered_read_state *state = tevent_req_data(
1118 req, struct messaging_filtered_read_state);
1121 if (tevent_req_is_unix_error(req, &err)) {
1122 tevent_req_received(req);
1125 if (presult != NULL) {
1126 *presult = talloc_move(mem_ctx, &state->rec);
1131 struct messaging_read_state {
1133 struct messaging_rec *rec;
1136 static bool messaging_read_filter(struct messaging_rec *rec,
1137 void *private_data);
1138 static void messaging_read_done(struct tevent_req *subreq);
1140 struct tevent_req *messaging_read_send(TALLOC_CTX *mem_ctx,
1141 struct tevent_context *ev,
1142 struct messaging_context *msg,
1145 struct tevent_req *req, *subreq;
1146 struct messaging_read_state *state;
1148 req = tevent_req_create(mem_ctx, &state,
1149 struct messaging_read_state);
1153 state->msg_type = msg_type;
1155 subreq = messaging_filtered_read_send(state, ev, msg,
1156 messaging_read_filter, state);
1157 if (tevent_req_nomem(subreq, req)) {
1158 return tevent_req_post(req, ev);
1160 tevent_req_set_callback(subreq, messaging_read_done, req);
1164 static bool messaging_read_filter(struct messaging_rec *rec,
1167 struct messaging_read_state *state = talloc_get_type_abort(
1168 private_data, struct messaging_read_state);
1170 if (rec->num_fds != 0) {
1174 return rec->msg_type == state->msg_type;
1177 static void messaging_read_done(struct tevent_req *subreq)
1179 struct tevent_req *req = tevent_req_callback_data(
1180 subreq, struct tevent_req);
1181 struct messaging_read_state *state = tevent_req_data(
1182 req, struct messaging_read_state);
1185 ret = messaging_filtered_read_recv(subreq, state, &state->rec);
1186 TALLOC_FREE(subreq);
1187 if (tevent_req_error(req, ret)) {
1190 tevent_req_done(req);
1193 int messaging_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
1194 struct messaging_rec **presult)
1196 struct messaging_read_state *state = tevent_req_data(
1197 req, struct messaging_read_state);
1200 if (tevent_req_is_unix_error(req, &err)) {
1203 if (presult != NULL) {
1204 *presult = talloc_move(mem_ctx, &state->rec);
1209 static bool messaging_append_new_waiters(struct messaging_context *msg_ctx)
1211 if (msg_ctx->num_new_waiters == 0) {
1215 if (talloc_array_length(msg_ctx->waiters) <
1216 (msg_ctx->num_waiters + msg_ctx->num_new_waiters)) {
1217 struct tevent_req **tmp;
1218 tmp = talloc_realloc(
1219 msg_ctx, msg_ctx->waiters, struct tevent_req *,
1220 msg_ctx->num_waiters + msg_ctx->num_new_waiters);
1222 DEBUG(1, ("%s: talloc failed\n", __func__));
1225 msg_ctx->waiters = tmp;
1228 memcpy(&msg_ctx->waiters[msg_ctx->num_waiters], msg_ctx->new_waiters,
1229 sizeof(struct tevent_req *) * msg_ctx->num_new_waiters);
1231 msg_ctx->num_waiters += msg_ctx->num_new_waiters;
1232 msg_ctx->num_new_waiters = 0;
1237 static bool messaging_dispatch_classic(struct messaging_context *msg_ctx,
1238 struct messaging_rec *rec)
1240 struct messaging_callback *cb, *next;
1242 for (cb = msg_ctx->callbacks; cb != NULL; cb = next) {
1246 if (cb->msg_type != rec->msg_type) {
1251 * the old style callbacks don't support fd passing
1253 for (j=0; j < rec->num_fds; j++) {
1254 int fd = rec->fds[j];
1260 cb->fn(msg_ctx, cb->private_data, rec->msg_type,
1261 rec->src, &rec->buf);
1269 static bool messaging_dispatch_waiters(struct messaging_context *msg_ctx,
1270 struct tevent_context *ev,
1271 struct messaging_rec *rec)
1275 if (!messaging_append_new_waiters(msg_ctx)) {
1280 while (i < msg_ctx->num_waiters) {
1281 struct tevent_req *req;
1282 struct messaging_filtered_read_state *state;
1284 req = msg_ctx->waiters[i];
1287 * This got cleaned up. In the meantime,
1288 * move everything down one. We need
1289 * to keep the order of waiters, as
1290 * other code may depend on this.
1292 if (i < msg_ctx->num_waiters - 1) {
1293 memmove(&msg_ctx->waiters[i],
1294 &msg_ctx->waiters[i+1],
1295 sizeof(struct tevent_req *) *
1296 (msg_ctx->num_waiters - i - 1));
1298 msg_ctx->num_waiters -= 1;
1302 state = tevent_req_data(
1303 req, struct messaging_filtered_read_state);
1304 if ((ev == state->ev) &&
1305 state->filter(rec, state->private_data)) {
1306 messaging_filtered_read_done(req, rec);
1317 Dispatch one messaging_rec
1319 static void messaging_dispatch_rec(struct messaging_context *msg_ctx,
1320 struct tevent_context *ev,
1321 struct messaging_rec *rec)
1326 if (ev == msg_ctx->event_ctx) {
1327 consumed = messaging_dispatch_classic(msg_ctx, rec);
1333 consumed = messaging_dispatch_waiters(msg_ctx, ev, rec);
1338 if (ev != msg_ctx->event_ctx) {
1340 int fds[rec->num_fds];
1344 * We've been listening on a nested event
1345 * context. Messages need to be handled in the main
1346 * event context, so post to ourselves
1349 iov.iov_base = rec->buf.data;
1350 iov.iov_len = rec->buf.length;
1352 for (i=0; i<rec->num_fds; i++) {
1353 fds[i] = rec->fds[i];
1356 ret = messaging_post_self(
1357 msg_ctx, rec->src, rec->dest, rec->msg_type,
1358 &iov, 1, fds, rec->num_fds);
1365 * If the fd-array isn't used, just close it.
1367 for (i=0; i < rec->num_fds; i++) {
1368 int fd = rec->fds[i];
1375 static int mess_parent_dgm_cleanup(void *private_data);
1376 static void mess_parent_dgm_cleanup_done(struct tevent_req *req);
1378 bool messaging_parent_dgm_cleanup_init(struct messaging_context *msg)
1380 struct tevent_req *req;
1382 req = background_job_send(
1383 msg, msg->event_ctx, msg, NULL, 0,
1384 lp_parm_int(-1, "messaging", "messaging dgm cleanup interval",
1386 mess_parent_dgm_cleanup, msg);
1388 DBG_WARNING("background_job_send failed\n");
1391 tevent_req_set_callback(req, mess_parent_dgm_cleanup_done, msg);
1395 static int mess_parent_dgm_cleanup(void *private_data)
1399 ret = messaging_dgm_wipe();
1400 DEBUG(10, ("messaging_dgm_wipe returned %s\n",
1401 ret ? strerror(ret) : "ok"));
1402 return lp_parm_int(-1, "messaging", "messaging dgm cleanup interval",
1406 static void mess_parent_dgm_cleanup_done(struct tevent_req *req)
1408 struct messaging_context *msg = tevent_req_callback_data(
1409 req, struct messaging_context);
1412 status = background_job_recv(req);
1414 DEBUG(1, ("messaging dgm cleanup job ended with %s\n",
1415 nt_errstr(status)));
1417 req = background_job_send(
1418 msg, msg->event_ctx, msg, NULL, 0,
1419 lp_parm_int(-1, "messaging", "messaging dgm cleanup interval",
1421 mess_parent_dgm_cleanup, msg);
1423 DEBUG(1, ("background_job_send failed\n"));
1426 tevent_req_set_callback(req, mess_parent_dgm_cleanup_done, msg);
1429 int messaging_cleanup(struct messaging_context *msg_ctx, pid_t pid)
1434 ret = messaging_dgm_wipe();
1436 ret = messaging_dgm_cleanup(pid);
1442 struct tevent_context *messaging_tevent_context(
1443 struct messaging_context *msg_ctx)
1445 return msg_ctx->event_ctx;
1448 struct server_id_db *messaging_names_db(struct messaging_context *msg_ctx)
1450 return msg_ctx->names_db;