1999-10-24 16:47:59 +00:00
|
|
|
/*
|
|
|
|
* Asterisk -- A telephony toolkit for Linux.
|
|
|
|
*
|
|
|
|
* General Definitions for Asterisk top level program
|
|
|
|
*
|
2006-04-24 17:11:45 +00:00
|
|
|
* Copyright (C) 1999-2006, Digium, Inc.
|
1999-10-24 16:47:59 +00:00
|
|
|
*
|
2005-06-06 20:27:51 +00:00
|
|
|
* Mark Spencer <markster@digium.com>
|
1999-10-24 16:47:59 +00:00
|
|
|
*
|
|
|
|
* This program is free software, distributed under the terms of
|
|
|
|
* the GNU General Public License
|
|
|
|
*/
|
|
|
|
|
2005-10-26 13:03:17 +00:00
|
|
|
/*! \file
|
|
|
|
* \brief Asterisk main include file. File version handling, generic pbx functions.
|
|
|
|
*/
|
|
|
|
|
1999-10-24 16:47:59 +00:00
|
|
|
#ifndef _ASTERISK_H
|
|
|
|
#define _ASTERISK_H
|
|
|
|
|
2006-06-07 19:05:35 +00:00
|
|
|
#include "asterisk/autoconfig.h"
|
2006-06-07 18:54:56 +00:00
|
|
|
|
2006-04-24 17:11:45 +00:00
|
|
|
#include "asterisk/compat.h"
|
|
|
|
|
2006-08-22 21:45:15 +00:00
|
|
|
#include "asterisk/paths.h"
|
2006-06-09 20:40:10 +00:00
|
|
|
|
2000-01-09 19:58:18 +00:00
|
|
|
#define DEFAULT_LANGUAGE "en"
|
|
|
|
|
2006-03-29 02:12:31 +00:00
|
|
|
#define DEFAULT_SAMPLE_RATE 8000
|
|
|
|
#define DEFAULT_SAMPLES_PER_MS ((DEFAULT_SAMPLE_RATE)/1000)
|
|
|
|
|
2005-06-06 03:04:58 +00:00
|
|
|
/* provided in asterisk.c */
|
2006-06-09 20:40:10 +00:00
|
|
|
extern char ast_config_AST_CONFIG_DIR[PATH_MAX];
|
|
|
|
extern char ast_config_AST_CONFIG_FILE[PATH_MAX];
|
|
|
|
extern char ast_config_AST_MODULE_DIR[PATH_MAX];
|
|
|
|
extern char ast_config_AST_SPOOL_DIR[PATH_MAX];
|
|
|
|
extern char ast_config_AST_MONITOR_DIR[PATH_MAX];
|
|
|
|
extern char ast_config_AST_VAR_DIR[PATH_MAX];
|
|
|
|
extern char ast_config_AST_DATA_DIR[PATH_MAX];
|
|
|
|
extern char ast_config_AST_LOG_DIR[PATH_MAX];
|
|
|
|
extern char ast_config_AST_AGI_DIR[PATH_MAX];
|
|
|
|
extern char ast_config_AST_DB[PATH_MAX];
|
|
|
|
extern char ast_config_AST_KEY_DIR[PATH_MAX];
|
|
|
|
extern char ast_config_AST_PID[PATH_MAX];
|
|
|
|
extern char ast_config_AST_SOCKET[PATH_MAX];
|
|
|
|
extern char ast_config_AST_RUN_DIR[PATH_MAX];
|
|
|
|
extern char ast_config_AST_CTL_PERMISSIONS[PATH_MAX];
|
|
|
|
extern char ast_config_AST_CTL_OWNER[PATH_MAX];
|
|
|
|
extern char ast_config_AST_CTL_GROUP[PATH_MAX];
|
|
|
|
extern char ast_config_AST_CTL[PATH_MAX];
|
2006-02-14 23:42:36 +00:00
|
|
|
extern char ast_config_AST_SYSTEM_NAME[20];
|
1999-10-24 16:47:59 +00:00
|
|
|
|
2006-06-08 07:29:46 +00:00
|
|
|
int ast_set_priority(int); /*!< Provided by asterisk.c */
|
2006-08-21 22:23:26 +00:00
|
|
|
int load_modules(unsigned int); /*!< Provided by loader.c */
|
2006-06-08 07:29:46 +00:00
|
|
|
int load_pbx(void); /*!< Provided by pbx.c */
|
2006-06-09 02:20:25 +00:00
|
|
|
int init_logger(void); /*!< Provided by logger.c */
|
|
|
|
void close_logger(void); /*!< Provided by logger.c */
|
2006-06-08 07:29:46 +00:00
|
|
|
int reload_logger(int); /*!< Provided by logger.c */
|
|
|
|
int init_framer(void); /*!< Provided by frame.c */
|
2006-10-04 00:26:21 +00:00
|
|
|
int ast_term_init(void); /*!< Provided by term.c */
|
2006-06-08 07:29:46 +00:00
|
|
|
int astdb_init(void); /*!< Provided by db.c */
|
|
|
|
void ast_channels_init(void); /*!< Provided by channel.c */
|
|
|
|
void ast_builtins_init(void); /*!< Provided by cli.c */
|
|
|
|
int dnsmgr_init(void); /*!< Provided by dnsmgr.c */
|
|
|
|
void dnsmgr_start_refresh(void); /*!< Provided by dnsmgr.c */
|
|
|
|
int dnsmgr_reload(void); /*!< Provided by dnsmgr.c */
|
2003-01-30 15:03:20 +00:00
|
|
|
|
2006-08-21 02:11:39 +00:00
|
|
|
/* Many headers need 'ast_channel' to be defined */
|
|
|
|
struct ast_channel;
|
|
|
|
|
|
|
|
/* Many headers need 'ast_module' to be defined */
|
|
|
|
struct ast_module;
|
|
|
|
|
2006-04-14 14:08:19 +00:00
|
|
|
/*!
|
|
|
|
* \brief Reload asterisk modules.
|
|
|
|
* \param name the name of the module to reload
|
|
|
|
*
|
|
|
|
* This function reloads the specified module, or if no modules are specified,
|
|
|
|
* it will reload all loaded modules.
|
|
|
|
*
|
|
|
|
* \note Modules are reloaded using their reload() functions, not unloading
|
|
|
|
* them and loading them again.
|
|
|
|
*
|
|
|
|
* \return Zero if the specified module was not found, 1 if the module was
|
|
|
|
* found but cannot be reloaded, -1 if a reload operation is already in
|
|
|
|
* progress, and 2 if the specfied module was found and reloaded.
|
|
|
|
*/
|
|
|
|
int ast_module_reload(const char *name);
|
|
|
|
|
2006-04-11 15:55:56 +00:00
|
|
|
/*!
|
|
|
|
* \brief Register a function to be executed before Asterisk exits.
|
|
|
|
* \param func The callback function to use.
|
2006-04-14 14:08:19 +00:00
|
|
|
*
|
2006-04-11 15:55:56 +00:00
|
|
|
* \return Zero on success, -1 on error.
|
|
|
|
*/
|
|
|
|
int ast_register_atexit(void (*func)(void));
|
2006-04-14 14:08:19 +00:00
|
|
|
|
|
|
|
/*!
|
2006-04-11 15:55:56 +00:00
|
|
|
* \brief Unregister a function registered with ast_register_atexit().
|
2006-04-14 14:08:19 +00:00
|
|
|
* \param func The callback function to unregister.
|
2006-04-11 15:55:56 +00:00
|
|
|
*/
|
|
|
|
void ast_unregister_atexit(void (*func)(void));
|
|
|
|
|
2006-10-04 21:10:36 +00:00
|
|
|
#if !defined(LOW_MEMORY)
|
2005-06-07 01:13:23 +00:00
|
|
|
/*!
|
|
|
|
* \brief Register the version of a source code file with the core.
|
|
|
|
* \param file the source file name
|
|
|
|
* \param version the version string (typically a CVS revision keyword string)
|
|
|
|
* \return nothing
|
|
|
|
*
|
|
|
|
* This function should not be called directly, but instead the
|
|
|
|
* ASTERISK_FILE_VERSION macro should be used to register a file with the core.
|
|
|
|
*/
|
2005-06-06 20:27:51 +00:00
|
|
|
void ast_register_file_version(const char *file, const char *version);
|
2005-06-07 01:13:23 +00:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* \brief Unregister a source code file from the core.
|
|
|
|
* \param file the source file name
|
|
|
|
* \return nothing
|
|
|
|
*
|
|
|
|
* This function should not be called directly, but instead the
|
|
|
|
* ASTERISK_FILE_VERSION macro should be used to automatically unregister
|
|
|
|
* the file when the module is unloaded.
|
|
|
|
*/
|
2005-06-06 20:27:51 +00:00
|
|
|
void ast_unregister_file_version(const char *file);
|
|
|
|
|
2005-06-07 01:13:23 +00:00
|
|
|
/*!
|
|
|
|
* \brief Register/unregister a source code file with the core.
|
|
|
|
* \param file the source file name
|
|
|
|
* \param version the version string (typically a CVS revision keyword string)
|
|
|
|
*
|
|
|
|
* This macro will place a file-scope constructor and destructor into the
|
|
|
|
* source of the module using it; this will cause the version of this file
|
|
|
|
* to registered with the Asterisk core (and unregistered) at the appropriate
|
|
|
|
* times.
|
|
|
|
*
|
|
|
|
* Example:
|
|
|
|
*
|
|
|
|
* \code
|
|
|
|
* ASTERISK_FILE_VERSION(__FILE__, "\$Revision\$")
|
|
|
|
* \endcode
|
2005-06-07 01:17:07 +00:00
|
|
|
*
|
|
|
|
* \note The dollar signs above have been protected with backslashes to keep
|
|
|
|
* CVS from modifying them in this file; under normal circumstances they would
|
|
|
|
* not be present and CVS would expand the Revision keyword into the file's
|
|
|
|
* revision number.
|
2005-06-07 01:13:23 +00:00
|
|
|
*/
|
2006-04-12 20:40:46 +00:00
|
|
|
#ifdef MTX_PROFILE
|
|
|
|
#define HAVE_MTX_PROFILE /* used in lock.h */
|
|
|
|
#define ASTERISK_FILE_VERSION(file, version) \
|
|
|
|
static int mtx_prof = -1; /* profile mutex */ \
|
|
|
|
static void __attribute__((constructor)) __register_file_version(void) \
|
|
|
|
{ \
|
|
|
|
mtx_prof = ast_add_profile("mtx_lock_" file, 0); \
|
|
|
|
ast_register_file_version(file, version); \
|
|
|
|
} \
|
|
|
|
static void __attribute__((destructor)) __unregister_file_version(void) \
|
|
|
|
{ \
|
|
|
|
ast_unregister_file_version(file); \
|
|
|
|
}
|
2006-10-04 21:10:36 +00:00
|
|
|
#else /* !MTX_PROFILE */
|
2005-06-06 22:12:19 +00:00
|
|
|
#define ASTERISK_FILE_VERSION(file, version) \
|
2005-06-06 20:27:51 +00:00
|
|
|
static void __attribute__((constructor)) __register_file_version(void) \
|
|
|
|
{ \
|
2005-06-06 22:12:19 +00:00
|
|
|
ast_register_file_version(file, version); \
|
2005-06-06 20:27:51 +00:00
|
|
|
} \
|
|
|
|
static void __attribute__((destructor)) __unregister_file_version(void) \
|
|
|
|
{ \
|
2005-06-06 22:12:19 +00:00
|
|
|
ast_unregister_file_version(file); \
|
2005-06-06 20:27:51 +00:00
|
|
|
}
|
2006-10-04 21:10:36 +00:00
|
|
|
#endif /* !MTX_PROFILE */
|
2005-06-07 16:07:06 +00:00
|
|
|
#else /* LOW_MEMORY */
|
|
|
|
#define ASTERISK_FILE_VERSION(file, x)
|
2006-10-04 21:10:36 +00:00
|
|
|
#endif /* LOW_MEMORY */
|
|
|
|
|
|
|
|
#if !defined(LOW_MEMORY)
|
|
|
|
/*!
|
|
|
|
* \brief support for event profiling
|
|
|
|
*
|
|
|
|
* (note, this must be documented a lot more)
|
|
|
|
* ast_add_profile allocates a generic 'counter' with a given name,
|
|
|
|
* which can be shown with the command 'show profile <name>'
|
|
|
|
*
|
|
|
|
* The counter accumulates positive or negative values supplied by
|
|
|
|
* ast_add_profile(), dividing them by the 'scale' value passed in the
|
|
|
|
* create call, and also counts the number of 'events'.
|
|
|
|
* Values can also be taked by the TSC counter on ia32 architectures,
|
|
|
|
* in which case you can mark the start of an event calling ast_mark(id, 1)
|
|
|
|
* and then the end of the event with ast_mark(id, 0).
|
|
|
|
* For non-i386 architectures, these two calls return 0.
|
|
|
|
*/
|
|
|
|
int ast_add_profile(const char *, uint64_t scale);
|
|
|
|
int64_t ast_profile(int, int64_t);
|
|
|
|
int64_t ast_mark(int, int start1_stop0);
|
|
|
|
#else /* LOW_MEMORY */
|
|
|
|
#define ast_add_profile(a, b) 0
|
|
|
|
#define ast_profile(a, b) do { } while (0)
|
|
|
|
#define ast_mark(a, b) do { } while (0)
|
|
|
|
#endif /* LOW_MEMORY */
|
2005-06-06 20:27:51 +00:00
|
|
|
|
|
|
|
#endif /* _ASTERISK_H */
|