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