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