core: Stop using AST_INLINE_API for allocator functions.
[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 #include "asterisk/compat.h"
23 #include "asterisk/astmm.h"
24
25 /* Default to allowing the umask or filesystem ACLs to determine actual file
26  * creation permissions
27  */
28 #ifndef AST_DIR_MODE
29 #define AST_DIR_MODE 0777
30 #endif
31 #ifndef AST_FILE_MODE
32 #define AST_FILE_MODE 0666
33 #endif
34
35 /* Make sure PATH_MAX is defined on platforms (HURD) that don't define it.
36  * Also be sure to handle the case of a path larger than PATH_MAX
37  * (err safely) in the code.
38  */
39 #ifndef PATH_MAX
40 #define PATH_MAX 4096
41 #endif
42
43
44 #define DEFAULT_LANGUAGE "en"
45
46 #define DEFAULT_SAMPLE_RATE 8000
47 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
48 #define setpriority     __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__
49 #define sched_setscheduler      __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__
50
51 #if defined(DEBUG_FD_LEAKS) && !defined(STANDALONE) && !defined(STANDALONE2) && !defined(STANDALONE_AEL)
52 /* These includes are all about ordering */
53 #include <sys/stat.h>
54 #include <sys/socket.h>
55 #include <fcntl.h>
56
57 #define open(a,...)     __ast_fdleak_open(__FILE__,__LINE__,__PRETTY_FUNCTION__, a, __VA_ARGS__)
58 #define pipe(a)         __ast_fdleak_pipe(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
59 #define socketpair(a,b,c,d)     __ast_fdleak_socketpair(a, b, c, d, __FILE__,__LINE__,__PRETTY_FUNCTION__)
60 #define socket(a,b,c)   __ast_fdleak_socket(a, b, c, __FILE__,__LINE__,__PRETTY_FUNCTION__)
61 #define accept(a,b,c)   __ast_fdleak_accept(a, b, c, __FILE__,__LINE__,__PRETTY_FUNCTION__)
62 #define close(a)        __ast_fdleak_close(a)
63 #define fopen(a,b)      __ast_fdleak_fopen(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
64 #define fclose(a)       __ast_fdleak_fclose(a)
65 #define dup2(a,b)       __ast_fdleak_dup2(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
66 #define dup(a)          __ast_fdleak_dup(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
67
68 #if defined(__cplusplus) || defined(c_plusplus)
69 extern "C" {
70 #endif
71 int __ast_fdleak_open(const char *file, int line, const char *func, const char *path, int flags, ...);
72 int __ast_fdleak_pipe(int *fds, const char *file, int line, const char *func);
73 int __ast_fdleak_socketpair(int domain, int type, int protocol, int sv[2],
74         const char *file, int line, const char *func);
75 int __ast_fdleak_socket(int domain, int type, int protocol, const char *file, int line, const char *func);
76 int __ast_fdleak_accept(int socket, struct sockaddr *address, socklen_t *address_len,
77         const char *file, int line, const char *func);
78 #if defined(HAVE_EVENTFD)
79 #include <sys/eventfd.h>
80 #define eventfd(a,b)    __ast_fdleak_eventfd(a,b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
81 int __ast_fdleak_eventfd(unsigned int initval, int flags, const char *file, int line, const char *func);
82 #endif
83 #if defined(HAVE_TIMERFD)
84 #include <sys/timerfd.h>
85 #define timerfd_create(a,b)     __ast_fdleak_timerfd_create(a,b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
86 int __ast_fdleak_timerfd_create(int clockid, int flags, const char *file, int line, const char *func);
87 #endif
88 int __ast_fdleak_close(int fd);
89 FILE *__ast_fdleak_fopen(const char *path, const char *mode, const char *file, int line, const char *func);
90 int __ast_fdleak_fclose(FILE *ptr);
91 int __ast_fdleak_dup2(int oldfd, int newfd, const char *file, int line, const char *func);
92 int __ast_fdleak_dup(int oldfd, const char *file, int line, const char *func);
93 #if defined(__cplusplus) || defined(c_plusplus)
94 }
95 #endif
96 #endif
97
98 int ast_set_priority(int);                      /*!< Provided by asterisk.c */
99 int ast_fd_init(void);                          /*!< Provided by astfd.c */
100 int ast_pbx_init(void);                         /*!< Provided by pbx.c */
101
102 /*!
103  * \brief Register a function to be executed before Asterisk exits.
104  * \param func The callback function to use.
105  *
106  * \retval 0 on success.
107  * \retval -1 on error.
108  *
109  * \note This function should be rarely used in situations where
110  * something must be shutdown to avoid corruption, excessive data
111  * loss, or when external programs must be stopped.  All other
112  * cleanup in the core should use ast_register_cleanup.
113  */
114 int ast_register_atexit(void (*func)(void));
115
116 /*!
117  * \since 11.9
118  * \brief Register a function to be executed before Asterisk gracefully exits.
119  *
120  * If Asterisk is immediately shutdown (core stop now, or sending the TERM
121  * signal), the callback is not run. When the callbacks are run, they are run in
122  * sequence with ast_register_atexit() callbacks, in the reverse order of
123  * registration.
124  *
125  * \param func The callback function to use.
126  *
127  * \retval 0 on success.
128  * \retval -1 on error.
129  */
130 int ast_register_cleanup(void (*func)(void));
131
132 /*!
133  * \brief Unregister a function registered with ast_register_atexit().
134  * \param func The callback function to unregister.
135  */
136 void ast_unregister_atexit(void (*func)(void));
137
138 /*!
139  * \brief Cancel an existing shutdown and return to normal operation.
140  *
141  * \note Shutdown can be cancelled while the server is waiting for
142  * any existing channels to be destroyed before shutdown becomes
143  * irreversible.
144  *
145  * \return non-zero if shutdown cancelled.
146  */
147 int ast_cancel_shutdown(void);
148
149 /*!
150  * \details
151  * The server is preventing new channel creation in preparation for
152  * shutdown and may actively be releasing resources.  The shutdown
153  * process may be canceled by ast_cancel_shutdown() if it is not too
154  * late.
155  *
156  * \note The preparation to shutdown phase can be quite lengthy
157  * if we are gracefully shutting down.  How long existing calls will
158  * last is not up to us.
159  *
160  * \return non-zero if the server is preparing to or actively shutting down.
161  */
162 int ast_shutting_down(void);
163
164 /*!
165  * \return non-zero if the server is actively shutting down.
166  * \since 13.3.0
167  *
168  * \details
169  * The server is releasing resources and unloading modules.
170  * It won't be long now.
171  */
172 int ast_shutdown_final(void);
173
174 #ifdef MTX_PROFILE
175 #define HAVE_MTX_PROFILE        /* used in lock.h */
176 #endif /* MTX_PROFILE */
177
178 /*!
179  * \brief support for event profiling
180  *
181  * (note, this must be documented a lot more)
182  * ast_add_profile allocates a generic 'counter' with a given name,
183  * which can be shown with the command 'core show profile &lt;name&gt;'
184  *
185  * The counter accumulates positive or negative values supplied by
186  * \see ast_add_profile(), dividing them by the 'scale' value passed in the
187  * create call, and also counts the number of 'events'.
188  * Values can also be taked by the TSC counter on ia32 architectures,
189  * in which case you can mark the start of an event calling ast_mark(id, 1)
190  * and then the end of the event with ast_mark(id, 0).
191  * For non-i386 architectures, these two calls return 0.
192  */
193 int ast_add_profile(const char *, uint64_t scale);
194 int64_t ast_profile(int, int64_t);
195 int64_t ast_mark(int, int start1_stop0);
196
197 /*! \brief
198  * Definition of various structures that many asterisk files need,
199  * but only because they need to know that the type exists.
200  *
201  */
202
203 struct ast_channel;
204 struct ast_frame;
205 struct ast_module;
206 struct ast_variable;
207 struct ast_str;
208 struct ast_sched_context;
209 struct ast_json;
210
211 /* Some handy macros for turning a preprocessor token into (effectively) a quoted string */
212 #define __stringify_1(x)        #x
213 #define __stringify(x)          __stringify_1(x)
214
215 #if defined(AST_IN_CORE) \
216         || (!defined(AST_MODULE_SELF_SYM) \
217                 && (defined(STANDALONE) || defined(STANDALONE2) || defined(AST_NOT_MODULE)))
218
219 #define AST_MODULE_SELF NULL
220
221 #elif defined(AST_MODULE_SELF_SYM)
222
223 /*! Retrieve the 'struct ast_module *' for the current module. */
224 #define AST_MODULE_SELF AST_MODULE_SELF_SYM()
225
226 struct ast_module;
227 /* Internal/forward declaration, AST_MODULE_SELF should be used instead. */
228 struct ast_module *AST_MODULE_SELF_SYM(void);
229
230 #else
231
232 #error "Externally compiled modules must declare AST_MODULE_SELF_SYM."
233
234 #endif
235
236 /*!
237  * \brief Retrieve the PBX UUID
238  * \param pbx_uuid A buffer of at least AST_UUID_STR_LEN (36 + 1) size to receive the UUID
239  * \param length The buffer length
240  */
241 int ast_pbx_uuid_get(char *pbx_uuid, int length);
242
243 #endif /* _ASTERISK_H */