r3029: implemented byte range lock timeouts.
[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, void *private)
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                     d->private == private) {
262                         DLIST_REMOVE(msg->dispatch, d);
263                         talloc_free(d);
264                 }
265         }       
266 }
267
268
269
270 /*
271   handle IO for sending a message
272 */
273 static void messaging_send_handler(struct event_context *ev, struct fd_event *fde, 
274                                    time_t t, uint16_t flags)
275 {
276         struct messaging_rec *rec = fde->private;
277         NTSTATUS status;
278
279         if (rec->ndone < sizeof(rec->header)) {
280                 /* send the header */
281                 size_t nsent;
282                 DATA_BLOB blob;
283
284                 blob.data = rec->ndone + (char *)&rec->header;
285                 blob.length = sizeof(rec->header) - rec->ndone;
286
287                 status = socket_send(rec->sock, rec, &blob, &nsent, 0);
288                 if (NT_STATUS_IS_ERR(status)) {
289                         talloc_free(rec);
290                         return;
291                 }
292
293                 if (nsent == 0) {
294                         return;
295                 }
296
297                 rec->ndone += nsent;
298         }
299
300         if (rec->ndone >= sizeof(rec->header) && 
301             rec->ndone < sizeof(rec->header) + rec->header.length) {
302                 /* send the body, if any */
303                 DATA_BLOB blob;
304                 size_t nsent;
305
306                 blob.data = rec->data.data + (rec->ndone - sizeof(rec->header));
307                 blob.length = rec->header.length - (rec->ndone - sizeof(rec->header));
308
309                 status = socket_send(rec->sock, rec, &blob, &nsent, 0);
310                 if (NT_STATUS_IS_ERR(status)) {
311                         talloc_free(rec);
312                         return;
313                 }
314
315                 rec->ndone += nsent;
316         }
317
318         if (rec->ndone == sizeof(rec->header) + rec->header.length) {
319                 /* we've done the whole message */
320                 talloc_free(rec);
321         }
322 }
323
324
325 /*
326   when the servers listen queue is full we use this to backoff the message
327 */
328 static void messaging_backoff_handler(struct event_context *ev, struct timed_event *te, time_t t)
329 {
330         struct messaging_rec *rec = te->private;
331         struct messaging_state *msg = rec->msg;
332         NTSTATUS status;
333         struct fd_event fde;
334
335         status = socket_connect(rec->sock, NULL, 0, rec->path, 0, 0);
336         if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
337                 /* backoff again */
338                 te->next_event = t+1;
339                 return;
340         }
341
342         if (!NT_STATUS_IS_OK(status)) {
343                 DEBUG(1,("messaging: Lost message from %u to %u of type %u after backoff - %s\n", 
344                          rec->header.from, rec->header.to, rec->header.msg_type, nt_errstr(status)));
345                 talloc_free(rec);
346                 return;
347         }
348
349         fde.private     = rec;
350         fde.fd          = socket_get_fd(rec->sock);
351         fde.flags       = EVENT_FD_WRITE;
352         fde.handler     = messaging_send_handler;
353
354         rec->fde        = event_add_fd(msg->event.ev, &fde);
355
356         talloc_set_destructor(rec, rec_destructor);
357
358         messaging_send_handler(msg->event.ev, rec->fde, 0, EVENT_FD_WRITE);
359 }
360
361
362 /*
363   Send a message to a particular server
364 */
365 NTSTATUS messaging_send(void *msg_ctx, servid_t server, uint32_t msg_type, DATA_BLOB *data)
366 {
367         struct messaging_state *msg = msg_ctx;
368         struct messaging_rec *rec;
369         NTSTATUS status;
370         struct fd_event fde;
371
372         rec = talloc_p(msg, struct messaging_rec);
373         if (rec == NULL) {
374                 return NT_STATUS_NO_MEMORY;
375         }
376
377         rec->msg = msg;
378         rec->header.version = MESSAGING_VERSION;
379         rec->header.msg_type = msg_type;
380         rec->header.from = msg->server_id;
381         rec->header.to = server;
382         rec->header.length = data?data->length:0;
383         if (rec->header.length != 0) {
384                 rec->data = data_blob_talloc(rec, data->data, data->length);
385         } else {
386                 rec->data = data_blob(NULL, 0);
387         }
388         rec->ndone = 0;
389
390         status = socket_create("unix", SOCKET_TYPE_STREAM, &rec->sock, 0);
391         if (!NT_STATUS_IS_OK(status)) {
392                 talloc_free(rec);
393                 return status;
394         }
395         talloc_steal(rec, rec->sock);
396
397         rec->path = messaging_path(rec, server);
398
399         status = socket_connect(rec->sock, NULL, 0, rec->path, 0, 0);
400         if (NT_STATUS_EQUAL(status, STATUS_MORE_ENTRIES)) {
401                 /* backoff on this message - the servers listen queue is full */
402                 struct timed_event te;
403                 te.next_event = time(NULL)+1;
404                 te.handler = messaging_backoff_handler;
405                 te.private = rec;
406                 event_add_timed(msg->event.ev, &te);
407                 return NT_STATUS_OK;
408         }
409
410         if (!NT_STATUS_IS_OK(status)) {
411                 talloc_free(rec);
412                 return status;
413         }
414
415         fde.private     = rec;
416         fde.fd          = socket_get_fd(rec->sock);
417         fde.flags       = EVENT_FD_WRITE;
418         fde.handler     = messaging_send_handler;
419
420         rec->fde        = event_add_fd(msg->event.ev, &fde);
421
422         talloc_set_destructor(rec, rec_destructor);
423
424         messaging_send_handler(msg->event.ev, rec->fde, 0, EVENT_FD_WRITE);
425
426         return NT_STATUS_OK;
427 }
428
429
430 /*
431   destroy the messaging context
432 */
433 static int messaging_destructor(void *msg_ctx)
434 {
435         struct messaging_state *msg = msg_ctx;
436         event_remove_fd(msg->event.ev, msg->event.fde);
437         return 0;
438 }
439
440 /*
441   create the listening socket and setup the dispatcher
442 */
443 void *messaging_init(TALLOC_CTX *mem_ctx, servid_t server_id, struct event_context *ev)
444 {
445         struct messaging_state *msg;
446         NTSTATUS status;
447         struct fd_event fde;
448
449         msg = talloc_p(mem_ctx, struct messaging_state);
450         if (msg == NULL) {
451                 return NULL;
452         }
453
454         /* create the messaging directory if needed */
455         msg->path = lock_path(msg, "messaging");
456         mkdir(msg->path, 0700);
457         talloc_free(msg->path);
458
459         msg->server_id = server_id;
460         msg->dispatch = NULL;
461         msg->path = messaging_path(msg, server_id);
462
463         status = socket_create("unix", SOCKET_TYPE_STREAM, &msg->sock, 0);
464         if (!NT_STATUS_IS_OK(status)) {
465                 talloc_free(msg);
466                 return NULL;
467         }
468
469         /* by stealing here we ensure that the socket is cleaned up (and even 
470            deleted) on exit */
471         talloc_steal(msg, msg->sock);
472
473         status = socket_listen(msg->sock, msg->path, 0, 50, 0);
474         if (!NT_STATUS_IS_OK(status)) {
475                 DEBUG(0,("Unable to setup messaging listener for '%s'\n", msg->path));
476                 talloc_free(msg);
477                 return NULL;
478         }
479
480         fde.private     = msg;
481         fde.fd          = socket_get_fd(msg->sock);
482         fde.flags       = EVENT_FD_READ;
483         fde.handler     = messaging_listen_handler;
484
485         msg->event.ev   = ev;
486         msg->event.fde  = event_add_fd(ev, &fde);
487
488         talloc_set_destructor(msg, messaging_destructor);
489         
490         messaging_register(msg, NULL, MSG_PING, ping_message);
491
492         return msg;
493 }
494
495