include "logger.h" and errno.h from asterisk.h - usage shows that they
[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 /* Many headers need 'ast_channel' to be defined */
72 struct ast_channel;
73
74 /* Many headers need 'ast_module' to be defined */
75 struct ast_module;
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 0 if the specified module was not found.
88  * \retval 1 if the module was found but cannot be reloaded.
89  * \retval -1 if a reload operation is already in progress.
90  * \retval 2 if the specfied module was found and reloaded.
91  */
92 int ast_module_reload(const char *name);
93
94 /*!
95  * \brief Register a function to be executed before Asterisk exits.
96  * \param func The callback function to use.
97  *
98  * \retval 0 on success.
99  * \retval -1 on error.
100  */
101 int ast_register_atexit(void (*func)(void));
102
103 /*!   
104  * \brief Unregister a function registered with ast_register_atexit().
105  * \param func The callback function to unregister.   
106  */
107 void ast_unregister_atexit(void (*func)(void));
108
109 #if !defined(LOW_MEMORY)
110 /*!
111  * \brief Register the version of a source code file with the core.
112  * \param file the source file name
113  * \param version the version string (typically a CVS revision keyword string)
114  * \return nothing
115  *
116  * This function should not be called directly, but instead the
117  * ASTERISK_FILE_VERSION macro should be used to register a file with the core.
118  */
119 void ast_register_file_version(const char *file, const char *version);
120
121 /*!
122  * \brief Unregister a source code file from the core.
123  * \param file the source file name
124  * \return nothing
125  *
126  * This function should not be called directly, but instead the
127  * ASTERISK_FILE_VERSION macro should be used to automatically unregister
128  * the file when the module is unloaded.
129  */
130 void ast_unregister_file_version(const char *file);
131
132 /*!
133  * \brief Register/unregister a source code file with the core.
134  * \param file the source file name
135  * \param version the version string (typically a CVS revision keyword string)
136  *
137  * This macro will place a file-scope constructor and destructor into the
138  * source of the module using it; this will cause the version of this file
139  * to registered with the Asterisk core (and unregistered) at the appropriate
140  * times.
141  *
142  * Example:
143  *
144  * \code
145  * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
146  * \endcode
147  *
148  * \note The dollar signs above have been protected with backslashes to keep
149  * CVS from modifying them in this file; under normal circumstances they would
150  * not be present and CVS would expand the Revision keyword into the file's
151  * revision number.
152  */
153 #ifdef MTX_PROFILE
154 #define HAVE_MTX_PROFILE        /* used in lock.h */
155 #define ASTERISK_FILE_VERSION(file, version) \
156         static int mtx_prof = -1;       /* profile mutex */     \
157         static void __attribute__((constructor)) __register_file_version(void) \
158         { \
159                 mtx_prof = ast_add_profile("mtx_lock_" file, 0);        \
160                 ast_register_file_version(file, version); \
161         } \
162         static void __attribute__((destructor)) __unregister_file_version(void) \
163         { \
164                 ast_unregister_file_version(file); \
165         }
166 #else /* !MTX_PROFILE */
167 #define ASTERISK_FILE_VERSION(file, version) \
168         static void __attribute__((constructor)) __register_file_version(void) \
169         { \
170                 ast_register_file_version(file, version); \
171         } \
172         static void __attribute__((destructor)) __unregister_file_version(void) \
173         { \
174                 ast_unregister_file_version(file); \
175         }
176 #endif /* !MTX_PROFILE */
177 #else /* LOW_MEMORY */
178 #define ASTERISK_FILE_VERSION(file, x)
179 #endif /* LOW_MEMORY */
180
181 #if !defined(LOW_MEMORY)
182 /*!
183  * \brief support for event profiling
184  *
185  * (note, this must be documented a lot more)
186  * ast_add_profile allocates a generic 'counter' with a given name,
187  * which can be shown with the command 'show profile <name>'
188  *
189  * The counter accumulates positive or negative values supplied by
190  * ast_add_profile(), dividing them by the 'scale' value passed in the
191  * create call, and also counts the number of 'events'.
192  * Values can also be taked by the TSC counter on ia32 architectures,
193  * in which case you can mark the start of an event calling ast_mark(id, 1)
194  * and then the end of the event with ast_mark(id, 0).
195  * For non-i386 architectures, these two calls return 0.
196  */
197 int ast_add_profile(const char *, uint64_t scale);
198 int64_t ast_profile(int, int64_t);
199 int64_t ast_mark(int, int start1_stop0);
200 #else /* LOW_MEMORY */
201 #define ast_add_profile(a, b) 0
202 #define ast_profile(a, b) do { } while (0)
203 #define ast_mark(a, b) do { } while (0)
204 #endif /* LOW_MEMORY */
205
206 #endif /* _ASTERISK_H */