switch compile-time option checking to string storage mode in this branch too
[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 /* The include of 'autoconfig.h' is not necessary for any modules that
22    are part of the Asterisk source tree, because the top-level Makefile
23    will forcibly include that header in all compilations before all
24    other headers (even system headers). However, leaving this here will
25    help out-of-tree module builders, and doesn't cause any harm for the
26    in-tree modules.
27 */
28 #include "asterisk/autoconfig.h"
29
30 #include "asterisk/compat.h"
31
32 #include "asterisk/paths.h"
33 #include "asterisk/logger.h"
34
35 /* Default to allowing the umask or filesystem ACLs to determine actual file
36  * creation permissions
37  */
38 #ifndef AST_DIR_MODE
39 #define AST_DIR_MODE 0777
40 #endif
41 #ifndef AST_FILE_MODE
42 #define AST_FILE_MODE 0666
43 #endif
44
45 #define DEFAULT_LANGUAGE "en"
46
47 #define DEFAULT_SAMPLE_RATE 8000
48 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
49 #define setpriority     __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__
50 #define sched_setscheduler      __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__
51
52 int ast_set_priority(int);                      /*!< Provided by asterisk.c */
53 int load_modules(unsigned int);                 /*!< Provided by loader.c */
54 int load_pbx(void);                             /*!< Provided by pbx.c */
55 int init_logger(void);                          /*!< Provided by logger.c */
56 void close_logger(void);                        /*!< Provided by logger.c */
57 int reload_logger(int);                         /*!< Provided by logger.c */
58 int init_framer(void);                          /*!< Provided by frame.c */
59 int ast_term_init(void);                        /*!< Provided by term.c */
60 int astdb_init(void);                           /*!< Provided by db.c */
61 void ast_channels_init(void);                   /*!< Provided by channel.c */
62 void ast_builtins_init(void);                   /*!< Provided by cli.c */
63 int dnsmgr_init(void);                          /*!< Provided by dnsmgr.c */ 
64 void dnsmgr_start_refresh(void);                /*!< Provided by dnsmgr.c */
65 int dnsmgr_reload(void);                        /*!< Provided by dnsmgr.c */
66 void threadstorage_init(void);                  /*!< Provided by threadstorage.c */
67 void ast_event_init(void);          /*!< Provided by event.c */
68 int ast_device_state_engine_init(void); /*!< Provided by devicestate.c */
69 int astobj2_init(void);                         /*! Provided by astobj2.c */
70
71 /*!
72  * \brief Reload asterisk modules.
73  * \param name the name of the module to reload
74  *
75  * This function reloads the specified module, or if no modules are specified,
76  * it will reload all loaded modules.
77  *
78  * \note Modules are reloaded using their reload() functions, not unloading
79  * them and loading them again.
80  * 
81  * \return 0 if the specified module was not found.
82  * \retval 1 if the module was found but cannot be reloaded.
83  * \retval -1 if a reload operation is already in progress.
84  * \retval 2 if the specfied module was found and reloaded.
85  */
86 int ast_module_reload(const char *name);
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 CVS 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 /*!
127  * \brief Register/unregister a source code file with the core.
128  * \param file the source file name
129  * \param version the version string (typically a CVS revision keyword string)
130  *
131  * This macro will place a file-scope constructor and destructor into the
132  * source of the module using it; this will cause the version of this file
133  * to registered with the Asterisk core (and unregistered) at the appropriate
134  * times.
135  *
136  * Example:
137  *
138  * \code
139  * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
140  * \endcode
141  *
142  * \note The dollar signs above have been protected with backslashes to keep
143  * CVS from modifying them in this file; under normal circumstances they would
144  * not be present and CVS would expand the Revision keyword into the file's
145  * revision number.
146  */
147 #ifdef MTX_PROFILE
148 #define HAVE_MTX_PROFILE        /* used in lock.h */
149 #define ASTERISK_FILE_VERSION(file, version) \
150         static int mtx_prof = -1;       /* profile mutex */     \
151         static void __attribute__((constructor)) __register_file_version(void) \
152         { \
153                 mtx_prof = ast_add_profile("mtx_lock_" file, 0);        \
154                 ast_register_file_version(file, version); \
155         } \
156         static void __attribute__((destructor)) __unregister_file_version(void) \
157         { \
158                 ast_unregister_file_version(file); \
159         }
160 #else /* !MTX_PROFILE */
161 #define ASTERISK_FILE_VERSION(file, version) \
162         static void __attribute__((constructor)) __register_file_version(void) \
163         { \
164                 ast_register_file_version(file, version); \
165         } \
166         static void __attribute__((destructor)) __unregister_file_version(void) \
167         { \
168                 ast_unregister_file_version(file); \
169         }
170 #endif /* !MTX_PROFILE */
171 #else /* LOW_MEMORY */
172 #define ASTERISK_FILE_VERSION(file, x)
173 #endif /* LOW_MEMORY */
174
175 #if !defined(LOW_MEMORY)
176 /*!
177  * \brief support for event profiling
178  *
179  * (note, this must be documented a lot more)
180  * ast_add_profile allocates a generic 'counter' with a given name,
181  * which can be shown with the command 'show profile <name>'
182  *
183  * The counter accumulates positive or negative values supplied by
184  * ast_add_profile(), dividing them by the 'scale' value passed in the
185  * create call, and also counts the number of 'events'.
186  * Values can also be taked by the TSC counter on ia32 architectures,
187  * in which case you can mark the start of an event calling ast_mark(id, 1)
188  * and then the end of the event with ast_mark(id, 0).
189  * For non-i386 architectures, these two calls return 0.
190  */
191 int ast_add_profile(const char *, uint64_t scale);
192 int64_t ast_profile(int, int64_t);
193 int64_t ast_mark(int, int start1_stop0);
194 #else /* LOW_MEMORY */
195 #define ast_add_profile(a, b) 0
196 #define ast_profile(a, b) do { } while (0)
197 #define ast_mark(a, b) do { } while (0)
198 #endif /* LOW_MEMORY */
199
200 #endif /* _ASTERISK_H */