9a0264e8ceed2c469ca7ed23927836dfdc67e365
[asterisk/asterisk.git] / include / asterisk.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * General Definitions for Asterisk top level program
5  *
6  * Copyright (C) 1999-2006, Digium, Inc.
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 /*! \file
15  * \brief Asterisk main include file. File version handling, generic pbx functions.
16  */
17
18 #ifndef _ASTERISK_H
19 #define _ASTERISK_H
20
21 #include "asterisk/autoconfig.h"
22
23 #if !defined(NO_MALLOC_DEBUG) && !defined(STANDALONE) && !defined(STANDALONE2) && defined(MALLOC_DEBUG)
24 #include "asterisk/astmm.h"
25 #endif
26
27 #include "asterisk/compat.h"
28
29 /* Default to allowing the umask or filesystem ACLs to determine actual file
30  * creation permissions
31  */
32 #ifndef AST_DIR_MODE
33 #define AST_DIR_MODE 0777
34 #endif
35 #ifndef AST_FILE_MODE
36 #define AST_FILE_MODE 0666
37 #endif
38
39 #define DEFAULT_LANGUAGE "en"
40
41 #define DEFAULT_SAMPLE_RATE 8000
42 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
43 #define setpriority     __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__
44 #define sched_setscheduler      __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__
45
46 #if defined(DEBUG_FD_LEAKS) && !defined(STANDALONE) && !defined(STANDALONE2) && !defined(STANDALONE_AEL)
47 /* These includes are all about ordering */
48 #include <stdio.h>
49 #include <sys/types.h>
50 #include <sys/stat.h>
51 #include <sys/socket.h>
52 #include <fcntl.h>
53
54 #define open(a,...)     __ast_fdleak_open(__FILE__,__LINE__,__PRETTY_FUNCTION__, a, __VA_ARGS__)
55 #define pipe(a)         __ast_fdleak_pipe(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
56 #define socket(a,b,c)   __ast_fdleak_socket(a, b, c, __FILE__,__LINE__,__PRETTY_FUNCTION__)
57 #define close(a)        __ast_fdleak_close(a)
58 #define fopen(a,b)      __ast_fdleak_fopen(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
59 #define fclose(a)       __ast_fdleak_fclose(a)
60 #define dup2(a,b)       __ast_fdleak_dup2(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
61 #define dup(a)          __ast_fdleak_dup(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
62
63 #if defined(__cplusplus) || defined(c_plusplus)
64 extern "C" {
65 #endif
66 int __ast_fdleak_open(const char *file, int line, const char *func, const char *path, int flags, ...);
67 int __ast_fdleak_pipe(int *fds, const char *file, int line, const char *func);
68 int __ast_fdleak_socket(int domain, int type, int protocol, const char *file, int line, const char *func);
69 int __ast_fdleak_close(int fd);
70 FILE *__ast_fdleak_fopen(const char *path, const char *mode, const char *file, int line, const char *func);
71 int __ast_fdleak_fclose(FILE *ptr);
72 int __ast_fdleak_dup2(int oldfd, int newfd, const char *file, int line, const char *func);
73 int __ast_fdleak_dup(int oldfd, const char *file, int line, const char *func);
74 #if defined(__cplusplus) || defined(c_plusplus)
75 }
76 #endif
77 #endif
78
79 int ast_set_priority(int);                      /*!< Provided by asterisk.c */
80 int ast_fd_init(void);                          /*!< Provided by astfd.c */
81 int ast_pbx_init(void);                         /*!< Provided by pbx.c */
82
83 /*!
84  * \brief Register a function to be executed before Asterisk exits.
85  * \param func The callback function to use.
86  *
87  * \retval 0 on success.
88  * \retval -1 on error.
89  *
90  * \note This function should be rarely used in situations where
91  * something must be shutdown to avoid corruption, excessive data
92  * loss, or when external programs must be stopped.  All other
93  * cleanup in the core should use ast_register_cleanup.
94  */
95 int ast_register_atexit(void (*func)(void));
96
97 /*!
98  * \since 11.9
99  * \brief Register a function to be executed before Asterisk gracefully exits.
100  *
101  * If Asterisk is immediately shutdown (core stop now, or sending the TERM
102  * signal), the callback is not run. When the callbacks are run, they are run in
103  * sequence with ast_register_atexit() callbacks, in the reverse order of
104  * registration.
105  *
106  * \param func The callback function to use.
107  *
108  * \retval 0 on success.
109  * \retval -1 on error.
110  */
111 int ast_register_cleanup(void (*func)(void));
112
113 /*!
114  * \brief Unregister a function registered with ast_register_atexit().
115  * \param func The callback function to unregister.
116  */
117 void ast_unregister_atexit(void (*func)(void));
118
119 /*!
120  * \brief Cancel an existing shutdown and return to normal operation.
121  *
122  * \note Shutdown can be cancelled while the server is waiting for
123  * any existing channels to be destroyed before shutdown becomes
124  * irreversible.
125  *
126  * \return non-zero if shutdown cancelled.
127  */
128 int ast_cancel_shutdown(void);
129
130 /*!
131  * \details
132  * The server is preventing new channel creation in preparation for
133  * shutdown and may actively be releasing resources.  The shutdown
134  * process may be canceled by ast_cancel_shutdown() if it is not too
135  * late.
136  *
137  * \note The preparation to shutdown phase can be quite lengthy
138  * if we are gracefully shutting down.  How long existing calls will
139  * last is not up to us.
140  *
141  * \return non-zero if the server is preparing to or actively shutting down.
142  */
143 int ast_shutting_down(void);
144
145 /*!
146  * \return non-zero if the server is actively shutting down.
147  * \since 13.3.0
148  *
149  * \details
150  * The server is releasing resources and unloading modules.
151  * It won't be long now.
152  */
153 int ast_shutdown_final(void);
154
155 #if !defined(LOW_MEMORY)
156 /*!
157  * \brief Register the version of a source code file with the core.
158  * \param file the source file name
159  * \param version the version string (typically a SVN revision keyword string)
160  * \return nothing
161  *
162  * This function should not be called directly, but instead the
163  * ASTERISK_FILE_VERSION macro should be used to register a file with the core.
164  */
165 void ast_register_file_version(const char *file, const char *version);
166
167 /*!
168  * \brief Unregister a source code file from the core.
169  * \param file the source file name
170  * \return nothing
171  *
172  * This function should not be called directly, but instead the
173  * ASTERISK_FILE_VERSION macro should be used to automatically unregister
174  * the file when the module is unloaded.
175  */
176 void ast_unregister_file_version(const char *file);
177
178 /*! \brief Find version for given module name
179  * \param file Module name (i.e. chan_sip.so)
180  * \return version string or NULL if the module is not found
181  */
182 const char *ast_file_version_find(const char *file);
183
184 char *ast_complete_source_filename(const char *partial, int n);
185
186 /*!
187  * \brief Register/unregister a source code file with the core.
188  * \param file the source file name
189  * \param version the version string (typically a SVN revision keyword string)
190  *
191  * This macro will place a file-scope constructor and destructor into the
192  * source of the module using it; this will cause the version of this file
193  * to registered with the Asterisk core (and unregistered) at the appropriate
194  * times.
195  *
196  * Example:
197  *
198  * \code
199  * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
200  * \endcode
201  *
202  * \note The dollar signs above have been protected with backslashes to keep
203  * SVN from modifying them in this file; under normal circumstances they would
204  * not be present and SVN would expand the Revision keyword into the file's
205  * revision number.
206  */
207 #ifdef MTX_PROFILE
208 #define HAVE_MTX_PROFILE        /* used in lock.h */
209 #define ASTERISK_FILE_VERSION(file, version) \
210         static int mtx_prof = -1;       /* profile mutex */     \
211         static void __attribute__((constructor)) __register_file_version(void) \
212         { \
213                 mtx_prof = ast_add_profile("mtx_lock_" file, 0);        \
214                 ast_register_file_version(file, version); \
215         } \
216         static void __attribute__((destructor)) __unregister_file_version(void) \
217         { \
218                 ast_unregister_file_version(file); \
219         }
220 #else /* !MTX_PROFILE */
221 #define ASTERISK_FILE_VERSION(file, version) \
222         static void __attribute__((constructor)) __register_file_version(void) \
223         { \
224                 ast_register_file_version(file, version); \
225         } \
226         static void __attribute__((destructor)) __unregister_file_version(void) \
227         { \
228                 ast_unregister_file_version(file); \
229         }
230 #endif /* !MTX_PROFILE */
231 #else /* LOW_MEMORY */
232 #define ASTERISK_FILE_VERSION(file, x)
233 #endif /* LOW_MEMORY */
234
235 #if !defined(LOW_MEMORY)
236 /*!
237  * \brief support for event profiling
238  *
239  * (note, this must be documented a lot more)
240  * ast_add_profile allocates a generic 'counter' with a given name,
241  * which can be shown with the command 'core show profile &lt;name&gt;'
242  *
243  * The counter accumulates positive or negative values supplied by
244  * \see ast_add_profile(), dividing them by the 'scale' value passed in the
245  * create call, and also counts the number of 'events'.
246  * Values can also be taked by the TSC counter on ia32 architectures,
247  * in which case you can mark the start of an event calling ast_mark(id, 1)
248  * and then the end of the event with ast_mark(id, 0).
249  * For non-i386 architectures, these two calls return 0.
250  */
251 int ast_add_profile(const char *, uint64_t scale);
252 int64_t ast_profile(int, int64_t);
253 int64_t ast_mark(int, int start1_stop0);
254 #else /* LOW_MEMORY */
255 #define ast_add_profile(a, b) 0
256 #define ast_profile(a, b) do { } while (0)
257 #define ast_mark(a, b) do { } while (0)
258 #endif /* LOW_MEMORY */
259
260 /*! \brief
261  * Definition of various structures that many asterisk files need,
262  * but only because they need to know that the type exists.
263  *
264  */
265
266 struct ast_channel;
267 struct ast_frame;
268 struct ast_module;
269 struct ast_variable;
270 struct ast_str;
271 struct ast_sched_context;
272
273 /* Some handy macros for turning a preprocessor token into (effectively) a quoted string */
274 #define __stringify_1(x)        #x
275 #define __stringify(x)          __stringify_1(x)
276
277 #endif /* _ASTERISK_H */