source4/samba/service.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    SERVER SERVICE code
   5
   6    Copyright (C) Andrew Tridgell 2003-2005
   7    Copyright (C) Stefan (metze) Metzmacher      2004
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef __SERVICE_H__
  24 #define __SERVICE_H__
  25
  26
  27 #include "samba/service_stream.h"
  28 #include "samba/service_task.h"
  29
  30 struct process_details {
  31         unsigned int instances;
  32 };
  33
  34 static const struct process_details initial_process_details = {
  35         .instances = 0
  36 };
  37
  38 struct service_details {
  39         /*
  40          * Prevent the standard process model from forking a new worker
  41          * process when accepting a new connection.  Do this when the service
  42          * relies on shared state, or the over-head of forking would be a
  43          * significant part of the response time
  44          */
  45         bool inhibit_fork_on_accept;
  46         /*
  47          * Prevent the pre-fork process model from pre-forking any worker
  48          * processes. In this mode pre-fork is equivalent to standard with
  49          * inhibit_fork_on_accept set.
  50          */
  51         bool inhibit_pre_fork;
  52         /*
  53          * Initialise the server task.
  54          */
  55         NTSTATUS (*task_init) (struct task_server *);
  56         /*
  57          * post fork processing this is called:
  58          *   - standard process model
  59          *      immediately after the task_init.
  60          *
  61          *   - single process model
  62          *     immediately after the task_init
  63          *
  64          *   - prefork process model, inhibit_pre_fork = true
  65          *     immediately after the task_init
  66          *
  67          *   - prefork process model, inhibit_pre_fork = false
  68          *     after each service worker has forked. It is not run on the
  69          *      service master process.
  70          *
  71          *   The post fork hook is not called in the standard model if a new
  72          *   process is forked on a new connection. It is instead called
  73          *   immediately after the task_init.
  74          */
  75         void (*post_fork) (struct task_server *, struct process_details *);
  76         /*
  77          * This is called before entering the tevent_loop_wait():
  78          *
  79          * Note that task_server->msg_ctx, task_server->event_ctx
  80          * and maybe other fields might have changed compared to
  81          * task_init()/post_fork(). The struct task_server pointer
  82          * may also change!
  83          *
  84          * before loop processing this is called in this order:
  85          *   - standard process model
  86          *     task_init() -> post_fork() -> before_loop()
  87          *
  88          *   - single process model
  89          *     task_init() -> post_fork() -> before_loop()
  90          *
  91          *   - prefork process model, inhibit_pre_fork = true
  92          *     task_init() -> post_fork() -> before_loop()
  93          *
  94          *   - prefork process model, inhibit_pre_fork = false
  95          *     In the service master process:
  96          *      task_init(master) -> before_loop(master)
  97          *
  98          *     After each service worker has forked:
  99          *      post_fork(worker) -> before_loop(worker)
 100          *
 101          * This gives the service a chance to register messaging
 102          * and/or event handlers on the correct contexts.
 103          */
 104         void (*before_loop) (struct task_server *);
 105 };
 106
 107 NTSTATUS samba_service_init(void);
 108
 109 #include "samba/service_proto.h"
 110
 111 #endif /* __SERVICE_H__ */