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 #if !defined(__Darwin__) && !defined(__OpenBSD__)
  24
  25 #define _POSIX_C_SOURCE 200112L
  26 #define _XOPEN_SOURCE 600
  27
  28 #include <unistd.h>
  29
  30 #if _POSIX_VERSION < 200112L
  31 #error System does not support POSIX version 200112.
  32 #endif
  33
  34 /* It is not clear if we need this version check at this time.
  35 #if _XOPEN_VERSION < 600
  36 #error System does not support XOPEN version 600.
  37 #endif
  38 */
  39
  40 #endif /* !__Darwin__ && !__OpenBSD__ */
  41
  42 #if !defined(NO_MALLOC_DEBUG) && !defined(STANDALONE) && defined(MALLOC_DEBUG)
  43 #include "asterisk/astmm.h"
  44 #endif
  45
  46 #include "asterisk/compat.h"
  47
  48 /* Default to allowing the umask or filesystem ACLs to determine actual file
  49  * creation permissions
  50  */
  51 #ifndef AST_DIR_MODE
  52 #define AST_DIR_MODE 0777
  53 #endif
  54 #ifndef AST_FILE_MODE
  55 #define AST_FILE_MODE 0666
  56 #endif
  57
  58 #define DEFAULT_LANGUAGE "en"
  59
  60 #define DEFAULT_SAMPLE_RATE 8000
  61 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
  62 #define setpriority     __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__
  63 #define sched_setscheduler      __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__
  64
  65 #if defined(DEBUG_FD_LEAKS) && !defined(STANDALONE) && !defined(STANDALONE_AEL)
  66 /* These includes are all about ordering */
  67 #include <stdio.h>
  68 #include <sys/types.h>
  69 #include <sys/stat.h>
  70 #include <sys/socket.h>
  71 #include <fcntl.h>
  72
  73 #define open(a,...)     __ast_fdleak_open(__FILE__,__LINE__,__PRETTY_FUNCTION__, a, __VA_ARGS__)
  74 #define pipe(a)         __ast_fdleak_pipe(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
  75 #define socket(a,b,c)   __ast_fdleak_socket(a, b, c, __FILE__,__LINE__,__PRETTY_FUNCTION__)
  76 #define close(a)        __ast_fdleak_close(a)
  77 #define fopen(a,b)      __ast_fdleak_fopen(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
  78 #define fclose(a)       __ast_fdleak_fclose(a)
  79 #define dup2(a,b)       __ast_fdleak_dup2(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
  80 #define dup(a)          __ast_fdleak_dup(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
  81
  82 #if defined(__cplusplus) || defined(c_plusplus)
  83 extern "C" {
  84 #endif
  85 int __ast_fdleak_open(const char *file, int line, const char *func, const char *path, int flags, ...);
  86 int __ast_fdleak_pipe(int *fds, const char *file, int line, const char *func);
  87 int __ast_fdleak_socket(int domain, int type, int protocol, const char *file, int line, const char *func);
  88 int __ast_fdleak_close(int fd);
  89 FILE *__ast_fdleak_fopen(const char *path, const char *mode, const char *file, int line, const char *func);
  90 int __ast_fdleak_fclose(FILE *ptr);
  91 int __ast_fdleak_dup2(int oldfd, int newfd, const char *file, int line, const char *func);
  92 int __ast_fdleak_dup(int oldfd, const char *file, int line, const char *func);
  93 #if defined(__cplusplus) || defined(c_plusplus)
  94 }
  95 #endif
  96 #endif
  97
  98 int ast_set_priority(int);                      /*!< Provided by asterisk.c */
  99 int ast_fd_init(void);                          /*!< Provided by astfd.c */
 100
 101 /*!
 102  * \brief Register a function to be executed before Asterisk exits.
 103  * \param func The callback function to use.
 104  *
 105  * \retval 0 on success.
 106  * \retval -1 on error.
 107  */
 108 int ast_register_atexit(void (*func)(void));
 109
 110 /*!
 111  * \brief Unregister a function registered with ast_register_atexit().
 112  * \param func The callback function to unregister.
 113  */
 114 void ast_unregister_atexit(void (*func)(void));
 115
 116 #if !defined(LOW_MEMORY)
 117 /*!
 118  * \brief Register the version of a source code file with the core.
 119  * \param file the source file name
 120  * \param version the version string (typically a SVN revision keyword string)
 121  * \return nothing
 122  *
 123  * This function should not be called directly, but instead the
 124  * ASTERISK_FILE_VERSION macro should be used to register a file with the core.
 125  */
 126 void ast_register_file_version(const char *file, const char *version);
 127
 128 /*!
 129  * \brief Unregister a source code file from the core.
 130  * \param file the source file name
 131  * \return nothing
 132  *
 133  * This function should not be called directly, but instead the
 134  * ASTERISK_FILE_VERSION macro should be used to automatically unregister
 135  * the file when the module is unloaded.
 136  */
 137 void ast_unregister_file_version(const char *file);
 138
 139 /*! \brief Find version for given module name
 140  * \param file Module name (i.e. chan_sip.so)
 141  * \return version string or NULL if the module is not found
 142  */
 143 const char *ast_file_version_find(const char *file);
 144
 145 char *ast_complete_source_filename(const char *partial, int n);
 146
 147 /*!
 148  * \brief Register/unregister a source code file with the core.
 149  * \param file the source file name
 150  * \param version the version string (typically a SVN revision keyword string)
 151  *
 152  * This macro will place a file-scope constructor and destructor into the
 153  * source of the module using it; this will cause the version of this file
 154  * to registered with the Asterisk core (and unregistered) at the appropriate
 155  * times.
 156  *
 157  * Example:
 158  *
 159  * \code
 160  * ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
 161  * \endcode
 162  *
 163  * \note The dollar signs above have been protected with backslashes to keep
 164  * SVN from modifying them in this file; under normal circumstances they would
 165  * not be present and SVN would expand the Revision keyword into the file's
 166  * revision number.
 167  */
 168 #ifdef MTX_PROFILE
 169 #define HAVE_MTX_PROFILE        /* used in lock.h */
 170 #define ASTERISK_FILE_VERSION(file, version) \
 171         static int mtx_prof = -1;       /* profile mutex */     \
 172         static void __attribute__((constructor)) __register_file_version(void) \
 173         { \
 174                 mtx_prof = ast_add_profile("mtx_lock_" file, 0);        \
 175                 ast_register_file_version(file, version); \
 176         } \
 177         static void __attribute__((destructor)) __unregister_file_version(void) \
 178         { \
 179                 ast_unregister_file_version(file); \
 180         }
 181 #else /* !MTX_PROFILE */
 182 #define ASTERISK_FILE_VERSION(file, version) \
 183         static void __attribute__((constructor)) __register_file_version(void) \
 184         { \
 185                 ast_register_file_version(file, version); \
 186         } \
 187         static void __attribute__((destructor)) __unregister_file_version(void) \
 188         { \
 189                 ast_unregister_file_version(file); \
 190         }
 191 #endif /* !MTX_PROFILE */
 192 #else /* LOW_MEMORY */
 193 #define ASTERISK_FILE_VERSION(file, x)
 194 #endif /* LOW_MEMORY */
 195
 196 #if !defined(LOW_MEMORY)
 197 /*!
 198  * \brief support for event profiling
 199  *
 200  * (note, this must be documented a lot more)
 201  * ast_add_profile allocates a generic 'counter' with a given name,
 202  * which can be shown with the command 'core show profile &lt;name&gt;'
 203  *
 204  * The counter accumulates positive or negative values supplied by
 205  * \see ast_add_profile(), dividing them by the 'scale' value passed in the
 206  * create call, and also counts the number of 'events'.
 207  * Values can also be taked by the TSC counter on ia32 architectures,
 208  * in which case you can mark the start of an event calling ast_mark(id, 1)
 209  * and then the end of the event with ast_mark(id, 0).
 210  * For non-i386 architectures, these two calls return 0.
 211  */
 212 int ast_add_profile(const char *, uint64_t scale);
 213 int64_t ast_profile(int, int64_t);
 214 int64_t ast_mark(int, int start1_stop0);
 215 #else /* LOW_MEMORY */
 216 #define ast_add_profile(a, b) 0
 217 #define ast_profile(a, b) do { } while (0)
 218 #define ast_mark(a, b) do { } while (0)
 219 #endif /* LOW_MEMORY */
 220
 221 /*! \brief
 222  * Definition of various structures that many asterisk files need,
 223  * but only because they need to know that the type exists.
 224  *
 225  */
 226
 227 struct ast_channel;
 228 struct ast_frame;
 229 struct ast_module;
 230 struct ast_variable;
 231 struct ast_str;
 232
 233 #ifdef bzero
 234 #undef bzero
 235 #endif
 236
 237 #ifdef bcopy
 238 #undef bcopy
 239 #endif
 240
 241 #define bzero  0x__dont_use_bzero__use_memset_instead""
 242 #define bcopy  0x__dont_use_bcopy__use_memmove_instead()
 243
 244 #endif /* _ASTERISK_H */