r3026: - added automatic retry to messages when the servers listen queue is
[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;
99         for (d=msg->dispatch;d;d=d->next) {
100                 if (d->msg_type == rec->header.msg_type) {
101                         d->fn(msg, d->private, d->msg_type, rec->header.from, &rec->data);
102                 }
103         }
104
105         /* we don't free the record itself here as there may
106            be more messages from this client */
107         data_blob_free(&rec->data);
108         rec->header.length = 0;
109         rec->ndone = 0;
110 }
111
112
113 /*
114   handle IO for a single message
115 */
116 static void messaging_recv_handler(struct event_context *ev, struct fd_event *fde, 
117                                  time_t t, uint16_t flags)
118 {
119         struct messaging_rec *rec = fde->private;
120         struct messaging_state *msg = rec->msg;
121         NTSTATUS status;
122
123         if (rec->ndone < sizeof(rec->header)) {
124                 /* receive the header */
125                 DATA_BLOB blob;
126                 blob.length = 0;
127                 status = socket_recv(rec->sock, rec, 
128                                      &blob, sizeof(rec->header) - rec->ndone, 0);
129                 if (NT_STATUS_IS_ERR(status)) {
130                         talloc_free(rec);
131                         return;
132                 }
133
134                 if (blob.length == 0) {
135                         return;
136                 }
137
138                 memcpy(rec->ndone + (char *)&rec->header, blob.data, blob.length);
139                 rec->ndone += blob.length;
140                 data_blob_free(&blob);
141
142                 if (rec->ndone == sizeof(rec->header)) {
143                         if (rec->header.version != MESSAGING_VERSION) {
144                                 DEBUG(0,("meessage with wrong version %u\n",
145                                          rec->header.version));
146                                 talloc_free(rec);
147                         }
148                         rec->data = data_blob_talloc(rec, NULL, rec->header.length);
149                         if (rec->data.length != rec->header.length) {
150                                 DEBUG(0,("Unable to allocate message of size %u\n",
151                                          rec->header.length));
152                                 talloc_free(rec);
153                         }
154                 }
155         }
156
157         if (rec->ndone >= sizeof(rec->header) && 
158             rec->ndone < sizeof(rec->header) + rec->header.length) {
159                 /* receive the body, if any */
160                 DATA_BLOB blob;
161                 blob.length = 0;
162                 status = socket_recv(rec->sock, rec, 
163                                      &blob, sizeof(rec->header) + rec->header.length - rec->ndone, 0);
164                 if (NT_STATUS_IS_ERR(status)) {
165                         talloc_free(rec);
166                         return;
167                 }
168
169                 if (blob.length == 0) {
170                         return;
171                 }
172
173                 memcpy(rec->data.data + (rec->ndone - sizeof(rec->header)), 
174                        blob.data, blob.length);
175
176                 rec->ndone += blob.length;
177         }
178
179         if (rec->ndone == sizeof(rec->header) + rec->header.length) {
180                 /* we've got the whole message */
181                 messaging_dispatch(msg, rec);
182         }
183 }
184
185 /*
186   destroy a messaging record
187 */
188 static int rec_destructor(void *ptr)
189 {
190         struct messaging_rec *rec = ptr;
191         struct messaging_state *msg = rec->msg;
192         event_remove_fd(msg->event.ev, rec->fde);
193         return 0;
194 }
195
196 /*
197   handle a new incoming connection
198 */
199 static void messaging_listen_handler(struct event_context *ev, struct fd_event *fde, 
200                                      time_t t, uint16_t flags)
201 {
202         struct messaging_state *msg = fde->private;
203         struct messaging_rec *rec;
204         NTSTATUS status;
205         struct fd_event fde2;
206
207         rec = talloc_p(msg, struct messaging_rec);
208         if (rec == NULL) {
209                 smb_panic("Unable to allocate messaging_rec");
210         }
211
212         status = socket_accept(msg->sock, &rec->sock, 0);
213         if (!NT_STATUS_IS_OK(status)) {
214                 smb_panic("Unable to accept messaging_rec");
215         }
216         talloc_steal(rec, rec->sock);
217
218         rec->msg = msg;
219         rec->ndone = 0;
220         rec->header.length = 0;
221         rec->path = msg->path;
222
223         fde2.private    = rec;
224         fde2.fd         = socket_get_fd(rec->sock);
225         fde2.flags      = EVENT_FD_READ;
226         fde2.handler    = messaging_recv_handler;
227
228         rec->fde        = event_add_fd(msg->event.ev, &fde2);
229
230         talloc_set_destructor(rec, rec_destructor);
231 }
232
233 /*
234   Register a dispatch function for a particular message type.
235 */
236 void messaging_register(void *ctx, void *private,
237                         uint32_t msg_type, 
238                         void (*fn)(void *, void *, uint32_t, servid_t, DATA_BLOB *))
239 {
240         struct messaging_state *msg = ctx;
241         struct dispatch_fn *d;
242
243         d = talloc_p(msg, struct dispatch_fn);
244         d->msg_type = msg_type;
245         d->private = private;
246         d->fn = fn;
247         DLIST_ADD(msg->dispatch, d);
248 }
249
250 /*
251   De-register the function for a particular message type.
252 */
253 void messaging_deregister(void *ctx, uint32_t msg_type)
254 {
255         struct messaging_state *msg = ctx;
256         struct dispatch_fn *d, *next;
257
258         for (d = msg->dispatch; d; d = next) {
259                 next = d->next;
260                 if (d->msg_type == msg_type) {
261                         DLIST_REMOVE(msg->dispatch, d);
262                         talloc_free(d);
263                 }
264         }       
265 }
266
267
268
269 /*
270   handle IO for sending a message
271 */
272 static void messaging_send_handler(struct event_context *ev, struct fd_event *fde, 
273                                    time_t t, uint16_t flags)
274 {
275         struct messaging_rec *rec = fde->private;
276         NTSTATUS status;
277
278         if (rec->ndone < sizeof(rec->header)) {
279                 /* send the header */
280                 size_t nsent;
281                 DATA_BLOB blob;
282
283                 blob.data = rec->ndone + (char *)&rec->header;
284                 blob.length = sizeof(rec->header) - rec->ndone;
285
286                 status = socket_send(rec->sock, rec, &blob, &nsent, 0);
287                 if (NT_STATUS_IS_ERR(status)) {
288                         talloc_free(rec);
289                         return;
290                 }
291
292                 if (nsent == 0) {
293                         return;
294                 }
295
296                 rec->ndone += nsent;
297         }
298
299         if (rec->ndone >= sizeof(rec->header) && 
300             rec->ndone < sizeof(rec->header) + rec->header.length) {
301                 /* send the body, if any */
302                 DATA_BLOB blob;
303                 size_t nsent;
304
305                 blob.data = rec->data.data + (rec->ndone - sizeof(rec->header));
306                 blob.length = rec->header.length - (rec->ndone - sizeof(rec->header));
307
308                 status = socket_send(rec->sock, rec, &blob, &nsent, 0);
309                 if (NT_STATUS_IS_ERR(status)) {
310                         talloc_free(rec);
311                         return;
312                 }
313
314                 rec->ndone += nsent;
315         }
316
317         if (rec->ndone == sizeof(rec->header) + rec->header.length) {
318                 /* we've done the whole message */
319                 talloc_free(rec);
320         }
321 }
322
323
324 /*
325   when the servers listen queue is full we use this to backoff the message
326 */
327 static void messaging_backoff_handler(struct event_context *ev, struct timed_event *te, time_t t)
328 {
329         struct messaging_rec *rec = te->private;
330         struct messaging_state *msg = rec->msg;
331         NTSTATUS status;
332         struct fd_event fde;
333
334         status = socket_connect(rec->sock, NULL, 0, rec->path, 0, 0);
335         if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
336                 /* backoff again */
337                 te->next_event = t+1;
338                 return;
339         }
340
341         if (!NT_STATUS_IS_OK(status)) {
342                 DEBUG(1,("messaging: Lost message from %u to %u of type %u after backoff - %s\n", 
343                          rec->header.from, rec->header.to, rec->header.msg_type, nt_errstr(status)));
344                 talloc_free(rec);
345                 return;
346         }
347
348         fde.private     = rec;
349         fde.fd          = socket_get_fd(rec->sock);
350         fde.flags       = EVENT_FD_WRITE;
351         fde.handler     = messaging_send_handler;
352
353         rec->fde        = event_add_fd(msg->event.ev, &fde);
354
355         talloc_set_destructor(rec, rec_destructor);
356
357         messaging_send_handler(msg->event.ev, rec->fde, 0, EVENT_FD_WRITE);
358 }
359
360
361 /*
362   Send a message to a particular server
363 */
364 NTSTATUS messaging_send(void *msg_ctx, servid_t server, uint32_t msg_type, DATA_BLOB *data)
365 {
366         struct messaging_state *msg = msg_ctx;
367         struct messaging_rec *rec;
368         NTSTATUS status;
369         struct fd_event fde;
370
371         rec = talloc_p(msg, struct messaging_rec);
372         if (rec == NULL) {
373                 return NT_STATUS_NO_MEMORY;
374         }
375
376         rec->msg = msg;
377         rec->header.version = MESSAGING_VERSION;
378         rec->header.msg_type = msg_type;
379         rec->header.from = msg->server_id;
380         rec->header.to = server;
381         rec->header.length = data?data->length:0;
382         if (rec->header.length != 0) {
383                 rec->data = data_blob_talloc(rec, data->data, data->length);
384         } else {
385                 rec->data = data_blob(NULL, 0);
386         }
387         rec->ndone = 0;
388
389         status = socket_create("unix", SOCKET_TYPE_STREAM, &rec->sock, 0);
390         if (!NT_STATUS_IS_OK(status)) {
391                 talloc_free(rec);
392                 return status;
393         }
394         talloc_steal(rec, rec->sock);
395
396         rec->path = messaging_path(rec, server);
397
398         status = socket_connect(rec->sock, NULL, 0, rec->path, 0, 0);
399         if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
400                 /* backoff on this message - the servers listen queue is full */
401                 struct timed_event te;
402                 te.next_event = time(NULL)+1;
403                 te.handler = messaging_backoff_handler;
404                 te.private = rec;
405                 event_add_timed(msg->event.ev, &te);
406                 return NT_STATUS_OK;
407         }
408
409         if (!NT_STATUS_IS_OK(status)) {
410                 talloc_free(rec);
411                 return status;
412         }
413
414         fde.private     = rec;
415         fde.fd          = socket_get_fd(rec->sock);
416         fde.flags       = EVENT_FD_WRITE;
417         fde.handler     = messaging_send_handler;
418
419         rec->fde        = event_add_fd(msg->event.ev, &fde);
420
421         talloc_set_destructor(rec, rec_destructor);
422
423         messaging_send_handler(msg->event.ev, rec->fde, 0, EVENT_FD_WRITE);
424
425         return NT_STATUS_OK;
426 }
427
428
429 /*
430   destroy the messaging context
431 */
432 static int messaging_destructor(void *msg_ctx)
433 {
434         struct messaging_state *msg = msg_ctx;
435         event_remove_fd(msg->event.ev, msg->event.fde);
436         return 0;
437 }
438
439 /*
440   create the listening socket and setup the dispatcher
441 */
442 void *messaging_init(TALLOC_CTX *mem_ctx, servid_t server_id, struct event_context *ev)
443 {
444         struct messaging_state *msg;
445         NTSTATUS status;
446         struct fd_event fde;
447
448         msg = talloc_p(mem_ctx, struct messaging_state);
449         if (msg == NULL) {
450                 return NULL;
451         }
452
453         /* create the messaging directory if needed */
454         msg->path = lock_path(msg, "messaging");
455         mkdir(msg->path, 0700);
456         talloc_free(msg->path);
457
458         msg->server_id = server_id;
459         msg->dispatch = NULL;
460         msg->path = messaging_path(msg, server_id);
461
462         status = socket_create("unix", SOCKET_TYPE_STREAM, &msg->sock, 0);
463         if (!NT_STATUS_IS_OK(status)) {
464                 talloc_free(msg);
465                 return NULL;
466         }
467
468         /* by stealing here we ensure that the socket is cleaned up (and even 
469            deleted) on exit */
470         talloc_steal(msg, msg->sock);
471
472         status = socket_listen(msg->sock, msg->path, 0, 50, 0);
473         if (!NT_STATUS_IS_OK(status)) {
474                 DEBUG(0,("Unable to setup messaging listener for '%s'\n", msg->path));
475                 talloc_free(msg);
476                 return NULL;
477         }
478
479         fde.private     = msg;
480         fde.fd          = socket_get_fd(msg->sock);
481         fde.flags       = EVENT_FD_READ;
482         fde.handler     = messaging_listen_handler;
483
484         msg->event.ev   = ev;
485         msg->event.fde  = event_add_fd(ev, &fde);
486
487         talloc_set_destructor(msg, messaging_destructor);
488         
489         messaging_register(msg, NULL, MSG_PING, ping_message);
490
491         return msg;
492 }
493
494