Core Update of doxygen, removal of history, changing "ser" to "kamailio"
[sip-router] / pt.h
1 /*
2  * Process Table
3  *
4  * Copyright (C) 2001-2003 FhG Fokus
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 /** Kamailio core :: internal fork functions and process table.
19  * @file: pt.h
20  * @ingroup core
21  */
22
23 #ifndef _PT_H
24 #define _PT_H
25
26 #include <sys/types.h>
27 #include <unistd.h>
28 #include <stdlib.h>
29
30 #include "globals.h"
31 #include "timer.h"
32 #include "socket_info.h"
33 #include "locking.h"
34
35 #define MAX_PT_DESC                     128
36
37 struct process_table {
38         int pid;
39 #ifdef USE_TCP
40         int unix_sock;  /* unix socket on which tcp main listens        */
41         int idx;                /* tcp child index, -1 for other processes      */
42 #endif
43         char desc[MAX_PT_DESC];
44 };
45
46 extern struct process_table *pt;
47 extern gen_lock_t* process_lock;
48 extern int *process_count;
49 extern int process_no;
50
51 extern struct tcp_child* tcp_children;
52
53 int init_pt(int proc_no);
54 int get_max_procs(void);
55 int register_procs(int no);
56 int get_max_open_fds(void);
57 int register_fds(int no);
58
59
60 int close_extra_socks(int proc_id, int proc_no);
61
62 #define get_proc_no() ((process_count)?*process_count:0)
63
64 /* return processes pid */
65 int my_pid(void);
66
67 /**
68  * Forks a new process.
69  * @param desc - text description for the process table
70  * @param make_sock - if to create a unix socket pair for it
71  * @returns the pid of the new process
72  */
73 int fork_process(int child_id,char *desc,int make_sock);
74
75 /**
76  * Forks a new TCP process.
77  * @param desc - text description for the process table
78  * @param r - index in the tcp_children array
79  * @param *reader_fd_1 - pointer to return the reader_fd[1]
80  * @returns the pid of the new process
81  */
82 #ifdef USE_TCP
83 int fork_tcp_process(int child_id,char *desc,int r,int *reader_fd_1);
84 #endif
85
86 #ifdef PKG_MALLOC
87 void mem_dump_pkg_cb(str *gname, str *name);
88 #endif
89
90 #ifdef SHM_MEM
91 int mem_dump_shm_fixup(void *handle, str *gname, str *name, void **val);
92 #endif
93
94 unsigned int set_fork_delay(unsigned int v);
95
96 #endif