core: fix another bunch of 'no real prototype' warnings, add doxygen docs
[sip-router] / timer_proc.c
1 /* 
2  * $Id$
3  * 
4  * Copyright (C) 2009 iptelorg GmbH
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 /*
19  * timer_proc.c  - separate process timers
20  * (unrelated to the main fast and slow timers)
21  */
22 /*
23  * History:
24  * --------
25  *  2009-03-10  initial version (andrei)
26 */
27
28 /**
29  * @file
30  * @brief SIP-router core ::  timer - separate process timers
31  *
32  *  (unrelated to the main fast and slow timers)
33  *
34  * @ingroup core
35  * Module: @ref core
36  */
37
38 #include "timer_proc.h"
39 #include "cfg/cfg_struct.h"
40 #include "pt.h"
41 #include "mem/shm_mem.h"
42
43 #include <unistd.h>
44
45
46 /** update internal counters for running new dummy timers
47  *  @param timers - number of dummy timer processes
48  *  @return - 0 on success; -1 on error
49  */
50 int register_dummy_timers(int timers)
51 {
52         if(register_procs(timers)<0)
53                 return -1;
54         cfg_register_child(timers);
55         return 0;
56 }
57
58 /** forks a separate simple sleep() periodic timer.
59   * Forks a very basic periodic timer process, that just sleep()s for 
60   * the specified interval and then calls the timer function.
61   * The new "dummy timer" process execution start immediately, the sleep()
62   * is called first (so the first call to the timer function will happen
63   * <interval> seconds after the call to fork_dummy_timer)
64   * @param child_id - @see fork_process()
65   * @param desc     - @see fork_process()
66   * @param make_sock - @see fork_process()
67   * @param f         - timer function/callback
68   * @param param     - parameter passed to the timer function
69   * @param interval  - interval in seconds.
70   * @return - pid of the new process on success, -1 on error
71   *           (doesn't return anything in the child process)
72   */
73 int fork_dummy_timer(int child_id, char* desc, int make_sock,
74                                                 timer_function* f, void* param, int interval)
75 {
76         int pid;
77         
78         pid=fork_process(child_id, desc, make_sock);
79         if (pid<0) return -1;
80         if (pid==0){
81                 /* child */
82                 if (cfg_child_init()) return -1;
83                 for(;;){
84                         sleep(interval);
85                         cfg_update();
86                         f(get_ticks(), param); /* ticks in s for compatibility with old
87                                                                           timers */
88                 }
89         }
90         /* parent */
91         return pid;
92 }
93
94
95
96 /** forks a timer process based on the local timer.
97  *  Forks a separate timer process running a local_timer.h type of timer
98  *  A pointer to the local_timer handle (allocated in shared memory) is
99  *  returned in lt_h. It can be used to add/delete more timers at runtime
100  *  (via local_timer_add()/local_timer_del() a.s.o).
101  *  If timers are added from separate processes, some form of locking must be
102  *  used (all the calls to local_timer* must be enclosed by locks if it
103  *  cannot be guaranteed that they cannot execute in the same time)
104  *  The timer "engine" must be run manually from the child process. For
105  *  example a very simple local timer process that just runs a single 
106  *  periodic timer can be started in the following way:
107  *      struct local_timer* lt_h;
108  *
109  *      pid=fork_local_timer_process(...., &lt_h);
110  *      if (pid==0){
111  *          timer_init(&my_timer, my_timer_f, 0, 0);
112  *          local_timer_add(&lt_h, &my_timer, S_TO_TICKS(10), get_ticks_raw());
113  *          while(1) { sleep(1); local_timer_run(lt, get_ticks_raw()); }
114  *      }
115  *
116  * @param child_id - @see fork_process()
117  * @param desc     - @see fork_process()
118  * @param make_sock - @see fork_process()
119  * @param lt_h      - local_timer handler
120  * @return - pid to the parent, 0 to the child, -1 if error.
121  */
122 int fork_local_timer_process(int child_id, char* desc, int make_sock,
123                                                 struct local_timer** lt_h)
124 {
125         int pid;
126         struct local_timer* lt;
127         
128         lt=shm_malloc(sizeof(*lt));
129         if (lt==0) goto error;
130         if (init_local_timer(lt, get_ticks_raw())<0) goto error;
131         pid=fork_process(child_id, desc, make_sock);
132         if (pid<0) goto error;
133         *lt_h=lt;
134         return pid;
135 error:
136         if (lt) shm_free(lt);
137         return -1;
138 }
139
140
141 /* vi: set ts=4 sw=4 tw=79:ai:cindent: */