Remove a redundant TALLOC_FREE
[jra/samba/.git] / source / modules / vfs_aio_fork.c
1 /*
2  * Simulate the Posix AIO using mmap/fork
3  *
4  * Copyright (C) Volker Lendecke 2008
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19  */
20
21 #include "includes.h"
22
23 struct mmap_area {
24         size_t size;
25         volatile void *ptr;
26 };
27
28 static int mmap_area_destructor(struct mmap_area *area)
29 {
30         munmap((void *)area->ptr, area->size);
31         return 0;
32 }
33
34 static struct mmap_area *mmap_area_init(TALLOC_CTX *mem_ctx, size_t size)
35 {
36         struct mmap_area *result;
37         int fd;
38
39         result = talloc(mem_ctx, struct mmap_area);
40         if (result == NULL) {
41                 DEBUG(0, ("talloc failed\n"));
42                 goto fail;
43         }
44
45         fd = open("/dev/zero", O_RDWR);
46         if (fd == -1) {
47                 DEBUG(3, ("open(\"/dev/zero\") failed: %s\n",
48                           strerror(errno)));
49                 goto fail;
50         }
51
52         result->ptr = mmap(NULL, size, PROT_READ|PROT_WRITE,
53                            MAP_SHARED|MAP_FILE, fd, 0);
54         if (result->ptr == MAP_FAILED) {
55                 DEBUG(1, ("mmap failed: %s\n", strerror(errno)));
56                 goto fail;
57         }
58
59         close(fd);
60
61         result->size = size;
62         talloc_set_destructor(result, mmap_area_destructor);
63
64         return result;
65
66 fail:
67         TALLOC_FREE(result);
68         return NULL;
69 }
70
71 struct rw_cmd {
72         size_t n;
73         SMB_OFF_T offset;
74         bool read_cmd;
75 };
76
77 struct rw_ret {
78         ssize_t size;
79         int ret_errno;
80 };
81
82 struct aio_child_list;
83
84 struct aio_child {
85         struct aio_child *prev, *next;
86         struct aio_child_list *list;
87         SMB_STRUCT_AIOCB *aiocb;
88         pid_t pid;
89         int sockfd;
90         struct fd_event *sock_event;
91         struct rw_ret retval;
92         struct mmap_area *map;  /* ==NULL means write request */
93         bool dont_delete;       /* Marked as in use since last cleanup */
94         bool cancelled;
95         bool read_cmd;
96 };
97
98 struct aio_child_list {
99         struct aio_child *children;
100         struct timed_event *cleanup_event;
101 };
102
103 static void free_aio_children(void **p)
104 {
105         TALLOC_FREE(*p);
106 }
107
108 static ssize_t read_fd(int fd, void *ptr, size_t nbytes, int *recvfd)
109 {
110         struct msghdr msg;
111         struct iovec iov[1];
112         ssize_t n;
113 #ifndef HAVE_MSGHDR_MSG_CONTROL
114         int newfd;
115 #endif
116
117 #ifdef  HAVE_MSGHDR_MSG_CONTROL
118         union {
119           struct cmsghdr        cm;
120           char                          control[CMSG_SPACE(sizeof(int))];
121         } control_un;
122         struct cmsghdr  *cmptr;
123
124         msg.msg_control = control_un.control;
125         msg.msg_controllen = sizeof(control_un.control);
126 #else
127 #if HAVE_MSGHDR_MSG_ACCTRIGHTS
128         msg.msg_accrights = (caddr_t) &newfd;
129         msg.msg_accrightslen = sizeof(int);
130 #else
131 #error Can not pass file descriptors
132 #endif
133 #endif
134
135         msg.msg_name = NULL;
136         msg.msg_namelen = 0;
137
138         iov[0].iov_base = ptr;
139         iov[0].iov_len = nbytes;
140         msg.msg_iov = iov;
141         msg.msg_iovlen = 1;
142
143         if ( (n = recvmsg(fd, &msg, 0)) <= 0) {
144                 return(n);
145         }
146
147 #ifdef  HAVE_MSGHDR_MSG_CONTROL
148         if ((cmptr = CMSG_FIRSTHDR(&msg)) != NULL
149             && cmptr->cmsg_len == CMSG_LEN(sizeof(int))) {
150                 if (cmptr->cmsg_level != SOL_SOCKET) {
151                         DEBUG(10, ("control level != SOL_SOCKET"));
152                         errno = EINVAL;
153                         return -1;
154                 }
155                 if (cmptr->cmsg_type != SCM_RIGHTS) {
156                         DEBUG(10, ("control type != SCM_RIGHTS"));
157                         errno = EINVAL;
158                         return -1;
159                 }
160                 *recvfd = *((int *) CMSG_DATA(cmptr));
161         } else {
162                 *recvfd = -1;           /* descriptor was not passed */
163         }
164 #else
165         if (msg.msg_accrightslen == sizeof(int)) {
166                 *recvfd = newfd;
167         }
168         else {
169                 *recvfd = -1;           /* descriptor was not passed */
170         }
171 #endif
172
173         return(n);
174 }
175
176 static ssize_t write_fd(int fd, void *ptr, size_t nbytes, int sendfd)
177 {
178         struct msghdr   msg;
179         struct iovec    iov[1];
180
181 #ifdef  HAVE_MSGHDR_MSG_CONTROL
182         union {
183                 struct cmsghdr  cm;
184                 char control[CMSG_SPACE(sizeof(int))];
185         } control_un;
186         struct cmsghdr  *cmptr;
187
188         ZERO_STRUCT(msg);
189         ZERO_STRUCT(control_un);
190
191         msg.msg_control = control_un.control;
192         msg.msg_controllen = sizeof(control_un.control);
193
194         cmptr = CMSG_FIRSTHDR(&msg);
195         cmptr->cmsg_len = CMSG_LEN(sizeof(int));
196         cmptr->cmsg_level = SOL_SOCKET;
197         cmptr->cmsg_type = SCM_RIGHTS;
198         *((int *) CMSG_DATA(cmptr)) = sendfd;
199 #else
200         ZERO_STRUCT(msg);
201         msg.msg_accrights = (caddr_t) &sendfd;
202         msg.msg_accrightslen = sizeof(int);
203 #endif
204
205         msg.msg_name = NULL;
206         msg.msg_namelen = 0;
207
208         ZERO_STRUCT(iov);
209         iov[0].iov_base = ptr;
210         iov[0].iov_len = nbytes;
211         msg.msg_iov = iov;
212         msg.msg_iovlen = 1;
213
214         return (sendmsg(fd, &msg, 0));
215 }
216
217 static void aio_child_cleanup(struct event_context *event_ctx,
218                               struct timed_event *te,
219                               const struct timeval *now,
220                               void *private_data)
221 {
222         struct aio_child_list *list = talloc_get_type_abort(
223                 private_data, struct aio_child_list);
224         struct aio_child *child, *next;
225
226         TALLOC_FREE(list->cleanup_event);
227
228         for (child = list->children; child != NULL; child = next) {
229                 next = child->next;
230
231                 if (child->aiocb != NULL) {
232                         DEBUG(10, ("child %d currently active\n",
233                                    (int)child->pid));
234                         continue;
235                 }
236
237                 if (child->dont_delete) {
238                         DEBUG(10, ("Child %d was active since last cleanup\n",
239                                    (int)child->pid));
240                         child->dont_delete = false;
241                         continue;
242                 }
243
244                 DEBUG(10, ("Child %d idle for more than 30 seconds, "
245                            "deleting\n", (int)child->pid));
246
247                 TALLOC_FREE(child);
248         }
249
250         if (list->children != NULL) {
251                 /*
252                  * Re-schedule the next cleanup round
253                  */
254                 list->cleanup_event = event_add_timed(smbd_event_context(), list,
255                                                       timeval_add(now, 30, 0),
256                                                       "aio_child_cleanup",
257                                                       aio_child_cleanup, list);
258
259         }
260 }
261
262 static struct aio_child_list *init_aio_children(struct vfs_handle_struct *handle)
263 {
264         struct aio_child_list *data = NULL;
265
266         if (SMB_VFS_HANDLE_TEST_DATA(handle)) {
267                 SMB_VFS_HANDLE_GET_DATA(handle, data, struct aio_child_list,
268                                         return NULL);
269         }
270
271         if (data == NULL) {
272                 data = TALLOC_ZERO_P(NULL, struct aio_child_list);
273                 if (data == NULL) {
274                         return NULL;
275                 }
276         }
277
278         /*
279          * Regardless of whether the child_list had been around or not, make
280          * sure that we have a cleanup timed event. This timed event will
281          * delete itself when it finds that no children are around anymore.
282          */
283
284         if (data->cleanup_event == NULL) {
285                 data->cleanup_event = event_add_timed(smbd_event_context(), data,
286                                                       timeval_current_ofs(30, 0),
287                                                       "aio_child_cleanup",
288                                                       aio_child_cleanup, data);
289                 if (data->cleanup_event == NULL) {
290                         TALLOC_FREE(data);
291                         return NULL;
292                 }
293         }
294
295         if (!SMB_VFS_HANDLE_TEST_DATA(handle)) {
296                 SMB_VFS_HANDLE_SET_DATA(handle, data, free_aio_children,
297                                         struct aio_child_list, return False);
298         }
299
300         return data;
301 }
302
303 static void aio_child_loop(int sockfd, struct mmap_area *map)
304 {
305         while (true) {
306                 int fd = -1;
307                 ssize_t ret;
308                 struct rw_cmd cmd_struct;
309                 struct rw_ret ret_struct;
310
311                 ret = read_fd(sockfd, &cmd_struct, sizeof(cmd_struct), &fd);
312                 if (ret != sizeof(cmd_struct)) {
313                         DEBUG(10, ("read_fd returned %d: %s\n", (int)ret,
314                                    strerror(errno)));
315                         exit(1);
316                 }
317
318                 DEBUG(10, ("aio_child_loop: %s %d bytes at %d from fd %d\n",
319                            cmd_struct.read_cmd ? "read" : "write",
320                            (int)cmd_struct.n, (int)cmd_struct.offset, fd));
321
322 #ifdef ENABLE_BUILD_FARM_HACKS
323                 {
324                         /*
325                          * In the build farm, we want erratic behaviour for
326                          * async I/O times
327                          */
328                         uint8_t randval;
329                         unsigned msecs;
330                         /*
331                          * use generate_random_buffer, we just forked from a
332                          * common parent state
333                          */
334                         generate_random_buffer(&randval, sizeof(randval));
335                         msecs = randval + 20;
336                         DEBUG(10, ("delaying for %u msecs\n", msecs));
337                         smb_msleep(msecs);
338                 }
339 #endif
340
341
342                 ZERO_STRUCT(ret_struct);
343
344                 if (cmd_struct.read_cmd) {
345                         ret_struct.size = sys_pread(
346                                 fd, (void *)map->ptr, cmd_struct.n,
347                                 cmd_struct.offset);
348                 }
349                 else {
350                         ret_struct.size = sys_pwrite(
351                                 fd, (void *)map->ptr, cmd_struct.n,
352                                 cmd_struct.offset);
353                 }
354
355                 DEBUG(10, ("aio_child_loop: syscall returned %d\n",
356                            (int)ret_struct.size));
357
358                 if (ret_struct.size == -1) {
359                         ret_struct.ret_errno = errno;
360                 }
361
362                 ret = write_data(sockfd, (char *)&ret_struct,
363                                  sizeof(ret_struct));
364                 if (ret != sizeof(ret_struct)) {
365                         DEBUG(10, ("could not write ret_struct: %s\n",
366                                    strerror(errno)));
367                         exit(2);
368                 }
369
370                 close(fd);
371         }
372 }
373
374 static void handle_aio_completion(struct event_context *event_ctx,
375                                   struct fd_event *event, uint16 flags,
376                                   void *p)
377 {
378         struct aio_child *child = (struct aio_child *)p;
379         uint16 mid;
380
381         DEBUG(10, ("handle_aio_completion called with flags=%d\n", flags));
382
383         if ((flags & EVENT_FD_READ) == 0) {
384                 return;
385         }
386
387         if (!NT_STATUS_IS_OK(read_data(child->sockfd,
388                                        (char *)&child->retval,
389                                        sizeof(child->retval)))) {
390                 DEBUG(0, ("aio child %d died\n", (int)child->pid));
391                 child->retval.size = -1;
392                 child->retval.ret_errno = EIO;
393         }
394
395         if (child->cancelled) {
396                 child->aiocb = NULL;
397                 child->cancelled = false;
398                 return;
399         }
400
401         if (child->read_cmd && (child->retval.size > 0)) {
402                 SMB_ASSERT(child->retval.size <= child->aiocb->aio_nbytes);
403                 memcpy((void *)child->aiocb->aio_buf, (void *)child->map->ptr,
404                        child->retval.size);
405         }
406
407         mid = child->aiocb->aio_sigevent.sigev_value.sival_int;
408
409         DEBUG(10, ("mid %d finished\n", (int)mid));
410
411         aio_request_done(mid);
412         process_aio_queue();
413 }
414
415 static int aio_child_destructor(struct aio_child *child)
416 {
417         SMB_ASSERT((child->aiocb == NULL) || child->cancelled);
418         close(child->sockfd);
419         DLIST_REMOVE(child->list->children, child);
420         return 0;
421 }
422
423 static NTSTATUS create_aio_child(struct aio_child_list *children,
424                                  size_t map_size,
425                                  struct aio_child **presult)
426 {
427         struct aio_child *result;
428         int fdpair[2];
429         NTSTATUS status;
430
431         fdpair[0] = fdpair[1] = -1;
432
433         result = TALLOC_ZERO_P(children, struct aio_child);
434         NT_STATUS_HAVE_NO_MEMORY(result);
435
436         if (socketpair(AF_UNIX, SOCK_STREAM, 0, fdpair) == -1) {
437                 status = map_nt_error_from_unix(errno);
438                 DEBUG(10, ("socketpair() failed: %s\n", strerror(errno)));
439                 goto fail;
440         }
441
442         DEBUG(10, ("fdpair = %d/%d\n", fdpair[0], fdpair[1]));
443
444         result->map = mmap_area_init(result, map_size);
445         if (result->map == NULL) {
446                 status = map_nt_error_from_unix(errno);
447                 DEBUG(0, ("Could not create mmap area\n"));
448                 goto fail;
449         }
450
451         result->pid = sys_fork();
452         if (result->pid == -1) {
453                 status = map_nt_error_from_unix(errno);
454                 DEBUG(0, ("fork failed: %s\n", strerror(errno)));
455                 goto fail;
456         }
457
458         if (result->pid == 0) {
459                 close(fdpair[0]);
460                 result->sockfd = fdpair[1];
461                 aio_child_loop(result->sockfd, result->map);
462         }
463
464         DEBUG(10, ("Child %d created\n", result->pid));
465
466         result->sockfd = fdpair[0];
467         close(fdpair[1]);
468
469         result->sock_event = event_add_fd(smbd_event_context(), result,
470                                           result->sockfd, EVENT_FD_READ,
471                                           handle_aio_completion,
472                                           result);
473         if (result->sock_event == NULL) {
474                 status = NT_STATUS_NO_MEMORY;
475                 DEBUG(0, ("event_add_fd failed\n"));
476                 goto fail;
477         }
478
479         result->list = children;
480         DLIST_ADD(children->children, result);
481
482         talloc_set_destructor(result, aio_child_destructor);
483
484         *presult = result;
485
486         return NT_STATUS_OK;
487
488  fail:
489         if (fdpair[0] != -1) close(fdpair[0]);
490         if (fdpair[1] != -1) close(fdpair[1]);
491         TALLOC_FREE(result);
492
493         return status;
494 }
495
496 static NTSTATUS get_idle_child(struct vfs_handle_struct *handle,
497                                struct aio_child **pchild)
498 {
499         struct aio_child_list *children;
500         struct aio_child *child;
501         NTSTATUS status;
502
503         children = init_aio_children(handle);
504         if (children == NULL) {
505                 return NT_STATUS_NO_MEMORY;
506         }
507
508         for (child = children->children; child != NULL; child = child->next) {
509                 if (child->aiocb == NULL) {
510                         /* idle */
511                         break;
512                 }
513         }
514
515         if (child == NULL) {
516                 DEBUG(10, ("no idle child found, creating new one\n"));
517
518                 status = create_aio_child(children, 128*1024, &child);
519                 if (!NT_STATUS_IS_OK(status)) {
520                         DEBUG(10, ("create_aio_child failed: %s\n",
521                                    nt_errstr(status)));
522                         return status;
523                 }
524         }
525
526         child->dont_delete = true;
527
528         *pchild = child;
529         return NT_STATUS_OK;
530 }
531
532 static int aio_fork_read(struct vfs_handle_struct *handle,
533                          struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
534 {
535         struct aio_child *child;
536         struct rw_cmd cmd;
537         ssize_t ret;
538         NTSTATUS status;
539
540         if (aiocb->aio_nbytes > 128*1024) {
541                 /* TODO: support variable buffers */
542                 errno = EINVAL;
543                 return -1;
544         }
545
546         status = get_idle_child(handle, &child);
547         if (!NT_STATUS_IS_OK(status)) {
548                 DEBUG(10, ("Could not get an idle child\n"));
549                 return -1;
550         }
551
552         child->read_cmd = true;
553         child->aiocb = aiocb;
554         child->retval.ret_errno = EINPROGRESS;
555
556         ZERO_STRUCT(cmd);
557         cmd.n = aiocb->aio_nbytes;
558         cmd.offset = aiocb->aio_offset;
559         cmd.read_cmd = child->read_cmd;
560
561         DEBUG(10, ("sending fd %d to child %d\n", fsp->fh->fd,
562                    (int)child->pid));
563
564         ret = write_fd(child->sockfd, &cmd, sizeof(cmd), fsp->fh->fd);
565         if (ret == -1) {
566                 DEBUG(10, ("write_fd failed: %s\n", strerror(errno)));
567                 return -1;
568         }
569
570         return 0;
571 }
572
573 static int aio_fork_write(struct vfs_handle_struct *handle,
574                           struct files_struct *fsp, SMB_STRUCT_AIOCB *aiocb)
575 {
576         struct aio_child *child;
577         struct rw_cmd cmd;
578         ssize_t ret;
579         NTSTATUS status;
580
581         if (aiocb->aio_nbytes > 128*1024) {
582                 /* TODO: support variable buffers */
583                 errno = EINVAL;
584                 return -1;
585         }
586
587         status = get_idle_child(handle, &child);
588         if (!NT_STATUS_IS_OK(status)) {
589                 DEBUG(10, ("Could not get an idle child\n"));
590                 return -1;
591         }
592
593         child->read_cmd = false;
594         child->aiocb = aiocb;
595         child->retval.ret_errno = EINPROGRESS;
596
597         memcpy((void *)child->map->ptr, (void *)aiocb->aio_buf,
598                aiocb->aio_nbytes);
599
600         ZERO_STRUCT(cmd);
601         cmd.n = aiocb->aio_nbytes;
602         cmd.offset = aiocb->aio_offset;
603         cmd.read_cmd = child->read_cmd;
604
605         DEBUG(10, ("sending fd %d to child %d\n", fsp->fh->fd,
606                    (int)child->pid));
607
608         ret = write_fd(child->sockfd, &cmd, sizeof(cmd), fsp->fh->fd);
609         if (ret == -1) {
610                 DEBUG(10, ("write_fd failed: %s\n", strerror(errno)));
611                 return -1;
612         }
613
614         return 0;
615 }
616
617 static struct aio_child *aio_fork_find_child(struct vfs_handle_struct *handle,
618                                              SMB_STRUCT_AIOCB *aiocb)
619 {
620         struct aio_child_list *children;
621         struct aio_child *child;
622
623         children = init_aio_children(handle);
624         if (children == NULL) {
625                 return NULL;
626         }
627
628         for (child = children->children; child != NULL; child = child->next) {
629                 if (child->aiocb == aiocb) {
630                         return child;
631                 }
632         }
633
634         return NULL;
635 }
636
637 static ssize_t aio_fork_return_fn(struct vfs_handle_struct *handle,
638                                   struct files_struct *fsp,
639                                   SMB_STRUCT_AIOCB *aiocb)
640 {
641         struct aio_child *child = aio_fork_find_child(handle, aiocb);
642
643         if (child == NULL) {
644                 errno = EINVAL;
645                 DEBUG(0, ("returning EINVAL\n"));
646                 return -1;
647         }
648
649         child->aiocb = NULL;
650
651         if (child->retval.size == -1) {
652                 errno = child->retval.ret_errno;
653         }
654
655         return child->retval.size;
656 }
657
658 static int aio_fork_cancel(struct vfs_handle_struct *handle,
659                            struct files_struct *fsp,
660                            SMB_STRUCT_AIOCB *aiocb)
661 {
662         struct aio_child_list *children;
663         struct aio_child *child;
664
665         children = init_aio_children(handle);
666         if (children == NULL) {
667                 errno = EINVAL;
668                 return -1;
669         }
670
671         for (child = children->children; child != NULL; child = child->next) {
672                 if (child->aiocb == NULL) {
673                         continue;
674                 }
675                 if (child->aiocb->aio_fildes != fsp->fh->fd) {
676                         continue;
677                 }
678                 if ((aiocb != NULL) && (child->aiocb != aiocb)) {
679                         continue;
680                 }
681
682                 /*
683                  * We let the child do its job, but we discard the result when
684                  * it's finished.
685                  */
686
687                 child->cancelled = true;
688         }
689
690         return AIO_CANCELED;
691 }
692
693 static int aio_fork_error_fn(struct vfs_handle_struct *handle,
694                              struct files_struct *fsp,
695                              SMB_STRUCT_AIOCB *aiocb)
696 {
697         struct aio_child *child = aio_fork_find_child(handle, aiocb);
698
699         if (child == NULL) {
700                 errno = EINVAL;
701                 return -1;
702         }
703
704         return child->retval.ret_errno;
705 }
706
707 /* VFS operations structure */
708
709 static vfs_op_tuple aio_fork_ops[] = {
710         {SMB_VFS_OP(aio_fork_read),     SMB_VFS_OP_AIO_READ,
711          SMB_VFS_LAYER_TRANSPARENT},
712         {SMB_VFS_OP(aio_fork_write),    SMB_VFS_OP_AIO_WRITE,
713          SMB_VFS_LAYER_TRANSPARENT},
714         {SMB_VFS_OP(aio_fork_return_fn), SMB_VFS_OP_AIO_RETURN,
715          SMB_VFS_LAYER_TRANSPARENT},
716         {SMB_VFS_OP(aio_fork_cancel),   SMB_VFS_OP_AIO_CANCEL,
717          SMB_VFS_LAYER_TRANSPARENT},
718         {SMB_VFS_OP(aio_fork_error_fn), SMB_VFS_OP_AIO_ERROR,
719          SMB_VFS_LAYER_TRANSPARENT},
720         {SMB_VFS_OP(NULL),              SMB_VFS_OP_NOOP,
721          SMB_VFS_LAYER_NOOP}
722 };
723
724 NTSTATUS vfs_aio_fork_init(void);
725 NTSTATUS vfs_aio_fork_init(void)
726 {
727         return smb_register_vfs(SMB_VFS_INTERFACE_VERSION,
728                                 "aio_fork", aio_fork_ops);
729 }