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