2 Unix SMB/CIFS implementation.
5 Copyright (C) Simo Sorce <idra@samba.org> 2011
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "system/time.h"
23 #include "system/shmem.h"
24 #include "system/filesys.h"
25 #include "server_prefork.h"
26 #include "../lib/util/util.h"
27 #include "../lib/util/tevent_unix.h"
34 prefork_main_fn_t *main_fn;
38 struct pf_worker_data *pool;
42 prefork_sigchld_fn_t *sigchld_fn;
46 static bool prefork_setup_sigchld_handler(struct tevent_context *ev_ctx,
47 struct prefork_pool *pfp);
49 static int prefork_pool_destructor(struct prefork_pool *pfp)
51 anonymous_shared_free(pfp->pool);
55 bool prefork_create_pool(TALLOC_CTX *mem_ctx,
56 struct tevent_context *ev_ctx,
57 struct messaging_context *msg_ctx,
58 int listen_fd_size, int *listen_fds,
59 int min_children, int max_children,
60 prefork_main_fn_t *main_fn, void *private_data,
61 struct prefork_pool **pf_pool)
63 struct prefork_pool *pfp;
65 time_t now = time(NULL);
71 pfp = talloc_zero(mem_ctx, struct prefork_pool);
73 DEBUG(1, ("Out of memory!\n"));
76 pfp->listen_fd_size = listen_fd_size;
77 pfp->listen_fds = talloc_array(pfp, int, listen_fd_size);
78 if (!pfp->listen_fds) {
79 DEBUG(1, ("Out of memory!\n"));
82 for (i = 0; i < listen_fd_size; i++) {
83 pfp->listen_fds[i] = listen_fds[i];
85 pfp->main_fn = main_fn;
86 pfp->private_data = private_data;
88 pfp->pool_size = max_children;
89 data_size = sizeof(struct pf_worker_data) * max_children;
91 pfp->pool = anonymous_shared_allocate(data_size);
92 if (pfp->pool == NULL) {
93 DEBUG(1, ("Failed to mmap memory for prefork pool!\n"));
97 talloc_set_destructor(pfp, prefork_pool_destructor);
99 for (i = 0; i < min_children; i++) {
101 pfp->pool[i].allowed_clients = 1;
102 pfp->pool[i].started = now;
107 DEBUG(1, ("Failed to prefork child n. %d !\n", i));
110 case 0: /* THE CHILD */
112 pfp->pool[i].status = PF_WORKER_ALIVE;
113 ret = pfp->main_fn(ev_ctx, msg_ctx,
114 &pfp->pool[i], i + 1,
120 default: /* THE PARENT */
121 pfp->pool[i].pid = pid;
126 ok = prefork_setup_sigchld_handler(ev_ctx, pfp);
128 DEBUG(1, ("Failed to setup SIGCHLD Handler!\n"));
137 /* Provide the new max children number in new_max
138 * (must be larger than current max).
139 * Returns: 0 if all fine
140 * ENOSPC if mremap fails to expand
141 * EINVAL if new_max is invalid
143 int prefork_expand_pool(struct prefork_pool *pfp, int new_max)
145 struct prefork_pool *pool;
150 if (new_max <= pfp->pool_size) {
154 old_size = sizeof(struct pf_worker_data) * pfp->pool_size;
155 new_size = sizeof(struct pf_worker_data) * new_max;
157 pool = anonymous_shared_resize(&pfp->pool, new_size, false);
160 DEBUG(3, ("Failed to mremap memory (%d: %s)!\n",
161 ret, strerror(ret)));
165 memset(&pool[pfp->pool_size], 0, new_size - old_size);
167 pfp->pool_size = new_max;
172 int prefork_add_children(struct tevent_context *ev_ctx,
173 struct messaging_context *msg_ctx,
174 struct prefork_pool *pfp,
178 time_t now = time(NULL);
182 for (i = 0, j = 0; i < pfp->pool_size && j < num_children; i++) {
184 if (pfp->pool[i].status != PF_WORKER_NONE) {
188 pfp->pool[i].allowed_clients = 1;
189 pfp->pool[i].started = now;
194 DEBUG(1, ("Failed to prefork child n. %d !\n", j));
197 case 0: /* THE CHILD */
199 pfp->pool[i].status = PF_WORKER_ALIVE;
200 ret = pfp->main_fn(ev_ctx, msg_ctx,
201 &pfp->pool[i], i + 1,
206 pfp->pool[i].status = PF_WORKER_EXITING;
209 default: /* THE PARENT */
210 pfp->pool[i].pid = pid;
216 DEBUG(5, ("Added %d children!\n", j));
221 struct prefork_oldest {
226 /* sort in inverse order */
227 static int prefork_sort_oldest(const void *ap, const void *bp)
229 const struct prefork_oldest *a = (const struct prefork_oldest *)ap;
230 const struct prefork_oldest *b = (const struct prefork_oldest *)bp;
232 if (a->started == b->started) {
235 if (a->started < b->started) {
241 int prefork_retire_children(struct prefork_pool *pfp,
242 int num_children, time_t age_limit)
244 time_t now = time(NULL);
245 struct prefork_oldest *oldest;
248 oldest = talloc_array(pfp, struct prefork_oldest, pfp->pool_size);
253 for (i = 0; i < pfp->pool_size; i++) {
255 if (pfp->pool[i].status == PF_WORKER_ALIVE ||
256 pfp->pool[i].status == PF_WORKER_ACCEPTING) {
257 oldest[i].started = pfp->pool[i].started;
259 oldest[i].started = now;
263 qsort(oldest, pfp->pool_size,
264 sizeof(struct prefork_oldest),
265 prefork_sort_oldest);
267 for (i = 0, j = 0; i < pfp->pool_size && j < num_children; i++) {
268 if ((pfp->pool[i].status == PF_WORKER_ALIVE ||
269 pfp->pool[i].status == PF_WORKER_ACCEPTING) &&
270 pfp->pool[i].started <= age_limit) {
271 /* tell the child it's time to give up */
272 DEBUG(5, ("Retiring pid %d!\n", pfp->pool[i].pid));
273 pfp->pool[i].cmds = PF_SRV_MSG_EXIT;
274 kill(pfp->pool[i].pid, SIGHUP);
282 int prefork_count_active_children(struct prefork_pool *pfp, int *total)
288 for (i = 0; i < pfp->pool_size; i++) {
289 if (pfp->pool[i].status == PF_WORKER_NONE) {
295 if (pfp->pool[i].num_clients == 0) {
306 static void prefork_cleanup_loop(struct prefork_pool *pfp)
312 /* TODO: should we use a process group id wait instead of looping ? */
313 for (i = 0; i < pfp->pool_size; i++) {
314 if (pfp->pool[i].status == PF_WORKER_NONE ||
315 pfp->pool[i].pid == 0) {
319 pid = sys_waitpid(pfp->pool[i].pid, &status, WNOHANG);
322 if (pfp->pool[i].status != PF_WORKER_EXITING) {
323 DEBUG(3, ("Child (%d) terminated abnormally:"
324 " %d\n", (int)pid, status));
326 DEBUG(10, ("Child (%d) terminated with status:"
327 " %d\n", (int)pid, status));
331 * this makes status = PF_WORK_NONE */
332 memset(&pfp->pool[i], 0,
333 sizeof(struct pf_worker_data));
339 int prefork_count_allowed_connections(struct prefork_pool *pfp)
345 for (i = 0; i < pfp->pool_size; i++) {
346 if (pfp->pool[i].status == PF_WORKER_NONE) {
350 c += pfp->pool[i].allowed_clients - pfp->pool[i].num_clients;
356 void prefork_increase_allowed_clients(struct prefork_pool *pfp, int max)
360 for (i = 0; i < pfp->pool_size; i++) {
361 if (pfp->pool[i].status == PF_WORKER_NONE) {
365 if (pfp->pool[i].allowed_clients < max) {
366 pfp->pool[i].allowed_clients++;
371 void prefork_decrease_allowed_clients(struct prefork_pool *pfp)
375 for (i = 0; i < pfp->pool_size; i++) {
376 if (pfp->pool[i].status == PF_WORKER_NONE) {
380 if (pfp->pool[i].allowed_clients > 1) {
381 pfp->pool[i].allowed_clients--;
386 void prefork_reset_allowed_clients(struct prefork_pool *pfp)
390 for (i = 0; i < pfp->pool_size; i++) {
391 pfp->pool[i].allowed_clients = 1;
395 void prefork_send_signal_to_all(struct prefork_pool *pfp, int signal_num)
399 for (i = 0; i < pfp->pool_size; i++) {
400 if (pfp->pool[i].status == PF_WORKER_NONE) {
404 kill(pfp->pool[i].pid, signal_num);
408 static void prefork_sigchld_handler(struct tevent_context *ev_ctx,
409 struct tevent_signal *se,
410 int signum, int count,
411 void *siginfo, void *pvt)
413 struct prefork_pool *pfp;
415 pfp = talloc_get_type_abort(pvt, struct prefork_pool);
417 /* run the cleanup function to make sure all dead children are
418 * properly and timely retired. */
419 prefork_cleanup_loop(pfp);
421 if (pfp->sigchld_fn) {
422 pfp->sigchld_fn(ev_ctx, pfp, pfp->sigchld_data);
426 static bool prefork_setup_sigchld_handler(struct tevent_context *ev_ctx,
427 struct prefork_pool *pfp)
429 struct tevent_signal *se;
431 se = tevent_add_signal(ev_ctx, pfp, SIGCHLD, 0,
432 prefork_sigchld_handler, pfp);
434 DEBUG(0, ("Failed to setup SIGCHLD handler!\n"));
441 void prefork_set_sigchld_callback(struct prefork_pool *pfp,
442 prefork_sigchld_fn_t *sigchld_fn,
445 pfp->sigchld_fn = sigchld_fn;
446 pfp->sigchld_data = private_data;
449 /* ==== Functions used by children ==== */
451 struct pf_listen_state {
452 struct tevent_context *ev;
453 struct pf_worker_data *pf;
460 struct tsocket_address *srv_addr;
461 struct tsocket_address *cli_addr;
466 struct pf_listen_ctx {
468 struct tevent_req *req;
472 static void prefork_listen_accept_handler(struct tevent_context *ev,
473 struct tevent_fd *fde,
474 uint16_t flags, void *pvt);
476 struct tevent_req *prefork_listen_send(TALLOC_CTX *mem_ctx,
477 struct tevent_context *ev,
478 struct pf_worker_data *pf,
482 struct tevent_req *req;
483 struct pf_listen_state *state;
484 struct pf_listen_ctx *ctx;
485 struct tevent_fd *fde;
489 req = tevent_req_create(mem_ctx, &state, struct pf_listen_state);
496 state->listen_fd_size = listen_fd_size;
497 state->listen_fds = listen_fds;
498 state->accept_fd = -1;
501 fde_ctx = talloc_new(state);
502 if (tevent_req_nomem(fde_ctx, req)) {
503 return tevent_req_post(req, ev);
507 for (i = 0; i < state->listen_fd_size; i++) {
508 ctx = talloc(fde_ctx, struct pf_listen_ctx);
509 if (tevent_req_nomem(ctx, req)) {
510 return tevent_req_post(req, ev);
512 ctx->fde_ctx = fde_ctx;
514 ctx->listen_fd = state->listen_fds[i];
516 fde = tevent_add_fd(state->ev, fde_ctx,
517 ctx->listen_fd, TEVENT_FD_READ,
518 prefork_listen_accept_handler, ctx);
519 if (tevent_req_nomem(fde, req)) {
520 return tevent_req_post(req, ev);
524 pf->status = PF_WORKER_ACCEPTING;
529 static void prefork_listen_accept_handler(struct tevent_context *ev,
530 struct tevent_fd *fde,
531 uint16_t flags, void *pvt)
533 struct pf_listen_state *state;
534 struct tevent_req *req;
535 struct pf_listen_ctx *ctx;
536 struct sockaddr_storage addr;
542 ctx = talloc_get_type_abort(pvt, struct pf_listen_ctx);
544 state = tevent_req_data(ctx->req, struct pf_listen_state);
546 if (state->pf->cmds == PF_SRV_MSG_EXIT) {
547 /* We have been asked to exit, so drop here and the next
548 * child will pick it up */
549 state->pf->status = PF_WORKER_EXITING;
550 state->error = EINTR;
555 addrlen = sizeof(addr);
556 sd = accept(ctx->listen_fd, (struct sockaddr *)&addr, &addrlen);
559 DEBUG(6, ("Accept failed! (%d, %s)\n", err, strerror(err)));
562 /* do not track the listen fds anymore */
563 talloc_free(ctx->fde_ctx);
570 state->accept_fd = sd;
572 ret = tsocket_address_bsd_from_sockaddr(state,
573 (struct sockaddr *)(void *)&addr,
574 addrlen, &state->cli_addr);
576 state->error = errno;
581 addrlen = sizeof(addr);
582 ret = getsockname(sd, (struct sockaddr *)(void *)&addr, &addrlen);
584 state->error = errno;
588 ret = tsocket_address_bsd_from_sockaddr(state,
589 (struct sockaddr *)(void *)&addr,
590 addrlen, &state->srv_addr);
592 state->error = errno;
597 tevent_req_done(req);
600 int prefork_listen_recv(struct tevent_req *req,
601 TALLOC_CTX *mem_ctx, int *fd,
602 struct tsocket_address **srv_addr,
603 struct tsocket_address **cli_addr)
605 struct pf_listen_state *state;
608 state = tevent_req_data(req, struct pf_listen_state);
613 tevent_req_is_unix_error(req, &ret);
617 if (state->accept_fd != -1) {
618 close(state->accept_fd);
621 *fd = state->accept_fd;
622 *srv_addr = talloc_move(mem_ctx, &state->srv_addr);
623 *cli_addr = talloc_move(mem_ctx, &state->cli_addr);
624 state->pf->num_clients++;
626 if (state->pf->status == PF_WORKER_ACCEPTING) {
627 state->pf->status = PF_WORKER_ALIVE;
630 tevent_req_received(req);