r15356: Remove unused 'flags' argument from socket_send() and friends.
[bbaumbach/samba-autobuild/.git] / source4 / lib / messaging / messaging.c
index 911d439de1993be545b036a2216a3d5489dea07f..bf06d68a3386911e66d8e89db81d12b2ff3b35dd 100644 (file)
 
 #include "includes.h"
 #include "lib/events/events.h"
-#include "system/dir.h"
 #include "system/filesys.h"
-#include "system/time.h"
-#include "messages.h"
+#include "messaging/messaging.h"
 #include "dlinklist.h"
 #include "lib/socket/socket.h"
 #include "librpc/gen_ndr/ndr_irpc.h"
 #include "lib/messaging/irpc.h"
 #include "db_wrap.h"
-#include "lib/tdb/include/tdb.h"
 #include "lib/tdb/include/tdbutil.h"
+#include "lib/util/unix_privs.h"
+#include "librpc/rpc/dcerpc.h"
 
 /* change the message version with any incompatible changes in the protocol */
 #define MESSAGING_VERSION 1
@@ -42,7 +41,9 @@ struct messaging_context {
        struct socket_context *sock;
        const char *base_path;
        const char *path;
-       struct dispatch_fn *dispatch;
+       struct dispatch_fn **dispatch;
+       uint32_t num_types;
+       struct idr_context *dispatch_tree;
        struct messaging_rec *pending;
        struct irpc_list *irpc;
        struct idr_context *idr;
@@ -55,14 +56,13 @@ struct messaging_context {
        } event;
 };
 
-/* we have a linked list of dispatch handlers that this messaging
-   server can deal with */
+/* we have a linked list of dispatch handlers for each msg_type that
+   this messaging server can deal with */
 struct dispatch_fn {
        struct dispatch_fn *next, *prev;
        uint32_t msg_type;
        void *private;
-       void (*fn)(struct messaging_context *msg, void *private, 
-                  uint32_t msg_type, uint32_t server_id, DATA_BLOB *data);
+       msg_callback_t fn;
 };
 
 /* an individual message */
@@ -120,18 +120,30 @@ static char *messaging_path(struct messaging_context *msg, uint32_t server_id)
 
 /*
   dispatch a fully received message
+
+  note that this deliberately can match more than one message handler
+  per message. That allows a single messasging context to register
+  (for example) a debug handler for more than one piece of code
 */
 static void messaging_dispatch(struct messaging_context *msg, struct messaging_rec *rec)
 {
        struct dispatch_fn *d, *next;
-       for (d=msg->dispatch;d;d=next) {
+
+       /* temporary IDs use an idtree, the rest use a array of pointers */
+       if (rec->header->msg_type >= MSG_TMP_BASE) {
+               d = idr_find(msg->dispatch_tree, rec->header->msg_type);
+       } else if (rec->header->msg_type < msg->num_types) {
+               d = msg->dispatch[rec->header->msg_type];
+       } else {
+               d = NULL;
+       }
+
+       for (; d; d = next) {
+               DATA_BLOB data;
                next = d->next;
-               if (d->msg_type == rec->header->msg_type) {
-                       DATA_BLOB data;
-                       data.data = rec->packet.data + sizeof(*rec->header);
-                       data.length = rec->header->length;
-                       d->fn(msg, d->private, d->msg_type, rec->header->from, &data);
-               }
+               data.data = rec->packet.data + sizeof(*rec->header);
+               data.length = rec->header->length;
+               d->fn(msg, d->private, d->msg_type, rec->header->from, &data);
        }
        rec->header->length = 0;
 }
@@ -146,10 +158,20 @@ static NTSTATUS try_send(struct messaging_rec *rec)
        size_t nsent;
        void *priv;
        NTSTATUS status;
+       struct socket_address *path;
+
+       /* rec->path is the path of the *other* socket, where we want
+        * this to end up */
+       path = socket_address_from_strings(msg, msg->sock->backend_name, 
+                                          rec->path, 0);
+       if (!path) {
+               return NT_STATUS_NO_MEMORY;
+       }
 
        /* we send with privileges so messages work from any context */
        priv = root_privileges();
-       status = socket_sendto(msg->sock, &rec->packet, &nsent, 0, rec->path, 0);
+       status = socket_sendto(msg->sock, &rec->packet, &nsent, path);
+       talloc_free(path);
        talloc_free(priv);
 
        return status;
@@ -204,7 +226,7 @@ static void messaging_recv_handler(struct messaging_context *msg)
                return;
        }
            
-       status = socket_recv(msg->sock, packet.data, msize, &msize, 0);
+       status = socket_recv(msg->sock, packet.data, msize, &msize);
        if (!NT_STATUS_IS_OK(status)) {
                data_blob_free(&packet);
                return;
@@ -259,17 +281,60 @@ static void messaging_handler(struct event_context *ev, struct fd_event *fde,
 /*
   Register a dispatch function for a particular message type.
 */
-void messaging_register(struct messaging_context *msg, void *private,
-                       uint32_t msg_type, 
-                       void (*fn)(struct messaging_context *, void *, uint32_t, uint32_t, DATA_BLOB *))
+NTSTATUS messaging_register(struct messaging_context *msg, void *private,
+                           uint32_t msg_type, msg_callback_t fn)
 {
        struct dispatch_fn *d;
 
-       d = talloc(msg, struct dispatch_fn);
+       /* possibly expand dispatch array */
+       if (msg_type >= msg->num_types) {
+               struct dispatch_fn **dp;
+               int i;
+               dp = talloc_realloc(msg, msg->dispatch, struct dispatch_fn *, msg_type+1);
+               NT_STATUS_HAVE_NO_MEMORY(dp);
+               msg->dispatch = dp;
+               for (i=msg->num_types;i<=msg_type;i++) {
+                       msg->dispatch[i] = NULL;
+               }
+               msg->num_types = msg_type+1;
+       }
+
+       d = talloc_zero(msg->dispatch, struct dispatch_fn);
+       NT_STATUS_HAVE_NO_MEMORY(d);
        d->msg_type = msg_type;
        d->private = private;
        d->fn = fn;
-       DLIST_ADD(msg->dispatch, d);
+
+       DLIST_ADD(msg->dispatch[msg_type], d);
+
+       return NT_STATUS_OK;
+}
+
+/*
+  register a temporary message handler. The msg_type is allocated
+  above MSG_TMP_BASE
+*/
+NTSTATUS messaging_register_tmp(struct messaging_context *msg, void *private,
+                               msg_callback_t fn, uint32_t *msg_type)
+{
+       struct dispatch_fn *d;
+       int id;
+
+       d = talloc_zero(msg->dispatch, struct dispatch_fn);
+       NT_STATUS_HAVE_NO_MEMORY(d);
+       d->private = private;
+       d->fn = fn;
+
+       id = idr_get_new_above(msg->dispatch_tree, d, MSG_TMP_BASE, UINT16_MAX);
+       if (id == -1) {
+               talloc_free(d);
+               return NT_STATUS_TOO_MANY_CONTEXT_IDS;
+       }
+
+       d->msg_type = (uint32_t)id;
+       (*msg_type) = d->msg_type;
+
+       return NT_STATUS_OK;
 }
 
 /*
@@ -279,17 +344,23 @@ void messaging_deregister(struct messaging_context *msg, uint32_t msg_type, void
 {
        struct dispatch_fn *d, *next;
 
-       for (d = msg->dispatch; d; d = next) {
+       if (msg_type >= msg->num_types) {
+               d = idr_find(msg->dispatch_tree, msg_type);
+               if (!d) return;
+               idr_remove(msg->dispatch_tree, msg_type);
+               talloc_free(d);
+               return;
+       }
+
+       for (d = msg->dispatch[msg_type]; d; d = next) {
                next = d->next;
-               if (d->msg_type == msg_type && 
-                   d->private == private) {
-                       DLIST_REMOVE(msg->dispatch, d);
+               if (d->private == private) {
+                       DLIST_REMOVE(msg->dispatch[msg_type], d);
                        talloc_free(d);
                }
-       }       
+       }
 }
 
-
 /*
   Send a message to a particular server
 */
@@ -381,9 +452,10 @@ struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx, uint32_t server_id
 {
        struct messaging_context *msg;
        NTSTATUS status;
-       char *path;
+       struct socket_address *path;
+       char *dir;
 
-       msg = talloc(mem_ctx, struct messaging_context);
+       msg = talloc_zero(mem_ctx, struct messaging_context);
        if (msg == NULL) {
                return NULL;
        }
@@ -393,19 +465,16 @@ struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx, uint32_t server_id
        }
 
        /* create the messaging directory if needed */
-       path = smbd_tmp_path(msg, "messaging");
-       mkdir(path, 0700);
-       talloc_free(path);
+       dir = smbd_tmp_path(msg, "messaging");
+       mkdir(dir, 0700);
+       talloc_free(dir);
 
-       msg->base_path  = smbd_tmp_path(msg, "messaging");
-       msg->path       = messaging_path(msg, server_id);
-       msg->server_id  = server_id;
-       msg->dispatch   = NULL;
-       msg->pending    = NULL;
-       msg->idr        = idr_init(msg);
-       msg->irpc       = NULL;
-       msg->names      = NULL;
-       msg->start_time = timeval_current();
+       msg->base_path     = smbd_tmp_path(msg, "messaging");
+       msg->path          = messaging_path(msg, server_id);
+       msg->server_id     = server_id;
+       msg->idr           = idr_init(msg);
+       msg->dispatch_tree = idr_init(msg);
+       msg->start_time    = timeval_current();
 
        status = socket_create("unix", SOCKET_TYPE_DGRAM, &msg->sock, 0);
        if (!NT_STATUS_IS_OK(status)) {
@@ -417,7 +486,14 @@ struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx, uint32_t server_id
           deleted) on exit */
        talloc_steal(msg, msg->sock);
 
-       status = socket_listen(msg->sock, msg->path, 0, 50, 0);
+       path = socket_address_from_strings(msg, msg->sock->backend_name, 
+                                          msg->path, 0);
+       if (!path) {
+               talloc_free(msg);
+               return NULL;
+       }
+
+       status = socket_listen(msg->sock, path, 50, 0);
        if (!NT_STATUS_IS_OK(status)) {
                DEBUG(0,("Unable to setup messaging listener for '%s':%s\n", msg->path, nt_errstr(status)));
                talloc_free(msg);
@@ -440,7 +516,14 @@ struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx, uint32_t server_id
        return msg;
 }
 
-
+/* 
+   A hack, for the short term until we get 'client only' messaging in place 
+*/
+struct messaging_context *messaging_client_init(TALLOC_CTX *mem_ctx, 
+                                               struct event_context *ev)
+{
+       return messaging_init(mem_ctx, random() % 0x10000000, ev);
+}
 /*
   a list of registered irpc server functions
 */
@@ -479,7 +562,7 @@ NTSTATUS irpc_register(struct messaging_context *msg_ctx,
        irpc->callnum = callnum;
        irpc->fn      = fn;
        irpc->private = private;
-       GUID_from_string(irpc->table->uuid, &irpc->uuid);
+       irpc->uuid = irpc->table->syntax_id.uuid;
 
        return NT_STATUS_OK;
 }
@@ -488,88 +571,116 @@ NTSTATUS irpc_register(struct messaging_context *msg_ctx,
 /*
   handle an incoming irpc reply message
 */
-static void irpc_handler_reply(struct messaging_context *msg_ctx, 
-                              struct ndr_pull *ndr, struct irpc_header *header)
+static void irpc_handler_reply(struct messaging_context *msg_ctx, struct irpc_message *m)
 {
        struct irpc_request *irpc;
 
-       irpc = idr_find(msg_ctx->idr, header->callid);
+       irpc = idr_find(msg_ctx->idr, m->header.callid);
        if (irpc == NULL) return;
 
        /* parse the reply data */
-       irpc->status = irpc->table->calls[irpc->callnum].ndr_pull(ndr, NDR_OUT, irpc->r);
+       irpc->status = irpc->table->calls[irpc->callnum].ndr_pull(m->ndr, NDR_OUT, irpc->r);
        if (NT_STATUS_IS_OK(irpc->status)) {
-               irpc->status = header->status;
+               irpc->status = m->header.status;
+               talloc_steal(irpc->mem_ctx, m);
+       } else {
+               talloc_steal(irpc, m);
        }
        irpc->done = True;
-       talloc_steal(irpc, ndr);
        if (irpc->async.fn) {
                irpc->async.fn(irpc);
        }
 }
 
+/*
+  send a irpc reply
+*/
+NTSTATUS irpc_send_reply(struct irpc_message *m, NTSTATUS status)
+{
+       struct ndr_push *push;
+       DATA_BLOB packet;
+
+       m->header.status = status;
+
+       /* setup the reply */
+       push = ndr_push_init_ctx(m->ndr);
+       if (push == NULL) {
+               status = NT_STATUS_NO_MEMORY;
+               goto failed;
+       }
+
+       m->header.flags |= IRPC_FLAG_REPLY;
+
+       /* construct the packet */
+       status = ndr_push_irpc_header(push, NDR_SCALARS|NDR_BUFFERS, &m->header);
+       if (!NT_STATUS_IS_OK(status)) goto failed;
+
+       status = m->irpc->table->calls[m->irpc->callnum].ndr_push(push, NDR_OUT, m->data);
+       if (!NT_STATUS_IS_OK(status)) goto failed;
+
+       /* send the reply message */
+       packet = ndr_push_blob(push);
+       status = messaging_send(m->msg_ctx, m->from, MSG_IRPC, &packet);
+       if (!NT_STATUS_IS_OK(status)) goto failed;
+
+failed:
+       talloc_free(m);
+       return status;
+}
 
 /*
   handle an incoming irpc request message
 */
 static void irpc_handler_request(struct messaging_context *msg_ctx, 
-                                struct ndr_pull *ndr, struct irpc_header *header,
-                                uint32_t src)
+                                struct irpc_message *m)
 {
        struct irpc_list *i;
        void *r;
        NTSTATUS status;
-       struct irpc_message m;
-       struct ndr_push *push;
-       DATA_BLOB packet;
 
        for (i=msg_ctx->irpc; i; i=i->next) {
-               if (GUID_equal(&i->uuid, &header->uuid) &&
-                   i->table->if_version == header->if_version &&
-                   i->callnum == header->callnum) {
+               if (GUID_equal(&i->uuid, &m->header.uuid) &&
+                   i->table->syntax_id.if_version == m->header.if_version &&
+                   i->callnum == m->header.callnum) {
                        break;
                }
        }
 
        if (i == NULL) {
                /* no registered handler for this message */
+               talloc_free(m);
                return;
        }
 
        /* allocate space for the structure */
-       r = talloc_zero_size(ndr, i->table->calls[header->callnum].struct_size);
+       r = talloc_zero_size(m->ndr, i->table->calls[m->header.callnum].struct_size);
        if (r == NULL) goto failed;
 
        /* parse the request data */
-       status = i->table->calls[i->callnum].ndr_pull(ndr, NDR_IN, r);
+       status = i->table->calls[i->callnum].ndr_pull(m->ndr, NDR_IN, r);
        if (!NT_STATUS_IS_OK(status)) goto failed;
 
        /* make the call */
-       m.from    = src;
-       m.private = i->private;
-       header->status = i->fn(&m, r);
-
-       /* setup the reply */
-       push = ndr_push_init_ctx(ndr);
-       if (push == NULL) goto failed;
-
-       header->flags |= IRPC_FLAG_REPLY;
-
-       /* construct the packet */
-       status = ndr_push_irpc_header(push, NDR_SCALARS|NDR_BUFFERS, header);
-       if (!NT_STATUS_IS_OK(status)) goto failed;
-
-       status = i->table->calls[i->callnum].ndr_push(push, NDR_OUT, r);
-       if (!NT_STATUS_IS_OK(status)) goto failed;
+       m->private     = i->private;
+       m->defer_reply = False;
+       m->msg_ctx     = msg_ctx;
+       m->irpc        = i;
+       m->data        = r;
+       m->ev          = msg_ctx->event.ev;
+
+       m->header.status = i->fn(m, r);
+
+       if (m->defer_reply) {
+               /* the server function has asked to defer the reply to later */
+               talloc_steal(msg_ctx, m);
+               return;
+       }
 
-       /* send the reply message */
-       packet = ndr_push_blob(push);
-       status = messaging_send(msg_ctx, src, MSG_IRPC, &packet);
-       if (!NT_STATUS_IS_OK(status)) goto failed;
+       irpc_send_reply(m, m->header.status);
+       return;
 
 failed:
-       /* nothing to clean up */
-       return;
+       talloc_free(m);
 }
 
 /*
@@ -578,28 +689,31 @@ failed:
 static void irpc_handler(struct messaging_context *msg_ctx, void *private, 
                         uint32_t msg_type, uint32_t src, DATA_BLOB *packet)
 {
-       struct irpc_header header;
-       struct ndr_pull *ndr;
+       struct irpc_message *m;
        NTSTATUS status;
 
-       ndr = ndr_pull_init_blob(packet, msg_ctx);
-       if (ndr == NULL) goto failed;
+       m = talloc(msg_ctx, struct irpc_message);
+       if (m == NULL) goto failed;
 
-       ndr->flags |= LIBNDR_FLAG_REF_ALLOC;
+       m->from = src;
 
-       status = ndr_pull_irpc_header(ndr, NDR_BUFFERS|NDR_SCALARS, &header);
+       m->ndr = ndr_pull_init_blob(packet, m);
+       if (m->ndr == NULL) goto failed;
+
+       m->ndr->flags |= LIBNDR_FLAG_REF_ALLOC;
+
+       status = ndr_pull_irpc_header(m->ndr, NDR_BUFFERS|NDR_SCALARS, &m->header);
        if (!NT_STATUS_IS_OK(status)) goto failed;
 
-       if (header.flags & IRPC_FLAG_REPLY) {
-               irpc_handler_reply(msg_ctx, ndr, &header);
+       if (m->header.flags & IRPC_FLAG_REPLY) {
+               irpc_handler_reply(msg_ctx, m);
        } else {
-               irpc_handler_request(msg_ctx, ndr, &header, src);
-               talloc_free(ndr);
+               irpc_handler_request(msg_ctx, m);
        }
        return;
 
 failed:
-       talloc_free(ndr);
+       talloc_free(m);
 }
 
 
@@ -634,7 +748,7 @@ static void irpc_timeout(struct event_context *ev, struct timed_event *te,
 struct irpc_request *irpc_call_send(struct messaging_context *msg_ctx, 
                                    uint32_t server_id, 
                                    const struct dcerpc_interface_table *table, 
-                                   int callnum, void *r)
+                                   int callnum, void *r, TALLOC_CTX *ctx)
 {
        struct irpc_header header;
        struct ndr_push *ndr;
@@ -653,14 +767,14 @@ struct irpc_request *irpc_call_send(struct messaging_context *msg_ctx,
        irpc->r        = r;
        irpc->done     = False;
        irpc->async.fn = NULL;
+       irpc->mem_ctx  = ctx;
 
        talloc_set_destructor(irpc, irpc_destructor);
 
        /* setup the header */
-       status = GUID_from_string(table->uuid, &header.uuid);
-       if (!NT_STATUS_IS_OK(status)) goto failed;
+       header.uuid = table->syntax_id.uuid;
 
-       header.if_version = table->if_version;
+       header.if_version = table->syntax_id.if_version;
        header.callid     = irpc->callid;
        header.callnum    = callnum;
        header.flags      = 0;
@@ -698,13 +812,18 @@ failed:
 */
 NTSTATUS irpc_call_recv(struct irpc_request *irpc)
 {
+       NTSTATUS status;
+
        NT_STATUS_HAVE_NO_MEMORY(irpc);
+
        while (!irpc->done) {
                if (event_loop_once(irpc->msg_ctx->event.ev) != 0) {
                        return NT_STATUS_CONNECTION_DISCONNECTED;
-               }               
+               }
        }
-       return irpc->status;
+       status = irpc->status;
+       talloc_free(irpc);
+       return status;
 }
 
 /*
@@ -713,13 +832,12 @@ NTSTATUS irpc_call_recv(struct irpc_request *irpc)
 NTSTATUS irpc_call(struct messaging_context *msg_ctx, 
                   uint32_t server_id, 
                   const struct dcerpc_interface_table *table, 
-                  int callnum, void *r)
+                  int callnum, void *r,
+                  TALLOC_CTX *mem_ctx)
 {
        struct irpc_request *irpc = irpc_call_send(msg_ctx, server_id, 
-                                                  table, callnum, r);
-       NTSTATUS status = irpc_call_recv(irpc);
-       talloc_free(irpc);
-       return status;
+                                                  table, callnum, r, mem_ctx);
+       return irpc_call_recv(irpc);
 }
 
 /*
@@ -757,7 +875,7 @@ NTSTATUS irpc_add_name(struct messaging_context *msg_ctx, const char *name)
        }
        rec = tdb_fetch_bystring(t->tdb, name);
        count = rec.dsize / sizeof(uint32_t);
-       rec.dptr = (char *)realloc_p(rec.dptr, uint32_t, count+1);
+       rec.dptr = (unsigned char *)realloc_p(rec.dptr, uint32_t, count+1);
        rec.dsize += sizeof(uint32_t);
        if (rec.dptr == NULL) {
                tdb_unlock_bystring(t->tdb, name);