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