b0ca9cc41e3c7f9800fd75e32fde37159d660ef2
[bbaumbach/samba-autobuild/.git] / source4 / lib / messaging / messaging.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    Samba internal messaging functions
5
6    Copyright (C) Andrew Tridgell 2004
7    
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12    
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 #include "includes.h"
24
25 /* change the message version with any incompatible changes in the protocol */
26 #define MESSAGING_VERSION 1
27
28 struct messaging_state {
29         servid_t server_id;
30         struct socket_context *sock;
31         char *path;
32         struct dispatch_fn *dispatch;
33
34         struct {
35                 struct event_context *ev;
36                 struct fd_event *fde;
37         } event;
38 };
39
40 /* we have a linked list of dispatch handlers that this messaging
41    server can deal with */
42 struct dispatch_fn {
43         struct dispatch_fn *next, *prev;
44         uint32_t msg_type;
45         void *private;
46         void (*fn)(void *msg_ctx, void *private, 
47                    uint32_t msg_type, servid_t server_id, DATA_BLOB *data);
48 };
49
50 /* an individual message */
51 struct messaging_rec {
52         struct messaging_state *msg;
53         struct socket_context *sock;
54         struct fd_event *fde;
55         const char *path;
56
57         struct {
58                 uint32_t version;
59                 uint32_t msg_type;
60                 servid_t from;
61                 servid_t to;
62                 uint32_t length;
63         } header;
64
65         DATA_BLOB data;
66
67         uint32_t ndone;
68 };
69
70 /*
71  A useful function for testing the message system.
72 */
73 static void ping_message(void *msg_ctx, void *private, 
74                          uint32_t msg_type, servid_t src, DATA_BLOB *data)
75 {
76         DEBUG(1,("INFO: Received PING message from server %u [%.*s]\n",
77                  (uint_t)src, data->length, data->data?(const char *)data->data:""));
78         messaging_send(msg_ctx, src, MSG_PONG, data);
79 }
80
81 /* 
82    return the path to a messaging socket
83 */
84 static char *messaging_path(TALLOC_CTX *mem_ctx, servid_t server_id)
85 {
86         char *name = talloc_asprintf(mem_ctx, "messaging/msg.%u", (unsigned)server_id);
87         char *ret;
88         ret = lock_path(mem_ctx, name);
89         talloc_free(name);
90         return ret;
91 }
92
93 /*
94   dispatch a fully received message
95 */
96 static void messaging_dispatch(struct messaging_state *msg, struct messaging_rec *rec)
97 {
98         struct dispatch_fn *d, *next;
99         for (d=msg->dispatch;d;d=next) {
100                 next = d->next;
101                 if (d->msg_type == rec->header.msg_type) {
102                         d->fn(msg, d->private, d->msg_type, rec->header.from, &rec->data);
103                 }
104         }
105
106         /* we don't free the record itself here as there may
107            be more messages from this client */
108         data_blob_free(&rec->data);
109         rec->header.length = 0;
110         rec->ndone = 0;
111 }
112
113
114 /*
115   handle IO for a single message
116 */
117 static void messaging_recv_handler(struct event_context *ev, struct fd_event *fde, 
118                                  time_t t, uint16_t flags)
119 {
120         struct messaging_rec *rec = fde->private;
121         struct messaging_state *msg = rec->msg;
122         NTSTATUS status;
123
124         if (rec->ndone < sizeof(rec->header)) {
125                 /* receive the header */
126                 DATA_BLOB blob;
127                 blob.length = 0;
128                 status = socket_recv(rec->sock, rec, 
129                                      &blob, sizeof(rec->header) - rec->ndone, 0);
130                 if (NT_STATUS_IS_ERR(status)) {
131                         talloc_free(rec);
132                         return;
133                 }
134
135                 if (blob.length == 0) {
136                         return;
137                 }
138
139                 memcpy(rec->ndone + (char *)&rec->header, blob.data, blob.length);
140                 rec->ndone += blob.length;
141                 data_blob_free(&blob);
142
143                 if (rec->ndone == sizeof(rec->header)) {
144                         if (rec->header.version != MESSAGING_VERSION) {
145                                 DEBUG(0,("meessage with wrong version %u\n",
146                                          rec->header.version));
147                                 talloc_free(rec);
148                         }
149                         rec->data = data_blob_talloc(rec, NULL, rec->header.length);
150                         if (rec->data.length != rec->header.length) {
151                                 DEBUG(0,("Unable to allocate message of size %u\n",
152                                          rec->header.length));
153                                 talloc_free(rec);
154                         }
155                 }
156         }
157
158         if (rec->ndone >= sizeof(rec->header) && 
159             rec->ndone < sizeof(rec->header) + rec->header.length) {
160                 /* receive the body, if any */
161                 DATA_BLOB blob;
162                 blob.length = 0;
163                 status = socket_recv(rec->sock, rec, 
164                                      &blob, sizeof(rec->header) + rec->header.length - rec->ndone, 0);
165                 if (NT_STATUS_IS_ERR(status)) {
166                         talloc_free(rec);
167                         return;
168                 }
169
170                 if (blob.length == 0) {
171                         return;
172                 }
173
174                 memcpy(rec->data.data + (rec->ndone - sizeof(rec->header)), 
175                        blob.data, blob.length);
176
177                 rec->ndone += blob.length;
178         }
179
180         if (rec->ndone == sizeof(rec->header) + rec->header.length) {
181                 /* we've got the whole message */
182                 messaging_dispatch(msg, rec);
183         }
184 }
185
186 /*
187   destroy a messaging record
188 */
189 static int rec_destructor(void *ptr)
190 {
191         struct messaging_rec *rec = ptr;
192         struct messaging_state *msg = rec->msg;
193         event_remove_fd(msg->event.ev, rec->fde);
194         return 0;
195 }
196
197 /*
198   handle a new incoming connection
199 */
200 static void messaging_listen_handler(struct event_context *ev, struct fd_event *fde, 
201                                      time_t t, uint16_t flags)
202 {
203         struct messaging_state *msg = fde->private;
204         struct messaging_rec *rec;
205         NTSTATUS status;
206         struct fd_event fde2;
207
208         rec = talloc_p(msg, struct messaging_rec);
209         if (rec == NULL) {
210                 smb_panic("Unable to allocate messaging_rec");
211         }
212
213         status = socket_accept(msg->sock, &rec->sock, 0);
214         if (!NT_STATUS_IS_OK(status)) {
215                 smb_panic("Unable to accept messaging_rec");
216         }
217         talloc_steal(rec, rec->sock);
218
219         rec->msg = msg;
220         rec->ndone = 0;
221         rec->header.length = 0;
222         rec->path = msg->path;
223
224         fde2.private    = rec;
225         fde2.fd         = socket_get_fd(rec->sock);
226         fde2.flags      = EVENT_FD_READ;
227         fde2.handler    = messaging_recv_handler;
228
229         rec->fde        = event_add_fd(msg->event.ev, &fde2);
230
231         talloc_set_destructor(rec, rec_destructor);
232 }
233
234 /*
235   Register a dispatch function for a particular message type.
236 */
237 void messaging_register(void *ctx, void *private,
238                         uint32_t msg_type, 
239                         void (*fn)(void *, void *, uint32_t, servid_t, DATA_BLOB *))
240 {
241         struct messaging_state *msg = ctx;
242         struct dispatch_fn *d;
243
244         d = talloc_p(msg, struct dispatch_fn);
245         d->msg_type = msg_type;
246         d->private = private;
247         d->fn = fn;
248         DLIST_ADD(msg->dispatch, d);
249 }
250
251 /*
252   De-register the function for a particular message type.
253 */
254 void messaging_deregister(void *ctx, uint32_t msg_type, void *private)
255 {
256         struct messaging_state *msg = ctx;
257         struct dispatch_fn *d, *next;
258
259         for (d = msg->dispatch; d; d = next) {
260                 next = d->next;
261                 if (d->msg_type == msg_type && 
262                     d->private == private) {
263                         DLIST_REMOVE(msg->dispatch, d);
264                         talloc_free(d);
265                 }
266         }       
267 }
268
269
270
271 /*
272   handle IO for sending a message
273 */
274 static void messaging_send_handler(struct event_context *ev, struct fd_event *fde, 
275                                    time_t t, uint16_t flags)
276 {
277         struct messaging_rec *rec = fde->private;
278         NTSTATUS status;
279
280         if (rec->ndone < sizeof(rec->header)) {
281                 /* send the header */
282                 size_t nsent;
283                 DATA_BLOB blob;
284
285                 blob.data = rec->ndone + (char *)&rec->header;
286                 blob.length = sizeof(rec->header) - rec->ndone;
287
288                 status = socket_send(rec->sock, rec, &blob, &nsent, 0);
289                 if (NT_STATUS_IS_ERR(status)) {
290                         talloc_free(rec);
291                         return;
292                 }
293
294                 if (nsent == 0) {
295                         return;
296                 }
297
298                 rec->ndone += nsent;
299         }
300
301         if (rec->ndone >= sizeof(rec->header) && 
302             rec->ndone < sizeof(rec->header) + rec->header.length) {
303                 /* send the body, if any */
304                 DATA_BLOB blob;
305                 size_t nsent;
306
307                 blob.data = rec->data.data + (rec->ndone - sizeof(rec->header));
308                 blob.length = rec->header.length - (rec->ndone - sizeof(rec->header));
309
310                 status = socket_send(rec->sock, rec, &blob, &nsent, 0);
311                 if (NT_STATUS_IS_ERR(status)) {
312                         talloc_free(rec);
313                         return;
314                 }
315
316                 rec->ndone += nsent;
317         }
318
319         if (rec->ndone == sizeof(rec->header) + rec->header.length) {
320                 /* we've done the whole message */
321                 talloc_free(rec);
322         }
323 }
324
325
326 /*
327   when the servers listen queue is full we use this to backoff the message
328 */
329 static void messaging_backoff_handler(struct event_context *ev, struct timed_event *te, time_t t)
330 {
331         struct messaging_rec *rec = te->private;
332         struct messaging_state *msg = rec->msg;
333         NTSTATUS status;
334         struct fd_event fde;
335
336         status = socket_connect(rec->sock, NULL, 0, rec->path, 0, 0);
337         if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
338                 /* backoff again */
339                 te->next_event = t+1;
340                 return;
341         }
342
343         if (!NT_STATUS_IS_OK(status)) {
344                 DEBUG(1,("messaging: Lost message from %u to %u of type %u after backoff - %s\n", 
345                          rec->header.from, rec->header.to, rec->header.msg_type, nt_errstr(status)));
346                 talloc_free(rec);
347                 return;
348         }
349
350         fde.private     = rec;
351         fde.fd          = socket_get_fd(rec->sock);
352         fde.flags       = EVENT_FD_WRITE;
353         fde.handler     = messaging_send_handler;
354
355         rec->fde        = event_add_fd(msg->event.ev, &fde);
356
357         talloc_set_destructor(rec, rec_destructor);
358
359         messaging_send_handler(msg->event.ev, rec->fde, 0, EVENT_FD_WRITE);
360 }
361
362
363 /*
364   Send a message to a particular server
365 */
366 NTSTATUS messaging_send(void *msg_ctx, servid_t server, uint32_t msg_type, DATA_BLOB *data)
367 {
368         struct messaging_state *msg = msg_ctx;
369         struct messaging_rec *rec;
370         NTSTATUS status;
371         struct fd_event fde;
372
373         rec = talloc_p(msg, struct messaging_rec);
374         if (rec == NULL) {
375                 return NT_STATUS_NO_MEMORY;
376         }
377
378         rec->msg = msg;
379         rec->header.version = MESSAGING_VERSION;
380         rec->header.msg_type = msg_type;
381         rec->header.from = msg->server_id;
382         rec->header.to = server;
383         rec->header.length = data?data->length:0;
384         if (rec->header.length != 0) {
385                 rec->data = data_blob_talloc(rec, data->data, data->length);
386         } else {
387                 rec->data = data_blob(NULL, 0);
388         }
389         rec->ndone = 0;
390
391         status = socket_create("unix", SOCKET_TYPE_STREAM, &rec->sock, 0);
392         if (!NT_STATUS_IS_OK(status)) {
393                 talloc_free(rec);
394                 return status;
395         }
396         talloc_steal(rec, rec->sock);
397
398         rec->path = messaging_path(rec, server);
399
400         status = socket_connect(rec->sock, NULL, 0, rec->path, 0, 0);
401         if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
402                 /* backoff on this message - the servers listen queue is full */
403                 struct timed_event te;
404                 te.next_event = time(NULL)+1;
405                 te.handler = messaging_backoff_handler;
406                 te.private = rec;
407                 event_add_timed(msg->event.ev, &te);
408                 return NT_STATUS_OK;
409         }
410
411         if (!NT_STATUS_IS_OK(status)) {
412                 talloc_free(rec);
413                 return status;
414         }
415
416         fde.private     = rec;
417         fde.fd          = socket_get_fd(rec->sock);
418         fde.flags       = EVENT_FD_WRITE;
419         fde.handler     = messaging_send_handler;
420
421         rec->fde        = event_add_fd(msg->event.ev, &fde);
422
423         talloc_set_destructor(rec, rec_destructor);
424
425         messaging_send_handler(msg->event.ev, rec->fde, 0, EVENT_FD_WRITE);
426
427         return NT_STATUS_OK;
428 }
429
430
431 /*
432   destroy the messaging context
433 */
434 static int messaging_destructor(void *msg_ctx)
435 {
436         struct messaging_state *msg = msg_ctx;
437         event_remove_fd(msg->event.ev, msg->event.fde);
438         return 0;
439 }
440
441 /*
442   create the listening socket and setup the dispatcher
443 */
444 void *messaging_init(TALLOC_CTX *mem_ctx, servid_t server_id, struct event_context *ev)
445 {
446         struct messaging_state *msg;
447         NTSTATUS status;
448         struct fd_event fde;
449
450         msg = talloc_p(mem_ctx, struct messaging_state);
451         if (msg == NULL) {
452                 return NULL;
453         }
454
455         /* create the messaging directory if needed */
456         msg->path = lock_path(msg, "messaging");
457         mkdir(msg->path, 0700);
458         talloc_free(msg->path);
459
460         msg->server_id = server_id;
461         msg->dispatch = NULL;
462         msg->path = messaging_path(msg, server_id);
463
464         status = socket_create("unix", SOCKET_TYPE_STREAM, &msg->sock, 0);
465         if (!NT_STATUS_IS_OK(status)) {
466                 talloc_free(msg);
467                 return NULL;
468         }
469
470         /* by stealing here we ensure that the socket is cleaned up (and even 
471            deleted) on exit */
472         talloc_steal(msg, msg->sock);
473
474         status = socket_listen(msg->sock, msg->path, 0, 50, 0);
475         if (!NT_STATUS_IS_OK(status)) {
476                 DEBUG(0,("Unable to setup messaging listener for '%s'\n", msg->path));
477                 talloc_free(msg);
478                 return NULL;
479         }
480
481         fde.private     = msg;
482         fde.fd          = socket_get_fd(msg->sock);
483         fde.flags       = EVENT_FD_READ;
484         fde.handler     = messaging_listen_handler;
485
486         msg->event.ev   = ev;
487         msg->event.fde  = event_add_fd(ev, &fde);
488
489         talloc_set_destructor(msg, messaging_destructor);
490         
491         messaging_register(msg, NULL, MSG_PING, ping_message);
492
493         return msg;
494 }
495
496