source/lib/messages.c

   1 /*
   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
   8
   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 2 of the License, or
  12    (at your option) any later version.
  13
  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.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 /**
  25   @defgroup messages Internal messaging framework
  26   @{
  27   @file messages.c
  28
  29   @brief  Module for internal messaging between Samba daemons.
  30
  31    The idea is that if a part of Samba wants to do communication with
  32    another Samba process then it will do a message_register() of a
  33    dispatch function, and use message_send_pid() to send messages to
  34    that process.
  35
  36    The dispatch function is given the pid of the sender, and it can
  37    use that to reply by message_send_pid().  See ping_message() for a
  38    simple example.
  39
  40    @caution Dispatch functions must be able to cope with incoming
  41    messages on an *odd* byte boundary.
  42
  43    This system doesn't have any inherent size limitations but is not
  44    very efficient for large messages or when messages are sent in very
  45    quick succession.
  46
  47 */
  48
  49 #include "includes.h"
  50 #include "librpc/gen_ndr/messaging.h"
  51 #include "librpc/gen_ndr/ndr_messaging.h"
  52
  53 struct messaging_callback {
  54         struct messaging_callback *prev, *next;
  55         uint32 msg_type;
  56         void (*fn)(struct messaging_context *msg, void *private_data,
  57                    uint32_t msg_type,
  58                    struct server_id server_id, DATA_BLOB *data);
  59         void *private_data;
  60 };
  61
  62 /****************************************************************************
  63  A useful function for testing the message system.
  64 ****************************************************************************/
  65
  66 static void ping_message(struct messaging_context *msg_ctx,
  67                          void *private_data,
  68                          uint32_t msg_type,
  69                          struct server_id src,
  70                          DATA_BLOB *data)
  71 {
  72         const char *msg = data->data ? (const char *)data->data : "none";
  73
  74         DEBUG(1,("INFO: Received PING message from PID %s [%s]\n",
  75                  procid_str_static(&src), msg));
  76         messaging_send(msg_ctx, src, MSG_PONG, data);
  77 }
  78
  79 /****************************************************************************
  80  Register/replace a dispatch function for a particular message type.
  81  JRA changed Dec 13 2006. Only one message handler now permitted per type.
  82  *NOTE*: Dispatch functions must be able to cope with incoming
  83  messages on an *odd* byte boundary.
  84 ****************************************************************************/
  85
  86 struct msg_all {
  87         struct messaging_context *msg_ctx;
  88         int msg_type;
  89         uint32 msg_flag;
  90         const void *buf;
  91         size_t len;
  92         int n_sent;
  93 };
  94
  95 /****************************************************************************
  96  Send one of the messages for the broadcast.
  97 ****************************************************************************/
  98
  99 static int traverse_fn(struct db_record *rec,
 100                        const struct connections_key *ckey,
 101                        const struct connections_data *crec,
 102                        void *state)
 103 {
 104         struct msg_all *msg_all = (struct msg_all *)state;
 105         NTSTATUS status;
 106
 107         if (crec->cnum != -1)
 108                 return 0;
 109
 110         /* Don't send if the receiver hasn't registered an interest. */
 111
 112         if(!(crec->bcast_msg_flags & msg_all->msg_flag))
 113                 return 0;
 114
 115         /* If the msg send fails because the pid was not found (i.e. smbd died),
 116          * the msg has already been deleted from the messages.tdb.*/
 117
 118         status = messaging_send_buf(msg_all->msg_ctx,
 119                                     crec->pid, msg_all->msg_type,
 120                                     (uint8 *)msg_all->buf, msg_all->len);
 121
 122         if (NT_STATUS_EQUAL(status, NT_STATUS_INVALID_HANDLE)) {
 123
 124                 /* If the pid was not found delete the entry from connections.tdb */
 125
 126                 DEBUG(2,("pid %s doesn't exist - deleting connections %d [%s]\n",
 127                          procid_str_static(&crec->pid), crec->cnum,
 128                          crec->servicename));
 129
 130                 rec->delete_rec(rec);
 131         }
 132         msg_all->n_sent++;
 133         return 0;
 134 }
 135
 136 /**
 137  * Send a message to all smbd processes.
 138  *
 139  * It isn't very efficient, but should be OK for the sorts of
 140  * applications that use it. When we need efficient broadcast we can add
 141  * it.
 142  *
 143  * @param n_sent Set to the number of messages sent.  This should be
 144  * equal to the number of processes, but be careful for races.
 145  *
 146  * @retval True for success.
 147  **/
 148 BOOL message_send_all(struct messaging_context *msg_ctx,
 149                       int msg_type,
 150                       const void *buf, size_t len,
 151                       int *n_sent)
 152 {
 153         struct msg_all msg_all;
 154
 155         msg_all.msg_type = msg_type;
 156         if (msg_type < 1000)
 157                 msg_all.msg_flag = FLAG_MSG_GENERAL;
 158         else if (msg_type > 1000 && msg_type < 2000)
 159                 msg_all.msg_flag = FLAG_MSG_NMBD;
 160         else if (msg_type > 2000 && msg_type < 2100)
 161                 msg_all.msg_flag = FLAG_MSG_PRINT_NOTIFY;
 162         else if (msg_type > 2100 && msg_type < 3000)
 163                 msg_all.msg_flag = FLAG_MSG_PRINT_GENERAL;
 164         else if (msg_type > 3000 && msg_type < 4000)
 165                 msg_all.msg_flag = FLAG_MSG_SMBD;
 166         else
 167                 return False;
 168
 169         msg_all.buf = buf;
 170         msg_all.len = len;
 171         msg_all.n_sent = 0;
 172         msg_all.msg_ctx = msg_ctx;
 173
 174         connections_forall(traverse_fn, &msg_all);
 175         if (n_sent)
 176                 *n_sent = msg_all.n_sent;
 177         return True;
 178 }
 179
 180 struct event_context *messaging_event_context(struct messaging_context *msg_ctx)
 181 {
 182         return msg_ctx->event_ctx;
 183 }
 184
 185 struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx,
 186                                          struct server_id server_id,
 187                                          struct event_context *ev)
 188 {
 189         struct messaging_context *ctx;
 190         NTSTATUS status;
 191
 192         if (!(ctx = TALLOC_ZERO_P(mem_ctx, struct messaging_context))) {
 193                 return NULL;
 194         }
 195
 196         ctx->id = server_id;
 197         ctx->event_ctx = ev;
 198
 199         status = messaging_tdb_init(ctx, ctx, &ctx->local);
 200
 201         if (!NT_STATUS_IS_OK(status)) {
 202                 DEBUG(0, ("messaging_tdb_init failed: %s\n", nt_errstr(status)));
 203                 TALLOC_FREE(ctx);
 204         }
 205
 206         messaging_register(ctx, NULL, MSG_PING, ping_message);
 207
 208         /* Register some debugging related messages */
 209
 210         register_msg_pool_usage(ctx);
 211         register_dmalloc_msgs(ctx);
 212         debug_register_msgs(ctx);
 213
 214         return ctx;
 215 }
 216
 217 /*
 218  * Register a dispatch function for a particular message type. Allow multiple
 219  * registrants
 220 */
 221 NTSTATUS messaging_register(struct messaging_context *msg_ctx,
 222                             void *private_data,
 223                             uint32_t msg_type,
 224                             void (*fn)(struct messaging_context *msg,
 225                                        void *private_data,
 226                                        uint32_t msg_type,
 227                                        struct server_id server_id,
 228                                        DATA_BLOB *data))
 229 {
 230         struct messaging_callback *cb;
 231
 232         /*
 233          * Only one callback per type
 234          */
 235
 236         for (cb = msg_ctx->callbacks; cb != NULL; cb = cb->next) {
 237                 if (cb->msg_type == msg_type) {
 238                         cb->fn = fn;
 239                         cb->private_data = private_data;
 240                         return NT_STATUS_OK;
 241                 }
 242         }
 243
 244         if (!(cb = talloc(msg_ctx, struct messaging_callback))) {
 245                 return NT_STATUS_NO_MEMORY;
 246         }
 247
 248         cb->msg_type = msg_type;
 249         cb->fn = fn;
 250         cb->private_data = private_data;
 251
 252         DLIST_ADD(msg_ctx->callbacks, cb);
 253         return NT_STATUS_OK;
 254 }
 255
 256 /*
 257   De-register the function for a particular message type.
 258 */
 259 void messaging_deregister(struct messaging_context *ctx, uint32_t msg_type,
 260                           void *private_data)
 261 {
 262         struct messaging_callback *cb, *next;
 263
 264         for (cb = ctx->callbacks; cb; cb = next) {
 265                 next = cb->next;
 266                 if ((cb->msg_type == msg_type)
 267                     && (cb->private_data == private_data)) {
 268                         DLIST_REMOVE(ctx->callbacks, cb);
 269                         TALLOC_FREE(cb);
 270                 }
 271         }
 272 }
 273
 274 /*
 275   Send a message to a particular server
 276 */
 277 NTSTATUS messaging_send(struct messaging_context *msg_ctx,
 278                         struct server_id server, uint32_t msg_type,
 279                         const DATA_BLOB *data)
 280 {
 281         return msg_ctx->local->send_fn(msg_ctx, server, msg_type, data,
 282                                        msg_ctx->local);
 283 }
 284
 285 NTSTATUS messaging_send_buf(struct messaging_context *msg_ctx,
 286                             struct server_id server, uint32_t msg_type,
 287                             const uint8 *buf, size_t len)
 288 {
 289         DATA_BLOB blob = data_blob_const(buf, len);
 290         return messaging_send(msg_ctx, server, msg_type, &blob);
 291 }
 292
 293 /*
 294   Dispatch one messsaging_rec
 295 */
 296 void messaging_dispatch_rec(struct messaging_context *msg_ctx,
 297                             struct messaging_rec *rec)
 298 {
 299         struct messaging_callback *cb, *next;
 300
 301         for (cb = msg_ctx->callbacks; cb != NULL; cb = next) {
 302                 next = cb->next;
 303                 if (cb->msg_type == rec->msg_type) {
 304                         cb->fn(msg_ctx, cb->private_data, rec->msg_type,
 305                                rec->src, &rec->buf);
 306                         return;
 307                 }
 308         }
 309         return;
 310 }
 311
 312 /** @} **/