We are shaking up trunk tonight! allow data dir to be specified (issue #6967 reported...
[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-2005, Mark Spencer
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 #include "asterisk/compat.h"
19
20 #ifndef _ASTERISK_H
21 #define _ASTERISK_H
22
23 #define DEFAULT_LANGUAGE "en"
24
25 #define DEFAULT_SAMPLE_RATE 8000
26 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
27
28 #define AST_CONFIG_MAX_PATH 255
29
30 /* provided in asterisk.c */
31 extern char ast_config_AST_CONFIG_DIR[AST_CONFIG_MAX_PATH];
32 extern char ast_config_AST_CONFIG_FILE[AST_CONFIG_MAX_PATH];
33 extern char ast_config_AST_MODULE_DIR[AST_CONFIG_MAX_PATH];
34 extern char ast_config_AST_SPOOL_DIR[AST_CONFIG_MAX_PATH];
35 extern char ast_config_AST_MONITOR_DIR[AST_CONFIG_MAX_PATH];
36 extern char ast_config_AST_VAR_DIR[AST_CONFIG_MAX_PATH];
37 extern char ast_config_AST_DATA_DIR[AST_CONFIG_MAX_PATH];
38 extern char ast_config_AST_LOG_DIR[AST_CONFIG_MAX_PATH];
39 extern char ast_config_AST_AGI_DIR[AST_CONFIG_MAX_PATH];
40 extern char ast_config_AST_DB[AST_CONFIG_MAX_PATH];
41 extern char ast_config_AST_KEY_DIR[AST_CONFIG_MAX_PATH];
42 extern char ast_config_AST_PID[AST_CONFIG_MAX_PATH];
43 extern char ast_config_AST_SOCKET[AST_CONFIG_MAX_PATH];
44 extern char ast_config_AST_RUN_DIR[AST_CONFIG_MAX_PATH];
45 extern char ast_config_AST_CTL_PERMISSIONS[AST_CONFIG_MAX_PATH];
46 extern char ast_config_AST_CTL_OWNER[AST_CONFIG_MAX_PATH];
47 extern char ast_config_AST_CTL_GROUP[AST_CONFIG_MAX_PATH];
48 extern char ast_config_AST_CTL[AST_CONFIG_MAX_PATH];
49 extern char ast_config_AST_SYSTEM_NAME[20];
50
51 /* Provided by asterisk.c */
52 int ast_set_priority(int);
53 /* Provided by module.c */
54 int load_modules(const int preload_only);
55 /* Provided by pbx.c */
56 int load_pbx(void);
57 /* Provided by logger.c */
58 int init_logger(void);
59 void close_logger(void);
60 /* Provided by frame.c */
61 int init_framer(void);
62 /* Provided by logger.c */
63 int reload_logger(int);
64 /* Provided by term.c */
65 int term_init(void);
66 /* Provided by db.c */
67 int astdb_init(void);
68 /* Provided by channel.c */
69 void ast_channels_init(void);
70 /* Provided by cli.c */
71 void ast_builtins_init(void);
72 /* Provided by dnsmgr.c */
73 int dnsmgr_init(void);
74 void dnsmgr_start_refresh(void);
75 int dnsmgr_reload(void);
76
77 /*!
78  * \brief Reload asterisk modules.
79  * \param name the name of the module to reload
80  *
81  * This function reloads the specified module, or if no modules are specified,
82  * it will reload all loaded modules.
83  *
84  * \note Modules are reloaded using their reload() functions, not unloading
85  * them and loading them again.
86  * 
87  * \return Zero if the specified module was not found, 1 if the module was
88  * found but cannot be reloaded, -1 if a reload operation is already in
89  * progress, and 2 if the specfied module was found and reloaded.
90  */
91 int ast_module_reload(const char *name);
92
93 /*!
94  * \brief Register a function to be executed before Asterisk exits.
95  * \param func The callback function to use.
96  *
97  * \return Zero on success, -1 on error.
98  */
99 int ast_register_atexit(void (*func)(void));
100
101 /*!   
102  * \brief Unregister a function registered with ast_register_atexit().
103  * \param func The callback function to unregister.   
104  */
105 void ast_unregister_atexit(void (*func)(void));
106
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 CVS 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 /*!
130  * \brief support for event profiling
131  * (note, this must be documented a lot more)
132  * ast_add_profile allocates a generic 'counter' with a given name,
133  * which can be shown with the command 'show profile <name>'
134  *
135  * The counter accumulates positive or negative values supplied by
136  * ast_add_profile(), dividing them by the 'scale' value passed in the
137  * create call, and also counts the number of 'events'.
138  * Values can also be taked by the TSC counter on ia32 architectures,
139  * in which case you can mark the start of an event calling ast_mark(id, 1)
140  * and then the end of the event with ast_mark(id, 0).
141  * For non-i386 architectures, these two calls return 0.
142  */
143 int ast_add_profile(const char *, uint64_t scale);
144 int64_t ast_profile(int, int64_t);
145 int64_t ast_mark(int, int start1_stop0);
146
147 /*!
148  * \brief Register/unregister a source code file with the core.
149  * \param file the source file name
150  * \param version the version string (typically a CVS revision keyword string)
151  *
152  * This macro will place a file-scope constructor and destructor into the
153  * source of the module using it; this will cause the version of this file
154  * to registered with the Asterisk core (and unregistered) at the appropriate
155  * times.
156  *
157  * Example:
158  *
159  * \code
160  * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
161  * \endcode
162  *
163  * \note The dollar signs above have been protected with backslashes to keep
164  * CVS from modifying them in this file; under normal circumstances they would
165  * not be present and CVS would expand the Revision keyword into the file's
166  * revision number.
167  */
168 #if defined(__GNUC__) && !defined(LOW_MEMORY)
169 #ifdef MTX_PROFILE
170 #define HAVE_MTX_PROFILE        /* used in lock.h */
171 #define ASTERISK_FILE_VERSION(file, version) \
172         static int mtx_prof = -1;       /* profile mutex */     \
173         static void __attribute__((constructor)) __register_file_version(void) \
174         { \
175                 mtx_prof = ast_add_profile("mtx_lock_" file, 0);        \
176                 ast_register_file_version(file, version); \
177         } \
178         static void __attribute__((destructor)) __unregister_file_version(void) \
179         { \
180                 ast_unregister_file_version(file); \
181         }
182 #else
183 #define ASTERISK_FILE_VERSION(file, version) \
184         static void __attribute__((constructor)) __register_file_version(void) \
185         { \
186                 ast_register_file_version(file, version); \
187         } \
188         static void __attribute__((destructor)) __unregister_file_version(void) \
189         { \
190                 ast_unregister_file_version(file); \
191         }
192 #endif
193 #elif !defined(LOW_MEMORY) /* ! __GNUC__  && ! LOW_MEMORY*/
194 #define ASTERISK_FILE_VERSION(file, x) static const char __file_version[] = x;
195 #else /* LOW_MEMORY */
196 #define ASTERISK_FILE_VERSION(file, x)
197 #endif /* __GNUC__ */
198
199 #endif /* _ASTERISK_H */