Asterisk - The Open Source Telephony Project GIT-master-57e2743
Loading...
Searching...
No Matches
asterisk.c
Go to the documentation of this file.
1/*
2 * Asterisk -- An open source telephony toolkit.
3 *
4 * Copyright (C) 1999 - 2025, Sangoma Technologies Corporation
5 *
6 * Mark Spencer <markster@digium.com>
7 *
8 * See http://www.asterisk.org for more information about
9 * the Asterisk project. Please do not directly contact
10 * any of the maintainers of this project for assistance;
11 * the project provides a web site, mailing lists and IRC
12 * channels for your use.
13 *
14 * This program is free software, distributed under the terms of
15 * the GNU General Public License Version 2. See the LICENSE file
16 * at the top of the source tree.
17 */
18
19
20/* Doxygenified Copyright Header */
21/*!
22 * \mainpage Asterisk -- The Open Source Telephony Project
23 *
24 * \par Welcome
25 *
26 * This documentation created by the Doxygen project clearly explains the
27 * internals of the Asterisk software. This documentation contains basic
28 * examples, developer documentation, support information, and information
29 * for upgrading.
30 *
31 * \section community Community
32 * Asterisk is a big project and has a busy community. Look at the
33 * resources for questions and stick around to help answer questions.
34 * \li \ref asterisk_community_resources
35 *
36 * \par Developer Documentation for Asterisk
37 *
38 * This is the main developer documentation for Asterisk. It is
39 * generated by running "make progdocs" from the Asterisk source tree.
40 *
41 * In addition to the information available on the Asterisk source code,
42 * please see the appendices for information on coding guidelines,
43 * release management, commit policies, and more.
44 *
45 * \arg \ref AsteriskArchitecture
46 *
47 * \par Additional documentation
48 * \arg \ref Licensing
49 * \arg \ref DevDoc
50 * \arg \ref configuration_file
51 * \arg \ref channel_drivers
52 * \arg \ref applications
53 *
54 * \section copyright Copyright and Author
55 *
56 * Copyright (C) 1999 - 2025, Sangoma Technologies Corporation.
57 * Asterisk is a <a href="https://cdn.sangoma.com/wp-content/uploads/Sangoma-Trademark-Policy.pdf">registered trademark</a>
58 * of <a rel="nofollow" href="http://www.sangoma.com">Sangoma Technologies Corporation</a>.
59 *
60 * \author Mark Spencer <markster@digium.com>
61 *
62 * See http://www.asterisk.org for more information about
63 * the Asterisk project. Please do not directly contact
64 * any of the maintainers of this project for assistance;
65 * the project provides a web site, mailing lists, and IRC
66 * channels for your use.
67 *
68 */
69
70/*!
71 * \page asterisk_community_resources Asterisk Community Resources
72 * \par Websites
73 * \li https://www.asterisk.org Asterisk Homepage
74 * \li https://docs.asterisk.org Asterisk documentation
75 *
76 * \par Mailing Lists
77 * \par
78 * All lists: http://lists.digium.com/mailman/listinfo
79 * \li aadk-commits SVN commits to the AADK repository
80 * \li asterisk-addons-commits SVN commits to the Asterisk addons project
81 * \li asterisk-announce [no description available]
82 * \li asterisk-biz Commercial and Business-Oriented Asterisk Discussion
83 * \li Asterisk-BSD Asterisk on BSD discussion
84 * \li asterisk-bugs [no description available]
85 * \li asterisk-commits SVN commits to the Asterisk project
86 * \li asterisk-dev Asterisk Developers Mailing List
87 * \li asterisk-doc Discussions regarding The Asterisk Documentation Project
88 * \li asterisk-embedded Asterisk Embedded Development
89 * \li asterisk-gui Asterisk GUI project discussion
90 * \li asterisk-gui-commits SVN commits to the Asterisk-GUI project
91 * \li asterisk-ha-clustering Asterisk High Availability and Clustering List - Non-Commercial Discussion
92 * \li Asterisk-i18n Discussion of Asterisk internationalization
93 * \li asterisk-r2 [no description available]
94 * \li asterisk-scf-commits Commits to the Asterisk SCF project code repositories
95 * \li asterisk-scf-committee Asterisk SCF Steering Committee discussions
96 * \li asterisk-scf-dev Asterisk SCF Developers Mailing List
97 * \li asterisk-scf-wiki-changes Changes to the Asterisk SCF space on wiki.asterisk.org
98 * \li asterisk-security Asterisk Security Discussion
99 * \li asterisk-speech-rec Use of speech recognition in Asterisk
100 * \li asterisk-ss7 [no description available]
101 * \li asterisk-users Asterisk Users Mailing List - Non-Commercial Discussion
102 * \li asterisk-video Development discussion of video media support in Asterisk
103 * \li asterisk-wiki-changes Changes to the Asterisk space on wiki.asterisk.org
104 * \li asterisknow AsteriskNOW Discussion
105 * \li dahdi-commits SVN commits to the DAHDI project
106 * \li digium-announce Digium Product Announcements
107 * \li Dundi Distributed Universal Number Discovery
108 * \li libiax2-commits SVN commits to the libiax2 project
109 * \li libpri-commits SVN commits to the libpri project
110 * \li libss7-commits SVN commits to the libss7 project
111 * \li svn-commits SVN commits to the Digium repositories
112 * \li Test-results Results from automated testing
113 * \li thirdparty-commits SVN commits to the Digium third-party software repository
114 * \li zaptel-commits SVN commits to the Zaptel project
115 *
116 * \par Forums
117 * \li Forums are located at http://forums.asterisk.org/
118 *
119 * \par IRC
120 * \par
121 * Use https://libera.chat IRC server to connect with Asterisk
122 * developers and users in realtime.
123 *
124 * \li \verbatim #asterisk \endverbatim Asterisk Users Room
125 * \li \verbatim #asterisk-dev \endverbatim Asterisk Developers Room
126 *
127 * \par More
128 * \par
129 * If you would like to add a resource to this list please create an issue
130 * on the issue tracker with a patch.
131 */
132
133/*! \file
134 * \brief Top level source file for Asterisk - the Open Source PBX.
135 * Implementation of PBX core functions and CLI interface.
136 */
137
138/*! \li \ref asterisk.c uses the configuration file \ref asterisk.conf
139 * \addtogroup configuration_file
140 */
141
142/*! \page asterisk.conf asterisk.conf
143 * \verbinclude asterisk.conf.sample
144 */
145
146/*** MODULEINFO
147 <support_level>core</support_level>
148 ***/
149
150#include "asterisk.h"
151
152#include "asterisk/_private.h"
153
154#undef sched_setscheduler
155#undef setpriority
156#include <sys/time.h>
157#include <fcntl.h>
158#include <signal.h>
159#include <sched.h>
160#include <sys/un.h>
161#include <sys/wait.h>
162#include <ctype.h>
163#include <sys/resource.h>
164#include <grp.h>
165#include <pwd.h>
166#include <sys/stat.h>
167#if defined(HAVE_SYSINFO)
168#include <sys/sysinfo.h>
169#elif defined(HAVE_SYSCTL)
170#include <sys/param.h>
171#include <sys/sysctl.h>
172#include <sys/vmmeter.h>
173#if defined(__FreeBSD__) || defined(__DragonFly__)
174#include <vm/vm_param.h>
175#endif
176#if defined(HAVE_SWAPCTL)
177#include <sys/swap.h>
178#endif
179#endif
180#include <regex.h>
181#include <histedit.h>
182
183#if defined(SOLARIS)
184int daemon(int, int); /* defined in libresolv of all places */
185#include <sys/loadavg.h>
186#endif
187
188#ifdef linux
189#include <sys/prctl.h>
190#ifdef HAVE_CAP
191#include <sys/capability.h>
192#endif /* HAVE_CAP */
193#endif /* linux */
194
195/* we define here the variables so to better agree on the prototype */
196#include "asterisk/paths.h"
197#include "asterisk/network.h"
198#include "asterisk/cli.h"
199#include "asterisk/channel.h"
200#include "asterisk/translate.h"
201#include "asterisk/pickup.h"
202#include "asterisk/acl.h"
203#include "asterisk/ulaw.h"
204#include "asterisk/alaw.h"
205#include "asterisk/callerid.h"
206#include "asterisk/image.h"
207#include "asterisk/tdd.h"
208#include "asterisk/term.h"
209#include "asterisk/manager.h"
210#include "asterisk/cdr.h"
211#include "asterisk/pbx.h"
212#include "asterisk/app.h"
213#include "asterisk/mwi.h"
214#include "asterisk/lock.h"
215#include "asterisk/utils.h"
216#include "asterisk/file.h"
217#include "asterisk/io.h"
218#include "asterisk/config.h"
219#include "asterisk/ast_version.h"
220#include "asterisk/linkedlists.h"
221#include "asterisk/devicestate.h"
223#include "asterisk/module.h"
224#include "asterisk/buildinfo.h"
225#include "asterisk/xmldoc.h"
226#include "asterisk/poll-compat.h"
227#include "asterisk/test.h"
228#include "asterisk/rtp_engine.h"
229#include "asterisk/format.h"
230#include "asterisk/aoc.h"
231#include "asterisk/uuid.h"
232#include "asterisk/sorcery.h"
233#include "asterisk/bucket.h"
234#include "asterisk/stasis.h"
235#include "asterisk/json.h"
239#include "asterisk/endpoints.h"
240#include "asterisk/codec.h"
242#include "asterisk/media_cache.h"
243#include "asterisk/astdb.h"
244#include "asterisk/options.h"
245#include "asterisk/utf8.h"
246
247#include "../defaults.h"
248#include "channelstorage.h"
249#include "editline_compat.h"
250
251/*** DOCUMENTATION
252 <managerEvent language="en_US" name="FullyBooted">
253 <managerEventInstance class="EVENT_FLAG_SYSTEM">
254 <since>
255 <version>12.0.0</version>
256 </since>
257 <synopsis>Raised when all Asterisk initialization procedures have finished.</synopsis>
258 <syntax>
259 <parameter name="Status">
260 <para>Informational message</para>
261 </parameter>
262 <parameter name="Uptime">
263 <para>Seconds since start</para>
264 </parameter>
265 <parameter name="LastReload">
266 <para>Seconds since last reload</para>
267 </parameter>
268 </syntax>
269 </managerEventInstance>
270 </managerEvent>
271 <managerEvent language="en_US" name="Shutdown">
272 <managerEventInstance class="EVENT_FLAG_SYSTEM">
273 <since>
274 <version>12.0.0</version>
275 </since>
276 <synopsis>Raised when Asterisk is shutdown or restarted.</synopsis>
277 <syntax>
278 <parameter name="Shutdown">
279 <para>Whether the shutdown is proceeding cleanly (all channels
280 were hungup successfully) or uncleanly (channels will be
281 terminated)</para>
282 <enumlist>
283 <enum name="Uncleanly"/>
284 <enum name="Cleanly"/>
285 </enumlist>
286 </parameter>
287 <parameter name="Restart">
288 <para>Whether or not a restart will occur.</para>
289 <enumlist>
290 <enum name="True"/>
291 <enum name="False"/>
292 </enumlist>
293 </parameter>
294 </syntax>
295 </managerEventInstance>
296 </managerEvent>
297 ***/
298
299#ifndef AF_LOCAL
300#define AF_LOCAL AF_UNIX
301#define PF_LOCAL PF_UNIX
302#endif
303
304#define AST_MAX_CONNECTS 128
305#define NUM_MSGS 64
306
307/*! Displayed copyright tag */
308#define COPYRIGHT_TAG "Copyright (C) 1999 - 2025, Sangoma Technologies Corporation and others."
309
310/*! \brief Welcome message when starting a CLI interface */
311#define WELCOME_MESSAGE \
312 ast_verbose("Asterisk %s, " COPYRIGHT_TAG "\n" \
313 "Created by Mark Spencer <markster@digium.com>\n" \
314 "Asterisk comes with ABSOLUTELY NO WARRANTY; type 'core show warranty' for details.\n" \
315 "This is free software, with components licensed under the GNU General Public\n" \
316 "License version 2 and other licenses; you are welcome to redistribute it under\n" \
317 "certain conditions. Type 'core show license' for details.\n" \
318 "=========================================================================\n", ast_get_version()) \
319
320static int ast_socket = -1; /*!< UNIX Socket for allowing remote control */
321static int ast_socket_is_sd = 0; /*!< Is socket activation responsible for ast_socket? */
322static int ast_consock = -1; /*!< UNIX Socket for controlling another asterisk */
324struct console {
325 int fd; /*!< File descriptor */
326 int p[2]; /*!< Pipe */
327 pthread_t t; /*!< Thread of handler */
328 int mute; /*!< Is the console muted for logs */
329 int uid; /*!< Remote user ID. */
330 int gid; /*!< Remote group ID. */
331 int levels[NUMLOGLEVELS]; /*!< Which log levels are enabled for the console */
332 /*! Verbosity level of this console. */
334};
335
341
343
344struct timeval ast_startuptime;
345struct timeval ast_lastreloadtime;
346
347static History *el_hist;
348static EditLine *el;
349static char *remotehostname;
350
352
353static int ast_el_add_history(const char *);
354static int ast_el_read_history(const char *);
355static int ast_el_write_history(const char *);
356
357static void ast_el_read_default_histfile(void);
358static void ast_el_write_default_histfile(void);
359
360static void asterisk_daemon(int isroot, const char *runuser, const char *rungroup);
361
362static char *_argv[256];
363
364typedef enum {
365 /*! Normal operation */
367 /*! Committed to shutting down. Final phase */
369 /*! Committed to shutting down. Initial phase */
371 /*!
372 * Valid values for quit_handler() niceness below.
373 * These shutdown/restart levels can be cancelled.
374 *
375 * Remote console exit right now
376 */
378 /*! core stop/restart now */
380 /*! core stop/restart gracefully */
382 /*! core stop/restart when convenient */
385
387
388/*! Prevent new channel allocation for shutdown. */
390
391static int restartnow;
393static pthread_t mon_sig_flags;
394static int canary_pid = 0;
395static char canary_filename[128];
397
398static char randompool[256];
399
400#ifdef HAVE_CAP
401static cap_t child_cap;
402#endif
403
404static int sig_alert_pipe[2] = { -1, -1 };
405static struct {
406 unsigned int need_reload:1;
407 unsigned int need_quit:1;
408 unsigned int need_quit_handler:1;
409 unsigned int need_el_end:1;
411
412#if !defined(LOW_MEMORY)
419
421
423{
424 struct thread_list_t *new = ast_calloc(1, sizeof(*new));
425
426 if (!new)
427 return;
428
430 new->id = pthread_self();
431 new->lwp = ast_get_tid();
432 new->name = name; /* steal the allocated memory for the thread name */
436}
437
439{
440 struct thread_list_t *x;
441
444 if ((void *) x->id == id) {
446 break;
447 }
448 }
451 if (x) {
452 ast_free(x->name);
453 ast_free(x);
454 }
455}
456
457/*! \brief Print the contents of a file */
458static int print_file(int fd, char *desc, const char *filename)
459{
460 FILE *f;
461 char c;
462 if (!(f = fopen(filename, "r"))) {
463 return -1;
464 }
465 ast_cli(fd, "%s", desc);
466 while ((c = fgetc(f)) != EOF) {
467 ast_cli(fd, "%c", c);
468 }
469 fclose(f);
470 /* no need for trailing new line, the file already has one */
471 return 0;
472}
473
474/*! \brief Give an overview of core settings */
475static char *handle_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
476{
477 char buf[BUFSIZ];
478 struct ast_tm tm;
479 char eid_str[128];
480 struct rlimit limits;
481 char pbx_uuid[AST_UUID_STR_LEN];
482#if defined(HAVE_EACCESS) || defined(HAVE_EUIDACCESS)
483 char dir[PATH_MAX];
484#endif
485
486 switch (cmd) {
487 case CLI_INIT:
488 e->command = "core show settings";
489 e->usage = "Usage: core show settings\n"
490 " Show core misc settings";
491 return NULL;
492 case CLI_GENERATE:
493 return NULL;
494 }
495
496 ast_eid_to_str(eid_str, sizeof(eid_str), &ast_eid_default);
497 ast_pbx_uuid_get(pbx_uuid, sizeof(pbx_uuid));
498
499 ast_cli(a->fd, "\nPBX Core settings\n");
500 ast_cli(a->fd, "-----------------\n");
501 ast_cli(a->fd, " Version: %s\n", ast_get_version());
502 ast_cli(a->fd, " ABI related Build Options: %s\n", S_OR(ast_get_build_opts(), "(none)"));
503 ast_cli(a->fd, " All Build Options: %s\n", S_OR(ast_get_build_opts_all(), "(none)"));
505 ast_cli(a->fd, " Maximum calls: %d (Current %d)\n", ast_option_maxcalls, ast_active_channels());
506 else
507 ast_cli(a->fd, " Maximum calls: Not set\n");
508
509 if (getrlimit(RLIMIT_NOFILE, &limits)) {
510 ast_cli(a->fd, " Maximum open file handles: Error because of %s\n", strerror(errno));
511 } else if (limits.rlim_cur == RLIM_INFINITY) {
512 ast_cli(a->fd, " Maximum open file handles: Unlimited\n");
513 } else if (limits.rlim_cur < ast_option_maxfiles) {
514 ast_cli(a->fd, " Maximum open file handles: %d (is) %d (requested)\n", (int) limits.rlim_cur, ast_option_maxfiles);
515 } else {
516 ast_cli(a->fd, " Maximum open file handles: %d\n", (int) limits.rlim_cur);
517 }
518
519 ast_cli(a->fd, " Root console verbosity: %d\n", option_verbose);
520 ast_cli(a->fd, " Current console verbosity: %d\n", ast_verb_console_get());
521 ast_cli(a->fd, " Debug level: %d\n", option_debug);
522 ast_cli(a->fd, " Trace level: %d\n", option_trace);
523 ast_cli(a->fd, " Dump core on crash: %s\n", ast_opt_dump_core ? "Yes" : "No");
524 print_file(a->fd, " Core dump file: ", "/proc/sys/kernel/core_pattern");
525 ast_cli(a->fd, " Maximum load average: %lf\n", ast_option_maxload);
526#if defined(HAVE_SYSINFO)
527 ast_cli(a->fd, " Minimum free memory: %ld MB\n", option_minmemfree);
528#endif
529 if (ast_localtime(&ast_startuptime, &tm, NULL)) {
530 ast_strftime(buf, sizeof(buf), "%H:%M:%S", &tm);
531 ast_cli(a->fd, " Startup time: %s\n", buf);
532 }
534 ast_strftime(buf, sizeof(buf), "%H:%M:%S", &tm);
535 ast_cli(a->fd, " Last reload time: %s\n", buf);
536 }
537 ast_cli(a->fd, " System: %s/%s built by %s on %s %s\n", ast_build_os, ast_build_kernel, ast_build_user, ast_build_machine, ast_build_date);
538 ast_cli(a->fd, " System name: %s\n", ast_config_AST_SYSTEM_NAME);
539 ast_cli(a->fd, " Entity ID: %s\n", eid_str);
540 ast_cli(a->fd, " PBX UUID: %s\n", pbx_uuid);
541 ast_cli(a->fd, " Default language: %s\n", ast_defaultlanguage);
542 ast_cli(a->fd, " User name and group: %s/%s\n", ast_config_AST_RUN_USER, ast_config_AST_RUN_GROUP);
543#if defined(HAVE_EACCESS) || defined(HAVE_EUIDACCESS)
544#if defined(HAVE_EUIDACCESS) && !defined(HAVE_EACCESS)
545#define eaccess euidaccess
546#endif
547 if (!getcwd(dir, sizeof(dir))) {
548 if (eaccess(dir, R_OK | X_OK | F_OK)) {
549 ast_cli(a->fd, " Running directory: %s\n", "Unable to access");
550 } else {
551 ast_cli(a->fd, " Running directory: %s (%s)\n", dir, "Unable to access");
552 }
553 } else {
554 ast_cli(a->fd, " Running directory: %s\n", dir);
555 }
556#endif /* defined(HAVE_EACCESS) || defined(HAVE_EUIDACCESS) */
557 ast_cli(a->fd, " Executable includes: %s\n", ast_opt_exec_includes ? "Enabled" : "Disabled");
558 ast_cli(a->fd, " Transcode via SLIN: %s\n", ast_opt_transcode_via_slin ? "Enabled" : "Disabled");
559 ast_cli(a->fd, " Transmit silence during rec: %s\n", ast_opt_transmit_silence ? "Enabled" : "Disabled");
560 ast_cli(a->fd, " Generic PLC: %s\n", ast_opt_generic_plc ? "Enabled" : "Disabled");
561 ast_cli(a->fd, " Generic PLC on equal codecs: %s\n", ast_opt_generic_plc_on_equal_codecs ? "Enabled" : "Disabled");
562 ast_cli(a->fd, " Hide Msg Chan AMI events: %s\n", ast_opt_hide_messaging_ami_events ? "Enabled" : "Disabled");
563 ast_cli(a->fd, " Sounds search custom dir: %s\n", ast_opt_sounds_search_custom ? "Enabled" : "Disabled");
564 ast_cli(a->fd, " Min DTMF duration:: %u\n", option_dtmfminduration);
565#if !defined(LOW_MEMORY)
566 ast_cli(a->fd, " Cache media frames: %s\n", ast_opt_cache_media_frames ? "Enabled" : "Disabled");
567#endif
568 ast_cli(a->fd, " RTP use dynamic payloads: %u\n", ast_option_rtpusedynamic);
569
571 ast_cli(a->fd, " RTP dynamic payload types: %u,%u-%u\n",
575 ast_cli(a->fd, " RTP dynamic payload types: %u-%u,%u-%u\n",
578 } else {
579 ast_cli(a->fd, " RTP dynamic payload types: %u-%u\n",
581 }
582 ast_cli(a->fd, " Channel storage backend: %s\n",
584 ast_cli(a->fd, " Shell on remote consoles: %s\n",
585 ast_option_disable_remote_console_shell ? "Disabled" : "Enabled");
586
587 ast_cli(a->fd, "\n* Subsystems\n");
588 ast_cli(a->fd, " -------------\n");
589 ast_cli(a->fd, " Manager (AMI): %s\n", ast_manager_check_enabled() ? "Enabled" : "Disabled");
590 ast_cli(a->fd, " Web Manager (AMI/HTTP): %s\n", ast_webmanager_check_enabled() ? "Enabled" : "Disabled");
591 ast_cli(a->fd, " Call data records: %s\n", ast_cdr_is_enabled() ? "Enabled" : "Disabled");
592 ast_cli(a->fd, " Realtime Architecture (ARA): %s\n", ast_realtime_enabled() ? "Enabled" : "Disabled");
593
594 /*! \todo we could check musiconhold, voicemail, smdi, adsi, queues */
595
596 ast_cli(a->fd, "\n* Directories\n");
597 ast_cli(a->fd, " -------------\n");
598 ast_cli(a->fd, " Configuration file: %s\n", ast_config_AST_CONFIG_FILE);
599 ast_cli(a->fd, " Configuration directory: %s\n", ast_config_AST_CONFIG_DIR);
600 ast_cli(a->fd, " Module directory: %s\n", ast_config_AST_MODULE_DIR);
601 ast_cli(a->fd, " Spool directory: %s\n", ast_config_AST_SPOOL_DIR);
602 ast_cli(a->fd, " Log directory: %s\n", ast_config_AST_LOG_DIR);
603 ast_cli(a->fd, " Run/Sockets directory: %s\n", ast_config_AST_RUN_DIR);
604 ast_cli(a->fd, " PID file: %s\n", ast_config_AST_PID);
605 ast_cli(a->fd, " VarLib directory: %s\n", ast_config_AST_VAR_DIR);
606 ast_cli(a->fd, " Data directory: %s\n", ast_config_AST_DATA_DIR);
607 ast_cli(a->fd, " ASTDB: %s\n", ast_config_AST_DB);
608 ast_cli(a->fd, " IAX2 Keys directory: %s\n", ast_config_AST_KEY_DIR);
609 ast_cli(a->fd, " AGI Scripts directory: %s\n", ast_config_AST_AGI_DIR);
610 ast_cli(a->fd, " Cache directory: %s\n", ast_config_AST_CACHE_DIR);
611 ast_cli(a->fd, "\n\n");
612 return CLI_SUCCESS;
613}
614
615static char *handle_show_threads(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
616{
617 int count = 0;
618 struct thread_list_t *cur;
619 switch (cmd) {
620 case CLI_INIT:
621 e->command = "core show threads";
622 e->usage =
623 "Usage: core show threads\n"
624 " List threads currently active in the system.\n";
625 return NULL;
626 case CLI_GENERATE:
627 return NULL;
628 }
629
632 ast_cli(a->fd, "%p %d %s\n", (void *)cur->id, cur->lwp, cur->name);
633 count++;
634 }
636 ast_cli(a->fd, "%d threads listed.\n", count);
637 return CLI_SUCCESS;
638}
639
640#if defined (HAVE_SYSCTL) && defined(HAVE_SWAPCTL)
641/*
642 * swapmode is rewritten by Tobias Weingartner <weingart@openbsd.org>
643 * to be based on the new swapctl(2) system call.
644 */
645static int swapmode(int *used, int *total)
646{
647 struct swapent *swdev;
648 int nswap, rnswap, i;
649
650 nswap = swapctl(SWAP_NSWAP, 0, 0);
651 if (nswap == 0)
652 return 0;
653
654 swdev = ast_calloc(nswap, sizeof(*swdev));
655 if (swdev == NULL)
656 return 0;
657
658 rnswap = swapctl(SWAP_STATS, swdev, nswap);
659 if (rnswap == -1) {
660 ast_free(swdev);
661 return 0;
662 }
663
664 /* if rnswap != nswap, then what? */
665
666 /* Total things up */
667 *total = *used = 0;
668 for (i = 0; i < nswap; i++) {
669 if (swdev[i].se_flags & SWF_ENABLE) {
670 *used += (swdev[i].se_inuse / (1024 / DEV_BSIZE));
671 *total += (swdev[i].se_nblks / (1024 / DEV_BSIZE));
672 }
673 }
674 ast_free(swdev);
675 return 1;
676}
677#endif
678
679#if defined(HAVE_SYSINFO) || defined(HAVE_SYSCTL)
680/*! \brief Give an overview of system statistics */
681static char *handle_show_sysinfo(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
682{
683 uint64_t physmem, freeram;
684#if defined(HAVE_SYSINFO) || defined(HAVE_SWAPCTL)
685 int totalswap = 0;
686 uint64_t freeswap = 0;
687#endif
688 int nprocs = 0;
689 long uptime = 0;
690#if defined(HAVE_SYSINFO)
691 struct sysinfo sys_info;
692#elif defined(HAVE_SYSCTL)
693 static int pageshift;
694 struct vmtotal vmtotal;
695 struct timeval boottime;
696 time_t now;
697 int mib[2], pagesize;
698#if defined(HAVE_SWAPCTL)
699 int usedswap = 0;
700#endif
701 size_t len;
702#endif
703
704 switch (cmd) {
705 case CLI_INIT:
706 e->command = "core show sysinfo";
707 e->usage =
708 "Usage: core show sysinfo\n"
709 " List current system information.\n";
710 return NULL;
711 case CLI_GENERATE:
712 return NULL;
713 }
714
715#if defined(HAVE_SYSINFO)
716 sysinfo(&sys_info);
717 uptime = sys_info.uptime / 3600;
718 physmem = sys_info.totalram * sys_info.mem_unit;
719 freeram = (sys_info.freeram * sys_info.mem_unit) / 1024;
720 totalswap = (sys_info.totalswap * sys_info.mem_unit) / 1024;
721 freeswap = (sys_info.freeswap * sys_info.mem_unit) / 1024;
722 nprocs = sys_info.procs;
723#elif defined(HAVE_SYSCTL)
724 /* calculate the uptime by looking at boottime */
725 time(&now);
726 mib[0] = CTL_KERN;
727 mib[1] = KERN_BOOTTIME;
728 len = sizeof(boottime);
729 if (sysctl(mib, 2, &boottime, &len, NULL, 0) != -1) {
730 uptime = now - boottime.tv_sec;
731 }
732 uptime = uptime/3600;
733 /* grab total physical memory */
734 mib[0] = CTL_HW;
735#if defined(HW_PHYSMEM64)
736 mib[1] = HW_PHYSMEM64;
737#else
738 mib[1] = HW_PHYSMEM;
739#endif
740 len = sizeof(physmem);
741 sysctl(mib, 2, &physmem, &len, NULL, 0);
742
743 pagesize = getpagesize();
744 pageshift = 0;
745 while (pagesize > 1) {
746 pageshift++;
747 pagesize >>= 1;
748 }
749
750 /* we only need the amount of log(2)1024 for our conversion */
751 pageshift -= 10;
752
753 /* grab vm totals */
754 mib[0] = CTL_VM;
755 mib[1] = VM_METER;
756 len = sizeof(vmtotal);
757 sysctl(mib, 2, &vmtotal, &len, NULL, 0);
758 freeram = (vmtotal.t_free << pageshift);
759 /* generate swap usage and totals */
760#if defined(HAVE_SWAPCTL)
761 swapmode(&usedswap, &totalswap);
762 freeswap = (totalswap - usedswap);
763#endif
764 /* grab number of processes */
765#if defined(__OpenBSD__)
766 mib[0] = CTL_KERN;
767 mib[1] = KERN_NPROCS;
768 len = sizeof(nprocs);
769 sysctl(mib, 2, &nprocs, &len, NULL, 0);
770#endif
771#endif
772
773 ast_cli(a->fd, "\nSystem Statistics\n");
774 ast_cli(a->fd, "-----------------\n");
775 ast_cli(a->fd, " System Uptime: %ld hours\n", uptime);
776 ast_cli(a->fd, " Total RAM: %" PRIu64 " KiB\n", physmem / 1024);
777 ast_cli(a->fd, " Free RAM: %" PRIu64 " KiB\n", freeram);
778#if defined(HAVE_SYSINFO)
779 ast_cli(a->fd, " Buffer RAM: %" PRIu64 " KiB\n", ((uint64_t) sys_info.bufferram * sys_info.mem_unit) / 1024);
780#endif
781#if defined(HAVE_SYSINFO) || defined(HAVE_SWAPCTL)
782 ast_cli(a->fd, " Total Swap Space: %d KiB\n", totalswap);
783 ast_cli(a->fd, " Free Swap Space: %" PRIu64 " KiB\n\n", freeswap);
784#endif
785 ast_cli(a->fd, " Number of Processes: %d \n\n", nprocs);
786 return CLI_SUCCESS;
787}
788#endif
789
791 const char *name;
792 uint64_t scale; /* if non-zero, values are scaled by this */
793 int64_t mark;
794 int64_t value;
795 int64_t events;
796};
797
801 struct profile_entry e[0];
802};
803
804static struct profile_data *prof_data;
805#endif /* ! LOW_MEMORY */
806
807/*! \brief allocates a counter with a given name and scale.
808 * \return Returns the identifier of the counter.
809 */
810int ast_add_profile(const char *name, uint64_t scale)
811{
812#if !defined(LOW_MEMORY)
813 int l = sizeof(struct profile_data);
814 int n = 10; /* default entries */
815
816 if (prof_data == NULL) {
817 prof_data = ast_calloc(1, l + n*sizeof(struct profile_entry));
818 if (prof_data == NULL)
819 return -1;
820 prof_data->entries = 0;
821 prof_data->max_size = n;
822 }
824 void *p;
825 n = prof_data->max_size + 20;
826 p = ast_realloc(prof_data, l + n*sizeof(struct profile_entry));
827 if (p == NULL)
828 return -1;
829 prof_data = p;
830 prof_data->max_size = n;
831 }
832 n = prof_data->entries++;
834 prof_data->e[n].value = 0;
835 prof_data->e[n].events = 0;
836 prof_data->e[n].mark = 0;
837 prof_data->e[n].scale = scale;
838 return n;
839#else /* if defined(LOW_MEMORY) */
840 return 0;
841#endif
842}
843
844int64_t ast_profile(int i, int64_t delta)
845{
846#if !defined(LOW_MEMORY)
847 if (!prof_data || i < 0 || i > prof_data->entries) /* invalid index */
848 return 0;
849 if (prof_data->e[i].scale > 1)
850 delta /= prof_data->e[i].scale;
851 prof_data->e[i].value += delta;
852 prof_data->e[i].events++;
853 return prof_data->e[i].value;
854#else /* if defined(LOW_MEMORY) */
855 return 0;
856#endif
857}
858
859#if !defined(LOW_MEMORY)
860/* The RDTSC instruction was introduced on the Pentium processor and is not
861 * implemented on certain clones, like the Cyrix 586. Hence, the previous
862 * expectation of __i386__ was in error. */
863#if defined ( __i686__) && (defined(__FreeBSD__) || defined(__NetBSD__) || defined(linux))
864#if defined(__FreeBSD__)
865#include <machine/cpufunc.h>
866#elif defined(__NetBSD__) || defined(linux)
867static __inline uint64_t
868rdtsc(void)
869{
870 uint64_t rv;
871
872 __asm __volatile(".byte 0x0f, 0x31" : "=A" (rv));
873 return (rv);
874}
875#endif
876#else /* supply a dummy function on other platforms */
877static __inline uint64_t
878rdtsc(void)
879{
880 return 0;
881}
882#endif
883#endif /* ! LOW_MEMORY */
884
885int64_t ast_mark(int i, int startstop)
886{
887#if !defined(LOW_MEMORY)
888 if (!prof_data || i < 0 || i > prof_data->entries) /* invalid index */
889 return 0;
890 if (startstop == 1)
891 prof_data->e[i].mark = rdtsc();
892 else {
893 prof_data->e[i].mark = (rdtsc() - prof_data->e[i].mark);
894 if (prof_data->e[i].scale > 1)
895 prof_data->e[i].mark /= prof_data->e[i].scale;
896 prof_data->e[i].value += prof_data->e[i].mark;
897 prof_data->e[i].events++;
898 }
899 return prof_data->e[i].mark;
900#else /* if defined(LOW_MEMORY) */
901 return 0;
902#endif
903}
904
905#if !defined(LOW_MEMORY)
906#define DEFINE_PROFILE_MIN_MAX_VALUES min = 0; \
907 max = prof_data->entries;\
908 if (a->argc > 3) { /* specific entries */ \
909 if (isdigit(a->argv[3][0])) { \
910 min = atoi(a->argv[3]); \
911 if (a->argc == 5 && strcmp(a->argv[4], "-")) \
912 max = atoi(a->argv[4]); \
913 } else \
914 search = a->argv[3]; \
915 } \
916 if (max > prof_data->entries) \
917 max = prof_data->entries;
918
919static char *handle_show_profile(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
920{
921 int i, min, max;
922 const char *search = NULL;
923 switch (cmd) {
924 case CLI_INIT:
925 e->command = "core show profile";
926 e->usage = "Usage: core show profile\n"
927 " show profile information";
928 return NULL;
929 case CLI_GENERATE:
930 return NULL;
931 }
932
933 if (prof_data == NULL)
934 return 0;
935
937 ast_cli(a->fd, "profile values (%d, allocated %d)\n-------------------\n",
939 ast_cli(a->fd, "%6s %8s %10s %12s %12s %s\n", "ID", "Scale", "Events",
940 "Value", "Average", "Name");
941 for (i = min; i < max; i++) {
942 struct profile_entry *entry = &prof_data->e[i];
943 if (!search || strstr(entry->name, search))
944 ast_cli(a->fd, "%6d: [%8ld] %10ld %12lld %12lld %s\n",
945 i,
946 (long)entry->scale,
947 (long)entry->events, (long long)entry->value,
948 (long long)(entry->events ? entry->value / entry->events : entry->value),
949 entry->name);
950 }
951 return CLI_SUCCESS;
952}
953
954static char *handle_clear_profile(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
955{
956 int i, min, max;
957 const char *search = NULL;
958 switch (cmd) {
959 case CLI_INIT:
960 e->command = "core clear profile";
961 e->usage = "Usage: core clear profile\n"
962 " clear profile information";
963 return NULL;
964 case CLI_GENERATE:
965 return NULL;
966 }
967
968 if (prof_data == NULL)
969 return 0;
970
972 for (i= min; i < max; i++) {
973 if (!search || strstr(prof_data->e[i].name, search)) {
974 prof_data->e[i].value = 0;
975 prof_data->e[i].events = 0;
976 }
977 }
978 return CLI_SUCCESS;
979}
980#undef DEFINE_PROFILE_MIN_MAX_VALUES
981
982#endif /* ! LOW_MEMORY */
983
984int ast_pbx_uuid_get(char *pbx_uuid, int length)
985{
986 return ast_db_get("pbx", "UUID", pbx_uuid, length);
987}
988
989static void publish_fully_booted(void)
990{
991 struct ast_json *json_object;
992 int uptime = 0;
993 int lastreloaded = 0;
994 struct timeval tmp;
995 struct timeval curtime = ast_tvnow();
996
997 if (ast_startuptime.tv_sec) {
998 tmp = ast_tvsub(curtime, ast_startuptime);
999 uptime = (int) tmp.tv_sec;
1000 }
1001
1002 if (ast_lastreloadtime.tv_sec) {
1003 tmp = ast_tvsub(curtime, ast_lastreloadtime);
1004 lastreloaded = (int) tmp.tv_sec;
1005 }
1006
1007 json_object = ast_json_pack("{s: s, s: i, s: i}",
1008 "Status", "Fully Booted",
1009 "Uptime", uptime,
1010 "LastReload", lastreloaded);
1011 ast_manager_publish_event("FullyBooted", EVENT_FLAG_SYSTEM, json_object);
1012 ast_json_unref(json_object);
1013}
1014
1015static void ast_run_atexits(int run_cleanups)
1016{
1017 struct ast_atexit *ae;
1018
1020 while ((ae = AST_LIST_REMOVE_HEAD(&atexits, list))) {
1021 if (ae->func && (!ae->is_cleanup || run_cleanups)) {
1022 ae->func();
1023 }
1024 ast_free(ae);
1025 }
1027}
1028
1029static void __ast_unregister_atexit(void (*func)(void))
1030{
1031 struct ast_atexit *ae;
1032
1034 if (ae->func == func) {
1036 ast_free(ae);
1037 break;
1038 }
1039 }
1041}
1042
1043static int register_atexit(void (*func)(void), int is_cleanup)
1044{
1045 struct ast_atexit *ae;
1046
1047 ae = ast_calloc(1, sizeof(*ae));
1048 if (!ae) {
1049 return -1;
1050 }
1051 ae->func = func;
1052 ae->is_cleanup = is_cleanup;
1053
1058
1059 return 0;
1060}
1061
1062int ast_register_atexit(void (*func)(void))
1063{
1064 return register_atexit(func, 0);
1065}
1066
1067int ast_register_cleanup(void (*func)(void))
1068{
1069 return register_atexit(func, 1);
1070}
1071
1078
1079/* Sending commands from consoles back to the daemon requires a terminating NULL */
1080static int fdsend(int fd, const char *s)
1081{
1082 return write(fd, s, strlen(s) + 1);
1083}
1084
1085/* Sending messages from the daemon back to the display requires _excluding_ the terminating NULL */
1086static int fdprint(int fd, const char *s)
1087{
1088 return write(fd, s, strlen(s));
1089}
1090
1091/*! \brief NULL handler so we can collect the child exit status */
1092static void _null_sig_handler(int sig)
1093{
1094}
1095
1096static struct sigaction null_sig_handler = {
1097 .sa_handler = _null_sig_handler,
1098 .sa_flags = SA_RESTART,
1099};
1100
1101static struct sigaction ignore_sig_handler = {
1102 .sa_handler = SIG_IGN,
1103};
1104
1106/*! \brief Keep track of how many threads are currently trying to wait*() on
1107 * a child process
1108 */
1109static unsigned int safe_system_level = 0;
1110static struct sigaction safe_system_prev_handler;
1111
1113{
1114 unsigned int level;
1115
1117 level = safe_system_level++;
1118
1119 /* only replace the handler if it has not already been done */
1120 if (level == 0) {
1121 sigaction(SIGCHLD, &null_sig_handler, &safe_system_prev_handler);
1122 }
1123
1125}
1126
1128{
1129 unsigned int level;
1130
1132
1133 /* Wrapping around here is an error */
1135
1136 level = --safe_system_level;
1137
1138 /* only restore the handler if we are the last one */
1139 if (level == 0) {
1140 sigaction(SIGCHLD, &safe_system_prev_handler, NULL);
1141 }
1142
1144}
1145
1146/*! \brief fork and perform other preparations for spawning applications */
1147static pid_t safe_exec_prep(int dualfork)
1148{
1149 pid_t pid;
1150
1151#if defined(HAVE_WORKING_FORK) || defined(HAVE_WORKING_VFORK)
1153
1154#ifdef HAVE_WORKING_FORK
1155 pid = fork();
1156#else
1157 pid = vfork();
1158#endif
1159
1160 if (pid == 0) {
1161#ifdef HAVE_CAP
1162 cap_set_proc(child_cap);
1163#endif
1164#ifdef HAVE_WORKING_FORK
1167 }
1168 /* Close file descriptors and launch system command */
1169 ast_close_fds_above_n(STDERR_FILENO);
1170#endif
1171 if (dualfork) {
1172#ifdef HAVE_WORKING_FORK
1173 pid = fork();
1174#else
1175 pid = vfork();
1176#endif
1177 if (pid < 0) {
1178 /* Second fork failed. */
1179 /* No logger available. */
1180 _exit(1);
1181 }
1182
1183 if (pid > 0) {
1184 /* This is the first fork, exit so the reaper finishes right away. */
1185 _exit(0);
1186 }
1187
1188 /* This is the second fork. The first fork will exit immediately so
1189 * Asterisk doesn't have to wait for completion.
1190 * ast_safe_system("cmd &") would run in the background, but the '&'
1191 * cannot be added with ast_safe_execvp, so we have to double fork.
1192 */
1193 }
1194 }
1195
1196 if (pid < 0) {
1197 ast_log(LOG_WARNING, "Fork failed: %s\n", strerror(errno));
1198 }
1199#else
1200 ast_log(LOG_WARNING, "Fork failed: %s\n", strerror(ENOTSUP));
1201 pid = -1;
1202#endif
1203
1204 return pid;
1205}
1206
1207/*! \brief wait for spawned application to complete and unreplace sigchld */
1208static int safe_exec_wait(pid_t pid)
1209{
1210 int res = -1;
1211
1212#if defined(HAVE_WORKING_FORK) || defined(HAVE_WORKING_VFORK)
1213 if (pid > 0) {
1214 for (;;) {
1215 int status;
1216
1217 res = waitpid(pid, &status, 0);
1218 if (res > -1) {
1219 res = WIFEXITED(status) ? WEXITSTATUS(status) : -1;
1220 break;
1221 }
1222 if (errno != EINTR) {
1223 break;
1224 }
1225 }
1226 }
1227
1229#endif
1230
1231 return res;
1232}
1233
1234int ast_safe_execvp(int dualfork, const char *file, char *const argv[])
1235{
1236 pid_t pid = safe_exec_prep(dualfork);
1237
1238 if (pid == 0) {
1239 execvp(file, argv);
1240 _exit(1);
1241 /* noreturn from _exit */
1242 }
1243
1244 return safe_exec_wait(pid);
1245}
1246
1247int ast_safe_system(const char *s)
1248{
1249 pid_t pid = safe_exec_prep(0);
1250
1251 if (pid == 0) {
1252 execl("/bin/sh", "/bin/sh", "-c", s, (char *) NULL);
1253 _exit(1);
1254 /* noreturn from _exit */
1255 }
1256
1257 return safe_exec_wait(pid);
1258}
1259
1260/*!
1261 * \brief enable or disable a logging level to a specified console
1262 */
1263void ast_console_toggle_loglevel(int fd, int level, int state)
1264{
1265 int x;
1266
1267 if (level >= NUMLOGLEVELS) {
1268 level = NUMLOGLEVELS - 1;
1269 }
1270
1271 for (x = 0;x < AST_MAX_CONNECTS; x++) {
1272 if (fd == consoles[x].fd) {
1273 /*
1274 * Since the logging occurs when levels are false, set to
1275 * flipped iinput because this function accepts 0 as off and 1 as on
1276 */
1277 consoles[x].levels[level] = state ? 0 : 1;
1278 return;
1279 }
1280 }
1281}
1282
1283/*!
1284 * \brief mute or unmute a console from logging
1285 */
1286void ast_console_toggle_mute(int fd, int silent)
1287{
1288 int x;
1289 for (x = 0;x < AST_MAX_CONNECTS; x++) {
1290 if (fd == consoles[x].fd) {
1291 if (consoles[x].mute) {
1292 consoles[x].mute = 0;
1293 if (!silent)
1294 ast_cli(fd, "Console is not muted anymore.\n");
1295 } else {
1296 consoles[x].mute = 1;
1297 if (!silent)
1298 ast_cli(fd, "Console is muted.\n");
1299 }
1300 return;
1301 }
1302 }
1303 ast_cli(fd, "Couldn't find remote console.\n");
1304}
1305
1306/*!
1307 * \brief log the string to all attached network console clients
1308 */
1309static void ast_network_puts_mutable(const char *string, int level, int sublevel)
1310{
1311 int x;
1312
1313 for (x = 0; x < AST_MAX_CONNECTS; ++x) {
1314 if (consoles[x].fd < 0
1315 || consoles[x].mute
1316 || consoles[x].levels[level]
1317 || (level == __LOG_VERBOSE && consoles[x].option_verbose < sublevel)) {
1318 continue;
1319 }
1320 fdprint(consoles[x].p[1], string);
1321 }
1322}
1323
1324/*!
1325 * \brief log the string to the root console, and all attached
1326 * network console clients
1327 */
1328void ast_console_puts_mutable(const char *string, int level)
1329{
1330 ast_console_puts_mutable_full(string, level, 0);
1331}
1332
1333static int console_print(const char *s);
1334
1335void ast_console_puts_mutable_full(const char *message, int level, int sublevel)
1336{
1337 /* Send to the root console */
1339
1340 /* Wake up a poll()ing console */
1342 pthread_kill(consolethread, SIGURG);
1343 }
1344
1345 /* Send to any network console clients */
1346 ast_network_puts_mutable(message, level, sublevel);
1347}
1348
1349/*!
1350 * \brief write the string to all attached console clients
1351 */
1352static void ast_network_puts(const char *string)
1353{
1354 int x;
1355
1356 for (x = 0; x < AST_MAX_CONNECTS; ++x) {
1357 if (consoles[x].fd < 0) {
1358 continue;
1359 }
1360 fdprint(consoles[x].p[1], string);
1361 }
1362}
1363
1364/*!
1365 * \brief write the string to the root console, and all attached
1366 * network console clients
1367 */
1368void ast_console_puts(const char *string)
1369{
1370 /* Send to the root console */
1371 fputs(string, stdout);
1372 fflush(stdout);
1373
1374 /* Send to any network console clients */
1375 ast_network_puts(string);
1376}
1377
1378static pthread_t lthread;
1379
1380/*!
1381 * \brief read() function supporting the reception of user credentials.
1382 *
1383 * \param fd Socket file descriptor.
1384 * \param buffer Receive buffer.
1385 * \param size 'buffer' size.
1386 * \param con Console structure to set received credentials
1387 * \retval -1 on error
1388 * \retval the number of bytes received on success.
1389 */
1390static int read_credentials(int fd, char *buffer, size_t size, struct console *con)
1391{
1392#if defined(SO_PEERCRED)
1393#ifdef HAVE_STRUCT_SOCKPEERCRED_UID
1394#define HAVE_STRUCT_UCRED_UID
1395 struct sockpeercred cred;
1396#else
1397 struct ucred cred;
1398#endif
1399 socklen_t len = sizeof(cred);
1400#endif
1401#if defined(HAVE_GETPEEREID)
1402 uid_t uid;
1403 gid_t gid;
1404#else
1405 int uid, gid;
1406#endif
1407 int result;
1408
1409 result = read(fd, buffer, size);
1410 if (result < 0) {
1411 return result;
1412 }
1413
1414#if defined(SO_PEERCRED) && (defined(HAVE_STRUCT_UCRED_UID) || defined(HAVE_STRUCT_UCRED_CR_UID))
1415 if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &cred, &len)) {
1416 return result;
1417 }
1418#if defined(HAVE_STRUCT_UCRED_UID)
1419 uid = cred.uid;
1420 gid = cred.gid;
1421#else /* defined(HAVE_STRUCT_UCRED_CR_UID) */
1422 uid = cred.cr_uid;
1423 gid = cred.cr_gid;
1424#endif /* defined(HAVE_STRUCT_UCRED_UID) */
1425
1426#elif defined(HAVE_GETPEEREID)
1427 if (getpeereid(fd, &uid, &gid)) {
1428 return result;
1429 }
1430#else
1431 return result;
1432#endif
1433 con->uid = uid;
1434 con->gid = gid;
1435
1436 return result;
1437}
1438
1439/* This is the thread running the remote console on the main process. */
1440static void *netconsole(void *vconsole)
1441{
1442 struct console *con = vconsole;
1443 char hostname[MAXHOSTNAMELEN] = "";
1444 char inbuf[512];
1445 char outbuf[512];
1446 const char * const end_buf = inbuf + sizeof(inbuf);
1447 char *start_read = inbuf;
1448 int res;
1449 struct pollfd fds[2];
1450
1451 if (gethostname(hostname, sizeof(hostname)-1))
1452 ast_copy_string(hostname, "<Unknown>", sizeof(hostname));
1453 snprintf(outbuf, sizeof(outbuf), "%s/%ld/%s\n", hostname, (long)ast_mainpid, ast_get_version());
1454 fdprint(con->fd, outbuf);
1456 for (;;) {
1457 fds[0].fd = con->fd;
1458 fds[0].events = POLLIN;
1459 fds[0].revents = 0;
1460 fds[1].fd = con->p[0];
1461 fds[1].events = POLLIN;
1462 fds[1].revents = 0;
1463
1464 res = ast_poll(fds, 2, -1);
1465 if (res < 0) {
1466 if (errno != EINTR)
1467 ast_log(LOG_WARNING, "poll returned < 0: %s\n", strerror(errno));
1468 continue;
1469 }
1470 if (fds[0].revents) {
1471 int cmds_read, bytes_read;
1472 if ((bytes_read = read_credentials(con->fd, start_read, end_buf - start_read, con)) < 1) {
1473 break;
1474 }
1475 /* XXX This will only work if it is the first command, and I'm not sure fixing it is worth the effort. */
1476 if (strncmp(inbuf, "cli quit after ", 15) == 0) {
1477 ast_cli_command_multiple_full(con->uid, con->gid, con->fd, bytes_read - 15, inbuf + 15);
1478 break;
1479 }
1480 /* ast_cli_command_multiple_full will only process individual commands terminated by a
1481 * NULL and not trailing partial commands. */
1482 if (!(cmds_read = ast_cli_command_multiple_full(con->uid, con->gid, con->fd, bytes_read + start_read - inbuf, inbuf))) {
1483 /* No commands were read. We either have a short read on the first command
1484 * with space left, or a command that is too long */
1485 if (start_read + bytes_read < end_buf) {
1486 start_read += bytes_read;
1487 } else {
1488 ast_log(LOG_ERROR, "Command too long! Skipping\n");
1489 start_read = inbuf;
1490 }
1491 continue;
1492 }
1493 if (start_read[bytes_read - 1] == '\0') {
1494 /* The read ended on a command boundary, start reading again at the head of inbuf */
1495 start_read = inbuf;
1496 continue;
1497 }
1498 /* If we get this far, we have left over characters that have not been processed.
1499 * Advance to the character after the last command read by ast_cli_command_multiple_full.
1500 * We are guaranteed to have at least cmds_read NULLs */
1501 while (cmds_read-- && (start_read = strchr(start_read, '\0'))) {
1502 start_read++;
1503 }
1504 memmove(inbuf, start_read, end_buf - start_read);
1505 start_read = end_buf - start_read + inbuf;
1506 }
1507 if (fds[1].revents) {
1508 res = read_credentials(con->p[0], outbuf, sizeof(outbuf), con);
1509 if (res < 1) {
1510 ast_log(LOG_ERROR, "read returned %d\n", res);
1511 break;
1512 }
1513 res = write(con->fd, outbuf, res);
1514 if (res < 1)
1515 break;
1516 }
1517 }
1519 if (!ast_opt_hide_connect) {
1520 ast_verb(3, "Remote UNIX connection disconnected\n");
1521 }
1522 close(con->fd);
1523 close(con->p[0]);
1524 close(con->p[1]);
1525 con->fd = -1;
1526
1527 return NULL;
1528}
1529
1530static void *listener(void *unused)
1531{
1532 struct sockaddr_un sunaddr;
1533 int s;
1534 socklen_t len;
1535 int x;
1536 int poll_result;
1537 struct pollfd fds[1];
1538
1539 for (;;) {
1540 if (ast_socket < 0) {
1541 return NULL;
1542 }
1543 fds[0].fd = ast_socket;
1544 fds[0].events = POLLIN;
1545 poll_result = ast_poll(fds, 1, -1);
1546 pthread_testcancel();
1547 if (poll_result < 0) {
1548 if (errno != EINTR) {
1549 ast_log(LOG_WARNING, "poll returned error: %s\n", strerror(errno));
1550 }
1551 continue;
1552 }
1553 len = sizeof(sunaddr);
1554 s = accept(ast_socket, (struct sockaddr *)&sunaddr, &len);
1555 if (s < 0) {
1556 if (errno != EINTR)
1557 ast_log(LOG_WARNING, "Accept returned %d: %s\n", s, strerror(errno));
1558 } else {
1559#if defined(SO_PASSCRED)
1560 int sckopt = 1;
1561 /* turn on socket credentials passing. */
1562 if (setsockopt(s, SOL_SOCKET, SO_PASSCRED, &sckopt, sizeof(sckopt)) < 0) {
1563 ast_log(LOG_WARNING, "Unable to turn on socket credentials passing\n");
1564 close(s);
1565 } else
1566#endif
1567 {
1568 for (x = 0; x < AST_MAX_CONNECTS; x++) {
1569 if (consoles[x].fd >= 0) {
1570 continue;
1571 }
1572 if (socketpair(AF_LOCAL, SOCK_STREAM, 0, consoles[x].p)) {
1573 ast_log(LOG_ERROR, "Unable to create pipe: %s\n", strerror(errno));
1574 fdprint(s, "Server failed to create pipe\n");
1575 close(s);
1576 break;
1577 }
1578 ast_fd_set_flags(consoles[x].p[1], O_NONBLOCK);
1579 consoles[x].mute = 1; /* Default is muted, we will un-mute if necessary */
1580 /* Default uid and gid to -2, so then in cli.c/cli_has_permissions() we will be able
1581 to know if the user didn't send the credentials. */
1582 consoles[x].uid = -2;
1583 consoles[x].gid = -2;
1584 /* Server default of remote console verbosity level is OFF. */
1585 consoles[x].option_verbose = 0;
1586 consoles[x].fd = s;
1588 consoles[x].fd = -1;
1589 ast_log(LOG_ERROR, "Unable to spawn thread to handle connection: %s\n", strerror(errno));
1590 close(consoles[x].p[0]);
1591 close(consoles[x].p[1]);
1592 fdprint(s, "Server failed to spawn thread\n");
1593 close(s);
1594 }
1595 break;
1596 }
1597 if (x >= AST_MAX_CONNECTS) {
1598 fdprint(s, "No more connections allowed\n");
1599 ast_log(LOG_WARNING, "No more connections allowed\n");
1600 close(s);
1601 } else if ((consoles[x].fd > -1) && (!ast_opt_hide_connect)) {
1602 ast_verb(3, "Remote UNIX connection\n");
1603 }
1604 }
1605 }
1606 }
1607 return NULL;
1608}
1609
1610static int ast_makesocket(void)
1611{
1612 struct sockaddr_un sunaddr;
1613 int res;
1614 int x;
1615 uid_t uid = -1;
1616 gid_t gid = -1;
1617
1618 for (x = 0; x < AST_MAX_CONNECTS; x++) {
1619 consoles[x].fd = -1;
1620 }
1621
1622 if (ast_socket_is_sd) {
1624
1625 goto start_lthread;
1626 }
1627
1628 unlink(ast_config_AST_SOCKET);
1629 ast_socket = socket(PF_LOCAL, SOCK_STREAM, 0);
1630 if (ast_socket < 0) {
1631 ast_log(LOG_WARNING, "Unable to create control socket: %s\n", strerror(errno));
1632 return -1;
1633 }
1634 memset(&sunaddr, 0, sizeof(sunaddr));
1635 sunaddr.sun_family = AF_LOCAL;
1636 ast_copy_string(sunaddr.sun_path, ast_config_AST_SOCKET, sizeof(sunaddr.sun_path));
1637 res = bind(ast_socket, (struct sockaddr *)&sunaddr, sizeof(sunaddr));
1638 if (res) {
1639 ast_log(LOG_WARNING, "Unable to bind socket to %s: %s\n", ast_config_AST_SOCKET, strerror(errno));
1640 close(ast_socket);
1641 ast_socket = -1;
1642 return -1;
1643 }
1644 res = listen(ast_socket, 2);
1645 if (res < 0) {
1646 ast_log(LOG_WARNING, "Unable to listen on socket %s: %s\n", ast_config_AST_SOCKET, strerror(errno));
1647 close(ast_socket);
1648 ast_socket = -1;
1649 return -1;
1650 }
1651
1652start_lthread:
1654 ast_log(LOG_WARNING, "Unable to create listener thread.\n");
1655 close(ast_socket);
1656 return -1;
1657 }
1658
1659 if (ast_socket_is_sd) {
1660 /* owner/group/permissions are set by systemd, we might not even have access
1661 * to socket file so leave it alone */
1662 return 0;
1663 }
1664
1666 struct passwd *pw;
1667 if ((pw = getpwnam(ast_config_AST_CTL_OWNER)) == NULL)
1668 ast_log(LOG_WARNING, "Unable to find uid of user %s\n", ast_config_AST_CTL_OWNER);
1669 else
1670 uid = pw->pw_uid;
1671 }
1672
1674 struct group *grp;
1675 if ((grp = getgrnam(ast_config_AST_CTL_GROUP)) == NULL)
1676 ast_log(LOG_WARNING, "Unable to find gid of group %s\n", ast_config_AST_CTL_GROUP);
1677 else
1678 gid = grp->gr_gid;
1679 }
1680
1681 if (chown(ast_config_AST_SOCKET, uid, gid) < 0)
1682 ast_log(LOG_WARNING, "Unable to change ownership of %s: %s\n", ast_config_AST_SOCKET, strerror(errno));
1683
1685 unsigned int p1;
1686 mode_t p;
1687 sscanf(ast_config_AST_CTL_PERMISSIONS, "%30o", &p1);
1688 p = p1;
1689 if ((chmod(ast_config_AST_SOCKET, p)) < 0)
1690 ast_log(LOG_WARNING, "Unable to change file permissions of %s: %s\n", ast_config_AST_SOCKET, strerror(errno));
1691 }
1692
1693 return 0;
1694}
1695
1696static int ast_tryconnect(void)
1697{
1698 struct sockaddr_un sunaddr;
1699 int res;
1700 ast_consock = socket(PF_LOCAL, SOCK_STREAM, 0);
1701 if (ast_consock < 0) {
1702 fprintf(stderr, "Unable to create socket: %s\n", strerror(errno));
1703 return 0;
1704 }
1705 memset(&sunaddr, 0, sizeof(sunaddr));
1706 sunaddr.sun_family = AF_LOCAL;
1707 ast_copy_string(sunaddr.sun_path, ast_config_AST_SOCKET, sizeof(sunaddr.sun_path));
1708 res = connect(ast_consock, (struct sockaddr *)&sunaddr, sizeof(sunaddr));
1709 if (res) {
1710 close(ast_consock);
1711 ast_consock = -1;
1712 return 0;
1713 } else
1714 return 1;
1715}
1716
1717/*! \brief Urgent handler
1718 *
1719 * Called by soft_hangup to interrupt the poll, read, or other
1720 * system call. We don't actually need to do anything though.
1721 * Remember: Cannot EVER ast_log from within a signal handler
1722 */
1723static void _urg_handler(int num)
1724{
1725 return;
1726}
1727
1728static struct sigaction urg_handler = {
1729 .sa_handler = _urg_handler,
1730};
1731
1732static void _hup_handler(int num)
1733{
1734 int save_errno = errno;
1735
1736 if (restartnow) {
1737 if (el) {
1738 el_end(el);
1739 }
1740 execvp(_argv[0], _argv);
1741 }
1742
1743 printf("Received HUP signal -- Reloading configs\n");
1744 sig_flags.need_reload = 1;
1746 fprintf(stderr, "hup_handler: write() failed: %s\n", strerror(errno));
1747 }
1748 errno = save_errno;
1749}
1750
1751static struct sigaction hup_handler = {
1752 .sa_handler = _hup_handler,
1753 .sa_flags = SA_RESTART,
1754};
1755
1756static void _child_handler(int sig)
1757{
1758 /* Must not ever ast_log or ast_verbose within signal handler */
1759 int n, status, save_errno = errno;
1760
1761 /*
1762 * Reap all dead children -- not just one
1763 */
1764 for (n = 0; waitpid(-1, &status, WNOHANG) > 0; n++)
1765 ;
1766 if (n == 0 && option_debug)
1767 printf("Huh? Child handler, but nobody there?\n");
1768 errno = save_errno;
1769}
1770
1771static struct sigaction child_handler = {
1772 .sa_handler = _child_handler,
1773 .sa_flags = SA_RESTART,
1774};
1775
1776/*! \brief Set an X-term or screen title */
1777static void set_title(char *text)
1778{
1779 if (getenv("TERM") && strstr(getenv("TERM"), "xterm"))
1780 fprintf(stdout, "\033]2;%s\007", text);
1781}
1782
1783static void set_icon(char *text)
1784{
1785 if (getenv("TERM") && strstr(getenv("TERM"), "xterm"))
1786 fprintf(stdout, "\033]1;%s\007", text);
1787}
1788
1789/*! \brief Check whether we were set to high(er) priority. */
1790static int has_priority(void)
1791{
1792 /* Neither of these calls should fail with these arguments. */
1793#ifdef __linux__
1794 /* For SCHED_OTHER, SCHED_BATCH and SCHED_IDLE, this will return
1795 * 0. For the realtime priorities SCHED_RR and SCHED_FIFO, it
1796 * will return something >= 1. */
1797 return sched_getscheduler(0);
1798#else
1799 /* getpriority() can return a value in -20..19 (or even -INF..20)
1800 * where negative numbers are high priority. We don't bother
1801 * checking errno. If the query fails and it returns -1, we'll
1802 * assume that we're running at high prio; a safe assumption
1803 * that will enable the resource starvation monitor (canary)
1804 * just in case. */
1805 return (getpriority(PRIO_PROCESS, 0) < 0);
1806#endif
1807}
1808
1809/*! \brief Set priority on all known threads. */
1810static int set_priority_all(int pri)
1811{
1812#if !defined(__linux__)
1813 /* The non-linux version updates the entire process prio. */
1814 return ast_set_priority(pri);
1815#elif defined(LOW_MEMORY)
1816 ast_log(LOG_WARNING, "Unable to enumerate all threads to update priority\n");
1817 return ast_set_priority(pri);
1818#else
1819 struct thread_list_t *cur;
1820 struct sched_param sched;
1821 char const *policy_str;
1822 int policy;
1823
1824 memset(&sched, 0, sizeof(sched));
1825 if (pri) {
1826 policy = SCHED_RR;
1827 policy_str = "realtime";
1828 sched.sched_priority = 10;
1829 } else {
1830 policy = SCHED_OTHER;
1831 policy_str = "regular";
1832 sched.sched_priority = 0;
1833 }
1834 if (sched_setscheduler(getpid(), policy, &sched)) {
1835 ast_log(LOG_WARNING, "Unable to set %s thread priority on main thread\n", policy_str);
1836 return -1;
1837 }
1838 ast_verb(1, "Setting %s thread priority on all threads\n", policy_str);
1840 AST_RWLIST_TRAVERSE(&thread_list, cur, list) {
1841 /* Don't care about the return value. It should work. */
1842 sched_setscheduler(cur->lwp, policy, &sched);
1843 }
1845 return 0;
1846#endif
1847}
1848
1849/*! \brief We set ourselves to a high priority, that we might pre-empt
1850 * everything else. If your PBX has heavy activity on it, this is a
1851 * good thing.
1852 */
1854{
1855 struct sched_param sched;
1856 memset(&sched, 0, sizeof(sched));
1857#ifdef __linux__
1858 if (pri) {
1859 sched.sched_priority = 10;
1860 if (sched_setscheduler(0, SCHED_RR, &sched)) {
1861 return -1;
1862 }
1863 } else {
1864 sched.sched_priority = 0;
1865 /* According to the manpage, these parameters can never fail. */
1866 sched_setscheduler(0, SCHED_OTHER, &sched);
1867 }
1868#else
1869 if (pri) {
1870 if (setpriority(PRIO_PROCESS, 0, -10) == -1) {
1871 ast_log(LOG_WARNING, "Unable to set high priority\n");
1872 return -1;
1873 } else
1874 ast_verb(1, "Set to high priority\n");
1875 } else {
1876 /* According to the manpage, these parameters can never fail. */
1877 setpriority(PRIO_PROCESS, 0, 0);
1878 }
1879#endif
1880 return 0;
1881}
1882
1884{
1886}
1887
1889{
1890 return shutdown_pending;
1891}
1892
1894{
1895 int shutdown_aborted = 0;
1896
1898 if (shuttingdown >= SHUTDOWN_FAST) {
1900 shutdown_pending = 0;
1901 shutdown_aborted = 1;
1902 }
1904 return shutdown_aborted;
1905}
1906
1907/*!
1908 * \internal
1909 * \brief Initiate system shutdown -- prevents new channels from being allocated.
1910 */
1919
1920static int can_safely_quit(shutdown_nice_t niceness, int restart);
1921static void really_quit(int num, shutdown_nice_t niceness, int restart);
1922
1923static void quit_handler(int num, shutdown_nice_t niceness, int restart)
1924{
1925 if (can_safely_quit(niceness, restart)) {
1926 really_quit(num, niceness, restart);
1927 /* No one gets here. */
1928 }
1929 /* It wasn't our time. */
1930}
1931
1932#define SHUTDOWN_TIMEOUT 15 /* Seconds */
1933
1934/*!
1935 * \internal
1936 * \brief Wait for all channels to die, a timeout, or shutdown cancelled.
1937 * \since 13.3.0
1938 *
1939 * \param niceness Shutdown niceness in effect
1940 * \param seconds Number of seconds to wait or less than zero if indefinitely.
1941 *
1942 * \retval zero if waiting wasn't necessary. We were idle.
1943 * \retval non-zero if we had to wait.
1944 */
1945static int wait_for_channels_to_die(shutdown_nice_t niceness, int seconds)
1946{
1947 time_t start;
1948 time_t now;
1949 int waited = 0;
1950
1951 time(&start);
1952 for (;;) {
1953 if (!ast_undestroyed_channels() || shuttingdown != niceness) {
1954 break;
1955 }
1956 if (seconds < 0) {
1957 /* No timeout so just poll every second */
1958 sleep(1);
1959 } else {
1960 time(&now);
1961
1962 /* Wait up to the given seconds for all channels to go away */
1963 if (seconds < (now - start)) {
1964 break;
1965 }
1966
1967 /* Sleep 1/10 of a second */
1968 usleep(100000);
1969 }
1970 waited = 1;
1971 }
1972 return waited;
1973}
1974
1975static int can_safely_quit(shutdown_nice_t niceness, int restart)
1976{
1977 int waited = 0;
1978
1979 /* Check if someone else isn't already doing this. */
1981 if (shuttingdown != NOT_SHUTTING_DOWN && niceness >= shuttingdown) {
1982 /* Already in progress and other request was less nice. */
1984 ast_verbose("Ignoring asterisk %s request, already in progress.\n", restart ? "restart" : "shutdown");
1985 return 0;
1986 }
1987 shuttingdown = niceness;
1989
1990 /* Try to get as many CDRs as possible submitted to the backend engines
1991 * (if in batch mode). really_quit happens to call it again when running
1992 * the atexit handlers, otherwise this would be a bit early. */
1994
1995 /*
1996 * Shutdown the message queue for the technology agnostic message channel.
1997 * This has to occur before we pause shutdown pending ast_undestroyed_channels.
1998 *
1999 * XXX This is not reversed on shutdown cancel.
2000 */
2002
2003 if (niceness == SHUTDOWN_NORMAL) {
2004 /* Begin shutdown routine, hanging up active channels */
2006 if (ast_opt_console) {
2007 ast_verb(0, "Beginning asterisk %s....\n", restart ? "restart" : "shutdown");
2008 }
2010 waited |= wait_for_channels_to_die(niceness, SHUTDOWN_TIMEOUT);
2011 } else if (niceness >= SHUTDOWN_NICE) {
2012 if (niceness != SHUTDOWN_REALLY_NICE) {
2014 }
2015 if (ast_opt_console) {
2016 ast_verb(0, "Waiting for inactivity to perform %s...\n", restart ? "restart" : "halt");
2017 }
2018 waited |= wait_for_channels_to_die(niceness, -1);
2019 }
2020
2021 /* Re-acquire lock and check if someone changed the niceness, in which
2022 * case someone else has taken over the shutdown.
2023 */
2025 if (shuttingdown != niceness) {
2027 ast_verb(0, "Asterisk %s cancelled.\n", restart ? "restart" : "shutdown");
2028 }
2030 return 0;
2031 }
2032
2033 if (niceness >= SHUTDOWN_REALLY_NICE) {
2036
2037 /* No more Mr. Nice guy. We are committed to shutting down now. */
2041
2043 }
2046
2047 if (niceness >= SHUTDOWN_NORMAL && waited) {
2048 /*
2049 * We were not idle. Give things in progress a chance to
2050 * recognize the final shutdown phase.
2051 */
2052 sleep(1);
2053 }
2054 return 1;
2055}
2056
2057/*! Called when exiting is certain. */
2058static void really_quit(int num, shutdown_nice_t niceness, int restart)
2059{
2060 int active_channels;
2061 struct ast_json *json_object = NULL;
2062 int run_cleanups = niceness >= SHUTDOWN_NICE;
2063
2064 if (run_cleanups && modules_shutdown()) {
2065 ast_verb(0, "Some modules could not be unloaded, switching to fast shutdown\n");
2066 run_cleanups = 0;
2067 }
2068
2069 if (!restart && !ast_opt_remote) {
2070 ast_sd_notify("STOPPING=1");
2071 }
2074 if (consolethread == AST_PTHREADT_NULL || consolethread == pthread_self()) {
2075 /* Only end if we are the consolethread, otherwise there's a race with that thread. */
2076 if (el != NULL) {
2077 el_end(el);
2078 }
2079 if (el_hist != NULL) {
2080 history_end(el_hist);
2081 }
2082 } else if (!restart) {
2083 sig_flags.need_el_end = 1;
2084 pthread_kill(consolethread, SIGURG);
2085 }
2086 }
2088 /* Don't publish messages if we're a remote console - we won't have all of the Stasis
2089 * topics or message types
2090 */
2091 if (!ast_opt_remote) {
2092 json_object = ast_json_pack("{s: s, s: s}",
2093 "Shutdown", active_channels ? "Uncleanly" : "Cleanly",
2094 "Restart", restart ? "True" : "False");
2095 ast_manager_publish_event("Shutdown", EVENT_FLAG_SYSTEM, json_object);
2096 ast_json_unref(json_object);
2097 json_object = NULL;
2098 }
2099 ast_verb(0, "Asterisk %s ending (%d).\n",
2100 active_channels ? "uncleanly" : "cleanly", num);
2101
2102 ast_verb(0, "Executing last minute cleanups\n");
2103 ast_run_atexits(run_cleanups);
2104
2105 ast_debug(1, "Asterisk ending (%d).\n", num);
2106 if (ast_socket > -1) {
2107 pthread_cancel(lthread);
2108 close(ast_socket);
2109 ast_socket = -1;
2110 if (!ast_socket_is_sd) {
2111 unlink(ast_config_AST_SOCKET);
2112 }
2113 pthread_kill(lthread, SIGURG);
2114 pthread_join(lthread, NULL);
2115 }
2116 if (ast_consock > -1)
2117 close(ast_consock);
2118 if (!ast_opt_remote)
2119 unlink(ast_config_AST_PID);
2121 printf("%s", term_quit());
2122 if (restart) {
2123 int i;
2124 ast_verb(0, "Preparing for Asterisk restart...\n");
2125 /* Mark all FD's for closing on exec */
2126 for (i = 3; i < 32768; i++) {
2127 fcntl(i, F_SETFD, FD_CLOEXEC);
2128 }
2129 ast_verb(0, "Asterisk is now restarting...\n");
2130 restartnow = 1;
2131
2132 /* close logger */
2133 close_logger();
2135
2136 /* If there is a consolethread running send it a SIGHUP
2137 so it can execvp, otherwise we can do it ourselves */
2138 if ((consolethread != AST_PTHREADT_NULL) && (consolethread != pthread_self())) {
2139 pthread_kill(consolethread, SIGHUP);
2140 /* Give the signal handler some time to complete */
2141 sleep(2);
2142 } else
2143 execvp(_argv[0], _argv);
2144
2145 } else {
2146 /* close logger */
2147 close_logger();
2149 }
2150
2151 exit(0);
2152}
2153
2154static void __quit_handler(int num)
2155{
2156 sig_flags.need_quit = 1;
2158 fprintf(stderr, "quit_handler: write() failed: %s\n", strerror(errno));
2159 }
2160 /* There is no need to restore the signal handler here, since the app
2161 * is going to exit */
2162}
2163
2164static void __remote_quit_handler(int num)
2165{
2166 sig_flags.need_quit = 1;
2167}
2168
2169static void set_header(char *outbuf, int maxout, char level)
2170{
2171 const char *cmp;
2172 char date[40];
2173
2174 switch (level) {
2175 case 0: cmp = NULL;
2176 break;
2177 case 1: cmp = VERBOSE_PREFIX_1;
2178 break;
2179 case 2: cmp = VERBOSE_PREFIX_2;
2180 break;
2181 case 3: cmp = VERBOSE_PREFIX_3;
2182 break;
2183 case 4: cmp = VERBOSE_PREFIX_4;
2184 break;
2185 case 5: cmp = VERBOSE_PREFIX_5;
2186 break;
2187 case 6: cmp = VERBOSE_PREFIX_6;
2188 break;
2189 case 7: cmp = VERBOSE_PREFIX_7;
2190 break;
2191 case 8: cmp = VERBOSE_PREFIX_8;
2192 break;
2193 case 9: cmp = VERBOSE_PREFIX_9;
2194 break;
2195 default: cmp = VERBOSE_PREFIX_10;
2196 break;
2197 }
2198
2199 if (ast_opt_timestamp) {
2200 struct ast_tm tm;
2201 struct timeval now = ast_tvnow();
2202 ast_localtime(&now, &tm, NULL);
2203 ast_strftime(date, sizeof(date), ast_logger_get_dateformat(), &tm);
2204 }
2205
2206 snprintf(outbuf, maxout, "%s%s%s%s%s%s",
2207 ast_opt_timestamp ? "[" : "",
2208 ast_opt_timestamp ? date : "",
2209 ast_opt_timestamp ? "] " : "",
2210 cmp ? ast_term_color(COLOR_GRAY, 0) : "",
2211 cmp ? cmp : "",
2212 cmp ? ast_term_reset() : "");
2213}
2214
2218
2219static int console_state_init(void *ptr)
2220{
2221 struct console_state_data *state = ptr;
2222 state->verbose_line_level = 0;
2223 return 0;
2224}
2225
2227
2228static int console_print(const char *s)
2229{
2230 struct console_state_data *state =
2231 ast_threadstorage_get(&console_state, sizeof(*state));
2232
2233 char prefix[80];
2234 const char *c;
2235 int num, res = 0;
2236 unsigned int newline;
2237
2238 do {
2239 if (VERBOSE_HASMAGIC(s)) {
2240
2241 /* always use the given line's level, otherwise
2242 we'll use the last line's level */
2243 state->verbose_line_level = VERBOSE_MAGIC2LEVEL(s);
2244
2245 /* move past magic */
2246 s++;
2247
2248 set_header(prefix, sizeof(prefix), state->verbose_line_level);
2249 } else {
2250 *prefix = '\0';
2251 }
2252 c = s;
2253
2254 /* for a given line separate on verbose magic, newline, and eol */
2255 if ((s = strchr(c, '\n'))) {
2256 ++s;
2257 newline = 1;
2258 } else {
2259 s = strchr(c, '\0');
2260 newline = 0;
2261 }
2262
2263 /* check if we should write this line after calculating begin/end
2264 so we process the case of a higher level line embedded within
2265 two lower level lines */
2266 if (state->verbose_line_level > option_verbose) {
2267 continue;
2268 }
2269
2270 if (!ast_strlen_zero(prefix)) {
2271 fputs(prefix, stdout);
2272 }
2273
2274 num = s - c;
2275 if (fwrite(c, sizeof(char), num, stdout) < num) {
2276 break;
2277 }
2278
2279 if (!res) {
2280 /* if at least some info has been written
2281 we'll want to return true */
2282 res = 1;
2283 }
2284 } while (*s);
2285
2286 if (newline) {
2287 /* if ending on a newline then reset last level to zero
2288 since what follows may be not be logging output */
2289 state->verbose_line_level = 0;
2290 }
2291
2292 if (res) {
2293 fflush(stdout);
2294 }
2295
2296 return res;
2297}
2298
2299static int ast_all_zeros(const char *s)
2300{
2301 while (*s) {
2302 if (*s > 32)
2303 return 0;
2304 s++;
2305 }
2306 return 1;
2307}
2308
2309/* This is the main console CLI command handler. Run by the main() thread. */
2310static void consolehandler(const char *s)
2311{
2312 printf("%s", term_end());
2313 fflush(stdout);
2314
2315 /* Called when readline data is available */
2316 if (!ast_all_zeros(s))
2318 /* The real handler for bang */
2319 if (s[0] == '!') {
2320 if (s[1])
2321 ast_safe_system(s+1);
2322 else
2323 ast_safe_system(getenv("SHELL") ? getenv("SHELL") : "/bin/sh");
2324 } else
2325 ast_cli_command(STDOUT_FILENO, s);
2326}
2327
2328static int remoteconsolehandler(const char *s)
2329{
2330 int ret = 0;
2331
2332 /* Called when readline data is available */
2333 if (!ast_all_zeros(s))
2335
2336 while (isspace(*s)) {
2337 s++;
2338 }
2339
2340 /* The real handler for bang */
2341 if (s[0] == '!') {
2343 printf("Shell access is disabled on remote consoles\n");
2344 return 1;
2345 }
2346 if (s[1])
2347 ast_safe_system(s+1);
2348 else
2349 ast_safe_system(getenv("SHELL") ? getenv("SHELL") : "/bin/sh");
2350 ret = 1;
2351 } else if ((strncasecmp(s, "quit", 4) == 0 || strncasecmp(s, "exit", 4) == 0) &&
2352 (s[4] == '\0' || isspace(s[4]))) {
2354 ret = 1;
2355 }
2356
2357 return ret;
2358}
2359
2360static char *handle_version(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2361{
2362 switch (cmd) {
2363 case CLI_INIT:
2364 e->command = "core show version";
2365 e->usage =
2366 "Usage: core show version\n"
2367 " Shows Asterisk version information.\n";
2368 return NULL;
2369 case CLI_GENERATE:
2370 return NULL;
2371 }
2372
2373 if (a->argc != 3)
2374 return CLI_SHOWUSAGE;
2375 ast_cli(a->fd, "Asterisk %s built by %s @ %s on a %s running %s on %s\n",
2378 return CLI_SUCCESS;
2379}
2380
2381static char *handle_stop_now(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2382{
2383 switch (cmd) {
2384 case CLI_INIT:
2385 e->command = "core stop now";
2386 e->usage =
2387 "Usage: core stop now\n"
2388 " Shuts down a running Asterisk immediately, hanging up all active calls .\n";
2390 return NULL;
2391 case CLI_GENERATE:
2392 return NULL;
2393 }
2394
2395 if (a->argc != e->args)
2396 return CLI_SHOWUSAGE;
2397 quit_handler(0, SHUTDOWN_NORMAL, 0 /* not restart */);
2398 return CLI_SUCCESS;
2399}
2400
2401static char *handle_stop_gracefully(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2402{
2403 switch (cmd) {
2404 case CLI_INIT:
2405 e->command = "core stop gracefully";
2406 e->usage =
2407 "Usage: core stop gracefully\n"
2408 " Causes Asterisk to not accept new calls, and exit when all\n"
2409 " active calls have terminated normally.\n";
2411 return NULL;
2412 case CLI_GENERATE:
2413 return NULL;
2414 }
2415
2416 if (a->argc != e->args)
2417 return CLI_SHOWUSAGE;
2418 quit_handler(0, SHUTDOWN_NICE, 0 /* no restart */);
2419 return CLI_SUCCESS;
2420}
2421
2422static char *handle_stop_when_convenient(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2423{
2424 switch (cmd) {
2425 case CLI_INIT:
2426 e->command = "core stop when convenient";
2427 e->usage =
2428 "Usage: core stop when convenient\n"
2429 " Causes Asterisk to perform a shutdown when all active calls have ended.\n";
2431 return NULL;
2432 case CLI_GENERATE:
2433 return NULL;
2434 }
2435
2436 if (a->argc != e->args)
2437 return CLI_SHOWUSAGE;
2438 ast_cli(a->fd, "Waiting for inactivity to perform halt\n");
2439 quit_handler(0, SHUTDOWN_REALLY_NICE, 0 /* don't restart */);
2440 return CLI_SUCCESS;
2441}
2442
2443static char *handle_restart_now(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2444{
2445 switch (cmd) {
2446 case CLI_INIT:
2447 e->command = "core restart now";
2448 e->usage =
2449 "Usage: core restart now\n"
2450 " Causes Asterisk to hangup all calls and exec() itself performing a cold\n"
2451 " restart.\n";
2453 return NULL;
2454 case CLI_GENERATE:
2455 return NULL;
2456 }
2457
2458 if (a->argc != e->args)
2459 return CLI_SHOWUSAGE;
2460 quit_handler(0, SHUTDOWN_NORMAL, 1 /* restart */);
2461 return CLI_SUCCESS;
2462}
2463
2464static char *handle_restart_gracefully(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2465{
2466 switch (cmd) {
2467 case CLI_INIT:
2468 e->command = "core restart gracefully";
2469 e->usage =
2470 "Usage: core restart gracefully\n"
2471 " Causes Asterisk to stop accepting new calls and exec() itself performing a cold\n"
2472 " restart when all active calls have ended.\n";
2474 return NULL;
2475 case CLI_GENERATE:
2476 return NULL;
2477 }
2478
2479 if (a->argc != e->args)
2480 return CLI_SHOWUSAGE;
2481 quit_handler(0, SHUTDOWN_NICE, 1 /* restart */);
2482 return CLI_SUCCESS;
2483}
2484
2485static char *handle_restart_when_convenient(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2486{
2487 switch (cmd) {
2488 case CLI_INIT:
2489 e->command = "core restart when convenient";
2490 e->usage =
2491 "Usage: core restart when convenient\n"
2492 " Causes Asterisk to perform a cold restart when all active calls have ended.\n";
2494 return NULL;
2495 case CLI_GENERATE:
2496 return NULL;
2497 }
2498
2499 if (a->argc != e->args)
2500 return CLI_SHOWUSAGE;
2501 ast_cli(a->fd, "Waiting for inactivity to perform restart\n");
2502 quit_handler(0, SHUTDOWN_REALLY_NICE, 1 /* restart */);
2503 return CLI_SUCCESS;
2504}
2505
2506static char *handle_abort_shutdown(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2507{
2508 switch (cmd) {
2509 case CLI_INIT:
2510 e->command = "core abort shutdown";
2511 e->usage =
2512 "Usage: core abort shutdown\n"
2513 " Causes Asterisk to abort an executing shutdown or restart, and resume normal\n"
2514 " call operations.\n";
2516 return NULL;
2517 case CLI_GENERATE:
2518 return NULL;
2519 }
2520
2521 if (a->argc != e->args)
2522 return CLI_SHOWUSAGE;
2523
2525
2526 return CLI_SUCCESS;
2527}
2528
2529static char *handle_bang(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2530{
2531 switch (cmd) {
2532 case CLI_INIT:
2533 e->command = "!";
2534 e->usage =
2535 "Usage: !<command>\n"
2536 " Executes a given shell command\n";
2537 return NULL;
2538 case CLI_GENERATE:
2539 return NULL;
2540 }
2541
2542 return CLI_SUCCESS;
2543}
2544static const char warranty_lines[] = {
2545 "\n"
2546 " NO WARRANTY\n"
2547 "\n"
2548 "BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY\n"
2549 "FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN\n"
2550 "OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES\n"
2551 "PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED\n"
2552 "OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n"
2553 "MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS\n"
2554 "TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE\n"
2555 "PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,\n"
2556 "REPAIR OR CORRECTION.\n"
2557 "\n"
2558 "IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\n"
2559 "WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR\n"
2560 "REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,\n"
2561 "INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING\n"
2562 "OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED\n"
2563 "TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY\n"
2564 "YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER\n"
2565 "PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE\n"
2566 "POSSIBILITY OF SUCH DAMAGES.\n"
2567};
2568
2569static char *show_warranty(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2570{
2571 switch (cmd) {
2572 case CLI_INIT:
2573 e->command = "core show warranty";
2574 e->usage =
2575 "Usage: core show warranty\n"
2576 " Shows the warranty (if any) for this copy of Asterisk.\n";
2577 return NULL;
2578 case CLI_GENERATE:
2579 return NULL;
2580 }
2581
2582 ast_cli(a->fd, "%s", warranty_lines);
2583
2584 return CLI_SUCCESS;
2585}
2586
2587static const char license_lines[] = {
2588 "\n"
2589 "This program is free software; you can redistribute it and/or modify\n"
2590 "it under the terms of the GNU General Public License version 2 as\n"
2591 "published by the Free Software Foundation.\n"
2592 "\n"
2593 "This program also contains components licensed under other licenses.\n"
2594 "They include:\n"
2595 "\n"
2596 "This program is distributed in the hope that it will be useful,\n"
2597 "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
2598 "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
2599 "GNU General Public License for more details.\n"
2600 "\n"
2601 "You should have received a copy of the GNU General Public License\n"
2602 "along with this program; if not, write to the Free Software\n"
2603 "Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA\n"
2604};
2605
2606static char *show_license(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2607{
2608 switch (cmd) {
2609 case CLI_INIT:
2610 e->command = "core show license";
2611 e->usage =
2612 "Usage: core show license\n"
2613 " Shows the license(s) for this copy of Asterisk.\n";
2614 return NULL;
2615 case CLI_GENERATE:
2616 return NULL;
2617 }
2618
2619 ast_cli(a->fd, "%s", license_lines);
2620
2621 return CLI_SUCCESS;
2622}
2623
2624#define ASTERISK_PROMPT "*CLI> "
2625
2626/*!
2627 * \brief Shutdown Asterisk CLI commands.
2628 *
2629 * \note These CLI commands cannot be unregistered at shutdown
2630 * because one of them is likely the reason for the shutdown.
2631 * The CLI generates a warning if a command is in-use when it is
2632 * unregistered.
2633 */
2635 AST_CLI_DEFINE(handle_stop_now, "Shut down Asterisk immediately"),
2636 AST_CLI_DEFINE(handle_stop_gracefully, "Gracefully shut down Asterisk"),
2637 AST_CLI_DEFINE(handle_stop_when_convenient, "Shut down Asterisk at empty call volume"),
2638 AST_CLI_DEFINE(handle_restart_now, "Restart Asterisk immediately"),
2639 AST_CLI_DEFINE(handle_restart_gracefully, "Restart Asterisk gracefully"),
2640 AST_CLI_DEFINE(handle_restart_when_convenient, "Restart Asterisk at empty call volume"),
2641};
2642
2643static struct ast_cli_entry cli_asterisk[] = {
2644 AST_CLI_DEFINE(handle_abort_shutdown, "Cancel a running shutdown"),
2645 AST_CLI_DEFINE(show_warranty, "Show the warranty (if any) for this copy of Asterisk"),
2646 AST_CLI_DEFINE(show_license, "Show the license(s) for this copy of Asterisk"),
2647 AST_CLI_DEFINE(handle_version, "Display version info"),
2648 AST_CLI_DEFINE(handle_bang, "Execute a shell command"),
2649#if !defined(LOW_MEMORY)
2650 AST_CLI_DEFINE(handle_show_threads, "Show running threads"),
2651#if defined(HAVE_SYSINFO) || defined(HAVE_SYSCTL)
2652 AST_CLI_DEFINE(handle_show_sysinfo, "Show System Information"),
2653#endif
2654 AST_CLI_DEFINE(handle_show_profile, "Display profiling info"),
2655 AST_CLI_DEFINE(handle_show_settings, "Show some core settings"),
2656 AST_CLI_DEFINE(handle_clear_profile, "Clear profiling info"),
2657#endif /* ! LOW_MEMORY */
2658};
2659
2661{
2662 char buf[80];
2663
2664 /*
2665 * Tell the server asterisk instance about the verbose level
2666 * initially desired.
2667 */
2668 if (option_verbose) {
2669 snprintf(buf, sizeof(buf), "core set verbose atleast %d silent", option_verbose);
2671 }
2672
2673 if (option_debug) {
2674 snprintf(buf, sizeof(buf), "core set debug atleast %d", option_debug);
2676 }
2677
2678 /* Leave verbose filtering to the server. */
2679 option_verbose = INT_MAX;
2680
2681 if (!ast_opt_mute) {
2682 fdsend(ast_consock, "logger mute silent");
2683 } else {
2684 printf("log and verbose output currently muted ('logger mute' to unmute)\n");
2685 }
2686}
2687
2688#ifdef HAVE_LIBEDIT_IS_UNICODE
2689#define CHAR_T_LIBEDIT wchar_t
2690#define CHAR_TO_LIBEDIT(c) btowc(c)
2691#else
2692#define CHAR_T_LIBEDIT char
2693#define CHAR_TO_LIBEDIT(c) c
2694#endif
2695
2696static int ast_el_read_char(EditLine *editline, CHAR_T_LIBEDIT *cp)
2697{
2698 int num_read = 0;
2699 int lastpos = 0;
2700 struct pollfd fds[2];
2701 int res;
2702 int max;
2703#define EL_BUF_SIZE 512
2704 char buf[EL_BUF_SIZE];
2705
2706 for (;;) {
2707 max = 1;
2708 fds[0].fd = ast_consock;
2709 fds[0].events = POLLIN;
2710 if (!ast_opt_exec) {
2711 fds[1].fd = STDIN_FILENO;
2712 fds[1].events = POLLIN;
2713 max++;
2714 }
2715 res = ast_poll(fds, max, -1);
2716 if (res < 0) {
2717 if (sig_flags.need_quit || sig_flags.need_quit_handler || sig_flags.need_el_end) {
2718 break;
2719 }
2720 if (errno == EINTR) {
2721 continue;
2722 }
2723 fprintf(stderr, "poll failed: %s\n", strerror(errno));
2724 break;
2725 }
2726
2727 if (!ast_opt_exec && fds[1].revents) {
2728#ifdef HAVE_LIBEDIT_IS_UNICODE
2729 num_read = editline_read_char(editline, cp);
2730 if (num_read < 1) {
2731 break;
2732 }
2733#else
2734 char c = '\0';
2735
2736 num_read = read(STDIN_FILENO, &c, 1);
2737 if (num_read < 1) {
2738 break;
2739 }
2740
2741 *cp = CHAR_TO_LIBEDIT(c);
2742
2743#endif
2744 return num_read;
2745 }
2746
2747 if (fds[0].revents) {
2748 res = read(ast_consock, buf, sizeof(buf) - 1);
2749 /* if the remote side disappears exit */
2750 if (res < 1) {
2751 fprintf(stderr, "\nDisconnected from Asterisk server\n");
2752 if (!ast_opt_reconnect) {
2754 } else {
2755 int tries;
2756 int reconnects_per_second = 20;
2757
2758 fprintf(stderr, "Attempting to reconnect for 30 seconds\n");
2759 for (tries = 0; tries < 30 * reconnects_per_second; tries++) {
2760 if (ast_tryconnect()) {
2761 fprintf(stderr, "Reconnect succeeded after %.3f seconds\n", 1.0 / reconnects_per_second * tries);
2762 printf("%s", term_quit());
2765 break;
2766 }
2767
2768 usleep(1000000 / reconnects_per_second);
2769 }
2770 if (tries >= 30 * reconnects_per_second) {
2771 fprintf(stderr, "Failed to reconnect for 30 seconds. Quitting.\n");
2773 }
2774 }
2775 continue;
2776 }
2777
2778 buf[res] = '\0';
2779
2780 /* Write over the CLI prompt */
2781 if (!ast_opt_exec && !lastpos) {
2782 if (write(STDOUT_FILENO, "\r␛[0K", 5) < 0) {
2783 }
2784 }
2785
2787
2788 if ((res < EL_BUF_SIZE - 1) && ((buf[res-1] == '\n') || (res >= 2 && buf[res-2] == '\n'))) {
2789 *cp = CHAR_TO_LIBEDIT(CC_REFRESH);
2790
2791 return 1;
2792 }
2793 lastpos = 1;
2794 }
2795 }
2796
2797 *cp = CHAR_TO_LIBEDIT('\0');
2798
2799 return 0;
2800}
2801
2802static struct ast_str *prompt = NULL;
2803
2804static char *cli_prompt(EditLine *editline)
2805{
2806 char tmp[100];
2807 char *pfmt;
2808 int color_used = 0;
2809 static int cli_prompt_changes = 0;
2810 struct passwd *pw;
2811 struct group *gr;
2812
2813 if (prompt == NULL) {
2814 prompt = ast_str_create(100);
2815 } else if (!cli_prompt_changes) {
2816 return ast_str_buffer(prompt);
2817 } else {
2819 }
2820
2821 if ((pfmt = getenv("ASTERISK_PROMPT"))) {
2822 char *t = pfmt;
2823 struct timeval ts = ast_tvnow();
2824 while (*t != '\0') {
2825 if (*t == '%') {
2826 char hostname[MAXHOSTNAMELEN] = "";
2827 int i, which;
2828 struct ast_tm tm = { 0, };
2829 int fgcolor = COLOR_WHITE, bgcolor = COLOR_BLACK;
2830
2831 t++;
2832 switch (*t) {
2833 case 'C': /* color */
2834 t++;
2835 if (sscanf(t, "%30d;%30d%n", &fgcolor, &bgcolor, &i) == 2) {
2836 ast_term_color_code(&prompt, fgcolor, bgcolor);
2837 t += i - 1;
2838 } else if (sscanf(t, "%30d%n", &fgcolor, &i) == 1) {
2839 ast_term_color_code(&prompt, fgcolor, 0);
2840 t += i - 1;
2841 }
2842
2843 /* If the color has been reset correctly, then there's no need to reset it later */
2844 color_used = ((fgcolor == COLOR_WHITE) && (bgcolor == COLOR_BLACK)) ? 0 : 1;
2845 break;
2846 case 'd': /* date */
2847 if (ast_localtime(&ts, &tm, NULL)) {
2848 ast_strftime(tmp, sizeof(tmp), "%Y-%m-%d", &tm);
2849 ast_str_append(&prompt, 0, "%s", tmp);
2850 cli_prompt_changes++;
2851 }
2852 break;
2853 case 'g': /* group */
2854 if ((gr = getgrgid(getgid()))) {
2855 ast_str_append(&prompt, 0, "%s", gr->gr_name);
2856 }
2857 break;
2858 case 'h': /* hostname */
2859 if (!gethostname(hostname, sizeof(hostname) - 1)) {
2860 ast_str_append(&prompt, 0, "%s", hostname);
2861 } else {
2862 ast_str_append(&prompt, 0, "%s", "localhost");
2863 }
2864 break;
2865 case 'H': /* short hostname */
2866 if (!gethostname(hostname, sizeof(hostname) - 1)) {
2867 char *dotptr;
2868 if ((dotptr = strchr(hostname, '.'))) {
2869 *dotptr = '\0';
2870 }
2871 ast_str_append(&prompt, 0, "%s", hostname);
2872 } else {
2873 ast_str_append(&prompt, 0, "%s", "localhost");
2874 }
2875 break;
2876#ifdef HAVE_GETLOADAVG
2877 case 'l': /* load avg */
2878 t++;
2879 if (sscanf(t, "%30d", &which) == 1 && which > 0 && which <= 3) {
2880 double list[3];
2881 getloadavg(list, 3);
2882 ast_str_append(&prompt, 0, "%.2f", list[which - 1]);
2883 cli_prompt_changes++;
2884 }
2885 break;
2886#endif
2887 case 's': /* Asterisk system name (from asterisk.conf) */
2889 break;
2890 case 't': /* time */
2891 if (ast_localtime(&ts, &tm, NULL)) {
2892 ast_strftime(tmp, sizeof(tmp), "%H:%M:%S", &tm);
2893 ast_str_append(&prompt, 0, "%s", tmp);
2894 cli_prompt_changes++;
2895 }
2896 break;
2897 case 'u': /* username */
2898 if ((pw = getpwuid(getuid()))) {
2899 ast_str_append(&prompt, 0, "%s", pw->pw_name);
2900 }
2901 break;
2902 case '#': /* process console or remote? */
2903 ast_str_append(&prompt, 0, "%c", ast_opt_remote ? '>' : '#');
2904 break;
2905 case '%': /* literal % */
2906 ast_str_append(&prompt, 0, "%c", '%');
2907 break;
2908 case '\0': /* % is last character - prevent bug */
2909 t--;
2910 break;
2911 }
2912 } else {
2913 ast_str_append(&prompt, 0, "%c", *t);
2914 }
2915 t++;
2916 }
2917 if (color_used) {
2918 /* Force colors back to normal at end */
2920 }
2921 } else {
2922 ast_str_set(&prompt, 0, "%s%s",
2925 }
2926
2927 return ast_str_buffer(prompt);
2928}
2929
2931{
2932 char *retstr;
2933 struct ast_vector_string *vec = ast_calloc(1, sizeof(*vec));
2934
2935 if (!vec) {
2936 return NULL;
2937 }
2938
2939 while ((retstr = strsep(&buf, " "))) {
2940 if (!strcmp(retstr, AST_CLI_COMPLETE_EOF)) {
2941 break;
2942 }
2943
2944 retstr = ast_strdup(retstr);
2945 if (!retstr || AST_VECTOR_APPEND(vec, retstr)) {
2946 ast_free(retstr);
2947 goto vector_cleanup;
2948 }
2949 }
2950
2951 if (!AST_VECTOR_SIZE(vec)) {
2952 goto vector_cleanup;
2953 }
2954
2955 return vec;
2956
2957vector_cleanup:
2960
2961 return NULL;
2962}
2963
2964static void ast_cli_display_match_list(struct ast_vector_string *matches, int max)
2965{
2966 int idx = 1;
2967 /* find out how many entries can be put on one line, with two spaces between strings */
2968 int limit = ast_get_termcols(STDOUT_FILENO) / (max + 2);
2969
2970 if (limit == 0) {
2971 limit = 1;
2972 }
2973
2974 for (;;) {
2975 int numoutputline;
2976
2977 for (numoutputline = 0; numoutputline < limit && idx < AST_VECTOR_SIZE(matches); idx++) {
2978 numoutputline++;
2979 fprintf(stdout, "%-*s ", max, AST_VECTOR_GET(matches, idx));
2980 }
2981
2982 if (!numoutputline) {
2983 break;
2984 }
2985
2986 fprintf(stdout, "\n");
2987 }
2988}
2989
2990
2991static char *cli_complete(EditLine *editline, int ch)
2992{
2993 int len = 0;
2994 char *ptr;
2995 struct ast_vector_string *matches;
2996 int retval = CC_ERROR;
2997 char savechr;
2998 int res;
2999
3000 LineInfo *lf = (LineInfo *)el_line(editline);
3001
3002 savechr = *(char *)lf->cursor;
3003 *(char *)lf->cursor = '\0';
3004 ptr = (char *)lf->cursor;
3005 if (ptr) {
3006 while (ptr > lf->buffer) {
3007 if (isspace(*ptr)) {
3008 ptr++;
3009 break;
3010 }
3011 ptr--;
3012 }
3013 }
3014
3015 len = lf->cursor - ptr;
3016
3017 if (ast_opt_remote) {
3018#define CMD_MATCHESARRAY "_COMMAND MATCHESARRAY \"%s\" \"%s\""
3019 char *mbuf;
3020 char *new_mbuf;
3021 int mlen = 0;
3022 int maxmbuf = ast_asprintf(&mbuf, CMD_MATCHESARRAY, lf->buffer, ptr);
3023
3024 if (maxmbuf == -1) {
3025 *((char *) lf->cursor) = savechr;
3026
3027 return (char *)(CC_ERROR);
3028 }
3029
3030 fdsend(ast_consock, mbuf);
3031 res = 0;
3032 mlen = 0;
3033 mbuf[0] = '\0';
3034
3035 while (!strstr(mbuf, AST_CLI_COMPLETE_EOF) && res != -1) {
3036 if (mlen + 1024 > maxmbuf) {
3037 /* Expand buffer to the next 1024 byte increment plus a NULL terminator. */
3038 maxmbuf = mlen + 1024;
3039 new_mbuf = ast_realloc(mbuf, maxmbuf + 1);
3040 if (!new_mbuf) {
3041 ast_free(mbuf);
3042 *((char *) lf->cursor) = savechr;
3043
3044 return (char *)(CC_ERROR);
3045 }
3046 mbuf = new_mbuf;
3047 }
3048 /* Only read 1024 bytes at a time */
3049 res = read(ast_consock, mbuf + mlen, 1024);
3050 if (res > 0) {
3051 if (!strncmp(mbuf, "Usage:", 6)) {
3052 /*
3053 * Abort on malformed tab completes
3054 * If help (tab complete) follows certain
3055 * special characters, the main Asterisk process
3056 * provides usage for the internal tab complete
3057 * helper command that the remote console processes
3058 * use.
3059 * If this happens, the AST_CLI_COMPLETE_EOF sentinel
3060 * value never gets sent. As a result, we'll just block
3061 * forever if we don't handle this case.
3062 * If we get command usage on a tab complete, then
3063 * we know this scenario just happened and we should
3064 * just silently ignore and do nothing.
3065 */
3066 break;
3067 }
3068 mlen += res;
3069 mbuf[mlen] = '\0';
3070 }
3071 }
3072 mbuf[mlen] = '\0';
3073
3074 matches = ast_el_strtoarr(mbuf);
3075 ast_free(mbuf);
3076 } else {
3077 matches = ast_cli_completion_vector((char *)lf->buffer, ptr);
3078 }
3079
3080 if (matches) {
3081 int i;
3082 int maxlen, match_len;
3083 const char *best_match = AST_VECTOR_GET(matches, 0);
3084
3085 if (!ast_strlen_zero(best_match)) {
3086 el_deletestr(editline, (int) len);
3087 el_insertstr(editline, best_match);
3088 retval = CC_REFRESH;
3089 }
3090
3091 if (AST_VECTOR_SIZE(matches) == 2) {
3092 /* Found an exact match */
3093 el_insertstr(editline, " ");
3094 retval = CC_REFRESH;
3095 } else {
3096 /* Must be more than one match */
3097 for (i = 1, maxlen = 0; i < AST_VECTOR_SIZE(matches); i++) {
3098 match_len = strlen(AST_VECTOR_GET(matches, i));
3099 if (match_len > maxlen) {
3100 maxlen = match_len;
3101 }
3102 }
3103
3104 fprintf(stdout, "\n");
3105 ast_cli_display_match_list(matches, maxlen);
3106 retval = CC_REDISPLAY;
3107 }
3109 AST_VECTOR_PTR_FREE(matches);
3110 }
3111
3112 *((char *) lf->cursor) = savechr;
3113
3114 return (char *)(long)retval;
3115}
3116
3117static int ast_el_initialize(void)
3118{
3119 HistEvent ev;
3120 char *editor, *editrc = getenv("EDITRC");
3121
3122 if (!(editor = getenv("AST_EDITMODE"))) {
3123 if (!(editor = getenv("AST_EDITOR"))) {
3124 editor = "emacs";
3125 }
3126 }
3127
3128 if (el != NULL)
3129 el_end(el);
3130 if (el_hist != NULL)
3131 history_end(el_hist);
3132
3133 el = el_init("asterisk", stdin, stdout, stderr);
3134 el_set(el, EL_PROMPT, cli_prompt);
3135
3136 el_set(el, EL_EDITMODE, 1);
3137 el_set(el, EL_EDITOR, editor);
3138 el_hist = history_init();
3139 if (!el || !el_hist)
3140 return -1;
3141
3142 /* setup history with 100 entries */
3143 history(el_hist, &ev, H_SETSIZE, 100);
3144
3145 el_set(el, EL_HIST, history, el_hist);
3146
3147 el_set(el, EL_ADDFN, "ed-complete", "Complete argument", cli_complete);
3148 /* Bind <tab> to command completion */
3149 el_set(el, EL_BIND, "^I", "ed-complete", NULL);
3150 /* Bind ? to command completion */
3151 el_set(el, EL_BIND, "?", "ed-complete", NULL);
3152 /* Bind ^D to redisplay */
3153 el_set(el, EL_BIND, "^D", "ed-redisplay", NULL);
3154 /* Bind Delete to delete char left */
3155 el_set(el, EL_BIND, "\\e[3~", "ed-delete-next-char", NULL);
3156 /* Bind Home and End to move to line start and end */
3157 el_set(el, EL_BIND, "\\e[1~", "ed-move-to-beg", NULL);
3158 el_set(el, EL_BIND, "\\e[4~", "ed-move-to-end", NULL);
3159 /* Bind C-left and C-right to move by word (not all terminals) */
3160 el_set(el, EL_BIND, "\\eOC", "vi-next-word", NULL);
3161 el_set(el, EL_BIND, "\\eOD", "vi-prev-word", NULL);
3162
3163 if (editrc) {
3164 el_source(el, editrc);
3165 }
3166
3167 return 0;
3168}
3169
3170#define MAX_HISTORY_COMMAND_LENGTH 256
3171
3172static int ast_el_add_history(const char *buf)
3173{
3174 HistEvent ev;
3175 char *stripped_buf;
3176
3177 if (el_hist == NULL || el == NULL) {
3179 }
3180 if (strlen(buf) > (MAX_HISTORY_COMMAND_LENGTH - 1)) {
3181 return 0;
3182 }
3183
3184 stripped_buf = ast_strip(ast_strdupa(buf));
3185
3186 /* HISTCONTROL=ignoredups */
3187 if (!history(el_hist, &ev, H_FIRST) && strcmp(ev.str, stripped_buf) == 0) {
3188 return 0;
3189 }
3190
3191 return history(el_hist, &ev, H_ENTER, stripped_buf);
3192}
3193
3194static int ast_el_write_history(const char *filename)
3195{
3196 HistEvent ev;
3197
3198 if (el_hist == NULL || el == NULL)
3200
3201 return (history(el_hist, &ev, H_SAVE, filename));
3202}
3203
3204static int ast_el_read_history(const char *filename)
3205{
3206 HistEvent ev;
3207
3208 if (el_hist == NULL || el == NULL) {
3210 }
3211
3212 if (access(filename, F_OK) == 0) {
3213 return history(el_hist, &ev, H_LOAD, filename);
3214 }
3215
3216 /* If the history file doesn't exist, failing to read it is unremarkable. */
3217 return 0;
3218}
3219
3220static void process_histfile(int (*readwrite)(const char *filename))
3221{
3222 struct passwd *pw = getpwuid(geteuid());
3223 int ret = 0;
3224 char *name = NULL;
3225
3226 if (!pw || ast_strlen_zero(pw->pw_dir)) {
3227 ast_log(LOG_ERROR, "Unable to determine home directory. History read/write disabled.\n");
3228 return;
3229 }
3230
3231 ret = ast_asprintf(&name, "%s/.asterisk_history", pw->pw_dir);
3232 if (ret <= 0) {
3233 ast_log(LOG_ERROR, "Unable to create history file name. History read/write disabled.\n");
3234 return;
3235 }
3236
3237 ret = readwrite(name);
3238 if (ret < 0) {
3239 ast_log(LOG_ERROR, "Unable to read or write history file '%s'\n", name);
3240 }
3241
3242 ast_free(name);
3243
3244 return;
3245}
3246
3251
3256
3257static void ast_remotecontrol(char *data)
3258{
3259 char buf[256] = "";
3260 int res;
3261 char *hostname;
3262 char *cpid;
3263 char *version;
3264 int pid;
3265 char *stringp = NULL;
3266
3267 char *ebuf;
3268 int num = 0;
3269
3270 ast_term_init();
3271 printf("%s", term_end());
3272 fflush(stdout);
3273
3274 memset(&sig_flags, 0, sizeof(sig_flags));
3275 signal(SIGINT, __remote_quit_handler);
3276 signal(SIGTERM, __remote_quit_handler);
3277 signal(SIGHUP, __remote_quit_handler);
3278
3279 if (read(ast_consock, buf, sizeof(buf) - 1) < 0) {
3280 ast_log(LOG_ERROR, "read() failed: %s\n", strerror(errno));
3281 return;
3282 }
3283 if (data) {
3284 char prefix[] = "cli quit after ";
3285 char *tmp = ast_alloca(strlen(data) + strlen(prefix) + 1);
3286 sprintf(tmp, "%s%s", prefix, data);
3287 if (write(ast_consock, tmp, strlen(tmp) + 1) < 0) {
3288 ast_log(LOG_ERROR, "write() failed: %s\n", strerror(errno));
3289 if (sig_flags.need_quit || sig_flags.need_quit_handler || sig_flags.need_el_end) {
3290 return;
3291 }
3292 }
3293 }
3294 stringp = buf;
3295 hostname = strsep(&stringp, "/");
3296 cpid = strsep(&stringp, "/");
3297 version = strsep(&stringp, "\n");
3298 if (!version)
3299 version = "<Version Unknown>";
3300 stringp = hostname;
3301 strsep(&stringp, ".");
3302 if (cpid)
3303 pid = atoi(cpid);
3304 else
3305 pid = -1;
3306 if (!data) {
3308 }
3309
3310 if (ast_opt_exec && data) { /* hack to print output then exit if asterisk -rx is used */
3311 int linefull = 1, prev_linefull = 1, prev_line_verbose = 0;
3312 struct pollfd fds;
3313 fds.fd = ast_consock;
3314 fds.events = POLLIN;
3315 fds.revents = 0;
3316
3317 while (ast_poll(&fds, 1, 60000) > 0) {
3318 char buffer[512] = "", *curline = buffer, *nextline;
3319 int not_written = 1;
3320
3321 if (sig_flags.need_quit || sig_flags.need_quit_handler || sig_flags.need_el_end) {
3322 break;
3323 }
3324
3325 if (read(ast_consock, buffer, sizeof(buffer) - 1) <= 0) {
3326 break;
3327 }
3328
3329 do {
3330 prev_linefull = linefull;
3331 if ((nextline = strchr(curline, '\n'))) {
3332 linefull = 1;
3333 nextline++;
3334 } else {
3335 linefull = 0;
3336 nextline = strchr(curline, '\0');
3337 }
3338
3339 /* Skip verbose lines */
3340 /* Prev line full? | Line is verbose | Last line verbose? | Print
3341 * TRUE | TRUE* | TRUE | FALSE
3342 * TRUE | TRUE* | FALSE | FALSE
3343 * TRUE | FALSE* | TRUE | TRUE
3344 * TRUE | FALSE* | FALSE | TRUE
3345 * FALSE | TRUE | TRUE* | FALSE
3346 * FALSE | TRUE | FALSE* | TRUE
3347 * FALSE | FALSE | TRUE* | FALSE
3348 * FALSE | FALSE | FALSE* | TRUE
3349 */
3350 if ((!prev_linefull && !prev_line_verbose) || (prev_linefull && *curline > 0)) {
3351 prev_line_verbose = 0;
3352 not_written = 0;
3353 if (write(STDOUT_FILENO, curline, nextline - curline) < 0) {
3354 ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
3355 }
3356 } else {
3357 prev_line_verbose = 1;
3358 }
3359 curline = nextline;
3360 } while (!ast_strlen_zero(curline));
3361
3362 /* No non-verbose output in 60 seconds. */
3363 if (not_written) {
3364 break;
3365 }
3366 }
3367 return;
3368 }
3369
3370 ast_verbose("Connected to Asterisk %s currently running on %s (pid = %d)\n", version, hostname, pid);
3372
3374 if (el_hist == NULL || el == NULL)
3377
3378 el_set(el, EL_GETCFN, ast_el_read_char);
3379
3380 for (;;) {
3381 ebuf = (char *)el_gets(el, &num);
3382
3383 if (sig_flags.need_quit || sig_flags.need_quit_handler || sig_flags.need_el_end) {
3384 break;
3385 }
3386
3387 if (!ebuf && write(1, "", 1) < 0)
3388 break;
3389
3390 if (!ast_strlen_zero(ebuf)) {
3391 if (ebuf[strlen(ebuf)-1] == '\n')
3392 ebuf[strlen(ebuf)-1] = '\0';
3393 if (!remoteconsolehandler(ebuf)) {
3394 res = write(ast_consock, ebuf, strlen(ebuf) + 1);
3395 if (res < 1) {
3396 ast_log(LOG_WARNING, "Unable to write: %s\n", strerror(errno));
3397 break;
3398 }
3399 }
3400 }
3401 }
3402 printf("\nDisconnected from Asterisk server\n");
3403}
3404
3405static int show_version(void)
3406{
3407 printf("Asterisk %s\n", ast_get_version());
3408 return 0;
3409}
3410
3411static int show_cli_help(void)
3412{
3413 printf("Asterisk %s, " COPYRIGHT_TAG "\n", ast_get_version());
3414 printf("Usage: asterisk [OPTIONS]\n");
3415 printf("Valid Options:\n");
3416 printf(" -V Display version number and exit\n");
3417 printf(" -C <configfile> Use an alternate configuration file\n");
3418 printf(" -G <group> Run as a group other than the caller\n");
3419 printf(" -U <user> Run as a user other than the caller\n");
3420 printf(" -c Provide console CLI\n");
3421 printf(" -d Increase debugging (multiple d's = more debugging)\n");
3422#if HAVE_WORKING_FORK
3423 printf(" -f Do not fork\n");
3424 printf(" -F Always fork\n");
3425#endif
3426 printf(" -g Dump core in case of a crash\n");
3427 printf(" -h This help screen\n");
3428 printf(" -i Initialize crypto keys at startup\n");
3429 printf(" -L <load> Limit the maximum load average before rejecting new calls\n");
3430 printf(" -M <value> Limit the maximum number of calls to the specified value\n");
3431 printf(" -m Mute debugging and console output on the console\n");
3432 printf(" -n Disable console colorization. Can be used only at startup.\n");
3433 printf(" -p Run as pseudo-realtime thread\n");
3434 printf(" -q Quiet mode (suppress output)\n");
3435 printf(" -r Connect to Asterisk on this machine\n");
3436 printf(" -R Same as -r, except attempt to reconnect if disconnected\n");
3437 printf(" -s <socket> Connect to Asterisk via socket <socket> (only valid with -r)\n");
3438 printf(" -t Record soundfiles in /var/tmp and move them where they\n");
3439 printf(" belong after they are done\n");
3440 printf(" -T Display the time in [Mmm dd hh:mm:ss] format for each line\n");
3441 printf(" of output to the CLI. Cannot be used with remote console mode.\n\n");
3442 printf(" -v Increase verbosity (multiple v's = more verbose)\n");
3443 printf(" -x <cmd> Execute command <cmd> (implies -r)\n");
3444 printf(" -X Enable use of #exec in asterisk.conf\n");
3445 printf(" -W Adjust terminal colors to compensate for a light background\n");
3446 printf("\n");
3447 return 0;
3448}
3449
3451{
3452 struct ast_config *cfg;
3453 struct ast_variable *v;
3454 struct ast_flags config_flags = { CONFIG_FLAG_NOCACHE | CONFIG_FLAG_NOREALTIME };
3455
3458
3459 cfg = ast_config_load2("pjproject.conf", "" /* core, can't reload */, config_flags);
3460 if (!cfg
3462 || cfg == CONFIG_STATUS_FILEINVALID) {
3463 /* We'll have to use defaults */
3464 return;
3465 }
3466
3467 for (v = ast_variable_browse(cfg, "startup"); v; v = v->next) {
3468 if (!strcasecmp(v->name, "log_level")) {
3469 if (sscanf(v->value, "%30d", &ast_option_pjproject_log_level) != 1) {
3471 } else if (ast_option_pjproject_log_level < 0) {
3475 }
3476 } else if (!strcasecmp(v->name, "cache_pools")) {
3478 }
3479 }
3480
3481 ast_config_destroy(cfg);
3482}
3483
3484static void *monitor_sig_flags(void *unused)
3485{
3486 for (;;) {
3487 struct pollfd p = { sig_alert_pipe[0], POLLIN, 0 };
3488
3489 ast_poll(&p, 1, -1);
3490 if (sig_flags.need_reload) {
3491 sig_flags.need_reload = 0;
3493 }
3494 if (sig_flags.need_quit) {
3495 sig_flags.need_quit = 0;
3496 if ((consolethread != AST_PTHREADT_NULL) && (consolethread != pthread_self())) {
3497 sig_flags.need_quit_handler = 1;
3498 pthread_kill(consolethread, SIGURG);
3499 } else {
3501 }
3502 }
3504 }
3505
3506 return NULL;
3507}
3508
3509static void *canary_thread(void *unused)
3510{
3511 struct stat canary_stat;
3512 struct timeval now;
3513
3514 /* Give the canary time to sing */
3515 sleep(120);
3516
3517 for (;;) {
3518 now = ast_tvnow();
3519 if (stat(canary_filename, &canary_stat) || now.tv_sec > canary_stat.st_mtime + 60) {
3521 "The canary is no more. He has ceased to be! "
3522 "He's expired and gone to meet his maker! "
3523 "He's a stiff! Bereft of life, he rests in peace. "
3524 "His metabolic processes are now history! He's off the twig! "
3525 "He's kicked the bucket. He's shuffled off his mortal coil, "
3526 "run down the curtain, and joined the bleeding choir invisible!! "
3527 "THIS is an EX-CANARY. (Reducing priority)\n");
3529 pthread_exit(NULL);
3530 }
3531
3532 /* Check the canary once a minute */
3533 sleep(60);
3534 }
3535}
3536
3537/* Used by libc's atexit(3) function */
3538static void canary_exit(void)
3539{
3540 if (canary_pid > 0) {
3541 int status;
3542 kill(canary_pid, SIGKILL);
3543 waitpid(canary_pid, &status, 0);
3544 }
3545}
3546
3552
3553static const char *startup_commands_phase_str[] = {
3554 "pre-init",
3555 "pre-module",
3556 "fully-booted,yes,true,y,t,1,on"
3557};
3558
3559/* Execute CLI commands on startup. Run by main() thread. */
3561{
3562 int fd;
3563 struct ast_config *cfg;
3564 struct ast_flags cfg_flags = { 0 };
3565 struct ast_variable *v;
3566
3567 if (!(cfg = ast_config_load2("cli.conf", "" /* core, can't reload */, cfg_flags)))
3568 return;
3570 return;
3571 }
3572
3573 fd = open("/dev/null", O_RDWR);
3574 if (fd < 0) {
3575 ast_config_destroy(cfg);
3576 return;
3577 }
3578
3579 for (v = ast_variable_browse(cfg, "startup_commands"); v; v = v->next) {
3582 ast_cli_command(fd, v->name);
3583 }
3584 }
3585
3586 close(fd);
3587 ast_config_destroy(cfg);
3588}
3589
3590static void env_init(void)
3591{
3592 setenv("AST_SYSTEMNAME", ast_config_AST_SYSTEM_NAME, 1);
3593 setenv("AST_BUILD_HOST", ast_build_hostname, 1);
3594 setenv("AST_BUILD_DATE", ast_build_date, 1);
3595 setenv("AST_BUILD_KERNEL", ast_build_kernel, 1);
3596 setenv("AST_BUILD_MACHINE", ast_build_machine, 1);
3597 setenv("AST_BUILD_OS", ast_build_os, 1);
3598 setenv("AST_BUILD_USER", ast_build_user, 1);
3599 setenv("AST_VERSION", ast_get_version(), 1);
3600}
3601
3602static void print_intro_message(const char *runuser, const char *rungroup)
3603{
3606 if (runuser) {
3607 ast_verbose("Running as user '%s'\n", runuser);
3608 }
3609 if (rungroup) {
3610 ast_verbose("Running under group '%s'\n", rungroup);
3611 }
3612 }
3613}
3614
3619
3620int main(int argc, char *argv[])
3621{
3622 int c;
3623 int x;
3624 int isroot = 1, rundir_exists = 0;
3625 RAII_VAR(char *, runuser, NULL, ast_free);
3626 RAII_VAR(char *, rungroup, NULL, ast_free);
3627 RAII_VAR(char *, xarg, NULL, ast_free);
3628 struct rlimit l;
3629 static const char *getopt_settings = "BC:cde:FfG:ghIiL:M:mnpqRrs:TtU:VvWXx:";
3630
3631 /* Try to explicitly set a UTF-8 locale. This is needed for
3632 libedit, as the LC_CTYPE category of the locale impacts the the
3633 multi-byte character functions provided by libc. If it fails,
3634 so be it. */
3635 if (!setlocale(LC_ALL, "C.UTF-8")) {
3636 ast_debug(1, "Tried to set locale to C.UTF-8 but it failed\n");
3637 }
3638
3639 /* Remember original args for restart */
3640 if (argc > ARRAY_LEN(_argv) - 1) {
3641 fprintf(stderr, "Truncating argument size to %d\n", (int)ARRAY_LEN(_argv) - 1);
3642 argc = ARRAY_LEN(_argv) - 1;
3643 }
3644 for (x = 0; x < argc; x++)
3645 _argv[x] = argv[x];
3646 _argv[x] = NULL;
3647
3648 if (geteuid() != 0)
3649 isroot = 0;
3650
3651 /* if the progname is rasterisk consider it a remote console */
3652 if (argv[0] && (strstr(argv[0], "rasterisk")) != NULL) {
3654 }
3655 ast_mainpid = getpid();
3656
3657 /* Process command-line options that affect asterisk.conf load. */
3658 while ((c = getopt(argc, argv, getopt_settings)) != -1) {
3659 switch (c) {
3660 case 'X':
3662 break;
3663 case 'C':
3664 set_asterisk_conf_path(optarg);
3665 break;
3666 case 'd':
3667 option_debug++;
3668 break;
3669 case 'h':
3670 show_cli_help();
3671 exit(0);
3672 case 'R':
3673 case 'r':
3674 case 'x':
3675 /* ast_opt_remote is checked during config load. This is only part of what
3676 * these options do, see the second loop for the rest of the actions. */
3678 break;
3679 case 'V':
3680 show_version();
3681 exit(0);
3682 case 'v':
3684 break;
3685 case '?':
3686 exit(1);
3687 }
3688 }
3689
3690 /* Initialize env so it is available if #exec is used in asterisk.conf. */
3691 env_init();
3692
3694
3695 /* Update env to include any systemname that was set. */
3696 env_init();
3697
3698 /*! \brief Check for options
3699 *
3700 * \todo Document these options
3701 */
3702 optind = 1;
3703 while ((c = getopt(argc, argv, getopt_settings)) != -1) {
3704 /*!\note Please keep the ordering here to alphabetical, capital letters
3705 * first. This will make it easier in the future to select unused
3706 * option flags for new features. */
3707 switch (c) {
3708 case 'B': /* Force black background */
3711 break;
3712 case 'X':
3713 /* The command-line -X option enables #exec for asterisk.conf only. */
3714 break;
3715 case 'C':
3716 /* already processed. */
3717 break;
3718 case 'c':
3720 break;
3721 case 'd':
3722 /* already processed. */
3723 break;
3724#if defined(HAVE_SYSINFO)
3725 case 'e':
3726 if ((sscanf(&optarg[1], "%30ld", &option_minmemfree) != 1) || (option_minmemfree < 0)) {
3728 }
3729 break;
3730#endif
3731#if HAVE_WORKING_FORK
3732 case 'F':
3734 break;
3735 case 'f':
3737 break;
3738#endif
3739 case 'G':
3740 rungroup = ast_strdup(optarg);
3741 break;
3742 case 'g':
3744 break;
3745 case 'h':
3746 /* already processed. */
3747 break;
3748 case 'I':
3749 fprintf(stderr,
3750 "NOTICE: The -I option is no longer needed.\n"
3751 " It will always be enabled if you have a timing module loaded.\n");
3752 break;
3753 case 'i':
3755 break;
3756 case 'L':
3757 if ((sscanf(optarg, "%30lf", &ast_option_maxload) != 1) || (ast_option_maxload < 0.0)) {
3758 ast_option_maxload = 0.0;
3759 }
3760 break;
3761 case 'M':
3762 if ((sscanf(optarg, "%30d", &ast_option_maxcalls) != 1) || (ast_option_maxcalls < 0)) {
3764 }
3765 break;
3766 case 'm':
3768 break;
3769 case 'n':
3771 break;
3772 case 'p':
3774 break;
3775 case 'q':
3777 break;
3778 case 'R':
3780 break;
3781 case 'r':
3783 break;
3784 case 's':
3785 if (ast_opt_remote) {
3786 set_socket_path(optarg);
3787 }
3788 break;
3789 case 'T':
3791 break;
3792 case 't':
3794 break;
3795 case 'U':
3796 runuser = ast_strdup(optarg);
3797 break;
3798 case 'V':
3799 case 'v':
3800 /* already processed. */
3801 break;
3802 case 'W': /* White background */
3805 break;
3806 case 'x':
3807 /* -r is implied by -x so set the flags -r sets as well. */
3809
3811 xarg = ast_strdup(optarg);
3812 break;
3813 case '?':
3814 /* already processed. */
3815 break;
3816 }
3817 }
3818
3819 if (ast_opt_remote) {
3820 int didwarn = 0;
3821 optind = 1;
3822
3823 /* Not all options can be used with remote console. Warn if they're used. */
3824 while ((c = getopt(argc, argv, getopt_settings)) != -1) {
3825 switch (c) {
3826 /* okay to run with remote console */
3827 case 'B': /* force black background */
3828 case 'C': /* set config path */
3829 case 'd': /* debug */
3830 case 'h': /* help */
3831 case 'I': /* obsolete timing option: warning already thrown if used */
3832 case 'L': /* max load */
3833 case 'M': /* max calls */
3834 case 'm': /* mute */
3835 /*! \note The q option is never used anywhere, only defined */
3836 case 'q': /* quiet */
3837 case 'R': /* reconnect */
3838 case 'r': /* remote */
3839 /*! \note Can ONLY be used with remote console */
3840 case 's': /* set socket path */
3841 case 'T': /* timestamp */
3842 case 'V': /* version */
3843 case 'v': /* verbose */
3844 case 'W': /* white background */
3845 case 'x': /* remote execute */
3846 case '?': /* ? */
3847 break;
3848 /* can only be run when Asterisk is starting */
3849 case 'X': /* enables #exec for asterisk.conf only. */
3850 case 'c': /* foreground console */
3851 case 'e': /* minimum memory free */
3852 case 'F': /* always fork */
3853 case 'f': /* no fork */
3854 case 'G': /* run group */
3855 case 'g': /* dump core */
3856 case 'i': /* init keys */
3857 case 'n': /* no color */
3858 case 'p': /* high priority */
3859 case 't': /* cache record files */
3860 case 'U': /* run user */
3861 fprintf(stderr, "'%c' option is not compatible with remote console mode and has no effect.\n", c);
3862 didwarn = 1;
3863 }
3864 }
3865 if (didwarn) {
3866 fprintf(stderr, "\n"); /* if any warnings print out, make them stand out */
3867 }
3868 }
3869
3870 /* For remote connections, change the name of the remote connection.
3871 * We do this for the benefit of init scripts (which need to know if/when
3872 * the main asterisk process has died yet). */
3873 if (ast_opt_remote) {
3874 strcpy(argv[0], "rasterisk");
3875 for (x = 1; x < argc; x++) {
3876 argv[x] = argv[0] + 10;
3877 }
3878 }
3879
3881 fprintf(stderr, "'alwaysfork' is not compatible with console or remote console mode; ignored\n");
3883 }
3884
3885 if (ast_opt_dump_core) {
3886 memset(&l, 0, sizeof(l));
3887 l.rlim_cur = RLIM_INFINITY;
3888 l.rlim_max = RLIM_INFINITY;
3889 if (setrlimit(RLIMIT_CORE, &l)) {
3890 fprintf(stderr, "Unable to disable core size resource limit: %s\n", strerror(errno));
3891 }
3892 }
3893
3894 if (getrlimit(RLIMIT_NOFILE, &l)) {
3895 fprintf(stderr, "Unable to check file descriptor limit: %s\n", strerror(errno));
3896 }
3897
3898#if !defined(CONFIGURE_RAN_AS_ROOT)
3899 /* Check if select(2) will run with more file descriptors */
3900 do {
3901 int fd, fd2;
3902 ast_fdset readers;
3903 struct timeval tv = { 0, };
3904
3905 if (l.rlim_cur <= FD_SETSIZE) {
3906 /* The limit of select()able FDs is irrelevant, because we'll never
3907 * open one that high. */
3908 break;
3909 }
3910
3911 if (!(fd = open("/dev/null", O_RDONLY))) {
3912 fprintf(stderr, "Cannot open a file descriptor at boot? %s\n", strerror(errno));
3913 break; /* XXX Should we exit() here? XXX */
3914 }
3915
3916 fd2 = ((l.rlim_cur > sizeof(readers) * 8) ? sizeof(readers) * 8 : l.rlim_cur) - 1;
3917 if (dup2(fd, fd2) < 0) {
3918 fprintf(stderr, "Cannot open maximum file descriptor %d at boot? %s\n", fd2, strerror(errno));
3919 close(fd);
3920 break;
3921 }
3922
3923 FD_ZERO(&readers);
3924 FD_SET(fd2, &readers);
3925 if (ast_select(fd2 + 1, &readers, NULL, NULL, &tv) < 0) {
3926 fprintf(stderr, "Maximum select()able file descriptor is %d\n", FD_SETSIZE);
3927 }
3928 ast_FD_SETSIZE = l.rlim_cur > ast_FDMAX ? ast_FDMAX : l.rlim_cur;
3929 close(fd);
3930 close(fd2);
3931 } while (0);
3932#elif defined(HAVE_VARIABLE_FDSET)
3933 ast_FD_SETSIZE = l.rlim_cur > ast_FDMAX ? ast_FDMAX : l.rlim_cur;
3934#endif /* !defined(CONFIGURE_RAN_AS_ROOT) */
3935
3936 if ((!rungroup) && !ast_strlen_zero(ast_config_AST_RUN_GROUP))
3938 if ((!runuser) && !ast_strlen_zero(ast_config_AST_RUN_USER))
3940
3941 /* Must install this signal handler up here to ensure that if the canary
3942 * fails to execute that it doesn't kill the Asterisk process.
3943 */
3944 sigaction(SIGCHLD, &child_handler, NULL);
3945
3946 /* It's common on some platforms to clear /var/run at boot. Create the
3947 * socket file directory before we drop privileges. */
3948 if (mkdir(ast_config_AST_RUN_DIR, 0755)) {
3949 if (errno == EEXIST) {
3950 rundir_exists = 1;
3951 } else {
3952 fprintf(stderr, "Unable to create socket file directory. Remote consoles will not be able to connect! (%s)\n", strerror(x));
3953 }
3954 }
3955
3956#ifndef __CYGWIN__
3957
3958 if (isroot) {
3960 }
3961
3962 if (isroot && rungroup) {
3963 struct group *gr;
3964 gr = getgrnam(rungroup);
3965 if (!gr) {
3966 fprintf(stderr, "No such group '%s'!\n", rungroup);
3967 exit(1);
3968 }
3969 if (!rundir_exists && chown(ast_config_AST_RUN_DIR, -1, gr->gr_gid)) {
3970 fprintf(stderr, "Unable to chgrp run directory to %d (%s)\n", (int) gr->gr_gid, rungroup);
3971 }
3972 if (setgid(gr->gr_gid)) {
3973 fprintf(stderr, "Unable to setgid to %d (%s)\n", (int)gr->gr_gid, rungroup);
3974 exit(1);
3975 }
3976 if (setgroups(0, NULL)) {
3977 fprintf(stderr, "Unable to drop unneeded groups\n");
3978 exit(1);
3979 }
3980 }
3981
3982 if (runuser && !ast_opt_remote) {
3983#ifdef HAVE_CAP
3984 int has_cap = 1;
3985#endif /* HAVE_CAP */
3986 struct passwd *pw;
3987 pw = getpwnam(runuser);
3988 if (!pw) {
3989 fprintf(stderr, "No such user '%s'!\n", runuser);
3990 exit(1);
3991 }
3992 if (chown(ast_config_AST_RUN_DIR, pw->pw_uid, -1)) {
3993 fprintf(stderr, "Unable to chown run directory to %d (%s)\n", (int) pw->pw_uid, runuser);
3994 }
3995#ifdef HAVE_CAP
3996 if (prctl(PR_SET_KEEPCAPS, 1, 0, 0, 0)) {
3997 ast_log(LOG_WARNING, "Unable to keep capabilities.\n");
3998 has_cap = 0;
3999 }
4000#endif /* HAVE_CAP */
4001 if (!isroot && pw->pw_uid != geteuid()) {
4002 fprintf(stderr, "Asterisk started as nonroot, but runuser '%s' requested.\n", runuser);
4003 exit(1);
4004 }
4005 if (!rungroup) {
4006 if (setgid(pw->pw_gid)) {
4007 fprintf(stderr, "Unable to setgid to %d!\n", (int)pw->pw_gid);
4008 exit(1);
4009 }
4010 if (isroot && initgroups(pw->pw_name, pw->pw_gid)) {
4011 fprintf(stderr, "Unable to init groups for '%s'\n", runuser);
4012 exit(1);
4013 }
4014 }
4015 if (setuid(pw->pw_uid)) {
4016 fprintf(stderr, "Unable to setuid to %d (%s)\n", (int)pw->pw_uid, runuser);
4017 exit(1);
4018 }
4019#ifdef HAVE_CAP
4020 if (has_cap) {
4021 cap_t cap;
4022
4023 cap = cap_from_text("cap_net_admin=eip");
4024
4025 if (cap_set_proc(cap)) {
4026 fprintf(stderr, "Unable to install capabilities.\n");
4027 }
4028 if (cap_free(cap)) {
4029 fprintf(stderr, "Unable to drop capabilities.\n");
4030 }
4031 }
4032#endif /* HAVE_CAP */
4033 }
4034
4035#endif /* __CYGWIN__ */
4036
4037#ifdef linux
4038 if (geteuid() && ast_opt_dump_core) {
4039 if (prctl(PR_SET_DUMPABLE, 1, 0, 0, 0) < 0) {
4040 fprintf(stderr, "Unable to set the process for core dumps after changing to a non-root user. %s\n", strerror(errno));
4041 }
4042 }
4043#endif
4044
4045 {
4046#if defined(HAVE_EACCESS) || defined(HAVE_EUIDACCESS)
4047 char dir[PATH_MAX];
4048 if (!getcwd(dir, sizeof(dir)) || eaccess(dir, R_OK | X_OK | F_OK)) {
4049 fprintf(stderr, "Unable to access the running directory (%s). Changing to '/' for compatibility.\n", strerror(errno));
4050 /* If we cannot access the CWD, then we couldn't dump core anyway,
4051 * so chdir("/") won't break anything. */
4052 if (chdir("/")) {
4053 /* chdir(/) should never fail, so this ends up being a no-op */
4054 fprintf(stderr, "chdir(\"/\") failed?!! %s\n", strerror(errno));
4055 }
4056 } else
4057#endif /* defined(HAVE_EACCESS) || defined(HAVE_EUIDACCESS) */
4059 /* Backgrounding, but no cores, so chdir won't break anything. */
4060 if (chdir("/")) {
4061 fprintf(stderr, "Unable to chdir(\"/\") ?!! %s\n", strerror(errno));
4062 }
4063 }
4064 }
4065
4066 /* Initial value of the maximum active system verbosity level. */
4068
4069 if (ast_sd_get_fd_un(SOCK_STREAM, ast_config_AST_SOCKET) > 0) {
4070 ast_socket_is_sd = 1;
4071 }
4072
4073 /* DO NOT perform check for existing daemon if systemd has CLI socket activation */
4074 if (!ast_socket_is_sd && ast_tryconnect()) {
4075 /* One is already running */
4076 if (ast_opt_remote) {
4078 if (ast_opt_exec) {
4079 ast_remotecontrol(xarg);
4081 exit(0);
4082 }
4083 ast_term_init();
4084 printf("%s", term_end());
4085 fflush(stdout);
4086
4087 print_intro_message(runuser, rungroup);
4088 printf("%s", term_quit());
4091 exit(0);
4092 } else {
4093 fprintf(stderr, "Asterisk already running on %s. Use 'asterisk -r' to connect.\n", ast_config_AST_SOCKET);
4094 printf("%s", term_quit());
4095 exit(1);
4096 }
4097 } else if (ast_opt_remote || ast_opt_exec) {
4098 fprintf(stderr, "Unable to connect to remote asterisk (does %s exist?)\n", ast_config_AST_SOCKET);
4099 printf("%s", term_quit());
4100 exit(1);
4101 }
4102
4103#ifdef HAVE_CAP
4104 child_cap = cap_from_text("cap_net_admin-eip");
4105#endif
4106 /* Not a remote console? Start the daemon. */
4107 asterisk_daemon(isroot, runuser, rungroup);
4108#ifdef HAS_CAP
4109 cap_free(child_cap);
4110#endif
4111 return 0;
4112}
4113
4114static inline void check_init(int init_result, const char *name)
4115{
4116 if (init_result) {
4118 ast_log(LOG_ERROR, "%s initialization failed. ASTERISK EXITING!\n%s", name, term_quit());
4119 } else {
4120 fprintf(stderr, "%s initialization failed. ASTERISK EXITING!\n%s", name, term_quit());
4121 }
4122 ast_run_atexits(0);
4123 exit(init_result == -2 ? 2 : 1);
4124 }
4125}
4126
4127static void asterisk_daemon(int isroot, const char *runuser, const char *rungroup)
4128{
4129 FILE *f;
4130 sigset_t sigs;
4131 int num;
4132 char *buf;
4133 char pbx_uuid[AST_UUID_STR_LEN];
4134
4135 /* Set time as soon as possible */
4137
4138 /* This needs to remain as high up in the initial start up as possible.
4139 * daemon causes a fork to occur, which has all sorts of unintended
4140 * consequences for things that interact with threads. This call *must*
4141 * occur before anything in Asterisk spawns or manipulates thread related
4142 * primitives. */
4143#if HAVE_WORKING_FORK
4145#ifndef HAVE_SBIN_LAUNCHD
4146 if (daemon(1, 0) < 0) {
4147 fprintf(stderr, "daemon() failed: %s\n", strerror(errno));
4148 } else {
4149 ast_mainpid = getpid();
4150 }
4151#else
4152 fprintf(stderr, "Mac OS X detected. Use 'launchctl load /Library/LaunchDaemon/org.asterisk.asterisk.plist'.\n");
4153#endif
4154 }
4155#endif
4156
4157 /* At this point everything has been forked successfully,
4158 * we have determined that we aren't attempting to connect to
4159 * an Asterisk instance, and that there isn't one already running. */
4161
4163
4164 /* Check whether high prio was successfully set by us or some
4165 * other incantation. */
4166 if (has_priority()) {
4168 } else {
4170 }
4171
4172 /* Spawning of astcanary must happen AFTER the call to daemon(3) */
4174 snprintf(canary_filename, sizeof(canary_filename), "%s/alt.asterisk.canary.tweet.tweet.tweet", ast_config_AST_RUN_DIR);
4175
4176 /* Don't let the canary child kill Asterisk, if it dies immediately */
4177 sigaction(SIGPIPE, &ignore_sig_handler, NULL);
4178
4179 canary_pid = fork();
4180 if (canary_pid == 0) {
4181 char canary_binary[PATH_MAX], ppid[12];
4182
4183 /* Reset signal handler */
4184 signal(SIGCHLD, SIG_DFL);
4185 signal(SIGPIPE, SIG_DFL);
4186
4189 snprintf(ppid, sizeof(ppid), "%d", (int) ast_mainpid);
4190
4191 /* Use the astcanary binary that we installed */
4192 snprintf(canary_binary, sizeof(canary_binary), "%s/astcanary", ast_config_AST_SBIN_DIR);
4193 execl(canary_binary, "astcanary", canary_filename, ppid, (char *)NULL);
4194
4195 /* Should never happen */
4196 _exit(1);
4197 } else if (canary_pid > 0) {
4198 pthread_t dont_care;
4200 }
4201
4202 /* Kill the canary when we exit */
4204 }
4205
4206 /* Blindly write the PID file. */
4207 unlink(ast_config_AST_PID);
4208 f = fopen(ast_config_AST_PID, "w");
4209 if (f) {
4210 fprintf(f, "%ld\n", (long)ast_mainpid);
4211 fclose(f);
4212 } else {
4213 fprintf(stderr, "Unable to open pid file '%s': %s\n", ast_config_AST_PID, strerror(errno));
4214 }
4215
4216 /* Initialize the terminal. Since all processes have been forked,
4217 * we can now start using the standard log messages.
4218 */
4219 ast_term_init();
4220 printf("%s", term_end());
4221 fflush(stdout);
4222
4223 print_intro_message(runuser, rungroup);
4224
4226
4227 check_init(astobj2_init(), "AO2");
4228 check_init(ast_named_locks_init(), "Named Locks");
4229
4230 if (ast_opt_console) {
4231 if (el_hist == NULL || el == NULL)
4234 }
4235
4236#ifdef AST_XML_DOCS
4237 /* Load XML documentation. */
4239#endif
4240
4241 check_init(astdb_init(), "ASTdb");
4242
4243 ast_uuid_init();
4244
4245 if (ast_pbx_uuid_get(pbx_uuid, sizeof(pbx_uuid))) {
4246 ast_uuid_generate_str(pbx_uuid, sizeof(pbx_uuid));
4247 ast_db_put("pbx", "UUID", pbx_uuid);
4248 }
4249 ast_verb(0, "PBX UUID: %s\n", pbx_uuid);
4250
4251 check_init(ast_json_init(), "libjansson");
4252 ast_ulaw_init();
4253 ast_alaw_init();
4254 ast_utf8_init();
4255 tdd_init();
4256 callerid_init();
4258
4259 check_init(ast_utils_init(), "Utilities");
4260 check_init(ast_tps_init(), "Task Processor Core");
4261 check_init(ast_taskpool_init(), "Taskpool Support");
4262 check_init(ast_fd_init(), "File Descriptor Debugging");
4263 check_init(ast_pbx_init(), "ast_pbx_init");
4264 check_init(aco_init(), "Configuration Option Framework");
4265 check_init(stasis_init(), "Stasis");
4266#ifdef TEST_FRAMEWORK
4267 check_init(ast_test_init(), "Test Framework");
4268#endif
4269 check_init(ast_translate_init(), "Translator Core");
4270
4272
4273 check_init(ast_sorcery_init(), "Sorcery");
4274 check_init(ast_codec_init(), "Codecs");
4275 check_init(ast_format_init(), "Formats");
4276 check_init(ast_format_cache_init(), "Format Cache");
4277 check_init(ast_codec_builtin_init(), "Built-in Codecs");
4278 check_init(ast_bucket_init(), "Bucket API");
4279 check_init(ast_stasis_system_init(), "Stasis system-level information");
4280 check_init(ast_endpoint_stasis_init(), "Stasis Endpoint");
4281
4283 /* GCC 4.9 gives a bogus "right-hand operand of comma expression has
4284 * no effect" warning */
4285 (void) sigemptyset(&sigs);
4286 (void) sigaddset(&sigs, SIGHUP);
4287 (void) sigaddset(&sigs, SIGTERM);
4288 (void) sigaddset(&sigs, SIGINT);
4289 (void) sigaddset(&sigs, SIGPIPE);
4290 (void) sigaddset(&sigs, SIGWINCH);
4291 pthread_sigmask(SIG_BLOCK, &sigs, NULL);
4292 sigaction(SIGURG, &urg_handler, NULL);
4293 signal(SIGINT, __quit_handler);
4294 signal(SIGTERM, __quit_handler);
4295 sigaction(SIGHUP, &hup_handler, NULL);
4296 sigaction(SIGPIPE, &ignore_sig_handler, NULL);
4297
4298 /* ensure that the random number generators are seeded with a different value every time
4299 Asterisk is started
4300 */
4301 srand((unsigned int) getpid() + (unsigned int) time(NULL));
4302 initstate((unsigned int) getpid() * 65536 + (unsigned int) time(NULL), randompool, sizeof(randompool));
4303
4305
4306 check_init(init_logger(), "Logger");
4308
4309 check_init(ast_rtp_engine_init(), "RTP Engine");
4310
4312
4313 check_init(ast_timing_init(), "Timing");
4314 check_init(ast_ssl_init(), "SSL");
4316 check_init(ast_pj_init(), "Embedded PJProject");
4317 check_init(app_init(), "App Core");
4318 check_init(mwi_init(), "MWI Core");
4319 check_init(devstate_init(), "Device State Core");
4320 check_init(ast_msg_init(), "Messaging API");
4321 check_init(ast_channels_init(), "Channel");
4322 check_init(ast_endpoint_init(), "Endpoints");
4323 check_init(ast_pickup_init(), "Call Pickup");
4324 check_init(ast_bridging_init(), "Bridging");
4325 check_init(ast_parking_stasis_init(), "Parking Core");
4326 check_init(ast_device_state_engine_init(), "Device State Engine");
4327 check_init(ast_presence_state_engine_init(), "Presence State Engine");
4328 check_init(dns_core_init(), "DNS Resolver Core");
4329 check_init(ast_dns_system_resolver_init(), "Default DNS resolver");
4330 check_init(ast_security_stasis_init(), "Security Stasis Topic and Events");
4331 check_init(ast_image_init(), "Image");
4332 check_init(ast_file_init(), "Generic File Format Support");
4333 check_init(load_pbx(), "load_pbx");
4334 check_init(load_pbx_builtins(), "Builtin PBX Applications");
4335 check_init(load_pbx_functions_cli(), "PBX Functions Support");
4336 check_init(load_pbx_variables(), "PBX Variables Support");
4337 check_init(load_pbx_switch(), "PBX Switch Support");
4338 check_init(load_pbx_app(), "PBX Application Support");
4339 check_init(load_pbx_hangup_handler(), "PBX Hangup Handler Support");
4340 check_init(ast_extension_state_init(), "Extension State Support");
4341 check_init(ast_extension_state_legacy_init(), "Extension State Legacy Support");
4342 check_init(ast_extension_state_autohints_init(), "Extension State Autohints Support");
4343 check_init(ast_local_init(), "Local Proxy Channel Driver");
4344 check_init(ast_refer_init(), "Refer API");
4345
4347
4348 /* We should avoid most config loads before this point as they can't use realtime. */
4349 check_init(load_modules(), "Module");
4350
4351 /*
4352 * This has to load after the dynamic modules load, as items in the media
4353 * cache can't be constructed from items in the AstDB without their
4354 * bucket backends.
4355 */
4356 check_init(ast_media_cache_init(), "Media Cache");
4357
4358 /* loads the cli_permissions.conf file needed to implement cli restrictions. */
4360 ast_cli_channels_init(); /* Not always safe to access CLI commands until startup is complete. */
4361
4362 ast_stun_init();
4363
4365
4366 if (ast_opt_no_fork) {
4367 consolethread = pthread_self();
4368 }
4369
4371
4373
4376
4377 pthread_sigmask(SIG_UNBLOCK, &sigs, NULL);
4378
4380
4384
4386 ast_sd_notify("READY=1");
4387
4388 ast_verb(0, COLORIZE_FMT "\n", COLORIZE(COLOR_BRGREEN, 0, "Asterisk Ready."));
4389
4391
4392 if (ast_opt_console) {
4393 /* Console stuff now... */
4394 /* Register our quit function */
4395 char title[296];
4396 char hostname[MAXHOSTNAMELEN] = "";
4397
4398 if (gethostname(hostname, sizeof(hostname) - 1)) {
4399 ast_copy_string(hostname, "<Unknown>", sizeof(hostname));
4400 }
4401
4403
4404 set_icon("Asterisk");
4405 snprintf(title, sizeof(title), "Asterisk Console on '%s' (pid %ld)", hostname, (long)ast_mainpid);
4406 set_title(title);
4407
4408 el_set(el, EL_GETCFN, ast_el_read_char);
4409
4410 for (;;) {
4411 if (sig_flags.need_el_end) {
4412 el_end(el);
4413
4414 return;
4415 }
4416
4417 if (sig_flags.need_quit || sig_flags.need_quit_handler) {
4419 break;
4420 }
4421 buf = (char *) el_gets(el, &num);
4422
4423 if (!buf && write(1, "", 1) < 0)
4424 return; /* quit */
4425
4426 if (buf) {
4427 if (buf[strlen(buf)-1] == '\n')
4428 buf[strlen(buf)-1] = '\0';
4429
4431 }
4432 }
4433 }
4434
4435 /* Stall until a quit signal is given */
4437}
Prototypes for public functions only of internal interest,.
int load_pbx_variables(void)
void threadstorage_init(void)
void ast_process_pending_reloads(void)
Process reload requests received during startup.
Definition loader.c:1575
int modules_shutdown(void)
Definition loader.c:1181
int ast_bridging_init(void)
Initialize the bridging system.
Definition bridge.c:5753
void dnsmgr_start_refresh(void)
Definition dnsmgr.c:302
int ast_extension_state_autohints_init(void)
int ast_timing_init(void)
Definition timing.c:289
int ast_device_state_engine_init(void)
Initialize the device state engine in separate thread.
int ast_term_init(void)
Definition term.c:165
int load_modules(void)
Definition loader.c:2517
void ast_cli_channels_init(void)
Definition main/cli.c:2329
void ast_msg_shutdown(void)
void logger_queue_start(void)
Start the ast_queue_log() logger.
Definition logger.c:2175
int aco_init(void)
void load_asterisk_conf(void)
Definition options.c:211
int ast_test_init(void)
Definition test.c:1505
void close_logger(void)
Definition logger.c:2234
void ast_stun_init(void)
Initialize the STUN system in Asterisk.
Definition stun.c:576
void set_asterisk_conf_path(const char *path)
Definition options.c:201
int astdb_init(void)
Definition db.c:1250
int ast_pj_init(void)
int load_pbx_functions_cli(void)
int ast_tps_init(void)
void load_astmm_phase_2(void)
Initialize malloc debug phase 2.
Definition astmm.c:1529
int ast_extension_state_legacy_init(void)
int ast_msg_init(void)
int load_pbx_hangup_handler(void)
int ast_extension_state_init(void)
int ast_local_init(void)
Initialize the local proxy channel.
int load_pbx_builtins(void)
int load_pbx_switch(void)
Definition pbx_switch.c:125
int ast_rtp_engine_init(void)
initializes the rtp engine arrays
int ast_xmldoc_load_documentation(void)
Load XML documentation. Provided by xmldoc.c.
Definition xmldoc.c:3214
int ast_named_locks_init(void)
Definition named_locks.c:52
int ast_taskpool_init(void)
Definition taskpool.c:1110
int ast_channels_init(void)
Definition channel.c:8177
void clean_time_zones(void)
Definition localtime.c:1590
void load_astmm_phase_1(void)
Initialize malloc debug phase 1.
Definition astmm.c:1525
void ast_builtins_init(void)
initialize the _full_cmd string in * each of the builtins.
Definition main/cli.c:2322
void ast_autoservice_init(void)
int init_logger(void)
Definition logger.c:2191
int ast_endpoint_init(void)
Endpoint support initialization.
int dns_core_init(void)
Definition dns_core.c:617
int load_pbx(void)
Definition pbx.c:6594
int astobj2_init(void)
Definition astobj2.c:1169
int load_pbx_app(void)
Definition pbx_app.c:550
int ast_dns_system_resolver_init(void)
Initializes the resolver.
int ast_ssl_init(void)
int ast_cli_perms_init(int reload)
Definition main/cli.c:2189
void set_socket_path(const char *path)
Definition options.c:206
int ast_file_init(void)
Definition file.c:2155
int ast_refer_init(void)
Definition refer.c:531
int ast_parking_stasis_init(void)
initializes the rtp engine arrays
Definition parking.c:53
Access Control of various sorts.
void ast_cli_unregister_multiple(void)
Definition ael_main.c:408
A-Law to Signed linear conversion.
void ast_alaw_init(void)
To init the alaw to slinear conversion stuff, this needs to be run.
Definition alaw.c:152
void ast_alertpipe_close(int alert_pipe[2])
Close an alert pipe.
Definition alertpipe.c:79
ssize_t ast_alertpipe_write(int alert_pipe[2])
Write an event to an alert pipe.
Definition alertpipe.c:120
int ast_alertpipe_init(int alert_pipe[2])
Initialize an alert pipe.
Definition alertpipe.c:38
ast_alert_status_t ast_alertpipe_read(int alert_pipe[2])
Read an event from an alert pipe.
Definition alertpipe.c:102
Generic Advice of Charge encode and decode routines.
int ast_aoc_cli_init(void)
enable aoc cli options
Definition aoc.c:2029
jack_status_t status
Definition app_jack.c:149
char * text
Definition app_queue.c:1791
Asterisk version information.
const char * ast_get_build_opts(void)
const char * ast_get_version(void)
Retrieve the Asterisk version string.
const char * ast_get_build_opts_all(void)
Persistent data storage (akin to *doze registry)
int ast_db_put(const char *family, const char *key, const char *value)
Store value addressed by family/key.
Definition db.c:335
int ast_db_get(const char *family, const char *key, char *value, int valuelen)
Get key value specified by family/key.
Definition db.c:421
int setenv(const char *name, const char *value, int overwrite)
int getloadavg(double *list, int nelem)
char * strsep(char **str, const char *delims)
static int ast_el_add_history(const char *)
Definition asterisk.c:3172
static char * remotehostname
Definition asterisk.c:349
static char * handle_stop_gracefully(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:2401
static void __ast_unregister_atexit(void(*func)(void))
Definition asterisk.c:1029
static char * cli_complete(EditLine *editline, int ch)
Definition asterisk.c:2991
int64_t ast_mark(int i, int startstop)
Definition asterisk.c:885
static int ast_socket_is_sd
Definition asterisk.c:321
int ast_shutdown_final(void)
Definition asterisk.c:1883
static void canary_exit(void)
Definition asterisk.c:3538
static shutdown_nice_t shuttingdown
Definition asterisk.c:386
static void check_init(int init_result, const char *name)
Definition asterisk.c:4114
static void __remote_quit_handler(int num)
Definition asterisk.c:2164
static void _urg_handler(int num)
Urgent handler.
Definition asterisk.c:1723
static char * show_license(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:2606
#define CHAR_T_LIBEDIT
Definition asterisk.c:2689
static char * handle_show_threads(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:615
static void ast_run_atexits(int run_cleanups)
Definition asterisk.c:1015
static int console_state_init(void *ptr)
Definition asterisk.c:2219
static struct profile_data * prof_data
Definition asterisk.c:804
startup_commands_phase
Definition asterisk.c:3547
@ STARTUP_COMMANDS_PRE_MODULE
Definition asterisk.c:3549
@ STARTUP_COMMANDS_PRE_INIT
Definition asterisk.c:3548
@ STARTUP_COMMANDS_FULLY_BOOTED
Definition asterisk.c:3550
static char * handle_stop_when_convenient(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:2422
static int remoteconsolehandler(const char *s)
Definition asterisk.c:2328
static struct ast_str * prompt
Definition asterisk.c:2802
unsigned int need_reload
Definition asterisk.c:406
static void publish_fully_booted(void)
Definition asterisk.c:989
static int show_version(void)
Definition asterisk.c:3405
static void main_atexit(void)
Definition asterisk.c:3615
static int safe_exec_wait(pid_t pid)
wait for spawned application to complete and unreplace sigchld
Definition asterisk.c:1208
int ast_add_profile(const char *name, uint64_t scale)
allocates a counter with a given name and scale.
Definition asterisk.c:810
static void ast_cli_display_match_list(struct ast_vector_string *matches, int max)
Definition asterisk.c:2964
static void _hup_handler(int num)
Definition asterisk.c:1732
static char * handle_version(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:2360
static pthread_t lthread
Definition asterisk.c:1378
static unsigned int safe_system_level
Keep track of how many threads are currently trying to wait*() on a child process.
Definition asterisk.c:1109
static void ast_network_puts_mutable(const char *string, int level, int sublevel)
log the string to all attached network console clients
Definition asterisk.c:1309
static char randompool[256]
Definition asterisk.c:398
static char * handle_show_sysinfo(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Give an overview of system statistics.
Definition asterisk.c:681
#define WELCOME_MESSAGE
Welcome message when starting a CLI interface.
Definition asterisk.c:311
int ast_safe_execvp(int dualfork, const char *file, char *const argv[])
Safely spawn an external program while closing file descriptors.
Definition asterisk.c:1234
int ast_register_cleanup(void(*func)(void))
Register a function to be executed before Asterisk gracefully exits.
Definition asterisk.c:1067
static void set_header(char *outbuf, int maxout, char level)
Definition asterisk.c:2169
static int ast_el_read_char(EditLine *editline, CHAR_T_LIBEDIT *cp)
Definition asterisk.c:2696
static char * handle_stop_now(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:2381
static char canary_filename[128]
Definition asterisk.c:395
#define CMD_MATCHESARRAY
static __inline uint64_t rdtsc(void)
Definition asterisk.c:878
static struct sigaction child_handler
Definition asterisk.c:1771
int ast_set_priority(int pri)
We set ourselves to a high priority, that we might pre-empt everything else. If your PBX has heavy ac...
Definition asterisk.c:1853
static void asterisk_daemon(int isroot, const char *runuser, const char *rungroup)
Definition asterisk.c:4127
void ast_console_toggle_loglevel(int fd, int level, int state)
enable or disable a logging level to a specified console
Definition asterisk.c:1263
static char * handle_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Give an overview of core settings.
Definition asterisk.c:475
static int has_priority(void)
Check whether we were set to high(er) priority.
Definition asterisk.c:1790
#define PF_LOCAL
Definition asterisk.c:301
unsigned int need_el_end
Definition asterisk.c:409
void ast_console_toggle_mute(int fd, int silent)
mute or unmute a console from logging
Definition asterisk.c:1286
static void send_rasterisk_connect_commands(void)
Definition asterisk.c:2660
unsigned int need_quit
Definition asterisk.c:407
#define ASTERISK_PROMPT
Definition asterisk.c:2624
static struct sigaction safe_system_prev_handler
Definition asterisk.c:1110
static char * handle_bang(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:2529
static struct sigaction hup_handler
Definition asterisk.c:1751
static pthread_t mon_sig_flags
Definition asterisk.c:393
static int fdprint(int fd, const char *s)
Definition asterisk.c:1086
static pthread_t consolethread
Definition asterisk.c:392
static EditLine * el
Definition asterisk.c:348
static void * netconsole(void *vconsole)
Definition asterisk.c:1440
static int ast_el_initialize(void)
Definition asterisk.c:3117
static int set_priority_all(int pri)
Set priority on all known threads.
Definition asterisk.c:1810
static void ast_begin_shutdown(void)
Definition asterisk.c:1911
static char * handle_restart_now(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:2443
static char * handle_restart_when_convenient(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:2485
static int ast_el_read_history(const char *)
Definition asterisk.c:3204
static char * handle_abort_shutdown(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:2506
int ast_shutting_down(void)
Definition asterisk.c:1888
static void _child_handler(int sig)
Definition asterisk.c:1756
void ast_console_puts_mutable(const char *string, int level)
log the string to the root console, and all attached network console clients
Definition asterisk.c:1328
#define AST_MAX_CONNECTS
Definition asterisk.c:304
int ast_pbx_uuid_get(char *pbx_uuid, int length)
Retrieve the PBX UUID.
Definition asterisk.c:984
void ast_replace_sigchld(void)
Replace the SIGCHLD handler.
Definition asterisk.c:1112
int ast_cancel_shutdown(void)
Cancel an existing shutdown and return to normal operation.
Definition asterisk.c:1893
static void ast_network_puts(const char *string)
write the string to all attached console clients
Definition asterisk.c:1352
static int read_credentials(int fd, char *buffer, size_t size, struct console *con)
read() function supporting the reception of user credentials.
Definition asterisk.c:1390
#define CHAR_TO_LIBEDIT(c)
Definition asterisk.c:2690
static int shutdown_pending
Definition asterisk.c:389
static void _null_sig_handler(int sig)
NULL handler so we can collect the child exit status.
Definition asterisk.c:1092
static void process_histfile(int(*readwrite)(const char *filename))
Definition asterisk.c:3220
static int sig_alert_pipe[2]
Definition asterisk.c:404
struct timeval ast_lastreloadtime
Definition asterisk.c:345
static const char warranty_lines[]
Definition asterisk.c:2544
void ast_console_puts(const char *string)
write the string to the root console, and all attached network console clients
Definition asterisk.c:1368
void ast_unregister_atexit(void(*func)(void))
Unregister a function registered with ast_register_atexit().
Definition asterisk.c:1072
static int console_print(const char *s)
Definition asterisk.c:2228
static void quit_handler(int num, shutdown_nice_t niceness, int restart)
Definition asterisk.c:1923
static History * el_hist
Definition asterisk.c:347
static char * handle_restart_gracefully(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:2464
static void * monitor_sig_flags(void *unused)
Definition asterisk.c:3484
#define COPYRIGHT_TAG
Definition asterisk.c:308
#define EL_BUF_SIZE
static char * show_warranty(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:2569
#define MAX_HISTORY_COMMAND_LENGTH
Definition asterisk.c:3170
void ast_register_thread(char *name)
Definition asterisk.c:422
static void ast_remotecontrol(char *data)
Definition asterisk.c:3257
static int restartnow
Definition asterisk.c:391
static int print_file(int fd, char *desc, const char *filename)
Print the contents of a file.
Definition asterisk.c:458
void ast_unregister_thread(void *id)
Definition asterisk.c:438
static void consolehandler(const char *s)
Definition asterisk.c:2310
static struct ast_cli_entry cli_asterisk_shutdown[]
Shutdown Asterisk CLI commands.
Definition asterisk.c:2634
int ast_register_atexit(void(*func)(void))
Register a function to be executed before Asterisk exits.
Definition asterisk.c:1062
shutdown_nice_t
Definition asterisk.c:364
@ SHUTDOWN_FAST
Definition asterisk.c:377
@ SHUTDOWN_NORMAL
Definition asterisk.c:379
@ SHUTDOWN_NICE
Definition asterisk.c:381
@ SHUTDOWN_REALLY_NICE
Definition asterisk.c:383
@ SHUTTING_DOWN
Definition asterisk.c:370
@ SHUTTING_DOWN_FINAL
Definition asterisk.c:368
@ NOT_SHUTTING_DOWN
Definition asterisk.c:366
static ast_mutex_t safe_system_lock
Definition asterisk.c:1105
static pid_t safe_exec_prep(int dualfork)
fork and perform other preparations for spawning applications
Definition asterisk.c:1147
int ast_safe_system(const char *s)
Safely spawn an OS shell command while closing file descriptors.
Definition asterisk.c:1247
static int ast_all_zeros(const char *s)
Definition asterisk.c:2299
#define SHUTDOWN_TIMEOUT
Definition asterisk.c:1932
static int can_safely_quit(shutdown_nice_t niceness, int restart)
Definition asterisk.c:1975
static char * cli_prompt(EditLine *editline)
Definition asterisk.c:2804
static void set_title(char *text)
Set an X-term or screen title.
Definition asterisk.c:1777
static char * _argv[256]
Definition asterisk.c:362
static int register_atexit(void(*func)(void), int is_cleanup)
Definition asterisk.c:1043
static char * handle_clear_profile(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:954
static int wait_for_channels_to_die(shutdown_nice_t niceness, int seconds)
Definition asterisk.c:1945
static int ast_makesocket(void)
Definition asterisk.c:1610
#define DEFINE_PROFILE_MIN_MAX_VALUES
Definition asterisk.c:906
unsigned int need_quit_handler
Definition asterisk.c:408
static int canary_pid
Definition asterisk.c:394
static int ast_tryconnect(void)
Definition asterisk.c:1696
static void * canary_thread(void *unused)
Definition asterisk.c:3509
static void * listener(void *unused)
Definition asterisk.c:1530
static struct ast_cli_entry cli_asterisk[]
Definition asterisk.c:2643
static int fdsend(int fd, const char *s)
Definition asterisk.c:1080
static struct @316 sig_flags
static int ast_el_write_history(const char *)
Definition asterisk.c:3194
static int show_cli_help(void)
Definition asterisk.c:3411
static void ast_el_read_default_histfile(void)
Definition asterisk.c:3247
static char * handle_show_profile(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition asterisk.c:919
static void env_init(void)
Definition asterisk.c:3590
static int ast_consock
Definition asterisk.c:322
struct timeval ast_startuptime
Definition asterisk.c:344
static const char * startup_commands_phase_str[]
Definition asterisk.c:3553
static void read_pjproject_startup_options(void)
Definition asterisk.c:3450
static const char license_lines[]
Definition asterisk.c:2587
void ast_unreplace_sigchld(void)
Restore the SIGCHLD handler.
Definition asterisk.c:1127
static void really_quit(int num, shutdown_nice_t niceness, int restart)
Definition asterisk.c:2058
static int ast_socket
Definition asterisk.c:320
pid_t ast_mainpid
Definition asterisk.c:323
static void ast_el_write_default_histfile(void)
Definition asterisk.c:3252
#define AF_LOCAL
Definition asterisk.c:300
static int multi_thread_safe
Definition asterisk.c:396
static struct ast_vector_string * ast_el_strtoarr(char *buf)
Definition asterisk.c:2930
static void __quit_handler(int num)
Definition asterisk.c:2154
void ast_console_puts_mutable_full(const char *message, int level, int sublevel)
log the string to the console, and all attached console clients
Definition asterisk.c:1335
static void set_icon(char *text)
Definition asterisk.c:1783
static void print_intro_message(const char *runuser, const char *rungroup)
Definition asterisk.c:3602
static struct sigaction ignore_sig_handler
Definition asterisk.c:1101
static struct sigaction null_sig_handler
Definition asterisk.c:1096
struct console consoles[AST_MAX_CONNECTS]
Definition asterisk.c:351
int64_t ast_profile(int i, int64_t delta)
Definition asterisk.c:844
static struct sigaction urg_handler
Definition asterisk.c:1728
static void run_startup_commands(enum startup_commands_phase phase)
Definition asterisk.c:3560
Asterisk main include file. File version handling, generic pbx functions.
#define sched_setscheduler
Definition asterisk.h:51
int ast_pbx_init(void)
Definition pbx.c:7045
#define setpriority
Definition asterisk.h:50
int ast_fd_init(void)
Definition astfd.c:371
#define PATH_MAX
Definition asterisk.h:40
#define ast_alloca(size)
call __builtin_alloca to ensure we get gcc builtin semantics
Definition astmm.h:288
#define ast_free(a)
Definition astmm.h:180
#define ast_realloc(p, len)
A wrapper for realloc()
Definition astmm.h:226
#define ast_strdup(str)
A wrapper for strdup()
Definition astmm.h:241
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition astmm.h:298
void ast_free_ptr(void *ptr)
free() wrapper
Definition astmm.c:1739
#define ast_asprintf(ret, fmt,...)
A wrapper for asprintf()
Definition astmm.h:267
#define ast_calloc(num, len)
A wrapper for calloc()
Definition astmm.h:202
#define ast_log
Definition astobj2.c:42
Bucket File API.
int ast_bucket_init(void)
Initialize bucket support.
Definition bucket.c:924
const char * ast_build_os
Definition buildinfo.c:32
const char * ast_build_machine
Definition buildinfo.c:31
const char * ast_build_hostname
Definition buildinfo.c:29
const char * ast_build_user
Definition buildinfo.c:34
const char * ast_build_date
Definition buildinfo.c:33
const char * ast_build_kernel
Definition buildinfo.c:30
CallerID (and other GR30) management and generation Includes code and algorithms from the Zapata libr...
void callerid_init(void)
CallerID Initialization.
Definition callerid.c:116
Call Detail Record API.
int ast_cdr_is_enabled(void)
Return TRUE if CDR subsystem is enabled.
Definition cdr.c:2999
void ast_cdr_engine_term(void)
Definition cdr.c:4758
static const char desc[]
Definition cdr_radius.c:84
static PGresult * result
Definition cel_pgsql.c:84
static char version[AST_MAX_EXTENSION]
General Asterisk PBX channel definitions.
void ast_softhangup_all(void)
Soft hangup all active channels.
Definition channel.c:494
const char * ast_channel_get_current_storage_driver_name(void)
Get the name of the current channel storage driver.
Definition channel.c:8149
int ast_undestroyed_channels(void)
Definition channel.c:505
int ast_active_channels(void)
returns number of active/allocated channels
Definition channel.c:500
static int active_channels(struct ast_channelstorage_instance *driver, int rdlock)
returns number of active/allocated channels
Standard Command Line Interface.
#define CLI_SHOWUSAGE
Definition cli.h:45
#define AST_CLI_COMPLETE_EOF
Definition cli.h:52
#define CLI_SUCCESS
Definition cli.h:44
#define AST_CLI_DEFINE(fn, txt,...)
Definition cli.h:197
void ast_cli(int fd, const char *fmt,...)
Definition clicompat.c:6
#define ast_cli_command(fd, s)
Definition cli.h:232
int ast_cli_allow_at_shutdown(struct ast_cli_entry *e)
Allow a CLI command to be executed while Asterisk is shutting down.
Definition main/cli.c:3145
int ast_cli_command_multiple_full(int uid, int gid, int fd, size_t size, const char *s)
Executes multiple CLI commands Interpret strings separated by NULL and execute each one,...
Definition main/cli.c:3123
@ CLI_INIT
Definition cli.h:152
@ CLI_GENERATE
Definition cli.h:153
struct ast_vector_string * ast_cli_completion_vector(const char *text, const char *word)
Generates a vector of strings for CLI completion.
Definition main/cli.c:2850
#define ast_cli_register_multiple(e, len)
Register multiple commands.
Definition cli.h:265
Codec API.
int ast_codec_init(void)
Initialize codec support within the core.
Definition codec.c:250
int ast_codec_builtin_init(void)
Initialize built-in codecs within the core.
Device state management.
int devstate_init(void)
Initialize the device state core.
char buf[BUFSIZE]
Definition eagi_proxy.c:66
int main()
Definition eagi_proxy.c:107
int editline_read_char(EditLine *el, wchar_t *cp)
Endpoint abstractions.
#define min(a, b)
Definition f2c.h:197
#define max(a, b)
Definition f2c.h:198
Generic File Format Support. Should be included by clients of the file handling routines....
Media Format API.
int ast_format_init(void)
Initialize media format support.
Definition format.c:77
Media Format Cache API.
int ast_format_cache_init(void)
Initialize format cache support within the core.
static const char name[]
Definition format_mp3.c:68
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
int ast_manager_check_enabled(void)
Check if AMI is enabled.
Definition manager.c:683
int ast_webmanager_check_enabled(void)
Check if AMI/HTTP is enabled.
Definition manager.c:688
void ast_manager_publish_event(const char *type, int class_type, struct ast_json *obj)
Publish an event to AMI.
Definition manager.c:637
void ast_init_logger_for_socket_console(void)
load logger.conf configuration for console socket connections
Definition logger.c:726
int ast_option_rtpusedynamic
Definition options.c:89
int ast_option_maxfiles
Definition options.c:82
int option_debug
Definition options.c:70
int ast_verb_sys_level
Definition options.c:65
int ast_option_maxcalls
Definition options.c:80
int ast_option_disable_remote_console_shell
Definition options.c:91
int ast_option_pjproject_log_level
Definition options.c:75
struct ast_flags64 ast_options
Definition options.c:62
double ast_option_maxload
Definition options.c:78
unsigned int ast_option_rtpptdynamic
Definition options.c:90
int option_verbose
Definition options.c:68
unsigned int option_dtmfminduration
Definition options.c:84
int ast_option_pjproject_cache_pools
Definition options.c:76
long option_minmemfree
Definition options.c:87
int option_trace
Definition options.c:72
@ AST_OPT_FLAG_HIGH_PRIORITY
Definition options.h:49
@ AST_OPT_FLAG_EXEC_INCLUDES
Definition options.h:41
@ AST_OPT_FLAG_NO_COLOR
Definition options.h:57
@ AST_OPT_FLAG_NO_FORK
Definition options.h:43
@ AST_OPT_FLAG_ALWAYS_FORK
Definition options.h:83
@ AST_OPT_FLAG_QUIET
Definition options.h:45
@ AST_OPT_FLAG_MUTE
Definition options.h:85
@ AST_OPT_FLAG_TIMESTAMP
Definition options.h:69
@ AST_OPT_FLAG_EXEC
Definition options.h:55
@ AST_OPT_FLAG_CACHE_RECORD_FILES
Definition options.h:67
@ AST_OPT_FLAG_FULLY_BOOTED
Definition options.h:59
@ AST_OPT_FLAG_INIT_KEYS
Definition options.h:51
@ AST_OPT_FLAG_CONSOLE
Definition options.h:47
@ AST_OPT_FLAG_FORCE_BLACK_BACKGROUND
Definition options.h:95
@ AST_OPT_FLAG_LIGHT_BACKGROUND
Definition options.h:91
@ AST_OPT_FLAG_REMOTE
Definition options.h:53
@ AST_OPT_FLAG_DUMP_CORE
Definition options.h:65
@ AST_OPT_FLAG_RECONNECT
Definition options.h:73
static char prefix[MAX_PREFIX]
Definition http.c:145
General Asterisk channel definitions for image handling.
int ast_image_init(void)
Initialize image stuff Initializes all the various image stuff. Basically just registers the cli stuf...
Definition image.c:212
Application convenience functions, designed to give consistent look and feel to Asterisk apps.
int app_init(void)
Initialize the application core.
Definition main/app.c:3366
void ast_close_fds_above_n(int n)
Common routine for child processes, to close all fds prior to exec(2)
Definition main/app.c:3203
Configuration File Parser.
@ CONFIG_FLAG_NOCACHE
@ CONFIG_FLAG_NOREALTIME
struct ast_config * ast_config_load2(const char *filename, const char *who_asked, struct ast_flags flags)
Load a config file.
#define CONFIG_STATUS_FILEMISSING
int ast_realtime_enabled(void)
Check if there's any realtime engines loaded.
#define CONFIG_STATUS_FILEUNCHANGED
#define CONFIG_STATUS_FILEINVALID
void ast_config_destroy(struct ast_config *cfg)
Destroys a config.
Definition extconf.c:1287
struct ast_variable * ast_variable_browse(const struct ast_config *config, const char *category_name)
Definition extconf.c:1213
int register_config_cli(void)
Exposed initialization method for core process.
#define VERBOSE_PREFIX_3
void ast_verb_console_unregister(void)
Unregister this thread's console verbosity level.
Definition logger.c:2729
void ast_verb_console_register(int *level)
Register this thread's console verbosity level pointer.
Definition logger.c:2713
#define NUMLOGLEVELS
#define ast_debug(level,...)
Log a DEBUG message.
#define VERBOSE_PREFIX_10
#define VERBOSE_PREFIX_6
int ast_is_logger_initialized(void)
Test if logger is initialized.
Definition logger.c:2164
#define VERBOSE_PREFIX_2
#define VERBOSE_PREFIX_8
#define VERBOSE_PREFIX_7
#define VERBOSE_PREFIX_4
#define __LOG_VERBOSE
#define VERBOSE_PREFIX_5
#define VERBOSE_PREFIX_1
#define LOG_ERROR
#define VERBOSE_PREFIX_9
#define ast_verb(level,...)
#define LOG_WARNING
int ast_verb_console_get(void)
Get this thread's console verbosity level.
Definition logger.c:2740
const char * ast_logger_get_dateformat(void)
Get the logger configured date format.
Definition logger.c:2994
#define VERBOSE_MAGIC2LEVEL(x)
#define VERBOSE_HASMAGIC(x)
#define ast_verbose(...)
I/O Management (derived from Cheops-NG)
int ast_get_termcols(int fd)
Columns of Terminal.
Definition io.c:373
int ast_sd_notify(const char *state)
a wrapper for sd_notify(): notify systemd of any state changes.
Definition io.c:392
int ast_sd_get_fd_un(int type, const char *path)
Find a listening AF_LOCAL file descriptor provided by socket activation.
Definition io.c:454
Asterisk JSON abstraction layer.
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition json.c:73
struct ast_json * ast_json_pack(char const *format,...)
Helper for creating complex JSON values.
Definition json.c:612
int ast_json_init(void)
Initialize the JSON library.
Definition json.c:726
A set of macros to manage forward-linked lists.
#define AST_RWLIST_REMOVE_CURRENT
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition linkedlists.h:78
#define AST_LIST_HEAD_STATIC(name, type)
Defines a structure to be used to hold a list of specified type, statically initialized.
#define AST_RWLIST_TRAVERSE_SAFE_BEGIN
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition linkedlists.h:52
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
#define AST_RWLIST_HEAD_STATIC(name, type)
Defines a structure to be used to hold a read/write list of specified type, statically initialized.
#define AST_LIST_ENTRY(type)
Declare a forward link structure inside a list entry.
#define AST_RWLIST_TRAVERSE_SAFE_END
#define AST_LIST_TRAVERSE_SAFE_END
Closes a safe loop traversal block.
#define AST_LIST_LOCK(head)
Locks a list.
Definition linkedlists.h:40
#define AST_RWLIST_TRAVERSE
#define AST_LIST_INSERT_HEAD(head, elm, field)
Inserts a list entry at the head of a list.
#define AST_LIST_TRAVERSE_SAFE_BEGIN(head, var, field)
Loops safely over (traverses) the entries in a list.
#define AST_LIST_REMOVE_CURRENT(field)
Removes the current entry from a list during a traversal.
#define AST_RWLIST_INSERT_HEAD
#define AST_LIST_REMOVE_HEAD(head, field)
Removes and returns the head entry from a list.
#define AST_LIST_UNLOCK(head)
Attempts to unlock a list.
#define AST_RWLIST_ENTRY
struct ast_tm * ast_localtime(const struct timeval *timep, struct ast_tm *p_tm, const char *zone)
Timezone-independent version of localtime_r(3).
Definition localtime.c:1739
int ast_strftime(char *buf, size_t len, const char *format, const struct ast_tm *tm)
Special version of strftime(3) that handles fractions of a second. Takes the same arguments as strfti...
Definition localtime.c:2524
Asterisk locking-related definitions:
#define AST_PTHREADT_NULL
Definition lock.h:73
#define ast_mutex_unlock(a)
Definition lock.h:197
#define ast_mutex_lock(a)
Definition lock.h:196
#define AST_MUTEX_DEFINE_STATIC(mutex)
Definition lock.h:527
static char * levels[NUMLOGLEVELS]
Logging channels used in the Asterisk logging system.
Definition logger.c:227
static char hostname[MAXHOSTNAMELEN]
Definition logger.c:124
#define R_OK
#define WEXITSTATUS(status)
#define WIFEXITED(status)
int errno
#define F_OK
The AMI - Asterisk Manager Interface - is a TCP protocol created to manage Asterisk with third-party ...
#define EVENT_FLAG_SYSTEM
Definition manager.h:75
An in-memory media cache.
int ast_media_cache_init(void)
Initialize the media cache.
Asterisk module definitions.
enum ast_module_reload_result ast_module_reload(const char *name)
Reload asterisk modules.
Definition loader.c:1730
Asterisk MWI API.
int mwi_init(void)
Initialize the mwi core.
Definition mwi.c:507
Wrapper for network related headers, masking differences between various operating systems....
#define MAXHOSTNAMELEN
Definition network.h:69
Options provided by main asterisk program.
#define ast_opt_dump_core
Definition options.h:129
#define ast_opt_remote
Definition options.h:124
#define MAX_PJ_LOG_MAX_LEVEL
Definition options.h:151
#define ast_opt_exec
Definition options.h:125
#define ast_opt_transcode_via_slin
Definition options.h:128
#define ast_opt_reconnect
Definition options.h:133
#define DEFAULT_PJPROJECT_CACHE_POOLS
Definition options.h:188
#define ast_opt_console
Definition options.h:121
#define ast_opt_generic_plc_on_equal_codecs
Definition options.h:146
#define ast_opt_hide_connect
Definition options.h:142
#define ast_opt_mute
Definition options.h:137
#define ast_opt_high_priority
Definition options.h:122
#define ast_opt_timestamp
Definition options.h:132
#define ast_opt_always_fork
Definition options.h:136
#define ast_opt_no_fork
Definition options.h:119
#define ast_opt_hide_messaging_ami_events
Definition options.h:147
#define ast_opt_sounds_search_custom
Definition options.h:148
#define DEFAULT_PJ_LOG_MAX_LEVEL
Definition options.h:159
#define ast_opt_generic_plc
Definition options.h:144
#define ast_opt_cache_media_frames
Definition options.h:131
#define ast_opt_exec_includes
Definition options.h:118
char ast_defaultlanguage[]
Definition options.c:99
#define ast_opt_transmit_silence
Definition options.h:134
Asterisk file paths, configured in asterisk.conf.
const char * ast_config_AST_KEY_DIR
Definition options.c:162
const char * ast_config_AST_CACHE_DIR
Definition options.c:151
const char * ast_config_AST_RUN_GROUP
Definition options.c:170
const char * ast_config_AST_SOCKET
Definition options.c:168
const char * ast_config_AST_RUN_USER
Definition options.c:169
const char * ast_config_AST_CTL_PERMISSIONS
Definition options.c:173
const char * ast_config_AST_CTL_GROUP
Definition options.c:175
const char * ast_config_AST_MODULE_DIR
Definition options.c:154
const char * ast_config_AST_PID
Definition options.c:167
const char * ast_config_AST_RUN_DIR
Definition options.c:163
const char * ast_config_AST_DATA_DIR
Definition options.c:159
const char * ast_config_AST_CONFIG_DIR
Definition options.c:152
const char * ast_config_AST_SPOOL_DIR
Definition options.c:155
const char * ast_config_AST_AGI_DIR
Definition options.c:161
const char * ast_config_AST_VAR_DIR
Definition options.c:158
const char * ast_config_AST_SYSTEM_NAME
Definition options.c:171
const char * ast_config_AST_SBIN_DIR
Definition options.c:164
const char * ast_config_AST_CONFIG_FILE
Definition options.c:153
const char * ast_config_AST_LOG_DIR
Definition options.c:160
const char * ast_config_AST_CTL_OWNER
Definition options.c:174
const char * ast_config_AST_DB
Definition options.c:166
Core PBX routines and definitions.
Call Pickup API.
int ast_pickup_init(void)
Initialize pickup.
Definition pickup.c:402
#define ast_poll(a, b, c)
Definition poll-compat.h:88
Presence state management.
int ast_presence_state_engine_init(void)
static int total
Definition res_adsi.c:970
#define NULL
Definition resample.c:96
Pluggable RTP Architecture.
#define AST_RTP_PT_LAST_REASSIGN
Definition rtp_engine.h:95
#define AST_RTP_MAX_PT
Definition rtp_engine.h:83
#define AST_RTP_PT_FIRST_DYNAMIC
Definition rtp_engine.h:92
Scheduler Routines (derived from cheops)
Security Event Reporting API.
int ast_security_stasis_init(void)
initializes stasis topic/event types for ast_security_topic and ast_security_event_type
#define FD_SET(fd, fds)
Definition select.h:58
#define ast_FDMAX
Definition select.h:41
unsigned int ast_FD_SETSIZE
Definition poll.c:86
static int ast_select(int nfds, ast_fdset *rfds, ast_fdset *wfds, ast_fdset *efds, struct timeval *tvp)
Waits for activity on a group of channels.
Definition select.h:79
#define FD_ZERO(a)
Definition select.h:49
Sorcery Data Access Layer API.
int ast_sorcery_init(void)
Initialize the sorcery API.
Definition sorcery.c:444
Stasis Message Bus API. See Stasis Message Bus API for detailed documentation.
int stasis_init(void)
Initialize the Stasis subsystem.
Definition stasis.c:3283
Endpoint abstractions.
int ast_endpoint_stasis_init(void)
Initialization function for endpoint stasis support.
int ast_stasis_system_init(void)
Initialize the stasis system topic and message types.
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition strings.h:1139
static force_inline char * ast_str_to_lower(char *str)
Convert a string to all lower-case.
Definition strings.h:1321
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition strings.h:80
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition strings.h:65
int attribute_pure ast_false(const char *val)
Make sure something is false. Determine if a string containing a boolean value is "false"....
Definition utils.c:2250
void ast_str_reset(struct ast_str *buf)
Reset the content of a dynamic string. Useful before a series of ast_str_append.
Definition strings.h:693
int ast_in_delimited_string(const char *needle, const char *haystack, char delim)
Check if there is an exact match for 'needle' between delimiters in 'haystack'.
Definition strings.c:466
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition strings.h:659
int ast_str_set(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Set a dynamic string using variable arguments.
Definition strings.h:1113
char *attribute_pure ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition strings.h:761
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition strings.h:425
char * ast_strip(char *s)
Strip leading/trailing whitespace from a string.
Definition strings.h:223
int is_cleanup
Definition asterisk.c:338
struct ast_atexit::@317 list
void(* func)(void)
Definition asterisk.c:337
descriptor for a cli entry.
Definition cli.h:171
int args
This gets set in ast_cli_register()
Definition cli.h:185
char * command
Definition cli.h:186
const char * usage
Definition cli.h:177
Structure used to handle boolean flags.
Definition utils.h:220
Abstract JSON element (object, array, string, int, ...).
Support for dynamic strings.
Definition strings.h:623
Structure for variables, used for configurations and for channel variables.
struct ast_variable * next
String vector definitions.
Definition vector.h:55
int mute
Definition asterisk.c:328
int uid
Definition asterisk.c:329
int gid
Definition asterisk.c:330
int p[2]
Definition asterisk.c:326
int fd
Definition asterisk.c:325
int option_verbose
Definition asterisk.c:333
pthread_t t
Definition asterisk.c:327
int levels[NUMLOGLEVELS]
Definition asterisk.c:331
struct profile_entry e[0]
Definition asterisk.c:801
Definition asterisk.c:790
int64_t events
Definition asterisk.c:795
int64_t mark
Definition asterisk.c:793
const char * name
Definition asterisk.c:791
int64_t value
Definition asterisk.c:794
uint64_t scale
Definition asterisk.c:792
Definition sched.c:76
struct thread_list_t::@318 list
pthread_t id
Definition asterisk.c:416
char * name
Definition asterisk.c:415
int value
Definition syslog.c:37
TTY/TDD Generation support.
void tdd_init(void)
Definition tdd.c:94
Handy terminal functions for vt* terms.
#define COLOR_BRGREEN
Definition term.h:55
const char * term_quit(void)
Definition term.c:412
#define COLOR_GRAY
Definition term.h:51
int ast_term_color_code(struct ast_str **str, int fgcolor, int bgcolor)
Append a color sequence to an ast_str.
Definition term.c:296
const char * ast_term_reset(void)
Returns the terminal reset code.
Definition term.c:357
#define COLOR_WHITE
Definition term.h:64
const char * ast_term_color(int fgcolor, int bgcolor)
Return a color sequence string.
Definition term.c:341
const char * term_end(void)
Definition term.c:407
#define COLOR_BLACK
Definition term.h:50
#define COLORIZE(fg, bg, str)
Definition term.h:72
#define COLORIZE_FMT
Shortcut macros for coloring a set of text.
Definition term.h:71
Test Framework API.
static struct test_val a
static struct test_val c
#define AST_THREADSTORAGE_CUSTOM(a, b, c)
Define a thread storage variable, with custom initialization and cleanup.
void * ast_threadstorage_get(struct ast_threadstorage *ts, size_t init_size)
Retrieve thread storage.
struct timeval ast_tvsub(struct timeval a, struct timeval b)
Returns the difference of two timevals a - b.
Definition extconf.c:2293
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition time.h:159
Support for translation of data formats. translate.c.
int ast_translate_init(void)
Initialize the translation matrix and index to format conversion table.
Definition translate.c:1949
u-Law to Signed linear conversion
void ast_ulaw_init(void)
Set up mu-law conversion table.
Definition ulaw.c:173
UTF-8 information and validation functions.
int ast_utf8_init(void)
Register UTF-8 tests.
Definition utf8.c:919
static int inbuf(struct baseio *bio, FILE *fi)
utility used by inchar(), for base_encode()
Definition utils.c:588
Utility functions.
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition utils.h:981
#define ast_assert(a)
Definition utils.h:779
#define ast_clear_flag64(p, flag)
Definition utils.h:154
#define ast_pthread_create_background(a, b, c, d)
Definition utils.h:632
char * ast_eid_to_str(char *s, int maxlen, struct ast_eid *eid)
Convert an EID to a string.
Definition utils.c:2873
int ast_get_tid(void)
Get current thread ID.
Definition utils.c:2786
int ast_utils_init(void)
Definition utils.c:2651
#define ast_pthread_create_detached(a, b, c, d)
Definition utils.h:628
#define ast_fd_set_flags(fd, flags)
Set flags on the given file descriptor.
Definition utils.h:1079
#define ast_pthread_create_detached_background(a, b, c, d)
Definition utils.h:637
#define ast_set_flag64(p, flag)
Definition utils.h:147
#define ARRAY_LEN(a)
Definition utils.h:706
struct ast_eid ast_eid_default
Global EID.
Definition options.c:94
Universally unique identifier support.
#define AST_UUID_STR_LEN
Definition uuid.h:27
void ast_uuid_init(void)
Initialize the UUID system.
Definition uuid.c:192
char * ast_uuid_generate_str(char *buf, size_t size)
Generate a UUID string.
Definition uuid.c:141
#define AST_VECTOR_SIZE(vec)
Get the number of elements in a vector.
Definition vector.h:637
#define AST_VECTOR_PTR_FREE(vec)
Deallocates this vector pointer.
Definition vector.h:200
#define AST_VECTOR_APPEND(vec, elem)
Append an element to a vector, growing the vector if needed.
Definition vector.h:267
#define AST_VECTOR_CALLBACK_VOID(vec, callback,...)
Execute a callback on every element in a vector disregarding callback return.
Definition vector.h:890
#define AST_VECTOR_GET(vec, idx)
Get an element from a vector.
Definition vector.h:708
Asterisk XML Documentation API.