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