s3-prefork: implement prefork framework
[idra/samba.git] / source3 / lib / server_prefork.h
1 /*
2    Unix SMB/CIFS implementation.
3    Common server globals
4
5    Copyright (C) Simo Sorce <idra@samba.org> 2011
6
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.
11
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.
16
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/>.
19 */
20
21 #include "system/network.h"
22 #include <tevent.h>
23
24 enum pf_worker_status {
25         PF_WORKER_NONE = 0,
26         PF_WORKER_IDLE,
27         PF_WORKER_ACCEPTING,
28         PF_WORKER_BUSY,
29         PF_WORKER_EXITING
30 };
31
32 enum pf_server_cmds {
33         PF_SRV_MSG_NONE = 0,
34         PF_SRV_MSG_EXIT
35 };
36
37 struct pf_worker_data {
38         pid_t pid;
39         enum pf_worker_status status;
40         enum pf_server_cmds cmds;
41         time_t started;
42         time_t last_used;
43         int num_clients;
44 };
45
46 typedef int (prefork_main_fn_t)(struct tevent_context *ev,
47                                 struct pf_worker_data *pf,
48                                 int listen_fd,
49                                 int lock_fd,
50                                 void *private_data);
51
52 struct prefork_pool;
53
54
55 /* ==== Functions used by controlling process ==== */
56
57 bool prefork_create_pool(struct tevent_context *ev_ctx,
58                          TALLOC_CTX *mem_ctx, int listen_fd,
59                          int min_children, int max_children,
60                          prefork_main_fn_t *main_fn, void *private_data,
61                          struct prefork_pool **pf_pool);
62
63 int prefork_add_children(struct tevent_context *ev_ctx,
64                          struct prefork_pool *pfp,
65                          int num_children);
66 int prefork_retire_children(struct prefork_pool *pfp,
67                             int num_children, time_t age_limit);
68 int prefork_count_active_children(struct prefork_pool *pfp, int *total);
69 bool prefork_mark_pid_dead(struct prefork_pool *pfp, pid_t pid);
70
71 /* ==== Functions used by children ==== */
72
73 int prefork_wait_for_client(struct pf_worker_data *pf,
74                             int lock_fd, int listen_fd,
75                             struct sockaddr *addr,
76                             socklen_t *addrlen, int *fd);