taskprocessor.c: New API for human friendly taskprocessor names.
[asterisk/asterisk.git] / include / asterisk / taskprocessor.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007-2013, Digium, Inc.
5  *
6  * Dwayne M. Hubbard <dhubbard@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 /*!
20  * \file taskprocessor.h
21  * \brief An API for managing task processing threads that can be shared across modules
22  *
23  * \author Dwayne M. Hubbard <dhubbard@digium.com>
24  *
25  * \note A taskprocessor is a named object containing a task queue that
26  * serializes tasks pushed into it by [a] module(s) that reference the taskprocessor.
27  * A taskprocessor is created the first time its name is requested via the
28  * ast_taskprocessor_get() function or the ast_taskprocessor_create_with_listener()
29  * function and destroyed when the taskprocessor reference count reaches zero. A
30  * taskprocessor also contains an accompanying listener that is notified when changes
31  * in the task queue occur.
32  *
33  * A task is a wrapper around a task-handling function pointer and a data
34  * pointer.  A task is pushed into a taskprocessor queue using the
35  * ast_taskprocessor_push(taskprocessor, taskhandler, taskdata) function and freed by the
36  * taskprocessor after the task handling function returns.  A module releases its
37  * reference to a taskprocessor using the ast_taskprocessor_unreference() function which
38  * may result in the destruction of the taskprocessor if the taskprocessor's reference
39  * count reaches zero. When the taskprocessor's reference count reaches zero, its
40  * listener's shutdown() callback will be called. Any further attempts to execute tasks
41  * will be denied.
42  *
43  * The taskprocessor listener has the flexibility of doling out tasks to best fit the
44  * module's needs. For instance, a taskprocessor listener may have a single dispatch
45  * thread that handles all tasks, or it may dispatch tasks to a thread pool.
46  *
47  * There is a default taskprocessor listener that will be used if a taskprocessor is
48  * created without any explicit listener. This default listener runs tasks sequentially
49  * in a single thread. The listener will execute tasks as long as there are tasks to be
50  * processed. When the taskprocessor is shut down, the default listener will stop
51  * processing tasks and join its execution thread.
52  */
53
54 #ifndef __AST_TASKPROCESSOR_H__
55 #define __AST_TASKPROCESSOR_H__
56
57 struct ast_taskprocessor;
58
59 /*! \brief Suggested maximum taskprocessor name length (less null terminator). */
60 #define AST_TASKPROCESSOR_MAX_NAME      45
61
62 #define AST_TASKPROCESSOR_HIGH_WATER_LEVEL 500
63
64 /*!
65  * \brief ast_tps_options for specification of taskprocessor options
66  *
67  * Specify whether a taskprocessor should be created via ast_taskprocessor_get() if the taskprocessor
68  * does not already exist.  The default behavior is to create a taskprocessor if it does not already exist
69  * and provide its reference to the calling function.  To only return a reference to a taskprocessor if
70  * and only if it exists, use the TPS_REF_IF_EXISTS option in ast_taskprocessor_get().
71  */
72 enum ast_tps_options {
73         /*! \brief return a reference to a taskprocessor, create one if it does not exist */
74         TPS_REF_DEFAULT = 0,
75         /*! \brief return a reference to a taskprocessor ONLY if it already exists */
76         TPS_REF_IF_EXISTS = (1 << 0),
77 };
78
79 struct ast_taskprocessor_listener;
80
81 struct ast_taskprocessor_listener_callbacks {
82         /*!
83          * \brief The taskprocessor has started completely
84          *
85          * This indicates that the taskprocessor is fully set up and the listener
86          * can now start interacting with it.
87          *
88          * \param listener The listener to start
89          */
90         int (*start)(struct ast_taskprocessor_listener *listener);
91         /*!
92          * \brief Indicates a task was pushed to the processor
93          *
94          * \param listener The listener
95          * \param was_empty If non-zero, the taskprocessor was empty prior to the task being pushed
96          */
97         void (*task_pushed)(struct ast_taskprocessor_listener *listener, int was_empty);
98         /*!
99          * \brief Indicates the task processor has become empty
100          *
101          * \param listener The listener
102          */
103         void (*emptied)(struct ast_taskprocessor_listener *listener);
104         /*!
105          * \brief Indicates the taskprocessor wishes to die.
106          *
107          * All operations on the task processor must to be stopped in
108          * this callback. This is an opportune time to free the listener's
109          * user data if it is not going to be used anywhere else.
110          *
111          * After this callback returns, it is NOT safe to operate on the
112          * listener's reference to the taskprocessor.
113          *
114          * \param listener The listener
115          */
116         void (*shutdown)(struct ast_taskprocessor_listener *listener);
117         void (*dtor)(struct ast_taskprocessor_listener *listener);
118 };
119
120 /*!
121  * \brief Get a reference to the listener's taskprocessor
122  *
123  * This will return the taskprocessor with its reference count increased. Release
124  * the reference to this object by using ast_taskprocessor_unreference()
125  *
126  * \param listener The listener that has the taskprocessor
127  * \return The taskprocessor
128  */
129 struct ast_taskprocessor *ast_taskprocessor_listener_get_tps(const struct ast_taskprocessor_listener *listener);
130
131 /*!
132  * \brief Get the user data from the listener
133  * \param listener The taskprocessor listener
134  * \return The listener's user data
135  */
136 void *ast_taskprocessor_listener_get_user_data(const struct ast_taskprocessor_listener *listener);
137
138 /*!
139  * \brief Allocate a taskprocessor listener
140  *
141  * \since 12.0.0
142  *
143  * This will result in the listener being allocated with the specified
144  * callbacks.
145  *
146  * \param callbacks The callbacks to assign to the listener
147  * \param user_data The user data for the listener
148  * \retval NULL Failure
149  * \retval non-NULL The newly allocated taskprocessor listener
150  */
151 struct ast_taskprocessor_listener *ast_taskprocessor_listener_alloc(const struct ast_taskprocessor_listener_callbacks *callbacks, void *user_data);
152
153 /*!
154  * \brief Get a reference to a taskprocessor with the specified name and create the taskprocessor if necessary
155  *
156  * The default behavior of instantiating a taskprocessor if one does not already exist can be
157  * disabled by specifying the TPS_REF_IF_EXISTS ast_tps_options as the second argument to ast_taskprocessor_get().
158  * \param name The name of the taskprocessor
159  * \param create Use 0 by default or specify TPS_REF_IF_EXISTS to return NULL if the taskprocessor does
160  * not already exist
161  * return A pointer to a reference counted taskprocessor under normal conditions, or NULL if the
162  * TPS_REF_IF_EXISTS reference type is specified and the taskprocessor does not exist
163  * \since 1.6.1
164  */
165 struct ast_taskprocessor *ast_taskprocessor_get(const char *name, enum ast_tps_options create);
166
167 /*!
168  * \brief Create a taskprocessor with a custom listener
169  *
170  * \since 12.0.0
171  *
172  * Note that when a taskprocessor is created in this way, it does not create
173  * any threads to execute the tasks. This job is left up to the listener.
174  * The listener's start() callback will be called during this function.
175  *
176  * \param name The name of the taskprocessor to create
177  * \param listener The listener for operations on this taskprocessor
178  * \retval NULL Failure
179  * \reval non-NULL success
180  */
181 struct ast_taskprocessor *ast_taskprocessor_create_with_listener(const char *name, struct ast_taskprocessor_listener *listener);
182
183 /*!
184  * \brief Sets the local data associated with a taskprocessor.
185  *
186  * \since 12.0.0
187  *
188  * See ast_taskprocessor_push_local().
189  *
190  * \param tps Task processor.
191  * \param local_data Local data to associate with \a tps.
192  */
193 void ast_taskprocessor_set_local(struct ast_taskprocessor *tps, void *local_data);
194
195 /*!
196  * \brief Unreference the specified taskprocessor and its reference count will decrement.
197  *
198  * Taskprocessors use astobj2 and will unlink from the taskprocessor singleton container and destroy
199  * themself when the taskprocessor reference count reaches zero.
200  * \param tps taskprocessor to unreference
201  * \return NULL
202  * \since 1.6.1
203  */
204 void *ast_taskprocessor_unreference(struct ast_taskprocessor *tps);
205
206 /*!
207  * \brief Push a task into the specified taskprocessor queue and signal the taskprocessor thread
208  * \param tps The taskprocessor structure
209  * \param task_exe The task handling function to push into the taskprocessor queue
210  * \param datap The data to be used by the task handling function
211  * \retval 0 success
212  * \retval -1 failure
213  * \since 1.6.1
214  */
215 int ast_taskprocessor_push(struct ast_taskprocessor *tps, int (*task_exe)(void *datap), void *datap);
216
217 /*! \brief Local data parameter */
218 struct ast_taskprocessor_local {
219         /*! Local data, associated with the taskprocessor. */
220         void *local_data;
221         /*! Data pointer passed with this task. */
222         void *data;
223 };
224
225 /*!
226  * \brief Push a task into the specified taskprocessor queue and signal the
227  * taskprocessor thread.
228  *
229  * The callback receives a \ref ast_taskprocessor_local struct, which contains
230  * both the provided \a datap pointer, and any local data set on the
231  * taskprocessor with ast_taskprocessor_set_local().
232  *
233  * \param tps The taskprocessor structure
234  * \param task_exe The task handling function to push into the taskprocessor queue
235  * \param datap The data to be used by the task handling function
236  * \retval 0 success
237  * \retval -1 failure
238  * \since 12.0.0
239  */
240 int ast_taskprocessor_push_local(struct ast_taskprocessor *tps,
241         int (*task_exe)(struct ast_taskprocessor_local *local), void *datap);
242
243 /*!
244  * \brief Pop a task off the taskprocessor and execute it.
245  *
246  * \since 12.0.0
247  *
248  * \param tps The taskprocessor from which to execute.
249  * \retval 0 There is no further work to be done.
250  * \retval 1 Tasks still remain in the taskprocessor queue.
251  */
252 int ast_taskprocessor_execute(struct ast_taskprocessor *tps);
253
254 /*!
255  * \brief Am I the given taskprocessor's current task.
256  * \since 12.7.0
257  *
258  * \param tps Taskprocessor to check.
259  *
260  * \retval non-zero if current thread is the taskprocessor thread.
261  */
262 int ast_taskprocessor_is_task(struct ast_taskprocessor *tps);
263
264 /*!
265  * \brief Get the next sequence number to create a human friendly taskprocessor name.
266  * \since 13.8.0
267  *
268  * \return Sequence number for use in creating human friendly taskprocessor names.
269  */
270 unsigned int ast_taskprocessor_seq_num(void);
271
272 /*!
273  * \brief Build a taskprocessor name with a sequence number on the end.
274  * \since 13.8.0
275  *
276  * \param buf Where to put the built taskprocessor name.
277  * \param size How large is buf including null terminator.
278  * \param format printf format to create the non-sequenced part of the name.
279  *
280  * \note The user supplied part of the taskprocessor name is truncated
281  * to allow the full sequence number to be appended within the supplied
282  * buffer size.
283  *
284  * \return Nothing
285  */
286 void __attribute__((format(printf, 3, 4))) ast_taskprocessor_build_name(char *buf, unsigned int size, const char *format, ...);
287
288 /*!
289  * \brief Return the name of the taskprocessor singleton
290  * \since 1.6.1
291  */
292 const char *ast_taskprocessor_name(struct ast_taskprocessor *tps);
293
294 /*!
295  * \brief Return the current size of the taskprocessor queue
296  * \since 13.7.0
297  */
298 long ast_taskprocessor_size(struct ast_taskprocessor *tps);
299
300 #endif /* __AST_TASKPROCESSOR_H__ */