s4-selftest: add unit tests for sites's function in python
[Samba/gebeck_regimport.git] / source4 / lib / messaging / messaging.c
blob21ff1b456a95ff1214471e1ae83e5ee45d30ce3d
1 /*
2 Unix SMB/CIFS implementation.
4 Samba internal messaging functions
6 Copyright (C) Andrew Tridgell 2004
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "includes.h"
23 #include "lib/events/events.h"
24 #include "system/filesys.h"
25 #include "messaging/messaging.h"
26 #include "../lib/util/dlinklist.h"
27 #include "lib/socket/socket.h"
28 #include "librpc/gen_ndr/ndr_irpc.h"
29 #include "lib/messaging/irpc.h"
30 #include "lib/util/tdb_wrap.h"
31 #include "../lib/util/unix_privs.h"
32 #include "librpc/rpc/dcerpc.h"
33 #include "../lib/tdb_compat/tdb_compat.h"
34 #include "../lib/util/util_tdb.h"
35 #include "cluster/cluster.h"
36 #include "../lib/util/tevent_ntstatus.h"
37 #include "lib/param/param.h"
39 /* change the message version with any incompatible changes in the protocol */
40 #define IMESSAGING_VERSION 1
43 a pending irpc call
45 struct irpc_request {
46 struct imessaging_context *msg_ctx;
47 int callid;
48 struct {
49 void (*handler)(struct irpc_request *irpc, struct irpc_message *m);
50 void *private_data;
51 } incoming;
54 struct imessaging_context {
55 struct server_id server_id;
56 struct socket_context *sock;
57 const char *base_path;
58 const char *path;
59 struct loadparm_context *lp_ctx;
60 struct dispatch_fn **dispatch;
61 uint32_t num_types;
62 struct idr_context *dispatch_tree;
63 struct imessaging_rec *pending;
64 struct imessaging_rec *retry_queue;
65 struct irpc_list *irpc;
66 struct idr_context *idr;
67 const char **names;
68 struct timeval start_time;
69 struct tevent_timer *retry_te;
70 struct {
71 struct tevent_context *ev;
72 struct tevent_fd *fde;
73 } event;
76 /* we have a linked list of dispatch handlers for each msg_type that
77 this messaging server can deal with */
78 struct dispatch_fn {
79 struct dispatch_fn *next, *prev;
80 uint32_t msg_type;
81 void *private_data;
82 msg_callback_t fn;
85 /* an individual message */
86 struct imessaging_rec {
87 struct imessaging_rec *next, *prev;
88 struct imessaging_context *msg;
89 const char *path;
91 struct imessaging_header {
92 uint32_t version;
93 uint32_t msg_type;
94 struct server_id from;
95 struct server_id to;
96 uint32_t length;
97 } *header;
99 DATA_BLOB packet;
100 uint32_t retries;
104 static void irpc_handler(struct imessaging_context *, void *,
105 uint32_t, struct server_id, DATA_BLOB *);
109 A useful function for testing the message system.
111 static void ping_message(struct imessaging_context *msg, void *private_data,
112 uint32_t msg_type, struct server_id src, DATA_BLOB *data)
114 char *task_id = server_id_str(NULL, &src);
115 DEBUG(1,("INFO: Received PING message from server %s [%.*s]\n",
116 task_id, (int)data->length,
117 data->data?(const char *)data->data:""));
118 talloc_free(task_id);
119 imessaging_send(msg, src, MSG_PONG, data);
123 return uptime of messaging server via irpc
125 static NTSTATUS irpc_uptime(struct irpc_message *msg,
126 struct irpc_uptime *r)
128 struct imessaging_context *ctx = talloc_get_type(msg->private_data, struct imessaging_context);
129 *r->out.start_time = timeval_to_nttime(&ctx->start_time);
130 return NT_STATUS_OK;
134 return the path to a messaging socket
136 static char *imessaging_path(struct imessaging_context *msg, struct server_id server_id)
138 TALLOC_CTX *tmp_ctx = talloc_new(msg);
139 const char *id = server_id_str(tmp_ctx, &server_id);
140 char *s;
141 if (id == NULL) {
142 return NULL;
144 s = talloc_asprintf(msg, "%s/msg.%s", msg->base_path, id);
145 talloc_steal(s, tmp_ctx);
146 return s;
150 dispatch a fully received message
152 note that this deliberately can match more than one message handler
153 per message. That allows a single messasging context to register
154 (for example) a debug handler for more than one piece of code
156 static void imessaging_dispatch(struct imessaging_context *msg, struct imessaging_rec *rec)
158 struct dispatch_fn *d, *next;
160 /* temporary IDs use an idtree, the rest use a array of pointers */
161 if (rec->header->msg_type >= MSG_TMP_BASE) {
162 d = (struct dispatch_fn *)idr_find(msg->dispatch_tree,
163 rec->header->msg_type);
164 } else if (rec->header->msg_type < msg->num_types) {
165 d = msg->dispatch[rec->header->msg_type];
166 } else {
167 d = NULL;
170 for (; d; d = next) {
171 DATA_BLOB data;
172 next = d->next;
173 data.data = rec->packet.data + sizeof(*rec->header);
174 data.length = rec->header->length;
175 d->fn(msg, d->private_data, d->msg_type, rec->header->from, &data);
177 rec->header->length = 0;
181 handler for messages that arrive from other nodes in the cluster
183 static void cluster_message_handler(struct imessaging_context *msg, DATA_BLOB packet)
185 struct imessaging_rec *rec;
187 rec = talloc(msg, struct imessaging_rec);
188 if (rec == NULL) {
189 smb_panic("Unable to allocate imessaging_rec");
192 rec->msg = msg;
193 rec->path = msg->path;
194 rec->header = (struct imessaging_header *)packet.data;
195 rec->packet = packet;
196 rec->retries = 0;
198 if (packet.length != sizeof(*rec->header) + rec->header->length) {
199 DEBUG(0,("messaging: bad message header size %d should be %d\n",
200 rec->header->length, (int)(packet.length - sizeof(*rec->header))));
201 talloc_free(rec);
202 return;
205 imessaging_dispatch(msg, rec);
206 talloc_free(rec);
212 try to send the message
214 static NTSTATUS try_send(struct imessaging_rec *rec)
216 struct imessaging_context *msg = rec->msg;
217 size_t nsent;
218 void *priv;
219 NTSTATUS status;
220 struct socket_address *path;
222 /* rec->path is the path of the *other* socket, where we want
223 * this to end up */
224 path = socket_address_from_strings(msg, msg->sock->backend_name,
225 rec->path, 0);
226 if (!path) {
227 return NT_STATUS_NO_MEMORY;
230 /* we send with privileges so messages work from any context */
231 priv = root_privileges();
232 status = socket_sendto(msg->sock, &rec->packet, &nsent, path);
233 talloc_free(path);
234 talloc_free(priv);
236 return status;
240 retry backed off messages
242 static void msg_retry_timer(struct tevent_context *ev, struct tevent_timer *te,
243 struct timeval t, void *private_data)
245 struct imessaging_context *msg = talloc_get_type(private_data,
246 struct imessaging_context);
247 msg->retry_te = NULL;
249 /* put the messages back on the main queue */
250 while (msg->retry_queue) {
251 struct imessaging_rec *rec = msg->retry_queue;
252 DLIST_REMOVE(msg->retry_queue, rec);
253 DLIST_ADD_END(msg->pending, rec, struct imessaging_rec *);
256 TEVENT_FD_WRITEABLE(msg->event.fde);
260 handle a socket write event
262 static void imessaging_send_handler(struct imessaging_context *msg)
264 while (msg->pending) {
265 struct imessaging_rec *rec = msg->pending;
266 NTSTATUS status;
267 status = try_send(rec);
268 if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
269 rec->retries++;
270 if (rec->retries > 3) {
271 /* we're getting continuous write errors -
272 backoff this record */
273 DLIST_REMOVE(msg->pending, rec);
274 DLIST_ADD_END(msg->retry_queue, rec,
275 struct imessaging_rec *);
276 if (msg->retry_te == NULL) {
277 msg->retry_te =
278 tevent_add_timer(msg->event.ev, msg,
279 timeval_current_ofs(1, 0),
280 msg_retry_timer, msg);
283 break;
285 rec->retries = 0;
286 if (!NT_STATUS_IS_OK(status)) {
287 TALLOC_CTX *tmp_ctx = talloc_new(msg);
288 DEBUG(1,("messaging: Lost message from %s to %s of type %u - %s\n",
289 server_id_str(tmp_ctx, &rec->header->from),
290 server_id_str(tmp_ctx, &rec->header->to),
291 rec->header->msg_type,
292 nt_errstr(status)));
293 talloc_free(tmp_ctx);
295 DLIST_REMOVE(msg->pending, rec);
296 talloc_free(rec);
298 if (msg->pending == NULL) {
299 TEVENT_FD_NOT_WRITEABLE(msg->event.fde);
304 handle a new incoming packet
306 static void imessaging_recv_handler(struct imessaging_context *msg)
308 struct imessaging_rec *rec;
309 NTSTATUS status;
310 DATA_BLOB packet;
311 size_t msize;
313 /* see how many bytes are in the next packet */
314 status = socket_pending(msg->sock, &msize);
315 if (!NT_STATUS_IS_OK(status)) {
316 DEBUG(0,("socket_pending failed in messaging - %s\n",
317 nt_errstr(status)));
318 return;
321 packet = data_blob_talloc(msg, NULL, msize);
322 if (packet.data == NULL) {
323 /* assume this is temporary and retry */
324 return;
327 status = socket_recv(msg->sock, packet.data, msize, &msize);
328 if (!NT_STATUS_IS_OK(status)) {
329 data_blob_free(&packet);
330 return;
333 if (msize < sizeof(*rec->header)) {
334 DEBUG(0,("messaging: bad message of size %d\n", (int)msize));
335 data_blob_free(&packet);
336 return;
339 rec = talloc(msg, struct imessaging_rec);
340 if (rec == NULL) {
341 smb_panic("Unable to allocate imessaging_rec");
344 talloc_steal(rec, packet.data);
345 rec->msg = msg;
346 rec->path = msg->path;
347 rec->header = (struct imessaging_header *)packet.data;
348 rec->packet = packet;
349 rec->retries = 0;
351 if (msize != sizeof(*rec->header) + rec->header->length) {
352 DEBUG(0,("messaging: bad message header size %d should be %d\n",
353 rec->header->length, (int)(msize - sizeof(*rec->header))));
354 talloc_free(rec);
355 return;
358 imessaging_dispatch(msg, rec);
359 talloc_free(rec);
364 handle a socket event
366 static void imessaging_handler(struct tevent_context *ev, struct tevent_fd *fde,
367 uint16_t flags, void *private_data)
369 struct imessaging_context *msg = talloc_get_type(private_data,
370 struct imessaging_context);
371 if (flags & TEVENT_FD_WRITE) {
372 imessaging_send_handler(msg);
374 if (flags & TEVENT_FD_READ) {
375 imessaging_recv_handler(msg);
381 Register a dispatch function for a particular message type.
383 NTSTATUS imessaging_register(struct imessaging_context *msg, void *private_data,
384 uint32_t msg_type, msg_callback_t fn)
386 struct dispatch_fn *d;
388 /* possibly expand dispatch array */
389 if (msg_type >= msg->num_types) {
390 struct dispatch_fn **dp;
391 int i;
392 dp = talloc_realloc(msg, msg->dispatch, struct dispatch_fn *, msg_type+1);
393 NT_STATUS_HAVE_NO_MEMORY(dp);
394 msg->dispatch = dp;
395 for (i=msg->num_types;i<=msg_type;i++) {
396 msg->dispatch[i] = NULL;
398 msg->num_types = msg_type+1;
401 d = talloc_zero(msg->dispatch, struct dispatch_fn);
402 NT_STATUS_HAVE_NO_MEMORY(d);
403 d->msg_type = msg_type;
404 d->private_data = private_data;
405 d->fn = fn;
407 DLIST_ADD(msg->dispatch[msg_type], d);
409 return NT_STATUS_OK;
413 register a temporary message handler. The msg_type is allocated
414 above MSG_TMP_BASE
416 NTSTATUS imessaging_register_tmp(struct imessaging_context *msg, void *private_data,
417 msg_callback_t fn, uint32_t *msg_type)
419 struct dispatch_fn *d;
420 int id;
422 d = talloc_zero(msg->dispatch, struct dispatch_fn);
423 NT_STATUS_HAVE_NO_MEMORY(d);
424 d->private_data = private_data;
425 d->fn = fn;
427 id = idr_get_new_above(msg->dispatch_tree, d, MSG_TMP_BASE, UINT16_MAX);
428 if (id == -1) {
429 talloc_free(d);
430 return NT_STATUS_TOO_MANY_CONTEXT_IDS;
433 d->msg_type = (uint32_t)id;
434 (*msg_type) = d->msg_type;
436 return NT_STATUS_OK;
440 De-register the function for a particular message type.
442 void imessaging_deregister(struct imessaging_context *msg, uint32_t msg_type, void *private_data)
444 struct dispatch_fn *d, *next;
446 if (msg_type >= msg->num_types) {
447 d = (struct dispatch_fn *)idr_find(msg->dispatch_tree,
448 msg_type);
449 if (!d) return;
450 idr_remove(msg->dispatch_tree, msg_type);
451 talloc_free(d);
452 return;
455 for (d = msg->dispatch[msg_type]; d; d = next) {
456 next = d->next;
457 if (d->private_data == private_data) {
458 DLIST_REMOVE(msg->dispatch[msg_type], d);
459 talloc_free(d);
465 Send a message to a particular server
467 NTSTATUS imessaging_send(struct imessaging_context *msg, struct server_id server,
468 uint32_t msg_type, const DATA_BLOB *data)
470 struct imessaging_rec *rec;
471 NTSTATUS status;
472 size_t dlength = data?data->length:0;
474 rec = talloc(msg, struct imessaging_rec);
475 if (rec == NULL) {
476 return NT_STATUS_NO_MEMORY;
479 rec->packet = data_blob_talloc(rec, NULL, sizeof(*rec->header) + dlength);
480 if (rec->packet.data == NULL) {
481 talloc_free(rec);
482 return NT_STATUS_NO_MEMORY;
485 rec->retries = 0;
486 rec->msg = msg;
487 rec->header = (struct imessaging_header *)rec->packet.data;
488 /* zero padding */
489 ZERO_STRUCTP(rec->header);
490 rec->header->version = IMESSAGING_VERSION;
491 rec->header->msg_type = msg_type;
492 rec->header->from = msg->server_id;
493 rec->header->to = server;
494 rec->header->length = dlength;
495 if (dlength != 0) {
496 memcpy(rec->packet.data + sizeof(*rec->header),
497 data->data, dlength);
500 if (!cluster_node_equal(&msg->server_id, &server)) {
501 /* the destination is on another node - dispatch via
502 the cluster layer */
503 status = cluster_message_send(server, &rec->packet);
504 talloc_free(rec);
505 return status;
508 rec->path = imessaging_path(msg, server);
509 talloc_steal(rec, rec->path);
511 if (msg->pending != NULL) {
512 status = STATUS_MORE_ENTRIES;
513 } else {
514 status = try_send(rec);
517 if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
518 if (msg->pending == NULL) {
519 TEVENT_FD_WRITEABLE(msg->event.fde);
521 DLIST_ADD_END(msg->pending, rec, struct imessaging_rec *);
522 return NT_STATUS_OK;
525 talloc_free(rec);
527 return status;
531 Send a message to a particular server, with the message containing a single pointer
533 NTSTATUS imessaging_send_ptr(struct imessaging_context *msg, struct server_id server,
534 uint32_t msg_type, void *ptr)
536 DATA_BLOB blob;
538 blob.data = (uint8_t *)&ptr;
539 blob.length = sizeof(void *);
541 return imessaging_send(msg, server, msg_type, &blob);
546 remove our messaging socket and database entry
548 int imessaging_cleanup(struct imessaging_context *msg)
550 if (!msg) {
551 return 0;
554 DEBUG(5,("imessaging: cleaning up %s\n", msg->path));
555 unlink(msg->path);
556 while (msg->names && msg->names[0]) {
557 irpc_remove_name(msg, msg->names[0]);
559 return 0;
563 create the listening socket and setup the dispatcher
565 use temporary=true when you want a destructor to remove the
566 associated messaging socket and database entry on talloc free. Don't
567 use this in processes that may fork and a child may talloc free this
568 memory
570 struct imessaging_context *imessaging_init(TALLOC_CTX *mem_ctx,
571 struct loadparm_context *lp_ctx,
572 struct server_id server_id,
573 struct tevent_context *ev,
574 bool auto_remove)
576 struct imessaging_context *msg;
577 NTSTATUS status;
578 struct socket_address *path;
580 if (ev == NULL) {
581 return NULL;
584 msg = talloc_zero(mem_ctx, struct imessaging_context);
585 if (msg == NULL) {
586 return NULL;
589 /* setup a handler for messages from other cluster nodes, if appropriate */
590 status = cluster_message_init(msg, server_id, cluster_message_handler);
591 if (!NT_STATUS_IS_OK(status)) {
592 talloc_free(msg);
593 return NULL;
596 /* create the messaging directory if needed */
598 msg->lp_ctx = talloc_reference(msg, lp_ctx);
599 if (!msg->lp_ctx) {
600 talloc_free(msg);
601 return NULL;
604 msg->base_path = lpcfg_imessaging_path(msg, lp_ctx);
606 mkdir(msg->base_path, 0700);
608 msg->path = imessaging_path(msg, server_id);
609 msg->server_id = server_id;
610 msg->idr = idr_init(msg);
611 msg->dispatch_tree = idr_init(msg);
612 msg->start_time = timeval_current();
614 status = socket_create("unix", SOCKET_TYPE_DGRAM, &msg->sock, 0);
615 if (!NT_STATUS_IS_OK(status)) {
616 talloc_free(msg);
617 return NULL;
620 /* by stealing here we ensure that the socket is cleaned up (and even
621 deleted) on exit */
622 talloc_steal(msg, msg->sock);
624 path = socket_address_from_strings(msg, msg->sock->backend_name,
625 msg->path, 0);
626 if (!path) {
627 talloc_free(msg);
628 return NULL;
631 status = socket_listen(msg->sock, path, 50, 0);
632 if (!NT_STATUS_IS_OK(status)) {
633 DEBUG(0,("Unable to setup messaging listener for '%s':%s\n", msg->path, nt_errstr(status)));
634 talloc_free(msg);
635 return NULL;
638 /* it needs to be non blocking for sends */
639 set_blocking(socket_get_fd(msg->sock), false);
641 msg->event.ev = ev;
642 msg->event.fde = tevent_add_fd(ev, msg, socket_get_fd(msg->sock),
643 TEVENT_FD_READ, imessaging_handler, msg);
644 tevent_fd_set_auto_close(msg->event.fde);
646 if (auto_remove) {
647 talloc_set_destructor(msg, imessaging_cleanup);
650 imessaging_register(msg, NULL, MSG_PING, ping_message);
651 imessaging_register(msg, NULL, MSG_IRPC, irpc_handler);
652 IRPC_REGISTER(msg, irpc, IRPC_UPTIME, irpc_uptime, msg);
654 return msg;
658 A hack, for the short term until we get 'client only' messaging in place
660 struct imessaging_context *imessaging_client_init(TALLOC_CTX *mem_ctx,
661 struct loadparm_context *lp_ctx,
662 struct tevent_context *ev)
664 struct server_id id;
665 ZERO_STRUCT(id);
666 id.pid = random() % 0x10000000;
667 return imessaging_init(mem_ctx, lp_ctx, id, ev, true);
670 a list of registered irpc server functions
672 struct irpc_list {
673 struct irpc_list *next, *prev;
674 struct GUID uuid;
675 const struct ndr_interface_table *table;
676 int callnum;
677 irpc_function_t fn;
678 void *private_data;
683 register a irpc server function
685 NTSTATUS irpc_register(struct imessaging_context *msg_ctx,
686 const struct ndr_interface_table *table,
687 int callnum, irpc_function_t fn, void *private_data)
689 struct irpc_list *irpc;
691 /* override an existing handler, if any */
692 for (irpc=msg_ctx->irpc; irpc; irpc=irpc->next) {
693 if (irpc->table == table && irpc->callnum == callnum) {
694 break;
697 if (irpc == NULL) {
698 irpc = talloc(msg_ctx, struct irpc_list);
699 NT_STATUS_HAVE_NO_MEMORY(irpc);
700 DLIST_ADD(msg_ctx->irpc, irpc);
703 irpc->table = table;
704 irpc->callnum = callnum;
705 irpc->fn = fn;
706 irpc->private_data = private_data;
707 irpc->uuid = irpc->table->syntax_id.uuid;
709 return NT_STATUS_OK;
714 handle an incoming irpc reply message
716 static void irpc_handler_reply(struct imessaging_context *msg_ctx, struct irpc_message *m)
718 struct irpc_request *irpc;
720 irpc = (struct irpc_request *)idr_find(msg_ctx->idr, m->header.callid);
721 if (irpc == NULL) return;
723 irpc->incoming.handler(irpc, m);
727 send a irpc reply
729 NTSTATUS irpc_send_reply(struct irpc_message *m, NTSTATUS status)
731 struct ndr_push *push;
732 DATA_BLOB packet;
733 enum ndr_err_code ndr_err;
735 m->header.status = status;
737 /* setup the reply */
738 push = ndr_push_init_ctx(m->ndr);
739 if (push == NULL) {
740 status = NT_STATUS_NO_MEMORY;
741 goto failed;
744 m->header.flags |= IRPC_FLAG_REPLY;
745 m->header.creds.token= NULL;
747 /* construct the packet */
748 ndr_err = ndr_push_irpc_header(push, NDR_SCALARS|NDR_BUFFERS, &m->header);
749 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
750 status = ndr_map_error2ntstatus(ndr_err);
751 goto failed;
754 ndr_err = m->irpc->table->calls[m->irpc->callnum].ndr_push(push, NDR_OUT, m->data);
755 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
756 status = ndr_map_error2ntstatus(ndr_err);
757 goto failed;
760 /* send the reply message */
761 packet = ndr_push_blob(push);
762 status = imessaging_send(m->msg_ctx, m->from, MSG_IRPC, &packet);
763 if (!NT_STATUS_IS_OK(status)) goto failed;
765 failed:
766 talloc_free(m);
767 return status;
771 handle an incoming irpc request message
773 static void irpc_handler_request(struct imessaging_context *msg_ctx,
774 struct irpc_message *m)
776 struct irpc_list *i;
777 void *r;
778 enum ndr_err_code ndr_err;
780 for (i=msg_ctx->irpc; i; i=i->next) {
781 if (GUID_equal(&i->uuid, &m->header.uuid) &&
782 i->table->syntax_id.if_version == m->header.if_version &&
783 i->callnum == m->header.callnum) {
784 break;
788 if (i == NULL) {
789 /* no registered handler for this message */
790 talloc_free(m);
791 return;
794 /* allocate space for the structure */
795 r = talloc_zero_size(m->ndr, i->table->calls[m->header.callnum].struct_size);
796 if (r == NULL) goto failed;
798 m->ndr->flags |= LIBNDR_FLAG_REF_ALLOC;
800 /* parse the request data */
801 ndr_err = i->table->calls[i->callnum].ndr_pull(m->ndr, NDR_IN, r);
802 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) goto failed;
804 /* make the call */
805 m->private_data= i->private_data;
806 m->defer_reply = false;
807 m->no_reply = false;
808 m->msg_ctx = msg_ctx;
809 m->irpc = i;
810 m->data = r;
811 m->ev = msg_ctx->event.ev;
813 m->header.status = i->fn(m, r);
815 if (m->no_reply) {
816 /* the server function won't ever be replying to this request */
817 talloc_free(m);
818 return;
821 if (m->defer_reply) {
822 /* the server function has asked to defer the reply to later */
823 talloc_steal(msg_ctx, m);
824 return;
827 irpc_send_reply(m, m->header.status);
828 return;
830 failed:
831 talloc_free(m);
835 handle an incoming irpc message
837 static void irpc_handler(struct imessaging_context *msg_ctx, void *private_data,
838 uint32_t msg_type, struct server_id src, DATA_BLOB *packet)
840 struct irpc_message *m;
841 enum ndr_err_code ndr_err;
843 m = talloc(msg_ctx, struct irpc_message);
844 if (m == NULL) goto failed;
846 m->from = src;
848 m->ndr = ndr_pull_init_blob(packet, m);
849 if (m->ndr == NULL) goto failed;
851 m->ndr->flags |= LIBNDR_FLAG_REF_ALLOC;
853 ndr_err = ndr_pull_irpc_header(m->ndr, NDR_BUFFERS|NDR_SCALARS, &m->header);
854 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) goto failed;
856 if (m->header.flags & IRPC_FLAG_REPLY) {
857 irpc_handler_reply(msg_ctx, m);
858 } else {
859 irpc_handler_request(msg_ctx, m);
861 return;
863 failed:
864 talloc_free(m);
869 destroy a irpc request
871 static int irpc_destructor(struct irpc_request *irpc)
873 if (irpc->callid != -1) {
874 idr_remove(irpc->msg_ctx->idr, irpc->callid);
875 irpc->callid = -1;
878 return 0;
882 open the naming database
884 static struct tdb_wrap *irpc_namedb_open(struct imessaging_context *msg_ctx)
886 struct tdb_wrap *t;
887 char *path = talloc_asprintf(msg_ctx, "%s/names.tdb", msg_ctx->base_path);
888 if (path == NULL) {
889 return NULL;
891 t = tdb_wrap_open(msg_ctx, path, 0, 0, O_RDWR|O_CREAT, 0660, msg_ctx->lp_ctx);
892 talloc_free(path);
893 return t;
898 add a string name that this irpc server can be called on
900 NTSTATUS irpc_add_name(struct imessaging_context *msg_ctx, const char *name)
902 struct tdb_wrap *t;
903 TDB_DATA rec;
904 int count;
905 NTSTATUS status = NT_STATUS_OK;
907 t = irpc_namedb_open(msg_ctx);
908 NT_STATUS_HAVE_NO_MEMORY(t);
910 if (tdb_lock_bystring(t->tdb, name) != 0) {
911 talloc_free(t);
912 return NT_STATUS_LOCK_NOT_GRANTED;
914 rec = tdb_fetch_bystring(t->tdb, name);
915 count = rec.dsize / sizeof(struct server_id);
916 rec.dptr = (unsigned char *)realloc_p(rec.dptr, struct server_id, count+1);
917 rec.dsize += sizeof(struct server_id);
918 if (rec.dptr == NULL) {
919 tdb_unlock_bystring(t->tdb, name);
920 talloc_free(t);
921 return NT_STATUS_NO_MEMORY;
923 ((struct server_id *)rec.dptr)[count] = msg_ctx->server_id;
924 if (tdb_store_bystring(t->tdb, name, rec, 0) != 0) {
925 status = NT_STATUS_INTERNAL_ERROR;
927 free(rec.dptr);
928 tdb_unlock_bystring(t->tdb, name);
929 talloc_free(t);
931 msg_ctx->names = str_list_add(msg_ctx->names, name);
932 talloc_steal(msg_ctx, msg_ctx->names);
934 return status;
938 return a list of server ids for a server name
940 struct server_id *irpc_servers_byname(struct imessaging_context *msg_ctx,
941 TALLOC_CTX *mem_ctx,
942 const char *name)
944 struct tdb_wrap *t;
945 TDB_DATA rec;
946 int count, i;
947 struct server_id *ret;
949 t = irpc_namedb_open(msg_ctx);
950 if (t == NULL) {
951 return NULL;
954 if (tdb_lock_bystring(t->tdb, name) != 0) {
955 talloc_free(t);
956 return NULL;
958 rec = tdb_fetch_bystring(t->tdb, name);
959 if (rec.dptr == NULL) {
960 tdb_unlock_bystring(t->tdb, name);
961 talloc_free(t);
962 return NULL;
964 count = rec.dsize / sizeof(struct server_id);
965 ret = talloc_array(mem_ctx, struct server_id, count+1);
966 if (ret == NULL) {
967 tdb_unlock_bystring(t->tdb, name);
968 talloc_free(t);
969 return NULL;
971 for (i=0;i<count;i++) {
972 ret[i] = ((struct server_id *)rec.dptr)[i];
974 ret[i] = cluster_id(0, 0);
975 free(rec.dptr);
976 tdb_unlock_bystring(t->tdb, name);
977 talloc_free(t);
979 return ret;
983 remove a name from a messaging context
985 void irpc_remove_name(struct imessaging_context *msg_ctx, const char *name)
987 struct tdb_wrap *t;
988 TDB_DATA rec;
989 int count, i;
990 struct server_id *ids;
992 str_list_remove(msg_ctx->names, name);
994 t = irpc_namedb_open(msg_ctx);
995 if (t == NULL) {
996 return;
999 if (tdb_lock_bystring(t->tdb, name) != 0) {
1000 talloc_free(t);
1001 return;
1003 rec = tdb_fetch_bystring(t->tdb, name);
1004 if (rec.dptr == NULL) {
1005 tdb_unlock_bystring(t->tdb, name);
1006 talloc_free(t);
1007 return;
1009 count = rec.dsize / sizeof(struct server_id);
1010 if (count == 0) {
1011 free(rec.dptr);
1012 tdb_unlock_bystring(t->tdb, name);
1013 talloc_free(t);
1014 return;
1016 ids = (struct server_id *)rec.dptr;
1017 for (i=0;i<count;i++) {
1018 if (cluster_id_equal(&ids[i], &msg_ctx->server_id)) {
1019 if (i < count-1) {
1020 memmove(ids+i, ids+i+1,
1021 sizeof(struct server_id) * (count-(i+1)));
1023 rec.dsize -= sizeof(struct server_id);
1024 break;
1027 tdb_store_bystring(t->tdb, name, rec, 0);
1028 free(rec.dptr);
1029 tdb_unlock_bystring(t->tdb, name);
1030 talloc_free(t);
1033 struct server_id imessaging_get_server_id(struct imessaging_context *msg_ctx)
1035 return msg_ctx->server_id;
1038 struct irpc_bh_state {
1039 struct imessaging_context *msg_ctx;
1040 struct server_id server_id;
1041 const struct ndr_interface_table *table;
1042 uint32_t timeout;
1043 struct security_token *token;
1046 static bool irpc_bh_is_connected(struct dcerpc_binding_handle *h)
1048 struct irpc_bh_state *hs = dcerpc_binding_handle_data(h,
1049 struct irpc_bh_state);
1051 if (!hs->msg_ctx) {
1052 return false;
1055 return true;
1058 static uint32_t irpc_bh_set_timeout(struct dcerpc_binding_handle *h,
1059 uint32_t timeout)
1061 struct irpc_bh_state *hs = dcerpc_binding_handle_data(h,
1062 struct irpc_bh_state);
1063 uint32_t old = hs->timeout;
1065 hs->timeout = timeout;
1067 return old;
1070 struct irpc_bh_raw_call_state {
1071 struct irpc_request *irpc;
1072 uint32_t opnum;
1073 DATA_BLOB in_data;
1074 DATA_BLOB in_packet;
1075 DATA_BLOB out_data;
1078 static void irpc_bh_raw_call_incoming_handler(struct irpc_request *irpc,
1079 struct irpc_message *m);
1081 static struct tevent_req *irpc_bh_raw_call_send(TALLOC_CTX *mem_ctx,
1082 struct tevent_context *ev,
1083 struct dcerpc_binding_handle *h,
1084 const struct GUID *object,
1085 uint32_t opnum,
1086 uint32_t in_flags,
1087 const uint8_t *in_data,
1088 size_t in_length)
1090 struct irpc_bh_state *hs =
1091 dcerpc_binding_handle_data(h,
1092 struct irpc_bh_state);
1093 struct tevent_req *req;
1094 struct irpc_bh_raw_call_state *state;
1095 bool ok;
1096 struct irpc_header header;
1097 struct ndr_push *ndr;
1098 NTSTATUS status;
1099 enum ndr_err_code ndr_err;
1101 req = tevent_req_create(mem_ctx, &state,
1102 struct irpc_bh_raw_call_state);
1103 if (req == NULL) {
1104 return NULL;
1106 state->opnum = opnum;
1107 state->in_data.data = discard_const_p(uint8_t, in_data);
1108 state->in_data.length = in_length;
1110 ok = irpc_bh_is_connected(h);
1111 if (!ok) {
1112 tevent_req_nterror(req, NT_STATUS_CONNECTION_DISCONNECTED);
1113 return tevent_req_post(req, ev);
1116 state->irpc = talloc_zero(state, struct irpc_request);
1117 if (tevent_req_nomem(state->irpc, req)) {
1118 return tevent_req_post(req, ev);
1121 state->irpc->msg_ctx = hs->msg_ctx;
1122 state->irpc->callid = idr_get_new(hs->msg_ctx->idr,
1123 state->irpc, UINT16_MAX);
1124 if (state->irpc->callid == -1) {
1125 tevent_req_nterror(req, NT_STATUS_INSUFFICIENT_RESOURCES);
1126 return tevent_req_post(req, ev);
1128 state->irpc->incoming.handler = irpc_bh_raw_call_incoming_handler;
1129 state->irpc->incoming.private_data = req;
1131 talloc_set_destructor(state->irpc, irpc_destructor);
1133 /* setup the header */
1134 header.uuid = hs->table->syntax_id.uuid;
1136 header.if_version = hs->table->syntax_id.if_version;
1137 header.callid = state->irpc->callid;
1138 header.callnum = state->opnum;
1139 header.flags = 0;
1140 header.status = NT_STATUS_OK;
1141 header.creds.token= hs->token;
1143 /* construct the irpc packet */
1144 ndr = ndr_push_init_ctx(state->irpc);
1145 if (tevent_req_nomem(ndr, req)) {
1146 return tevent_req_post(req, ev);
1149 ndr_err = ndr_push_irpc_header(ndr, NDR_SCALARS|NDR_BUFFERS, &header);
1150 status = ndr_map_error2ntstatus(ndr_err);
1151 if (!NT_STATUS_IS_OK(status)) {
1152 tevent_req_nterror(req, status);
1153 return tevent_req_post(req, ev);
1156 ndr_err = ndr_push_bytes(ndr, in_data, in_length);
1157 status = ndr_map_error2ntstatus(ndr_err);
1158 if (!NT_STATUS_IS_OK(status)) {
1159 tevent_req_nterror(req, status);
1160 return tevent_req_post(req, ev);
1163 /* and send it */
1164 state->in_packet = ndr_push_blob(ndr);
1165 status = imessaging_send(hs->msg_ctx, hs->server_id,
1166 MSG_IRPC, &state->in_packet);
1167 if (!NT_STATUS_IS_OK(status)) {
1168 tevent_req_nterror(req, status);
1169 return tevent_req_post(req, ev);
1172 if (hs->timeout != IRPC_CALL_TIMEOUT_INF) {
1173 /* set timeout-callback in case caller wants that */
1174 ok = tevent_req_set_endtime(req, ev, timeval_current_ofs(hs->timeout, 0));
1175 if (!ok) {
1176 return tevent_req_post(req, ev);
1180 return req;
1183 static void irpc_bh_raw_call_incoming_handler(struct irpc_request *irpc,
1184 struct irpc_message *m)
1186 struct tevent_req *req =
1187 talloc_get_type_abort(irpc->incoming.private_data,
1188 struct tevent_req);
1189 struct irpc_bh_raw_call_state *state =
1190 tevent_req_data(req,
1191 struct irpc_bh_raw_call_state);
1193 talloc_steal(state, m);
1195 if (!NT_STATUS_IS_OK(m->header.status)) {
1196 tevent_req_nterror(req, m->header.status);
1197 return;
1200 state->out_data = data_blob_talloc(state,
1201 m->ndr->data + m->ndr->offset,
1202 m->ndr->data_size - m->ndr->offset);
1203 if ((m->ndr->data_size - m->ndr->offset) > 0 && !state->out_data.data) {
1204 tevent_req_oom(req);
1205 return;
1208 tevent_req_done(req);
1211 static NTSTATUS irpc_bh_raw_call_recv(struct tevent_req *req,
1212 TALLOC_CTX *mem_ctx,
1213 uint8_t **out_data,
1214 size_t *out_length,
1215 uint32_t *out_flags)
1217 struct irpc_bh_raw_call_state *state =
1218 tevent_req_data(req,
1219 struct irpc_bh_raw_call_state);
1220 NTSTATUS status;
1222 if (tevent_req_is_nterror(req, &status)) {
1223 tevent_req_received(req);
1224 return status;
1227 *out_data = talloc_move(mem_ctx, &state->out_data.data);
1228 *out_length = state->out_data.length;
1229 *out_flags = 0;
1230 tevent_req_received(req);
1231 return NT_STATUS_OK;
1234 struct irpc_bh_disconnect_state {
1235 uint8_t _dummy;
1238 static struct tevent_req *irpc_bh_disconnect_send(TALLOC_CTX *mem_ctx,
1239 struct tevent_context *ev,
1240 struct dcerpc_binding_handle *h)
1242 struct irpc_bh_state *hs = dcerpc_binding_handle_data(h,
1243 struct irpc_bh_state);
1244 struct tevent_req *req;
1245 struct irpc_bh_disconnect_state *state;
1246 bool ok;
1248 req = tevent_req_create(mem_ctx, &state,
1249 struct irpc_bh_disconnect_state);
1250 if (req == NULL) {
1251 return NULL;
1254 ok = irpc_bh_is_connected(h);
1255 if (!ok) {
1256 tevent_req_nterror(req, NT_STATUS_CONNECTION_DISCONNECTED);
1257 return tevent_req_post(req, ev);
1260 hs->msg_ctx = NULL;
1262 tevent_req_done(req);
1263 return tevent_req_post(req, ev);
1266 static NTSTATUS irpc_bh_disconnect_recv(struct tevent_req *req)
1268 NTSTATUS status;
1270 if (tevent_req_is_nterror(req, &status)) {
1271 tevent_req_received(req);
1272 return status;
1275 tevent_req_received(req);
1276 return NT_STATUS_OK;
1279 static bool irpc_bh_ref_alloc(struct dcerpc_binding_handle *h)
1281 return true;
1284 static const struct dcerpc_binding_handle_ops irpc_bh_ops = {
1285 .name = "wbint",
1286 .is_connected = irpc_bh_is_connected,
1287 .set_timeout = irpc_bh_set_timeout,
1288 .raw_call_send = irpc_bh_raw_call_send,
1289 .raw_call_recv = irpc_bh_raw_call_recv,
1290 .disconnect_send = irpc_bh_disconnect_send,
1291 .disconnect_recv = irpc_bh_disconnect_recv,
1293 .ref_alloc = irpc_bh_ref_alloc,
1296 /* initialise a irpc binding handle */
1297 struct dcerpc_binding_handle *irpc_binding_handle(TALLOC_CTX *mem_ctx,
1298 struct imessaging_context *msg_ctx,
1299 struct server_id server_id,
1300 const struct ndr_interface_table *table)
1302 struct dcerpc_binding_handle *h;
1303 struct irpc_bh_state *hs;
1305 h = dcerpc_binding_handle_create(mem_ctx,
1306 &irpc_bh_ops,
1307 NULL,
1308 table,
1309 &hs,
1310 struct irpc_bh_state,
1311 __location__);
1312 if (h == NULL) {
1313 return NULL;
1315 hs->msg_ctx = msg_ctx;
1316 hs->server_id = server_id;
1317 hs->table = table;
1318 hs->timeout = IRPC_CALL_TIMEOUT;
1320 dcerpc_binding_handle_set_sync_ev(h, msg_ctx->event.ev);
1322 return h;
1325 struct dcerpc_binding_handle *irpc_binding_handle_by_name(TALLOC_CTX *mem_ctx,
1326 struct imessaging_context *msg_ctx,
1327 const char *dest_task,
1328 const struct ndr_interface_table *table)
1330 struct dcerpc_binding_handle *h;
1331 struct server_id *sids;
1332 struct server_id sid;
1334 /* find the server task */
1335 sids = irpc_servers_byname(msg_ctx, mem_ctx, dest_task);
1336 if (sids == NULL) {
1337 errno = EADDRNOTAVAIL;
1338 return NULL;
1340 if (sids[0].pid == 0) {
1341 talloc_free(sids);
1342 errno = EADDRNOTAVAIL;
1343 return NULL;
1345 sid = sids[0];
1346 talloc_free(sids);
1348 h = irpc_binding_handle(mem_ctx, msg_ctx,
1349 sid, table);
1350 if (h == NULL) {
1351 return NULL;
1354 return h;
1357 void irpc_binding_handle_add_security_token(struct dcerpc_binding_handle *h,
1358 struct security_token *token)
1360 struct irpc_bh_state *hs =
1361 dcerpc_binding_handle_data(h,
1362 struct irpc_bh_state);
1364 hs->token = token;