(closes issue #13557)
[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 #if !defined(NO_MALLOC_DEBUG) && !defined(STANDALONE) && defined(MALLOC_DEBUG)
24 #include "asterisk/astmm.h"
25 #endif
26
27 #include "asterisk/compat.h"
28
29 #include "asterisk/logger.h"
30
31 /* Default to allowing the umask or filesystem ACLs to determine actual file
32  * creation permissions
33  */
34 #ifndef AST_DIR_MODE
35 #define AST_DIR_MODE 0777
36 #endif
37 #ifndef AST_FILE_MODE
38 #define AST_FILE_MODE 0666
39 #endif
40
41 #define DEFAULT_LANGUAGE "en"
42
43 #define DEFAULT_SAMPLE_RATE 8000
44 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
45 #define setpriority     __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__
46 #define sched_setscheduler      __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__
47
48 int ast_set_priority(int);                      /*!< Provided by asterisk.c */
49
50 /*!
51  * \brief Register a function to be executed before Asterisk exits.
52  * \param func The callback function to use.
53  *
54  * \retval 0 on success.
55  * \retval -1 on error.
56  */
57 int ast_register_atexit(void (*func)(void));
58
59 /*!   
60  * \brief Unregister a function registered with ast_register_atexit().
61  * \param func The callback function to unregister.   
62  */
63 void ast_unregister_atexit(void (*func)(void));
64
65 #if !defined(LOW_MEMORY)
66 /*!
67  * \brief Register the version of a source code file with the core.
68  * \param file the source file name
69  * \param version the version string (typically a CVS revision keyword string)
70  * \return nothing
71  *
72  * This function should not be called directly, but instead the
73  * ASTERISK_FILE_VERSION macro should be used to register a file with the core.
74  */
75 void ast_register_file_version(const char *file, const char *version);
76
77 /*!
78  * \brief Unregister a source code file from the core.
79  * \param file the source file name
80  * \return nothing
81  *
82  * This function should not be called directly, but instead the
83  * ASTERISK_FILE_VERSION macro should be used to automatically unregister
84  * the file when the module is unloaded.
85  */
86 void ast_unregister_file_version(const char *file);
87
88 /*! \brief Find version for given module name
89  * \param file Module name (i.e. chan_sip.so)
90  * \return version string or NULL if the module is not found
91  */
92 const char *ast_file_version_find(const char *file);
93
94
95 /*!
96  * \brief Register/unregister a source code file with the core.
97  * \param file the source file name
98  * \param version the version string (typically a CVS revision keyword string)
99  *
100  * This macro will place a file-scope constructor and destructor into the
101  * source of the module using it; this will cause the version of this file
102  * to registered with the Asterisk core (and unregistered) at the appropriate
103  * times.
104  *
105  * Example:
106  *
107  * \code
108  * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
109  * \endcode
110  *
111  * \note The dollar signs above have been protected with backslashes to keep
112  * CVS from modifying them in this file; under normal circumstances they would
113  * not be present and CVS would expand the Revision keyword into the file's
114  * revision number.
115  */
116 #ifdef MTX_PROFILE
117 #define HAVE_MTX_PROFILE        /* used in lock.h */
118 #define ASTERISK_FILE_VERSION(file, version) \
119         static int mtx_prof = -1;       /* profile mutex */     \
120         static void __attribute__((constructor)) __register_file_version(void) \
121         { \
122                 mtx_prof = ast_add_profile("mtx_lock_" file, 0);        \
123                 ast_register_file_version(file, version); \
124         } \
125         static void __attribute__((destructor)) __unregister_file_version(void) \
126         { \
127                 ast_unregister_file_version(file); \
128         }
129 #else /* !MTX_PROFILE */
130 #define ASTERISK_FILE_VERSION(file, version) \
131         static void __attribute__((constructor)) __register_file_version(void) \
132         { \
133                 ast_register_file_version(file, version); \
134         } \
135         static void __attribute__((destructor)) __unregister_file_version(void) \
136         { \
137                 ast_unregister_file_version(file); \
138         }
139 #endif /* !MTX_PROFILE */
140 #else /* LOW_MEMORY */
141 #define ASTERISK_FILE_VERSION(file, x)
142 #endif /* LOW_MEMORY */
143
144 #if !defined(LOW_MEMORY)
145 /*!
146  * \brief support for event profiling
147  *
148  * (note, this must be documented a lot more)
149  * ast_add_profile allocates a generic 'counter' with a given name,
150  * which can be shown with the command 'show profile <name>'
151  *
152  * The counter accumulates positive or negative values supplied by
153  * ast_add_profile(), dividing them by the 'scale' value passed in the
154  * create call, and also counts the number of 'events'.
155  * Values can also be taked by the TSC counter on ia32 architectures,
156  * in which case you can mark the start of an event calling ast_mark(id, 1)
157  * and then the end of the event with ast_mark(id, 0).
158  * For non-i386 architectures, these two calls return 0.
159  */
160 int ast_add_profile(const char *, uint64_t scale);
161 int64_t ast_profile(int, int64_t);
162 int64_t ast_mark(int, int start1_stop0);
163 #else /* LOW_MEMORY */
164 #define ast_add_profile(a, b) 0
165 #define ast_profile(a, b) do { } while (0)
166 #define ast_mark(a, b) do { } while (0)
167 #endif /* LOW_MEMORY */
168
169 /*! \brief
170  * Definition of various structures that many asterisk files need,
171  * but only because they need to know that the type exists.
172  *
173  */
174
175 struct ast_channel;
176 struct ast_frame;
177 struct ast_module;
178 struct ast_variable;
179 struct ast_str;
180
181 #define bzero  0x__dont_use_bzero__use_memset_instead""
182 #define bcopy  0x__dont_use_bcopy__use_memmove_instead()
183
184 #endif /* _ASTERISK_H */