Correct "initialze" typos.
[nivanova/samba-autobuild/.git] / source4 / smbd / process_standard.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    process model: standard (1 process per client connection)
5
6    Copyright (C) Andrew Tridgell 1992-2005
7    Copyright (C) James J Myers 2003 <myersjj@samba.org>
8    Copyright (C) Stefan (metze) Metzmacher 2004
9    
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 3 of the License, or
13    (at your option) any later version.
14    
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19    
20    You should have received a copy of the GNU General Public License
21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
22 */
23
24 #include "includes.h"
25 #include "lib/events/events.h"
26 #include "smbd/process_model.h"
27 #include "system/filesys.h"
28 #include "cluster/cluster.h"
29 #include "param/param.h"
30 #include "ldb_wrap.h"
31
32 struct standard_child_state {
33         const char *name;
34         pid_t pid;
35         int to_parent_fd;
36         int from_child_fd;
37         struct tevent_fd *from_child_fde;
38 };
39
40 NTSTATUS process_model_standard_init(void);
41
42 /* we hold a pipe open in the parent, and the any child
43    processes wait for EOF on that pipe. This ensures that
44    children die when the parent dies */
45 static int child_pipe[2] = { -1, -1 };
46
47 /*
48   called when the process model is selected
49 */
50 static void standard_model_init(void)
51 {
52         int rc;
53
54         rc = pipe(child_pipe);
55         if (rc < 0) {
56                 smb_panic("Failed to initialize pipe!");
57         }
58 }
59
60 /*
61   handle EOF on the parent-to-all-children pipe in the child
62 */
63 static void standard_pipe_handler(struct tevent_context *event_ctx, struct tevent_fd *fde, 
64                                   uint16_t flags, void *private_data)
65 {
66         DEBUG(10,("Child %d exiting\n", (int)getpid()));
67         exit(0);
68 }
69
70 /*
71   handle EOF on the child pipe in the parent, so we know when a
72   process terminates without using SIGCHLD or waiting on all possible pids.
73
74   We need to ensure we do not ignore SIGCHLD because we need it to
75   work to get a valid error code from samba_runcmd_*().
76  */
77 static void standard_child_pipe_handler(struct tevent_context *ev,
78                                         struct tevent_fd *fde,
79                                         uint16_t flags,
80                                         void *private_data)
81 {
82         struct standard_child_state *state
83                 = talloc_get_type_abort(private_data, struct standard_child_state);
84         int status = 0;
85         pid_t pid;
86
87         /* the child has closed the pipe, assume its dead */
88         errno = 0;
89         pid = waitpid(state->pid, &status, 0);
90
91         if (pid != state->pid) {
92                 if (errno == ECHILD) {
93                         /*
94                          * this happens when the
95                          * parent has set SIGCHLD to
96                          * SIG_IGN. In that case we
97                          * can only get error
98                          * information for the child
99                          * via its logging. We should
100                          * stop using SIG_IGN on
101                          * SIGCHLD in the standard
102                          * process model.
103                          */
104                         DEBUG(0, ("Error in waitpid() unexpectedly got ECHILD "
105                                   "for child %d (%s) - %s, someone has set SIGCHLD "
106                                   "to SIG_IGN!\n",
107                                   (int)state->pid, state->name,
108                                   strerror(errno)));
109                         TALLOC_FREE(state);
110                         return;
111                 }
112                 DEBUG(0, ("Error in waitpid() for child %d (%s) - %s \n",
113                           (int)state->pid, state->name, strerror(errno)));
114                 if (errno == 0) {
115                         errno = ECHILD;
116                 }
117                 TALLOC_FREE(state);
118                 return;
119         }
120         if (WIFEXITED(status)) {
121                 status = WEXITSTATUS(status);
122                 DEBUG(2, ("Child %d (%s) exited with status %d\n",
123                           (int)state->pid, state->name, status));
124         } else if (WIFSIGNALED(status)) {
125                 status = WTERMSIG(status);
126                 DEBUG(0, ("Child %d (%s) terminated with signal %d\n",
127                           (int)state->pid, state->name, status));
128         }
129         TALLOC_FREE(state);
130         return;
131 }
132
133 static struct standard_child_state *setup_standard_child_pipe(struct tevent_context *ev,
134                                                               const char *name)
135 {
136         struct standard_child_state *state;
137         int parent_child_pipe[2];
138         int ret;
139
140         /*
141          * Prepare a pipe to allow us to know when the child exits,
142          * because it will trigger a read event on this private
143          * pipe.
144          *
145          * We do all this before the accept and fork(), so we can
146          * clean up if it fails.
147          */
148         state = talloc_zero(ev, struct standard_child_state);
149         if (state == NULL) {
150                 return NULL;
151         }
152
153         if (name == NULL) {
154                 name = "";
155         }
156
157         state->name = talloc_strdup(state, name);
158         if (state->name == NULL) {
159                 TALLOC_FREE(state);
160                 return NULL;
161         }
162
163         ret = pipe(parent_child_pipe);
164         if (ret == -1) {
165                 DEBUG(0, ("Failed to create parent-child pipe to handle "
166                           "SIGCHLD to track new process for socket\n"));
167                 TALLOC_FREE(state);
168                 return NULL;
169         }
170
171         smb_set_close_on_exec(parent_child_pipe[0]);
172         smb_set_close_on_exec(parent_child_pipe[1]);
173
174         state->from_child_fd = parent_child_pipe[0];
175         state->to_parent_fd = parent_child_pipe[1];
176
177         /*
178          * The basic purpose of calling this handler is to ensure we
179          * call waitpid() and so avoid zombies (now that we no longer
180          * user SIGIGN on for SIGCHLD), but it also allows us to clean
181          * up other resources in the future.
182          */
183         state->from_child_fde = tevent_add_fd(ev, state,
184                                               state->from_child_fd,
185                                               TEVENT_FD_READ,
186                                               standard_child_pipe_handler,
187                                               state);
188         if (state->from_child_fde == NULL) {
189                 TALLOC_FREE(state);
190                 return NULL;
191         }
192         tevent_fd_set_auto_close(state->from_child_fde);
193
194         return state;
195 }
196
197 /*
198   called when a listening socket becomes readable. 
199 */
200 static void standard_accept_connection(struct tevent_context *ev, 
201                                        struct loadparm_context *lp_ctx,
202                                        struct socket_context *sock, 
203                                        void (*new_conn)(struct tevent_context *,
204                                                         struct loadparm_context *, struct socket_context *, 
205                                                         struct server_id , void *), 
206                                        void *private_data)
207 {
208         NTSTATUS status;
209         struct socket_context *sock2;
210         pid_t pid;
211         struct socket_address *c, *s;
212         struct standard_child_state *state;
213
214         state = setup_standard_child_pipe(ev, NULL);
215         if (state == NULL) {
216                 return;
217         }
218
219         /* accept an incoming connection. */
220         status = socket_accept(sock, &sock2);
221         if (!NT_STATUS_IS_OK(status)) {
222                 DEBUG(0,("standard_accept_connection: accept: %s\n",
223                          nt_errstr(status)));
224                 /* this looks strange, but is correct. We need to throttle things until
225                    the system clears enough resources to handle this new socket */
226                 sleep(1);
227                 close(state->to_parent_fd);
228                 state->to_parent_fd = -1;
229                 TALLOC_FREE(state);
230                 return;
231         }
232
233         pid = fork();
234
235         if (pid != 0) {
236                 close(state->to_parent_fd);
237                 state->to_parent_fd = -1;
238
239                 if (pid > 0) {
240                         state->pid = pid;
241                 } else {
242                         TALLOC_FREE(state);
243                 }
244
245                 /* parent or error code ... */
246                 talloc_free(sock2);
247                 /* go back to the event loop */
248                 return;
249         }
250
251         /* this leaves state->to_parent_fd open */
252         TALLOC_FREE(state);
253
254         pid = getpid();
255
256         /* This is now the child code. We need a completely new event_context to work with */
257
258         if (tevent_re_initialise(ev) != 0) {
259                 smb_panic("Failed to re-initialise tevent after fork");
260         }
261
262         /* this will free all the listening sockets and all state that
263            is not associated with this new connection */
264         talloc_free(sock);
265
266         /* we don't care if the dup fails, as its only a select()
267            speed optimisation */
268         socket_dup(sock2);
269                         
270         /* tdb needs special fork handling */
271         ldb_wrap_fork_hook();
272
273         tevent_add_fd(ev, ev, child_pipe[0], TEVENT_FD_READ,
274                       standard_pipe_handler, NULL);
275         if (child_pipe[1] != -1) {
276                 close(child_pipe[1]);
277                 child_pipe[1] = -1;
278         }
279
280         /* setup the process title */
281         c = socket_get_peer_addr(sock2, ev);
282         s = socket_get_my_addr(sock2, ev);
283         if (s && c) {
284                 setproctitle("conn c[%s:%u] s[%s:%u] server_id[%d]",
285                              c->addr, c->port, s->addr, s->port, (int)pid);
286         }
287         talloc_free(c);
288         talloc_free(s);
289
290         /* setup this new connection.  Cluster ID is PID based for this process model */
291         new_conn(ev, lp_ctx, sock2, cluster_id(pid, 0), private_data);
292
293         /* we can't return to the top level here, as that event context is gone,
294            so we now process events in the new event context until there are no
295            more to process */      
296         tevent_loop_wait(ev);
297
298         talloc_free(ev);
299         exit(0);
300 }
301
302 /*
303   called to create a new server task
304 */
305 static void standard_new_task(struct tevent_context *ev, 
306                               struct loadparm_context *lp_ctx,
307                               const char *service_name,
308                               void (*new_task)(struct tevent_context *, struct loadparm_context *lp_ctx, struct server_id , void *),
309                               void *private_data)
310 {
311         pid_t pid;
312         struct standard_child_state *state;
313
314         state = setup_standard_child_pipe(ev, service_name);
315         if (state == NULL) {
316                 return;
317         }
318
319         pid = fork();
320
321         if (pid != 0) {
322                 close(state->to_parent_fd);
323                 state->to_parent_fd = -1;
324
325                 if (pid > 0) {
326                         state->pid = pid;
327                 } else {
328                         TALLOC_FREE(state);
329                 }
330
331                 /* parent or error code ... go back to the event loop */
332                 return;
333         }
334
335         /* this leaves state->to_parent_fd open */
336         TALLOC_FREE(state);
337
338         pid = getpid();
339
340         /* this will free all the listening sockets and all state that
341            is not associated with this new connection */
342         if (tevent_re_initialise(ev) != 0) {
343                 smb_panic("Failed to re-initialise tevent after fork");
344         }
345
346         /* ldb/tdb need special fork handling */
347         ldb_wrap_fork_hook();
348
349         tevent_add_fd(ev, ev, child_pipe[0], TEVENT_FD_READ,
350                       standard_pipe_handler, NULL);
351         if (child_pipe[1] != -1) {
352                 close(child_pipe[1]);
353                 child_pipe[1] = -1;
354         }
355
356         setproctitle("task %s server_id[%d]", service_name, (int)pid);
357
358         /* setup this new task.  Cluster ID is PID based for this process model */
359         new_task(ev, lp_ctx, cluster_id(pid, 0), private_data);
360
361         /* we can't return to the top level here, as that event context is gone,
362            so we now process events in the new event context until there are no
363            more to process */      
364         tevent_loop_wait(ev);
365
366         talloc_free(ev);
367         exit(0);
368 }
369
370
371 /* called when a task goes down */
372 _NORETURN_ static void standard_terminate(struct tevent_context *ev, struct loadparm_context *lp_ctx,
373                                           const char *reason) 
374 {
375         DEBUG(2,("standard_terminate: reason[%s]\n",reason));
376
377         talloc_free(ev);
378
379         /* this reload_charcnv() has the effect of freeing the iconv context memory,
380            which makes leak checking easier */
381         reload_charcnv(lp_ctx);
382
383         /* terminate this process */
384         exit(0);
385 }
386
387 /* called to set a title of a task or connection */
388 static void standard_set_title(struct tevent_context *ev, const char *title) 
389 {
390         if (title) {
391                 setproctitle("%s", title);
392         } else {
393                 setproctitle(NULL);
394         }
395 }
396
397 static const struct model_ops standard_ops = {
398         .name                   = "standard",
399         .model_init             = standard_model_init,
400         .accept_connection      = standard_accept_connection,
401         .new_task               = standard_new_task,
402         .terminate              = standard_terminate,
403         .set_title              = standard_set_title,
404 };
405
406 /*
407   initialise the standard process model, registering ourselves with the process model subsystem
408  */
409 NTSTATUS process_model_standard_init(void)
410 {
411         return register_process_model(&standard_ops);
412 }