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