source3/include/messages.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    messages.c header
   4    Copyright (C) Andrew Tridgell 2000
   5    Copyright (C) 2001, 2002 by Martin Pool
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifndef _MESSAGES_H_
  22 #define _MESSAGES_H_
  23
  24 /* change the message version with any incompatible changes in the protocol */
  25 #define MESSAGE_VERSION 2
  26
  27 /*
  28  * Special flags passed to message_send. Allocated from the top, lets see when
  29  * it collides with the message types in the lower 16 bits :-)
  30  */
  31
  32 /*
  33  * Under high load, this message can be dropped. Use for notify-style
  34  * messages that are not critical for correct operation.
  35  */
  36 #define MSG_FLAG_LOWPRIORITY            0x80000000
  37
  38
  39 /*
  40  * ctdb gives us 64-bit server ids for messaging_send. This is done to avoid
  41  * pid clashes and to be able to register for special messages like "all
  42  * smbds".
  43  *
  44  * Normal individual server id's have the upper 32 bits to 0, I picked "1" for
  45  * Samba, other subsystems might use something else.
  46  */
  47
  48 #define MSG_SRVID_SAMBA 0x0000000100000000LL
  49
  50 #include "librpc/gen_ndr/server_id.h"
  51 #include "lib/util/data_blob.h"
  52 #include "system/network.h"
  53
  54 #define MSG_BROADCAST_PID_STR   "0:0"
  55
  56 struct messaging_context;
  57 struct messaging_rec;
  58
  59 struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx,
  60                                          struct tevent_context *ev);
  61 NTSTATUS messaging_init_client(TALLOC_CTX *mem_ctx,
  62                                struct tevent_context *ev,
  63                                struct messaging_context **pmsg_ctx);
  64
  65 struct server_id messaging_server_id(const struct messaging_context *msg_ctx);
  66 struct tevent_context *messaging_tevent_context(
  67         struct messaging_context *msg_ctx);
  68 struct server_id_db *messaging_names_db(struct messaging_context *msg_ctx);
  69
  70 /*
  71  * re-init after a fork
  72  */
  73 NTSTATUS messaging_reinit(struct messaging_context *msg_ctx);
  74
  75 NTSTATUS messaging_register(struct messaging_context *msg_ctx,
  76                             void *private_data,
  77                             uint32_t msg_type,
  78                             void (*fn)(struct messaging_context *msg,
  79                                        void *private_data,
  80                                        uint32_t msg_type,
  81                                        struct server_id server_id,
  82                                        DATA_BLOB *data));
  83 void messaging_deregister(struct messaging_context *ctx, uint32_t msg_type,
  84                           void *private_data);
  85
  86 /**
  87  * CAVEAT:
  88  *
  89  * While the messaging_send*() functions are synchronuous by API,
  90  * they trigger a tevent-based loop upon sending bigger messages.
  91  *
  92  * Hence callers should not use these in purely synchonous code,
  93  * but run a tevent_loop instead.
  94  */
  95 NTSTATUS messaging_send(struct messaging_context *msg_ctx,
  96                         struct server_id server,
  97                         uint32_t msg_type, const DATA_BLOB *data);
  98
  99 NTSTATUS messaging_send_buf(struct messaging_context *msg_ctx,
 100                             struct server_id server, uint32_t msg_type,
 101                             const uint8_t *buf, size_t len);
 102 int messaging_send_iov_from(struct messaging_context *msg_ctx,
 103                             struct server_id src, struct server_id dst,
 104                             uint32_t msg_type,
 105                             const struct iovec *iov, int iovlen,
 106                             const int *fds, size_t num_fds);
 107 NTSTATUS messaging_send_iov(struct messaging_context *msg_ctx,
 108                             struct server_id server, uint32_t msg_type,
 109                             const struct iovec *iov, int iovlen,
 110                             const int *fds, size_t num_fds);
 111
 112 struct tevent_req *messaging_filtered_read_send(
 113         TALLOC_CTX *mem_ctx, struct tevent_context *ev,
 114         struct messaging_context *msg_ctx,
 115         bool (*filter)(struct messaging_rec *rec, void *private_data),
 116         void *private_data);
 117 int messaging_filtered_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
 118                                  struct messaging_rec **presult);
 119
 120 struct tevent_req *messaging_read_send(TALLOC_CTX *mem_ctx,
 121                                        struct tevent_context *ev,
 122                                        struct messaging_context *msg,
 123                                        uint32_t msg_type);
 124 int messaging_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
 125                         struct messaging_rec **presult);
 126
 127 int messaging_cleanup(struct messaging_context *msg_ctx, pid_t pid);
 128
 129 bool messaging_parent_dgm_cleanup_init(struct messaging_context *msg);
 130
 131 struct messaging_rec *messaging_rec_create(
 132         TALLOC_CTX *mem_ctx, struct server_id src, struct server_id dst,
 133         uint32_t msg_type, const struct iovec *iov, int iovlen,
 134         const int *fds, size_t num_fds);
 135
 136 #include "librpc/gen_ndr/ndr_messaging.h"
 137
 138 #endif