both md5sum and variable substitutions such as ${BUILDSUM:0:8}
[asterisk/asterisk.git] / include / asterisk.h
index 7d052bb..4468754 100644 (file)
@@ -3,7 +3,7 @@
  *
  * General Definitions for Asterisk top level program
  * 
- * Copyright (C) 1999-2005, Mark Spencer
+ * Copyright (C) 1999-2006, Digium, Inc.
  *
  * Mark Spencer <markster@digium.com>
  *
 #ifndef _ASTERISK_H
 #define _ASTERISK_H
 
+/* The include of 'autoconfig.h' is not necessary for any modules that
+   are part of the Asterisk source tree, because the top-level Makefile
+   will forcibly include that header in all compilations before all
+   other headers (even system headers). However, leaving this here will
+   help out-of-tree module builders, and doesn't cause any harm for the
+   in-tree modules.
+*/
+#include "asterisk/autoconfig.h"
+
+#include "asterisk/compat.h"
+
+#include "asterisk/paths.h"
+
+/* Default to allowing the umask or filesystem ACLs to determine actual file
+ * creation permissions
+ */
+#ifndef AST_DIR_MODE
+#define AST_DIR_MODE 0777
+#endif
+#ifndef AST_FILE_MODE
+#define AST_FILE_MODE 0666
+#endif
+
 #define DEFAULT_LANGUAGE "en"
 
-#define AST_CONFIG_MAX_PATH 255
+#define DEFAULT_SAMPLE_RATE 8000
+#define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
+#define        setpriority     __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__
+#define        sched_setscheduler      __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__
 
 /* provided in asterisk.c */
-extern char ast_config_AST_CONFIG_DIR[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_CONFIG_FILE[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_MODULE_DIR[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_SPOOL_DIR[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_MONITOR_DIR[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_VAR_DIR[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_LOG_DIR[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_AGI_DIR[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_DB[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_KEY_DIR[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_PID[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_SOCKET[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_RUN_DIR[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_CTL_PERMISSIONS[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_CTL_OWNER[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_CTL_GROUP[AST_CONFIG_MAX_PATH];
-extern char ast_config_AST_CTL[AST_CONFIG_MAX_PATH];
+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_RUN_GROUP[PATH_MAX];
+extern char ast_config_AST_RUN_USER[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];
 extern char ast_config_AST_SYSTEM_NAME[20];
 
-/* Provided by asterisk.c */
-int ast_set_priority(int);
-/* Provided by module.c */
-int load_modules(const int preload_only);
-/* Provided by pbx.c */
-int load_pbx(void);
-/* Provided by logger.c */
-int init_logger(void);
-void close_logger(void);
-/* Provided by frame.c */
-int init_framer(void);
-/* Provided by logger.c */
-int reload_logger(int);
-/* Provided by term.c */
-int term_init(void);
-/* Provided by db.c */
-int astdb_init(void);
-/* Provided by channel.c */
-void ast_channels_init(void);
-/* Provided by cli.c */
-void ast_builtins_init(void);
-/* Provided by dnsmgr.c */
-int dnsmgr_init(void);
-void dnsmgr_start_refresh(void);
-int dnsmgr_reload(void);
+int ast_set_priority(int);                     /*!< Provided by asterisk.c */
+int load_modules(unsigned int);                        /*!< Provided by loader.c */
+int load_pbx(void);                            /*!< Provided by pbx.c */
+int init_logger(void);                         /*!< Provided by logger.c */
+void close_logger(void);                       /*!< Provided by logger.c */
+int reload_logger(int);                                /*!< Provided by logger.c */
+int init_framer(void);                         /*!< Provided by frame.c */
+int ast_term_init(void);                       /*!< Provided by term.c */
+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 */
+void threadstorage_init(void);                 /*!< Provided by threadstorage.c */
+void ast_event_init(void);          /*!< Provided by event.c */
+int ast_device_state_engine_init(void); /*!< Provided by devicestate.c */
+int astobj2_init(void);                                /*! Provided by astobj2.c */
+
+/* Many headers need 'ast_channel' to be defined */
+struct ast_channel;
+
+/* Many headers need 'ast_module' to be defined */
+struct ast_module;
+
+/*!
+ * \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 0 if the specified module was not found.
+ * \retval 1 if the module was found but cannot be reloaded.
+ * \retval -1 if a reload operation is already in progress.
+ * \retval 2 if the specfied module was found and reloaded.
+ */
+int ast_module_reload(const char *name);
+
+/*!
+ * \brief Register a function to be executed before Asterisk exits.
+ * \param func The callback function to use.
+ *
+ * \retval 0 on success.
+ * \retval -1 on error.
+ */
+int ast_register_atexit(void (*func)(void));
+
+/*!   
+ * \brief Unregister a function registered with ast_register_atexit().
+ * \param func The callback function to unregister.   
+ */
+void ast_unregister_atexit(void (*func)(void));
 
+#if !defined(LOW_MEMORY)
 /*!
  * \brief Register the version of a source code file with the core.
  * \param file the source file name
@@ -111,20 +172,57 @@ void ast_unregister_file_version(const char *file);
  * not be present and CVS would expand the Revision keyword into the file's
  * revision number.
  */
-#if defined(__GNUC__) && !defined(LOW_MEMORY)
+#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); \
        }
-#elif !defined(LOW_MEMORY) /* ! __GNUC__  && ! LOW_MEMORY*/
-#define ASTERISK_FILE_VERSION(file, x) static const char __file_version[] = x;
+#else /* !MTX_PROFILE */
+#define ASTERISK_FILE_VERSION(file, version) \
+       static void __attribute__((constructor)) __register_file_version(void) \
+       { \
+               ast_register_file_version(file, version); \
+       } \
+       static void __attribute__((destructor)) __unregister_file_version(void) \
+       { \
+               ast_unregister_file_version(file); \
+       }
+#endif /* !MTX_PROFILE */
 #else /* LOW_MEMORY */
 #define ASTERISK_FILE_VERSION(file, x)
-#endif /* __GNUC__ */
+#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 */
 
 #endif /* _ASTERISK_H */