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 2 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, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #ifndef _MESSAGES_H_
  23 #define _MESSAGES_H_
  24
  25 /* change the message version with any incompatible changes in the protocol */
  26 #define MESSAGE_VERSION 2
  27
  28
  29 #define MSG_TYPE_MASK                   0xFFFF
  30
  31 /* general messages */
  32 #define MSG_DEBUG                       0x0001
  33 #define MSG_PING                        0x0002
  34 #define MSG_PONG                        0x0003
  35 #define MSG_PROFILE                     0x0004
  36 #define MSG_REQ_DEBUGLEVEL              0x0005
  37 #define MSG_DEBUGLEVEL                  0x0006
  38 #define MSG_REQ_PROFILELEVEL            0x0007
  39 #define MSG_PROFILELEVEL                0x0008
  40 #define MSG_REQ_POOL_USAGE              0x0009
  41 #define MSG_POOL_USAGE                  0x000A
  42
  43 /* If dmalloc is included, set a steady-state mark */
  44 #define MSG_REQ_DMALLOC_MARK            0x000B
  45
  46 /* If dmalloc is included, dump to the dmalloc log a description of
  47  * what has changed since the last MARK */
  48 #define MSG_REQ_DMALLOC_LOG_CHANGED     0x000C
  49
  50 #define MSG_SHUTDOWN                    0x000D
  51
  52 /* nmbd messages */
  53 #define MSG_FORCE_ELECTION              0x0101
  54 #define MSG_WINS_NEW_ENTRY              0x0102
  55 #define MSG_SEND_PACKET                 0x0103
  56
  57 /* printing messages */
  58 /* #define MSG_PRINTER_NOTIFY  2001*/ /* Obsolete */
  59 #define MSG_PRINTER_NOTIFY2             0x0202
  60
  61 #define MSG_PRINTER_DRVUPGRADE          0x0203
  62 #define MSG_PRINTERDATA_INIT_RESET      0x0204
  63 #define MSG_PRINTER_UPDATE              0x0205
  64 #define MSG_PRINTER_MOD                 0x0206
  65
  66 /* smbd messages */
  67 #define MSG_SMB_CONF_UPDATED            0x0301
  68 #define MSG_SMB_FORCE_TDIS              0x0302
  69 #define MSG_SMB_SAM_SYNC                0x0303
  70 #define MSG_SMB_SAM_REPL                0x0304
  71 #define MSG_SMB_UNLOCK                  0x0305
  72 #define MSG_SMB_BREAK_REQUEST           0x0306
  73 #define MSG_SMB_BREAK_RESPONSE          0x0307
  74 #define MSG_SMB_ASYNC_LEVEL2_BREAK      0x0308
  75 #define MSG_SMB_OPEN_RETRY              0x0309
  76 #define MSG_SMB_KERNEL_BREAK            0x030A
  77 #define MSG_SMB_FILE_RENAME             0x030B
  78 #define MSG_SMB_INJECT_FAULT            0x030C
  79 #define MSG_SMB_BLOCKING_LOCK_CANCEL    0x030D
  80 #define MSG_SMB_NOTIFY                  0x030E
  81 #define MSG_SMB_STAT_CACHE_DELETE       0x030F
  82 /*
  83  * Samba4 compatibility
  84  */
  85 #define MSG_PVFS_NOTIFY                 0x0310
  86 /*
  87  * cluster reconfigure events
  88  */
  89 #define MSG_SMB_BRL_VALIDATE            0x0311
  90 #define MSG_SMB_RELEASE_IP              0x0312
  91
  92 /* winbind messages */
  93 #define MSG_WINBIND_FINISHED            0x0401
  94 #define MSG_WINBIND_FORGET_STATE        0x0402
  95 #define MSG_WINBIND_ONLINE              0x0403
  96 #define MSG_WINBIND_OFFLINE             0x0404
  97 #define MSG_WINBIND_ONLINESTATUS        0x0405
  98 #define MSG_WINBIND_TRY_TO_GO_ONLINE    0x0406
  99 #define MSG_WINBIND_FAILED_TO_GO_ONLINE 0x0407
 100
 101 /*
 102  * Special flags passed to message_send. Allocated from the top, lets see when
 103  * it collides with the message types in the lower 16 bits :-)
 104  */
 105
 106 /*
 107  * Under high load, this message can be dropped. Use for notify-style
 108  * messages that are not critical for correct operation.
 109  */
 110 #define MSG_FLAG_LOWPRIORITY            0x80000000
 111
 112
 113 /* Flags to classify messages - used in message_send_all() */
 114 /* Sender will filter by flag. */
 115
 116 #define FLAG_MSG_GENERAL                0x0001
 117 #define FLAG_MSG_SMBD                   0x0002
 118 #define FLAG_MSG_NMBD                   0x0004
 119 #define FLAG_MSG_PRINT_NOTIFY           0x0008
 120 #define FLAG_MSG_PRINT_GENERAL          0x0010
 121
 122
 123 /*
 124  * Virtual Node Numbers are identifying a node within a cluster. Ctdbd sets
 125  * this, we retrieve our vnn from it.
 126  */
 127
 128 #define NONCLUSTER_VNN (0xFFFFFFFF)
 129
 130 /*
 131  * ctdb gives us 64-bit server ids for messaging_send. This is done to avoid
 132  * pid clashes and to be able to register for special messages like "all
 133  * smbds".
 134  *
 135  * Normal individual server id's have the upper 32 bits to 0, I picked "1" for
 136  * Samba, other subsystems might use something else.
 137  */
 138
 139 #define MSG_SRVID_SAMBA 0x0000000100000000LL
 140
 141
 142 struct server_id {
 143         pid_t pid;
 144 #ifdef CLUSTER_SUPPORT
 145         uint32 vnn;
 146 #endif
 147 };
 148
 149
 150
 151 struct messaging_context;
 152 struct messaging_rec;
 153 struct data_blob;
 154
 155 /*
 156  * struct messaging_context belongs to messages.c, but because we still have
 157  * messaging_dispatch, we need it here. Once we get rid of signals for
 158  * notifying processes, this will go.
 159  */
 160
 161 struct messaging_context {
 162         struct server_id id;
 163         struct event_context *event_ctx;
 164         struct messaging_callback *callbacks;
 165
 166         struct messaging_backend *local;
 167         struct messaging_backend *remote;
 168 };
 169
 170 struct messaging_backend {
 171         NTSTATUS (*send_fn)(struct messaging_context *msg_ctx,
 172                             struct server_id pid, int msg_type,
 173                             const struct data_blob *data,
 174                             struct messaging_backend *backend);
 175         void *private_data;
 176 };
 177
 178 NTSTATUS messaging_tdb_init(struct messaging_context *msg_ctx,
 179                             TALLOC_CTX *mem_ctx,
 180                             struct messaging_backend **presult);
 181 void message_dispatch(struct messaging_context *msg_ctx);
 182
 183 NTSTATUS messaging_ctdbd_init(struct messaging_context *msg_ctx,
 184                               TALLOC_CTX *mem_ctx,
 185                               struct messaging_backend **presult);
 186 struct ctdbd_connection *messaging_ctdbd_connection(void);
 187
 188 BOOL message_send_all(struct messaging_context *msg_ctx,
 189                       int msg_type,
 190                       const void *buf, size_t len,
 191                       int *n_sent);
 192 struct event_context *messaging_event_context(struct messaging_context *msg_ctx);
 193 struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx,
 194                                          struct server_id server_id,
 195                                          struct event_context *ev);
 196
 197 /*
 198  * re-init after a fork
 199  */
 200 NTSTATUS messaging_reinit(struct messaging_context *msg_ctx);
 201
 202 NTSTATUS messaging_register(struct messaging_context *msg_ctx,
 203                             void *private_data,
 204                             uint32_t msg_type,
 205                             void (*fn)(struct messaging_context *msg,
 206                                        void *private_data,
 207                                        uint32_t msg_type,
 208                                        struct server_id server_id,
 209                                        struct data_blob *data));
 210 void messaging_deregister(struct messaging_context *ctx, uint32_t msg_type,
 211                           void *private_data);
 212 NTSTATUS messaging_send(struct messaging_context *msg_ctx,
 213                         struct server_id server,
 214                         uint32_t msg_type, const struct data_blob *data);
 215 NTSTATUS messaging_send_buf(struct messaging_context *msg_ctx,
 216                             struct server_id server, uint32_t msg_type,
 217                             const uint8 *buf, size_t len);
 218 void messaging_dispatch_rec(struct messaging_context *msg_ctx,
 219                             struct messaging_rec *rec);
 220
 221 #endif