core: Remove disabled code.
[asterisk/asterisk.git] / include / asterisk.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
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 #include "asterisk/compat.h"
23
24 #if !defined(NO_MALLOC_DEBUG) && !defined(STANDALONE) && !defined(STANDALONE2) && defined(MALLOC_DEBUG)
25 #include "asterisk/astmm.h"
26 #endif
27
28 /* Default to allowing the umask or filesystem ACLs to determine actual file
29  * creation permissions
30  */
31 #ifndef AST_DIR_MODE
32 #define AST_DIR_MODE 0777
33 #endif
34 #ifndef AST_FILE_MODE
35 #define AST_FILE_MODE 0666
36 #endif
37
38 /* Make sure PATH_MAX is defined on platforms (HURD) that don't define it.
39  * Also be sure to handle the case of a path larger than PATH_MAX
40  * (err safely) in the code.
41  */
42 #ifndef PATH_MAX
43 #define PATH_MAX 4096
44 #endif
45
46
47 #define DEFAULT_LANGUAGE "en"
48
49 #define DEFAULT_SAMPLE_RATE 8000
50 #define DEFAULT_SAMPLES_PER_MS  ((DEFAULT_SAMPLE_RATE)/1000)
51 #define setpriority     __PLEASE_USE_ast_set_priority_INSTEAD_OF_setpriority__
52 #define sched_setscheduler      __PLEASE_USE_ast_set_priority_INSTEAD_OF_sched_setscheduler__
53
54 #if defined(DEBUG_FD_LEAKS) && !defined(STANDALONE) && !defined(STANDALONE2) && !defined(STANDALONE_AEL)
55 /* These includes are all about ordering */
56 #include <sys/stat.h>
57 #include <sys/socket.h>
58 #include <fcntl.h>
59
60 #define open(a,...)     __ast_fdleak_open(__FILE__,__LINE__,__PRETTY_FUNCTION__, a, __VA_ARGS__)
61 #define pipe(a)         __ast_fdleak_pipe(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
62 #define socket(a,b,c)   __ast_fdleak_socket(a, b, c, __FILE__,__LINE__,__PRETTY_FUNCTION__)
63 #define close(a)        __ast_fdleak_close(a)
64 #define fopen(a,b)      __ast_fdleak_fopen(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
65 #define fclose(a)       __ast_fdleak_fclose(a)
66 #define dup2(a,b)       __ast_fdleak_dup2(a, b, __FILE__,__LINE__,__PRETTY_FUNCTION__)
67 #define dup(a)          __ast_fdleak_dup(a, __FILE__,__LINE__,__PRETTY_FUNCTION__)
68
69 #if defined(__cplusplus) || defined(c_plusplus)
70 extern "C" {
71 #endif
72 int __ast_fdleak_open(const char *file, int line, const char *func, const char *path, int flags, ...);
73 int __ast_fdleak_pipe(int *fds, const char *file, int line, const char *func);
74 int __ast_fdleak_socket(int domain, int type, int protocol, const char *file, int line, const char *func);
75 int __ast_fdleak_close(int fd);
76 FILE *__ast_fdleak_fopen(const char *path, const char *mode, const char *file, int line, const char *func);
77 int __ast_fdleak_fclose(FILE *ptr);
78 int __ast_fdleak_dup2(int oldfd, int newfd, const char *file, int line, const char *func);
79 int __ast_fdleak_dup(int oldfd, const char *file, int line, const char *func);
80 #if defined(__cplusplus) || defined(c_plusplus)
81 }
82 #endif
83 #endif
84
85 int ast_set_priority(int);                      /*!< Provided by asterisk.c */
86 int ast_fd_init(void);                          /*!< Provided by astfd.c */
87 int ast_pbx_init(void);                         /*!< Provided by pbx.c */
88
89 /*!
90  * \brief Register a function to be executed before Asterisk exits.
91  * \param func The callback function to use.
92  *
93  * \retval 0 on success.
94  * \retval -1 on error.
95  *
96  * \note This function should be rarely used in situations where
97  * something must be shutdown to avoid corruption, excessive data
98  * loss, or when external programs must be stopped.  All other
99  * cleanup in the core should use ast_register_cleanup.
100  */
101 int ast_register_atexit(void (*func)(void));
102
103 /*!
104  * \since 11.9
105  * \brief Register a function to be executed before Asterisk gracefully exits.
106  *
107  * If Asterisk is immediately shutdown (core stop now, or sending the TERM
108  * signal), the callback is not run. When the callbacks are run, they are run in
109  * sequence with ast_register_atexit() callbacks, in the reverse order of
110  * registration.
111  *
112  * \param func The callback function to use.
113  *
114  * \retval 0 on success.
115  * \retval -1 on error.
116  */
117 int ast_register_cleanup(void (*func)(void));
118
119 /*!
120  * \brief Unregister a function registered with ast_register_atexit().
121  * \param func The callback function to unregister.
122  */
123 void ast_unregister_atexit(void (*func)(void));
124
125 /*!
126  * \brief Cancel an existing shutdown and return to normal operation.
127  *
128  * \note Shutdown can be cancelled while the server is waiting for
129  * any existing channels to be destroyed before shutdown becomes
130  * irreversible.
131  *
132  * \return non-zero if shutdown cancelled.
133  */
134 int ast_cancel_shutdown(void);
135
136 /*!
137  * \details
138  * The server is preventing new channel creation in preparation for
139  * shutdown and may actively be releasing resources.  The shutdown
140  * process may be canceled by ast_cancel_shutdown() if it is not too
141  * late.
142  *
143  * \note The preparation to shutdown phase can be quite lengthy
144  * if we are gracefully shutting down.  How long existing calls will
145  * last is not up to us.
146  *
147  * \return non-zero if the server is preparing to or actively shutting down.
148  */
149 int ast_shutting_down(void);
150
151 /*!
152  * \return non-zero if the server is actively shutting down.
153  * \since 13.3.0
154  *
155  * \details
156  * The server is releasing resources and unloading modules.
157  * It won't be long now.
158  */
159 int ast_shutdown_final(void);
160
161 #ifdef MTX_PROFILE
162 #define HAVE_MTX_PROFILE        /* used in lock.h */
163 #endif /* MTX_PROFILE */
164
165 /*!
166  * \brief support for event profiling
167  *
168  * (note, this must be documented a lot more)
169  * ast_add_profile allocates a generic 'counter' with a given name,
170  * which can be shown with the command 'core show profile &lt;name&gt;'
171  *
172  * The counter accumulates positive or negative values supplied by
173  * \see ast_add_profile(), dividing them by the 'scale' value passed in the
174  * create call, and also counts the number of 'events'.
175  * Values can also be taked by the TSC counter on ia32 architectures,
176  * in which case you can mark the start of an event calling ast_mark(id, 1)
177  * and then the end of the event with ast_mark(id, 0).
178  * For non-i386 architectures, these two calls return 0.
179  */
180 int ast_add_profile(const char *, uint64_t scale);
181 int64_t ast_profile(int, int64_t);
182 int64_t ast_mark(int, int start1_stop0);
183
184 /*! \brief
185  * Definition of various structures that many asterisk files need,
186  * but only because they need to know that the type exists.
187  *
188  */
189
190 struct ast_channel;
191 struct ast_frame;
192 struct ast_module;
193 struct ast_variable;
194 struct ast_str;
195 struct ast_sched_context;
196 struct ast_json;
197
198 /* Some handy macros for turning a preprocessor token into (effectively) a quoted string */
199 #define __stringify_1(x)        #x
200 #define __stringify(x)          __stringify_1(x)
201
202 #if defined(AST_IN_CORE) \
203         || (!defined(AST_MODULE_SELF_SYM) \
204                 && (defined(STANDALONE) || defined(STANDALONE2) || defined(AST_NOT_MODULE)))
205
206 #define AST_MODULE_SELF NULL
207
208 #elif defined(AST_MODULE_SELF_SYM)
209
210 /*! Retreive the 'struct ast_module *' for the current module. */
211 #define AST_MODULE_SELF AST_MODULE_SELF_SYM()
212
213 struct ast_module;
214 /* Internal/forward declaration, AST_MODULE_SELF should be used instead. */
215 struct ast_module *AST_MODULE_SELF_SYM(void);
216
217 #else
218
219 #error "Externally compiled modules must declare AST_MODULE_SELF_SYM."
220
221 #endif
222
223 /*!
224  * \brief Retrieve the PBX UUID
225  * \param pbx_uuid A buffer of at least AST_UUID_STR_LEN (36 + 1) size to receive the UUID
226  * \param length The buffer length
227  */
228 int ast_pbx_uuid_get(char *pbx_uuid, int length);
229
230 #endif /* _ASTERISK_H */