9f9c7e8664d6d05e20065f677829b62bc2e373b4
[asterisk/asterisk.git] / include / asterisk.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
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 #define _POSIX_C_SOURCE 200112L
24 #define _XOPEN_SOURCE 600
25
26 #include <unistd.h>
27
28 #if _POSIX_VERSION < 200112L
29 #error System does not support POSIX version 200112.
30 #endif
31
32 /* It is not clear if we need this version check at this time.
33 #if _XOPEN_VERSION < 600
34 #error System does not support XOPEN version 600.
35 #endif
36 */
37
38 #if !defined(NO_MALLOC_DEBUG) && !defined(STANDALONE) && defined(MALLOC_DEBUG)
39 #include "asterisk/astmm.h"
40 #endif
41
42 #include "asterisk/compat.h"
43
44 /* Default to allowing the umask or filesystem ACLs to determine actual file
45  * creation permissions
46  */
47 #ifndef AST_DIR_MODE
48 #define AST_DIR_MODE 0777
49 #endif
50 #ifndef AST_FILE_MODE
51 #define AST_FILE_MODE 0666
52 #endif
53
54 #define DEFAULT_LANGUAGE "en"
55
56 #define DEFAULT_SAMPLE_RATE 8000
57 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
58 #define setpriority     __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__
59 #define sched_setscheduler      __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__
60
61 #if defined(DEBUG_FD_LEAKS) && !defined(STANDALONE) && !defined(STANDALONE_AEL)
62 /* These includes are all about ordering */
63 #include <stdio.h>
64 #include <sys/types.h>
65 #include <sys/stat.h>
66 #include <sys/socket.h>
67 #include <fcntl.h>
68
69 #define open(a,...)     __ast_fdleak_open(__FILE__,__LINE__,__PRETTY_FUNCTION__, a, __VA_ARGS__)
70 #define pipe(a)         __ast_fdleak_pipe(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
71 #define socket(a,b,c)   __ast_fdleak_socket(a, b, c, __FILE__,__LINE__,__PRETTY_FUNCTION__)
72 #define close(a)        __ast_fdleak_close(a)
73 #define fopen(a,b)      __ast_fdleak_fopen(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
74 #define fclose(a)       __ast_fdleak_fclose(a)
75 #define dup2(a,b)       __ast_fdleak_dup2(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
76 #define dup(a)          __ast_fdleak_dup(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
77
78 int __ast_fdleak_open(const char *file, int line, const char *func, const char *path, int flags, ...);
79 int __ast_fdleak_pipe(int *fds, const char *file, int line, const char *func);
80 int __ast_fdleak_socket(int domain, int type, int protocol, const char *file, int line, const char *func);
81 int __ast_fdleak_close(int fd);
82 FILE *__ast_fdleak_fopen(const char *path, const char *mode, const char *file, int line, const char *func);
83 int __ast_fdleak_fclose(FILE *ptr);
84 int __ast_fdleak_dup2(int oldfd, int newfd, const char *file, int line, const char *func);
85 int __ast_fdleak_dup(int oldfd, const char *file, int line, const char *func);
86 #endif
87
88 int ast_set_priority(int);                      /*!< Provided by asterisk.c */
89 int ast_fd_init(void);                          /*!< Provided by astfd.c */
90
91 /*!
92  * \brief Register a function to be executed before Asterisk exits.
93  * \param func The callback function to use.
94  *
95  * \retval 0 on success.
96  * \retval -1 on error.
97  */
98 int ast_register_atexit(void (*func)(void));
99
100 /*!
101  * \brief Unregister a function registered with ast_register_atexit().
102  * \param func The callback function to unregister.
103  */
104 void ast_unregister_atexit(void (*func)(void));
105
106 #if !defined(LOW_MEMORY)
107 /*!
108  * \brief Register the version of a source code file with the core.
109  * \param file the source file name
110  * \param version the version string (typically a SVN revision keyword string)
111  * \return nothing
112  *
113  * This function should not be called directly, but instead the
114  * ASTERISK_FILE_VERSION macro should be used to register a file with the core.
115  */
116 void ast_register_file_version(const char *file, const char *version);
117
118 /*!
119  * \brief Unregister a source code file from the core.
120  * \param file the source file name
121  * \return nothing
122  *
123  * This function should not be called directly, but instead the
124  * ASTERISK_FILE_VERSION macro should be used to automatically unregister
125  * the file when the module is unloaded.
126  */
127 void ast_unregister_file_version(const char *file);
128
129 /*! \brief Find version for given module name
130  * \param file Module name (i.e. chan_sip.so)
131  * \return version string or NULL if the module is not found
132  */
133 const char *ast_file_version_find(const char *file);
134
135 char *ast_complete_source_filename(const char *partial, int n);
136
137 /*!
138  * \brief Register/unregister a source code file with the core.
139  * \param file the source file name
140  * \param version the version string (typically a SVN revision keyword string)
141  *
142  * This macro will place a file-scope constructor and destructor into the
143  * source of the module using it; this will cause the version of this file
144  * to registered with the Asterisk core (and unregistered) at the appropriate
145  * times.
146  *
147  * Example:
148  *
149  * \code
150  * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
151  * \endcode
152  *
153  * \note The dollar signs above have been protected with backslashes to keep
154  * SVN from modifying them in this file; under normal circumstances they would
155  * not be present and SVN would expand the Revision keyword into the file's
156  * revision number.
157  */
158 #ifdef MTX_PROFILE
159 #define HAVE_MTX_PROFILE        /* used in lock.h */
160 #define ASTERISK_FILE_VERSION(file, version) \
161         static int mtx_prof = -1;       /* profile mutex */     \
162         static void __attribute__((constructor)) __register_file_version(void) \
163         { \
164                 mtx_prof = ast_add_profile("mtx_lock_" file, 0);        \
165                 ast_register_file_version(file, version); \
166         } \
167         static void __attribute__((destructor)) __unregister_file_version(void) \
168         { \
169                 ast_unregister_file_version(file); \
170         }
171 #else /* !MTX_PROFILE */
172 #define ASTERISK_FILE_VERSION(file, version) \
173         static void __attribute__((constructor)) __register_file_version(void) \
174         { \
175                 ast_register_file_version(file, version); \
176         } \
177         static void __attribute__((destructor)) __unregister_file_version(void) \
178         { \
179                 ast_unregister_file_version(file); \
180         }
181 #endif /* !MTX_PROFILE */
182 #else /* LOW_MEMORY */
183 #define ASTERISK_FILE_VERSION(file, x)
184 #endif /* LOW_MEMORY */
185
186 #if !defined(LOW_MEMORY)
187 /*!
188  * \brief support for event profiling
189  *
190  * (note, this must be documented a lot more)
191  * ast_add_profile allocates a generic 'counter' with a given name,
192  * which can be shown with the command 'core show profile &lt;name&gt;'
193  *
194  * The counter accumulates positive or negative values supplied by
195  * \see ast_add_profile(), dividing them by the 'scale' value passed in the
196  * create call, and also counts the number of 'events'.
197  * Values can also be taked by the TSC counter on ia32 architectures,
198  * in which case you can mark the start of an event calling ast_mark(id, 1)
199  * and then the end of the event with ast_mark(id, 0).
200  * For non-i386 architectures, these two calls return 0.
201  */
202 int ast_add_profile(const char *, uint64_t scale);
203 int64_t ast_profile(int, int64_t);
204 int64_t ast_mark(int, int start1_stop0);
205 #else /* LOW_MEMORY */
206 #define ast_add_profile(a, b) 0
207 #define ast_profile(a, b) do { } while (0)
208 #define ast_mark(a, b) do { } while (0)
209 #endif /* LOW_MEMORY */
210
211 /*! \brief
212  * Definition of various structures that many asterisk files need,
213  * but only because they need to know that the type exists.
214  *
215  */
216
217 struct ast_channel;
218 struct ast_frame;
219 struct ast_module;
220 struct ast_variable;
221 struct ast_str;
222
223 #ifdef bzero
224 #undef bzero
225 #endif
226
227 #ifdef bcopy
228 #undef bcopy
229 #endif
230
231 #define bzero  0x__dont_use_bzero__use_memset_instead""
232 #define bcopy  0x__dont_use_bcopy__use_memmove_instead()
233
234 #endif /* _ASTERISK_H */