Fix a number of problems with ast_sched_report().
[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  * Since macro expansion essentially works like pass-by-name
46  * parameter passing, this macro will still work correctly even
47  * if the id of the task to delete changes. This holds as long as 
48  * the name of the id which could change is passed to the macro 
49  * and not a copy of the value of the id.
50  */
51 #define AST_SCHED_DEL(sched, id) \
52         ({ \
53                 int _count = 0; \
54                 int _sched_res = -1; \
55                 while (id > -1 && (_sched_res = ast_sched_del(sched, id)) && ++_count < 10) \
56                         usleep(1); \
57                 if (_count == 10 && option_debug > 2) { \
58                         ast_log(LOG_DEBUG, "Unable to cancel schedule ID %d.\n", id); \
59                 } \
60                 id = -1; \
61                 (_sched_res); \
62         })
63
64 #define AST_SCHED_DEL_UNREF(sched, id, refcall)                 \
65         do { \
66                 int _count = 0; \
67                 while (id > -1 && ast_sched_del(sched, id) && ++_count < 10) { \
68                         usleep(1); \
69                 } \
70                 if (_count == 10) \
71                         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__); \
72                 if (id > -1) \
73                         refcall; \
74                 id = -1; \
75         } while (0);
76
77 #define AST_SCHED_DEL_SPINLOCK(sched, id, lock) \
78         ({ \
79                 int _count = 0; \
80                 int _sched_res = -1; \
81                 while (id > -1 && (_sched_res = ast_sched_del(sched, id)) && ++_count < 10) { \
82                         ast_mutex_unlock(lock); \
83                         usleep(1); \
84                         ast_mutex_lock(lock); \
85                 } \
86                 if (_count == 10 && option_debug > 2) { \
87                         ast_log(LOG_DEBUG, "Unable to cancel schedule ID %d.\n", id); \
88                 } \
89                 id = -1; \
90                 (_sched_res); \
91         })
92
93 #define AST_SCHED_REPLACE_VARIABLE(id, sched, when, callback, data, variable) \
94         do { \
95                 int _count = 0; \
96                 while (id > -1 && ast_sched_del(sched, id) && ++_count < 10) { \
97                         usleep(1); \
98                 } \
99                 if (_count == 10) \
100                         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__); \
101                 id = ast_sched_add_variable(sched, when, callback, data, variable); \
102         } while (0);
103
104 #define AST_SCHED_REPLACE(id, sched, when, callback, data) \
105                 AST_SCHED_REPLACE_VARIABLE(id, sched, when, callback, data, 0)
106
107 #define AST_SCHED_REPLACE_VARIABLE_UNREF(id, sched, when, callback, data, variable, unrefcall, addfailcall, refcall) \
108         do { \
109                 int _count = 0, _res=1;                                                                                  \
110                 void *_data = (void *)ast_sched_find_data(sched, id);                   \
111                 while (id > -1 && (_res = ast_sched_del(sched, id) && _count++ < 10)) { \
112                         usleep(1); \
113                 } \
114                 if (!_res && _data)                                                     \
115                         unrefcall;      /* should ref _data! */         \
116                 if (_count == 10) \
117                         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__); \
118                 refcall; \
119                 id = ast_sched_add_variable(sched, when, callback, data, variable); \
120                 if (id == -1)  \
121                         addfailcall;    \
122         } while (0);
123
124 #define AST_SCHED_REPLACE_UNREF(id, sched, when, callback, data, unrefcall, addfailcall, refcall) \
125         AST_SCHED_REPLACE_VARIABLE_UNREF(id, sched, when, callback, data, 0, unrefcall, addfailcall, refcall)
126
127 struct sched_context;
128
129 /*! \brief New schedule context
130  * \note Create a scheduling context
131  * \return Returns a malloc'd sched_context structure, NULL on failure
132  */
133 struct sched_context *sched_context_create(void);
134
135 /*! \brief destroys a schedule context
136  * Destroys (free's) the given sched_context structure
137  * \param c Context to free
138  * \return Returns 0 on success, -1 on failure
139  */
140 void sched_context_destroy(struct sched_context *c);
141
142 /*! \brief callback for a cheops scheduler
143  * A cheops scheduler callback takes a pointer with callback data and
144  * \return returns a 0 if it should not be run again, or non-zero if it should be
145  * rescheduled to run again
146  */
147 typedef int (*ast_sched_cb)(const void *data);
148 #define AST_SCHED_CB(a) ((ast_sched_cb)(a))
149
150 struct ast_cb_names {
151         int numassocs;
152         char *list[10];
153         ast_sched_cb cblist[10];
154 };
155 void ast_sched_report(struct sched_context *con, struct ast_str **buf, struct ast_cb_names *cbnames);
156                 
157 /*! \brief Adds a scheduled event
158  * Schedule an event to take place at some point in the future.  callback
159  * will be called with data as the argument, when milliseconds into the
160  * future (approximately)
161  * If callback returns 0, no further events will be re-scheduled
162  * \param con Scheduler context to add
163  * \param when how many milliseconds to wait for event to occur
164  * \param callback function to call when the amount of time expires
165  * \param data data to pass to the callback
166  * \return Returns a schedule item ID on success, -1 on failure
167  */
168 int ast_sched_add(struct sched_context *con, int when, ast_sched_cb callback, const void *data) attribute_warn_unused_result;
169
170 /*!
171  * \brief replace a scheduler entry
172  * \deprecated You should use the AST_SCHED_REPLACE() macro instead.
173  *
174  * This deletes the scheduler entry for old_id if it exists, and then
175  * calls ast_sched_add to create a new entry.  A negative old_id will
176  * be ignored.
177  *
178  * \retval -1 failure
179  * \retval otherwise, returns scheduled item ID
180  */
181 int ast_sched_replace(int old_id, struct sched_context *con, int when, ast_sched_cb callback, const void *data) attribute_warn_unused_result;
182
183 /*!Adds a scheduled event with rescheduling support
184  * \param con Scheduler context to add
185  * \param when how many milliseconds to wait for event to occur
186  * \param callback function to call when the amount of time expires
187  * \param data data to pass to the callback
188  * \param variable If true, the result value of callback function will be
189  *       used for rescheduling
190  * Schedule an event to take place at some point in the future.  Callback
191  * will be called with data as the argument, when milliseconds into the
192  * future (approximately)
193  * If callback returns 0, no further events will be re-scheduled
194  * \return Returns a schedule item ID on success, -1 on failure
195  */
196 int ast_sched_add_variable(struct sched_context *con, int when, ast_sched_cb callback, const void *data, int variable) attribute_warn_unused_result;
197
198 /*!
199  * \brief replace a scheduler entry
200  * \deprecated You should use the AST_SCHED_REPLACE_VARIABLE() macro instead.
201  *
202  * This deletes the scheduler entry for old_id if it exists, and then
203  * calls ast_sched_add to create a new entry.  A negative old_id will
204  * be ignored.
205  *
206  * \retval -1 failure
207  * \retval otherwise, returns scheduled item ID
208  */
209 int ast_sched_replace_variable(int old_id, struct sched_context *con, int when, ast_sched_cb callback, const void *data, int variable) attribute_warn_unused_result;
210
211         
212 /*! \brief Find a sched structure and return the data field associated with it. 
213  * \param con scheduling context in which to search fro the matching id
214  * \param id ID of the scheduled item to find
215  * \return the data field from the matching sched struct if found; else return NULL if not found.
216  */
217
218 const void *ast_sched_find_data(struct sched_context *con, int id);
219         
220 /*! \brief Deletes a scheduled event
221  * Remove this event from being run.  A procedure should not remove its own
222  * event, but return 0 instead.  In most cases, you should not call this
223  * routine directly, but use the AST_SCHED_DEL() macro instead (especially if
224  * you don't intend to do something different when it returns failure).
225  * \param con scheduling context to delete item from
226  * \param id ID of the scheduled item to delete
227  * \return Returns 0 on success, -1 on failure
228  */
229 #ifndef AST_DEVMODE
230 int ast_sched_del(struct sched_context *con, int id) attribute_warn_unused_result;
231 #else
232 int _ast_sched_del(struct sched_context *con, int id, const char *file, int line, const char *function) attribute_warn_unused_result;
233 #define ast_sched_del(a, b)     _ast_sched_del(a, b, __FILE__, __LINE__, __PRETTY_FUNCTION__)
234 #endif
235
236 /*! \brief Determines number of seconds until the next outstanding event to take place
237  * Determine the number of seconds until the next outstanding event
238  * should take place, and return the number of milliseconds until
239  * it needs to be run.  This value is perfect for passing to the poll
240  * call.
241  * \param con context to act upon
242  * \return Returns "-1" if there is nothing there are no scheduled events
243  * (and thus the poll should not timeout)
244  */
245 int ast_sched_wait(struct sched_context *con) attribute_warn_unused_result;
246
247 /*! \brief Runs the queue
248  * \param con Scheduling context to run
249  * Run the queue, executing all callbacks which need to be performed
250  * at this time.
251  * \param con context to act upon
252  * \return Returns the number of events processed.
253  */
254 int ast_sched_runq(struct sched_context *con);
255
256 /*! \brief Dumps the scheduler contents
257  * Debugging: Dump the contents of the scheduler to stderr
258  * \param con Context to dump
259  */
260 void ast_sched_dump(const struct sched_context *con);
261
262 /*! \brief Returns the number of seconds before an event takes place
263  * \param con Context to use
264  * \param id Id to dump
265  */
266 long ast_sched_when(struct sched_context *con,int id);
267
268 /*!
269  * \brief Convenience macro for objects and reference (add)
270  *
271  */
272 #define ast_sched_add_object(obj,con,when,callback) ast_sched_add((con),(when),(callback), ASTOBJ_REF((obj)))
273
274 /*!
275  * \brief Convenience macro for objects and reference (del)
276  *
277  */
278 #define ast_sched_del_object(obj,destructor,con,id) do { \
279         if ((id) > -1) { \
280                 ast_sched_del((con),(id)); \
281                 (id) = -1; \
282                 ASTOBJ_UNREF((obj),(destructor)); \
283         } \
284 } while(0)
285
286 /*!
287  * \brief An opaque type representing a scheduler thread
288  *
289  * The purpose of the ast_sched_thread API is to provide a common implementation
290  * of the case where a module wants to have a dedicated thread for handling the
291  * scheduler.
292  */
293 struct ast_sched_thread;
294
295 /*!
296  * \brief Create a scheduler with a dedicated thread
297  *
298  * This function should be used to allocate a scheduler context and a dedicated
299  * thread for processing scheduler entries.  The thread is started immediately.
300  *
301  * \retval NULL error
302  * \retval non-NULL a handle to the scheduler and its dedicated thread.
303  */
304 struct ast_sched_thread *ast_sched_thread_create(void);
305
306 /*!
307  * \brief Destroy a scheduler and its thread
308  *
309  * This function is used to destroy a scheduler context and the dedicated thread
310  * that was created for handling scheduler entries.  Any entries in the scheduler
311  * that have not yet been processed will be thrown away.  Once this function is
312  * called, the handle must not be used again.
313  *
314  * \param st the handle to the scheduler and thread
315  *
316  * \return NULL for convenience
317  */
318 struct ast_sched_thread *ast_sched_thread_destroy(struct ast_sched_thread *st);
319
320 /*!
321  * \brief Add a scheduler entry
322  *
323  * \param st the handle to the scheduler and thread
324  * \param when the number of ms in the future to run the task.  A value <= 0
325  *        is treated as "run now".
326  * \param cb the function to call when the scheduled time arrives
327  * \param data the parameter to pass to the scheduler callback
328  *
329  * \retval 0 success
330  * \retval non-zero failure
331  */
332 int ast_sched_thread_add(struct ast_sched_thread *st, int when, ast_sched_cb cb,
333                 const void *data);
334
335 /*!
336  * \brief Add a variable reschedule time scheduler entry
337  *
338  * \param st the handle to the scheduler and thread
339  * \param when the number of ms in the future to run the task.  A value <= 0
340  *        is treated as "run now".
341  * \param cb the function to call when the scheduled time arrives
342  * \param data the parameter to pass to the scheduler callback
343  * \param variable If this value is non-zero, then the scheduler will use the return
344  *        value of the scheduler as the amount of time in the future to run the
345  *        task again.  Normally, a return value of 0 means do not re-schedule, and
346  *        non-zero means re-schedule using the time provided when the scheduler
347  *        entry was first created.
348  *
349  * \retval 0 success
350  * \retval non-zero failure
351  */
352 int ast_sched_thread_add_variable(struct ast_sched_thread *st, int when, ast_sched_cb cb,
353                 const void *data, int variable);
354
355 /*!
356  * \brief Get the scheduler context for a given ast_sched_thread
357  *
358  * This function should be used only when direct access to the scheduler context
359  * is required.  Its use is discouraged unless necessary.  The cases where 
360  * this is currently required is when you want to take advantage of one of the 
361  * AST_SCHED macros.
362  *
363  * \param st the handle to the scheduler and thread
364  *
365  * \return the sched_context associated with an ast_sched_thread
366  */
367 struct sched_context *ast_sched_thread_get_context(struct ast_sched_thread *st);
368
369 /*!
370  * \brief Delete a scheduler entry
371  *
372  * This uses the AST_SCHED_DEL macro internally.
373  *
374  * \param st the handle to the scheduler and thread
375  * \param id scheduler entry id to delete
376  *
377  * \retval 0 success
378  * \retval non-zero failure
379  */
380 #define ast_sched_thread_del(st, id) ({ \
381         struct sched_context *__tmp_context = ast_sched_thread_get_context(st); \
382         AST_SCHED_DEL(__tmp_context, id); \
383 })
384
385 /*!
386  * \brief Force re-processing of the scheduler context
387  *
388  * \param st the handle to the scheduler and thread
389  *
390  * \return nothing
391  */
392 void ast_sched_thread_poke(struct ast_sched_thread *st);
393
394 #if defined(__cplusplus) || defined(c_plusplus)
395 }
396 #endif
397
398 #endif /* _ASTERISK_SCHED_H */