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