Introducing a small upgrade to the ast_sched_xxx facility, to keep it from eating...
[asterisk/asterisk.git] / include / asterisk / sched.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Scheduler Routines (derived from cheops)
21  */
22
23 #ifndef _ASTERISK_SCHED_H
24 #define _ASTERISK_SCHED_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30
31 /*! \brief Max num of schedule structs
32  * \note The max number of schedule structs to keep around
33  * for use.  Undefine to disable schedule structure
34  * caching. (Only disable this on very low memory
35  * machines)
36  */
37 #define SCHED_MAX_CACHE 128
38
39 /*! \brief a loop construct to ensure that
40  * the scheduled task get deleted. The idea is that
41  * if we loop attempting to remove the scheduled task,
42  * then whatever callback had been running will complete
43  * and reinsert the task into the scheduler.
44  *
45  * Note that this is NOT always appropriate. This should 
46  * only be used for tasks whose callback may return non-zero 
47  * to indicate that the task needs to be rescheduled with the
48  * SAME id as previously.
49  *
50  * Some scheduler callbacks instead may reschedule the task themselves,
51  * thus removing the previous task id from the queue. If the task is rescheduled
52  * in this manner, then the id for the task will be different than before
53  * and so it makes no sense to use this macro. Note that if using the scheduler
54  * in this manner, it is perfectly acceptable for ast_sched_del to fail, and this
55  * macro should NOT be used.
56  */
57 #define AST_SCHED_DEL(sched, id) \
58         do { \
59                 int _count = 0; \
60                 while (id > -1 && ast_sched_del(sched, id) && ++_count < 10) { \
61                         usleep(1); \
62                 } \
63                 if (_count == 10) \
64                         ast_debug(3, "Unable to cancel schedule ID %d.\n", id); \
65                 id = -1; \
66         } while (0);
67
68 #define AST_SCHED_DEL_UNREF(sched, id, refcall)                 \
69         do { \
70                 int _count = 0; \
71                 while (id > -1 && ast_sched_del(sched, id) && ++_count < 10) { \
72                         usleep(1); \
73                 } \
74                 if (_count == 10) \
75                         ast_log(LOG_WARNING, "Unable to cancel schedule ID %d.  This is probably a bug (%s: %s, line %d).\n", id, __FILE__, __PRETTY_FUNCTION__, __LINE__); \
76                 if (id > -1) \
77                         refcall; \
78                 id = -1; \
79         } while (0);
80
81 #define AST_SCHED_REPLACE_VARIABLE(id, sched, when, callback, data, variable) \
82         do { \
83                 int _count = 0; \
84                 while (id > -1 && ast_sched_del(sched, id) && ++_count < 10) { \
85                         usleep(1); \
86                 } \
87                 if (_count == 10) \
88                         ast_log(LOG_WARNING, "Unable to cancel schedule ID %d.  This is probably a bug (%s: %s, line %d).\n", id, __FILE__, __PRETTY_FUNCTION__, __LINE__); \
89                 id = ast_sched_add_variable(sched, when, callback, data, variable); \
90         } while (0);
91
92 #define AST_SCHED_REPLACE(id, sched, when, callback, data) \
93                 AST_SCHED_REPLACE_VARIABLE(id, sched, when, callback, data, 0)
94
95 #define AST_SCHED_REPLACE_VARIABLE_UNREF(id, sched, when, callback, data, variable, unrefcall, addfailcall, refcall) \
96         do { \
97                 int _count = 0, _res=1;                                                                                  \
98                 void *_data = (void *)ast_sched_find_data(sched, id);                   \
99                 while (id > -1 && (_res = ast_sched_del(sched, id) && _count++ < 10)) { \
100                         usleep(1); \
101                 } \
102                 if (!_res && _data)                                                     \
103                         unrefcall;      /* should ref _data! */         \
104                 if (_count == 10) \
105                         ast_log(LOG_WARNING, "Unable to cancel schedule ID %d.  This is probably a bug (%s: %s, line %d).\n", id, __FILE__, __PRETTY_FUNCTION__, __LINE__); \
106                 id = ast_sched_add_variable(sched, when, callback, data, variable); \
107                 if (id == -1)  \
108                         addfailcall;    \
109                 else \
110                         refcall; \
111         } while (0);
112
113 #define AST_SCHED_REPLACE_UNREF(id, sched, when, callback, data, unrefcall, addfailcall, refcall) \
114         AST_SCHED_REPLACE_VARIABLE_UNREF(id, sched, when, callback, data, 0, unrefcall, addfailcall, refcall)
115
116 struct sched_context;
117
118 /*! \brief New schedule context
119  * \note Create a scheduling context
120  * \return Returns a malloc'd sched_context structure, NULL on failure
121  */
122 struct sched_context *sched_context_create(void);
123
124 /*! \brief destroys a schedule context
125  * Destroys (free's) the given sched_context structure
126  * \param c Context to free
127  * \return Returns 0 on success, -1 on failure
128  */
129 void sched_context_destroy(struct sched_context *c);
130
131 /*! \brief callback for a cheops scheduler
132  * A cheops scheduler callback takes a pointer with callback data and
133  * \return returns a 0 if it should not be run again, or non-zero if it should be
134  * rescheduled to run again
135  */
136 typedef int (*ast_sched_cb)(const void *data);
137 #define AST_SCHED_CB(a) ((ast_sched_cb)(a))
138
139 struct ast_cb_names
140 {
141         int numassocs;
142         char *list[10];
143         ast_sched_cb cblist[10];
144 };
145 char *ast_sched_report(struct sched_context *con, char *buf, int bufsiz, struct ast_cb_names *cbnames);
146                 
147 /*! \brief Adds a scheduled event
148  * Schedule an event to take place at some point in the future.  callback
149  * will be called with data as the argument, when milliseconds into the
150  * future (approximately)
151  * If callback returns 0, no further events will be re-scheduled
152  * \param con Scheduler context to add
153  * \param when how many milliseconds to wait for event to occur
154  * \param callback function to call when the amount of time expires
155  * \param data data to pass to the callback
156  * \return Returns a schedule item ID on success, -1 on failure
157  */
158 int ast_sched_add(struct sched_context *con, int when, ast_sched_cb callback, const void *data);
159
160 /*!
161  * \brief replace a scheduler entry
162  * \deprecated You should use the AST_SCHED_REPLACE() macro instead.
163  *
164  * This deletes the scheduler entry for old_id if it exists, and then
165  * calls ast_sched_add to create a new entry.  A negative old_id will
166  * be ignored.
167  *
168  * \retval -1 failure
169  * \retval otherwise, returns scheduled item ID
170  */
171 int ast_sched_replace(int old_id, struct sched_context *con, int when, ast_sched_cb callback, const void *data);
172
173 /*!Adds a scheduled event with rescheduling support
174  * \param con Scheduler context to add
175  * \param when how many milliseconds to wait for event to occur
176  * \param callback function to call when the amount of time expires
177  * \param data data to pass to the callback
178  * \param variable If true, the result value of callback function will be
179  *       used for rescheduling
180  * Schedule an event to take place at some point in the future.  Callback
181  * will be called with data as the argument, when milliseconds into the
182  * future (approximately)
183  * If callback returns 0, no further events will be re-scheduled
184  * \return Returns a schedule item ID on success, -1 on failure
185  */
186 int ast_sched_add_variable(struct sched_context *con, int when, ast_sched_cb callback, const void *data, int variable);
187
188 /*!
189  * \brief replace a scheduler entry
190  * \deprecated You should use the AST_SCHED_REPLACE_VARIABLE() macro instead.
191  *
192  * This deletes the scheduler entry for old_id if it exists, and then
193  * calls ast_sched_add to create a new entry.  A negative old_id will
194  * be ignored.
195  *
196  * \retval -1 failure
197  * \retval otherwise, returns scheduled item ID
198  */
199 int ast_sched_replace_variable(int old_id, struct sched_context *con, int when, ast_sched_cb callback, const void *data, int variable);
200
201         
202 /*! \brief Find a sched structure and return the data field associated with it. 
203  * \param con scheduling context in which to search fro the matching id
204  * \param id ID of the scheduled item to find
205  * \return the data field from the matching sched struct if found; else return NULL if not found.
206  */
207
208 const void *ast_sched_find_data(struct sched_context *con, int id);
209         
210 /*! \brief Deletes a scheduled event
211  * Remove this event from being run.  A procedure should not remove its own
212  * event, but return 0 instead.  In most cases, you should not call this
213  * routine directly, but use the AST_SCHED_DEL() macro instead (especially if
214  * you don't intend to do something different when it returns failure).
215  * \param con scheduling context to delete item from
216  * \param id ID of the scheduled item to delete
217  * \return Returns 0 on success, -1 on failure
218  */
219
220 int ast_sched_del(struct sched_context *con, int id);
221
222 /*! \brief Determines number of seconds until the next outstanding event to take place
223  * Determine the number of seconds until the next outstanding event
224  * should take place, and return the number of milliseconds until
225  * it needs to be run.  This value is perfect for passing to the poll
226  * call.
227  * \param con context to act upon
228  * \return Returns "-1" if there is nothing there are no scheduled events
229  * (and thus the poll should not timeout)
230  */
231 int ast_sched_wait(struct sched_context *con);
232
233 /*! \brief Runs the queue
234  * \param con Scheduling context to run
235  * Run the queue, executing all callbacks which need to be performed
236  * at this time.
237  * \param con context to act upon
238  * \return Returns the number of events processed.
239  */
240 int ast_sched_runq(struct sched_context *con);
241
242 /*! \brief Dumps the scheduler contents
243  * Debugging: Dump the contents of the scheduler to stderr
244  * \param con Context to dump
245  */
246 void ast_sched_dump(const struct sched_context *con);
247
248 /*! \brief Returns the number of seconds before an event takes place
249  * \param con Context to use
250  * \param id Id to dump
251  */
252 long ast_sched_when(struct sched_context *con,int id);
253
254 /*!
255  * \brief Convenience macro for objects and reference (add)
256  *
257  */
258 #define ast_sched_add_object(obj,con,when,callback) ast_sched_add((con),(when),(callback), ASTOBJ_REF((obj)))
259
260 /*!
261  * \brief Convenience macro for objects and reference (del)
262  *
263  */
264 #define ast_sched_del_object(obj,destructor,con,id) do { \
265         if ((id) > -1) { \
266                 ast_sched_del((con),(id)); \
267                 (id) = -1; \
268                 ASTOBJ_UNREF((obj),(destructor)); \
269         } \
270 } while(0)
271
272 #if defined(__cplusplus) || defined(c_plusplus)
273 }
274 #endif
275
276 #endif /* _ASTERISK_SCHED_H */