Doxygen Updates - Title update
[asterisk/asterisk.git] / include / asterisk / doxygen / architecture.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, Digium, Inc.
5  *
6  * Russell Bryant <russell@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  * \file
21  * \author Russell Bryant <russell@digium.com>
22  */
23
24 /*!
25 \page AsteriskArchitecture Asterisk Architecture Overview
26 \author Russell Bryant <russell@digium.com>
27
28 <hr>
29
30 \section ArchTOC Table of Contents
31
32  -# \ref ArchIntro
33  -# \ref ArchLayout
34  -# \ref ArchInterfaces
35     -# \ref ArchInterfaceCodec
36     -# \ref ArchInterfaceFormat
37     -# \ref ArchInterfaceAPIs
38     -# \ref ArchInterfaceAMI
39     -# \ref ArchInterfaceChannelDrivers
40     -# \ref ArchInterfaceBridge
41     -# \ref ArchInterfaceCDR
42     -# \ref ArchInterfaceCEL
43     -# \ref ArchInterfaceDialplanApps
44     -# \ref ArchInterfaceDialplanFuncs
45     -# \ref ArchInterfaceRTP
46     -# \ref ArchInterfaceTiming
47  -# \ref ArchThreadingModel
48     -# \ref ArchChannelThreads
49     -# \ref ArchMonitorThreads
50     -# \ref ArchServiceThreads
51     -# \ref ArchOtherThreads
52  -# \ref ArchConcepts
53     -# \ref ArchConceptBridging
54  -# \ref ArchCodeFlows
55     -# \ref ArchCodeFlowPlayback
56     -# \ref ArchCodeFlowBridge 
57  -# \ref ArchDataStructures
58     -# \ref ArchAstobj2
59     -# \ref ArchLinkedLists
60     -# \ref ArchDLinkedLists
61     -# \ref ArchHeap
62  -# \ref ArchDebugging
63     -# \ref ArchThreadDebugging
64     -# \ref ArchMemoryDebugging
65
66 <hr>
67
68 \section ArchIntro Introduction
69
70 This section of the documentation includes an overview of the Asterisk architecture
71 from a developer's point of view.  For detailed API discussion, see the documentation
72 associated with public API header files.  This documentation assumes some knowledge
73 of what Asterisk is and how to use it.
74
75 The intent behind this documentation is to start looking at Asterisk from a high
76 level and progressively dig deeper into the details.  It begins with talking about
77 the different types of components that make up Asterisk and eventually will go
78 through interactions between these components in different use cases.
79
80 Throughout this documentation, many links are also provided as references to more
81 detailed information on related APIs, as well as the related source code to what
82 is being discussed.
83
84 Feedback and contributions to this documentation are very welcome.  Please send your
85 comments to the asterisk-dev mailing list on http://lists.digium.com/.
86
87 Thank you, and enjoy Asterisk!
88
89
90 \section ArchLayout Modular Architecture
91
92 Asterisk is a highly modularized application.  There is a core application that
93 is built from the source in the <code>main/</code> directory.  However, it is
94 not very useful by itself.
95
96 There are many modules that are loaded at runtime.  Asterisk modules have names that
97 give an indication as to what functionality they provide, but the name is not special
98 in any technical sense.  When Asterisk loads a module, the module registers the
99 functionality that it provides with the Asterisk core.
100
101  -# Asterisk starts
102  -# Asterisk loads modules
103  -# Modules say "Hey Asterisk!  I am a module.  I can provide functionality X, Y,
104     and Z.  Let me know when you'd like to use my functionality!"
105
106
107 \section ArchInterfaces Abstract Interface types
108
109 There are many types of interfaces that modules can implement and register their
110 implementations of with the Asterisk core.  Any module is allowed to register as
111 many of these different interfaces as they would like.  Generally, related
112 functionality is grouped into a single module.
113
114 In this section, the types of interfaces are discussed.  Later, there will
115 be discussions about how different components interact in various scenarios.
116
117 \subsection ArchInterfaceCodec Codec Interpreter
118
119 An implementation of the codec interpreter interface provides the ability to
120 convert between two codecs.  Asterisk currently only has the ability to translate
121 between audio codecs.
122
123 These modules have no knowledge about phone calls or anything else about why
124 they are being asked to convert audio.  They just get audio samples as input
125 in their specified input format, and are expected to provide audio in the
126 specified output format.
127
128 It is possible to have multiple paths to get from codec A to codec B once many
129 codec implementations are registered.  After modules have been loaded, Asterisk
130 builds a translation table with measurements of the performance of each codec
131 translator so that it can always find the best path to get from A to B.
132
133 Codec modules typically live in the <code>codecs/</code> directory in the
134 source tree.
135
136 For a list of codec interpreter implementations, see \ref codecs.
137
138 For additional information on the codec interpreter API, see the interface
139 definition in <code>include/asterisk/translate.h</code>.
140
141 For core implementation details related to the codec interpreter API, see
142 <code>main/translate.c</code>.
143
144 \subsection ArchInterfaceFormat File Format Handler
145
146 An implementation of the file format handler interface provides Asterisk the
147 ability to read and optionally write files.  File format handlers may provide
148 access to audio, video, or image files.
149
150 The interface for a file format handler is rather primitive.  A module simply
151 tells the Asterisk core that it can handle files with a given %extension,
152 for example, ".wav".  It also says that after reading the file, it will
153 provide audio in the form of codec X.  If a file format handler provides the
154 ability to write out files, it also must specify what codec the audio should
155 be in before provided to the file format handler.
156
157 File format modules typically live in the <code>formats/</code> directory in the
158 source tree.
159
160 For a list of file format handler implementations, see \ref formats.
161
162 For additional information on the file format handler API, see the interface
163 definition in <code>include/asterisk/file.h</code>.
164
165 For core implementation details related to the file format API, see
166 <code>main/file.c</code>.
167
168 \subsection ArchInterfaceAPIs C API Providers
169
170 There are some C APIs in Asterisk that are optional.  Core APIs are built into
171 the main application and are always available.  Optional C APIs are provided
172 by a module and are only available for use when the module is loaded.  Some of
173 these API providers also contain their own interfaces that other modules can
174 implement and register.
175
176 Modules that provide a C API typically live in the <code>res/</code> directory
177 in the source tree.
178
179 Some examples of modules that provide C APIs (potentially among other things) are:
180  - res_musiconhold.c
181  - res_calendar.c
182    - provides a calendar technology interface.
183  - res_odbc.c
184  - res_ael_share.c
185  - res_crypto.c
186  - res_curl.c
187  - res_xmpp.c
188  - res_monitor.c
189  - res_smdi.c
190  - res_speech.c
191    - provides a speech recognition engine interface.
192
193 \subsection ArchInterfaceAMI Manager Interface (AMI) Actions
194
195 The Asterisk manager interface is a socket interface for monitoring and control
196 of Asterisk.  It is a core feature built in to the main application.  However,
197 modules can register %actions that may be requested by clients.
198
199 Modules that register manager %actions typically do so as auxiliary functionality
200 to complement whatever main functionality it provides.  For example, a module that
201 provides call conferencing services may have a manager action that will return the
202 list of participants in a conference.
203
204 \subsection ArchInterfaceCLI CLI Commands
205
206 The Asterisk CLI is a feature implemented in the main application.  Modules may
207 register additional CLI commands.
208
209 \subsection ArchInterfaceChannelDrivers Channel Drivers
210
211 The Asterisk channel driver interface is the most complex and most important
212 interface available.  The Asterisk channel API provides the telephony protocol
213 abstraction which allows all other Asterisk features to work independently of
214 the telephony protocol in use.
215
216 The specific interface that channel drivers implement is the ast_channel_tech
217 interface.  A channel driver must implement functions that perform various
218 call signaling tasks.  For example, they must implement a method for initiating
219 a call and hanging up a call.  The ast_channel data structure is the abstract
220 channel data structure.  Each ast_channel instance has an associated
221 ast_channel_tech which identifies the channel type.  An ast_channel instance
222 represents one leg of a call (a connection between Asterisk and an endpoint).
223
224 Channel drivers typically live in the <code>channels/</code> directory in the
225 source tree.
226
227 For a list of channel driver implementations, see \ref channel_drivers.
228
229 For additional information on the channel API, see
230 <code>include/asterisk/channel.h</code>.
231
232 For additional implementation details regarding the core ast_channel API, see
233 <code>main/channel.c</code>.
234
235 \subsection ArchInterfaceBridge Bridging Technologies
236
237 Bridging is the operation which connects two or more channels together.  A simple
238 two channel bridge is a normal A to B phone call, while a multi-party bridge would
239 be something like a 3-way call or a full conference call.
240
241 The bridging API allows modules to register bridging technologies.  An implementation
242 of a bridging technology knows how to take two (or optionally more) channels and
243 connect them together.  Exactly how this happens is up to the implementation.
244
245 This interface is used such that the code that needs to pass audio between channels
246 doesn't need to know how it is done.  Underneath, the conferencing may be done in
247 the kernel (via DAHDI), via software methods inside of Asterisk, or could be done
248 in hardware in the future if someone implemented a module to do so.
249
250 At the time of this writing, the bridging API is still relatively new, so it is
251 not used everywhere that bridging operations are performed.  The ConfBridge dialplan
252 application is a new conferencing application which has been implemented on top of
253 this bridging API.
254
255 Bridging technology modules typically live in the <code>bridges/</code> directory
256 in the source tree.
257
258 For a list of bridge technology implementations, see \ref bridges.
259
260 For additional information on the bridging API, see
261 <code>include/asterisk/bridging.h</code> and
262 <code>include/asterisk/bridging_technology.h</code>.
263
264 For additional implementation details regarding the core bridging API, see
265 <code>main/bridging.c</code>.
266
267 \subsection ArchInterfaceCDR Call Detail Record (CDR) Handlers
268
269 The Asterisk core implements functionality for keeping records of calls.  These
270 records are built while calls are processed and live in data structures.  At the
271 end of the call, these data structures are released.  Before the records are thrown
272 away, they are passed in to all of the registered CDR handlers.  These handlers may
273 write out the records to a file, post them to a database, etc.
274
275 CDR modules typically live in the <code>cdr</code> directory in the source tree.
276
277 For a list of CDR handlers, see \ref cdr_drivers.
278
279 For additional information on the CDR API, see
280 <code>include/asterisk/cdr.h</code>.
281
282 For additional implementation details regarding CDR handling, see
283 <code>main/cdr.c</code>.
284
285 \subsection ArchInterfaceCEL Call Event Logging (CEL) Handlers
286
287 The Asterisk core includes a generic event system that allows Asterisk components
288 to report events that can be subscribed to by other parts of the system.  One of
289 the things built on this event system is Call Event Logging (CEL).
290
291 CEL is similar to CDR in that they are both for tracking call history.  While CDR
292 records are typically have a one record to one call relationship, CEL events are
293 many events to one call.  The CEL modules look very similar to CDR modules.
294
295 CEL modules typically live in the <code>cel/</code> directory in the source tree.
296
297 For a list of CEL handlers, see cel_drivers.
298
299 For additional information about the CEL API, see
300 <code>include/asterisk/cel.h</code>.
301
302 For additional implementation details for the CEL API, see <code>main/cel.c</code>.
303
304 \subsection ArchInterfaceDialplanApps Dialplan Applications
305
306 Dialplan applications implement features that interact with calls that can be
307 executed from the Asterisk dialplan.  For example, in <code>extensions.conf</code>:
308
309 <code>exten => 123,1,NoOp()</code>
310
311 In this case, NoOp is the application.  Of course, NoOp doesn't actually do
312 anything.
313
314 These applications use a %number of APIs available in Asterisk to interact with
315 the channel.  One of the most important tasks of an application is to continuously
316 read audio from the channel, and also write audio back to the channel.  The details
317 of how this is done is usually hidden behind an API call used to play a file or wait
318 for digits to be pressed by a caller.
319
320 In addition to interacting with the channel that originally executed the application,
321 dialplan applications sometimes also create additional outbound channels.
322 For example, the Dial() application creates an outbound channel and bridges it to the
323 inbound channel.  Further discussion about the functionality of applications will be
324 discussed in detailed use cases.
325
326 Dialplan applications are typically found in the <code>apps/</code> directory in
327 the source tree.
328
329 For a list of dialplan applications, see \ref applications.
330
331 For details on the API used to register an application with the Asterisk core, see
332 <code>include/asterisk/pbx.h</code>.
333
334 \subsection ArchInterfaceDialplanFuncs Dialplan Functions
335
336 As the name suggests, dialplan functions, like dialplan applications, are primarily
337 used from the Asterisk dialplan.  Functions are used mostly in the same way that
338 variables are used in the dialplan.  They provide a read and/or write interface, with
339 optional arguments.  While they behave similarly to variables, they storage and
340 retrieval of a value is more complex than a simple variable with a text value.
341
342 For example, the <code>CHANNEL()</code> dialplan function allows you to access
343 data on the current channel.
344
345 <code>exten => 123,1,NoOp(This channel has the name: ${CHANNEL(name)})</code>
346
347 Dialplan functions are typically found in the <code>funcs/</code> directory in
348 the source tree.
349
350 For a list of dialplan function implementations, see \ref functions.
351
352 For details on the API used to register a dialplan function with the Asterisk core,
353 see <code>include/asterisk/pbx.h</code>.
354
355 \subsection ArchInterfaceRTP RTP Engines
356
357 The Asterisk core provides an API for handling RTP streams.  However, the actual
358 handling of these streams is done by modules that implement the RTP engine interface.
359 Implementations of an RTP engine typically live in the <code>res/</code> directory
360 of the source tree, and have a <code>res_rtp_</code> prefix in their name.
361
362 \subsection ArchInterfaceTiming Timing Interfaces
363
364 The Asterisk core implements an API that can be used by components that need access
365 to timing services.  For example, a timer is used to send parts of an audio file at
366 proper intervals when playing back a %sound file to a caller.  The API relies on
367 timing interface implementations to provide a source for reliable timing.
368
369 Timing interface implementations are typically found in the <code>res/</code>
370 subdirectory of the source tree.
371
372 For a list of timing interface implementations, see \ref timing_interfaces.
373
374 For additional information on the timing API, see <code>include/asterisk/timing.h</code>.
375
376 For additional implementation details for the timing API, see <code>main/timing.c</code>.
377
378
379 \section ArchThreadingModel Asterisk Threading Model
380
381 Asterisk is a very heavily multi threaded application.  It uses the POSIX threads API
382 to manage threads and related services such as locking.  Almost all of the Asterisk code
383 that interacts with pthreads does so by going through a set of wrappers used for
384 debugging and code reduction.
385
386 Threads in Asterisk can be classified as one of the following types:
387
388  - Channel threads (sometimes referred to as PBX threads)
389  - Network Monitor threads
390  - Service connection threads
391  - Other threads
392
393 \subsection ArchChannelThreads Channel Threads
394
395 A channel is a fundamental concept in Asterisk.  Channels are either inbound
396 or outbound.  An inbound channel is created when a call comes in to the Asterisk
397 system.  These channels are the ones that execute the Asterisk dialplan.  A thread
398 is created for every channel that executes the dialplan.  These threads are referred
399 to as a channel thread.  They are sometimes also referred to as a PBX thread, since
400 one of the primary tasks of the thread is to execute the Asterisk dialplan for an
401 inbound call.
402
403 A channel thread starts out by only being responsible for a single Asterisk channel.
404 However, there are cases where a second channel may also live in a channel thread.
405 When an inbound channel executes an application such as <code>Dial()</code>, an
406 outbound channel is created and bridged to the inbound channel once it answers.
407
408 Dialplan applications always execute in the context of a channel thread.  Dialplan
409 functions almost always do, as well.  However, it is possible to read and write
410 dialplan functions from an asynchronous interface such as the Asterisk CLI or the
411 manager interface (AMI).  However, it is still always the channel thread that is
412 the owner of the ast_channel data structure.
413
414 \subsection ArchMonitorThreads Network Monitor Threads
415
416 Network monitor threads exist in almost every major channel driver in Asterisk.
417 They are responsible for monitoring whatever network they are connected to (whether
418 that is an IP network, the PSTN, etc.) and monitor for incoming calls or other types
419 of incoming %requests.  They handle the initial connection setup steps such as
420 authentication and dialed %number validation.  Finally, once the call setup has been
421 completed, the monitor threads will create an instance of an Asterisk channel
422 (ast_channel), and start a channel thread to handle the call for the rest of its
423 lifetime.
424
425 \subsection ArchServiceThreads Service Connection Threads
426
427 There are a %number of TCP based services that use threads, as well.  Some examples
428 include SIP and the AMI.  In these cases, threads are used to handle each TCP
429 connection.
430
431 The Asterisk CLI also operates in a similar manner.  However, instead of TCP, the
432 Asterisk CLI operates using connections to a UNIX %domain socket.
433
434 \subsection ArchOtherThreads Other Threads
435
436 There are other miscellaneous threads throughout the system that perform a specific task.
437 For example, the event API (include/asterisk/event.h) uses a thread internally
438 (main/event.c) to handle asychronous event dispatching.  The devicestate API
439 (include/asterisk/devicestate.h) uses a thread internally (main/devicestate.c) 
440 to asynchronously process device state changes.
441
442
443 \section ArchConcepts Other Architecture Concepts
444
445 This section covers some other important Asterisk architecture concepts.
446
447 \subsection ArchConceptBridging Channel Bridging
448
449 As previously mentioned when discussing the bridging technology interface
450 (\ref ArchInterfaceBridge), bridging is the act of connecting one or more channel
451 together so that they may pass audio between each other.  However, it was also
452 mentioned that most of the code in Asterisk that does bridging today does not use
453 this new bridging infrastructure.  So, this section discusses the legacy bridging
454 functionality that is used by the <code>Dial()</code> and <code>Queue()</code>
455 applications.
456
457 When one of these applications decides it would like to bridge two channels together,
458 it does so by executing the ast_channel_bridge() API call.  From there, there are
459 two types of bridges that may occur.
460
461  -# <b>Generic Bridge:</b> A generic bridge (ast_generic_bridge()) is a bridging
462     method that works regardless of what channel technologies are in use.  It passes
463     all audio and signaling through the Asterisk abstract channel and frame interfaces
464     so that they can be communicated between channel drivers of any type.  While this
465     is the most flexible, it is also the least efficient bridging method due to the
466     levels of abstraction necessary.
467  -# <b>Native Bridge:</b> Channel drivers have the option of implementing their own
468     bridging functionality.  Specifically, this means to implement the bridge callback
469     in the ast_channel_tech structure.  If two channels of the same type are bridged,
470     a native bridge method is available, and Asterisk does not have a reason to force
471     the call to stay in the core of Asterisk, then the native bridge function will be
472     invoked.  This allows channel drivers to take advantage of the fact that the
473     channels are the same type to optimize bridge processing.  In the case of a DAHDI
474     channel, this may mean that the channels are bridged natively on hardware.  In the
475     case of SIP, this means that Asterisk can direct the audio to flow between the
476     endpoints and only require the signaling to continue to flow through Asterisk.
477
478
479 \section ArchCodeFlows Code Flow Examples
480
481 Now that there has been discussion about the various components that make up Asterisk,
482 this section goes through examples to demonstrate how these components work together
483 to provide useful functionality.
484
485 \subsection ArchCodeFlowPlayback SIP Call to File Playback
486
487 This example consists of a call that comes in to Asterisk via the SIP protocol.
488 Asterisk accepts this call, plays back a %sound file to the caller, and then hangs up.
489
490 Example dialplan:
491
492 <code>exten => 5551212,1,Answer()</code><br/>
493 <code>exten => 5551212,n,Playback(demo-congrats)</code><br/>
494 <code>exten => 5551212,n,Hangup()</code><br/>
495
496  -# <b>Call Setup:</b> An incoming SIP INVITE begins this scenario.  It is received by
497     the SIP channel driver (chan_sip.c).  Specifically, the monitor thread in chan_sip
498     is responsible for handling this incoming request.  Further, the monitor thread
499     is responsible for completing any handshake necessary to complete the call setup
500     process.
501  -# <b>Accept Call:</b> Once the SIP channel driver has completed the call setup process,
502     it accepts the call and initiates the call handling process in Asterisk.  To do so,
503     it must allocate an instance of an abstract channel (ast_channel) using the
504     ast_channel_alloc() API call.  This instance of an ast_channel will be referred to
505     as a SIP channel.  The SIP channel driver will take care of SIP specific channel
506     initialization.  Once the channel has been created and initialized, a channel thread
507     is created to handle the call (ast_pbx_start()).
508  -# <b>Run the Dialplan:</b>: The main loop that runs in the channel thread is the code
509     responsible for looking for the proper extension and then executing it.  This loop
510     lives in ast_pbx_run() in main/pbx.c.
511  -# <b>Answer the Call:</b>: Once the dialplan is being executed, the first application
512     that is executed is <code>Answer()</code>.  This application is a built in
513     application that is defined in main/pbx.c.  The <code>Answer()</code> application
514     code simply executes the ast_answer() API call.  This API call operates on an
515     ast_channel.  It handles generic ast_channel hangup processing, as well as executes
516     the answer callback function defined in the associated ast_channel_tech for the
517     active channel.  In this case, the sip_answer() function in chan_sip.c will get
518     executed to handle the SIP specific operations required to answer a call.
519  -# <b>Play the File:</b> The next step of the dialplan says to play back a %sound file
520     to the caller.  The <code>Playback()</code> application will be executed.
521     The code for this application is in apps/app_playback.c.  The code in the application
522     is pretty simple.  It does argument handling and uses API calls to play back the
523     file, ast_streamfile(), ast_waitstream(), and ast_stopstream(), which set up file
524     playback, wait for the file to finish playing, and then free up resources.  Some
525     of the important operations of these API calls are described in steps here:
526     -# <b>Open a File:</b> The file format API is responsible for opening the %sound file.
527        It will start by looking for a file that is encoded in the same format that the
528        channel is expecting to receive audio in.  If that is not possible, it will find
529        another type of file that can be translated into the codec that the channel is
530        expecting.  Once a file is found, the appropriate file format interface is invoked
531        to handle reading the file and turning it into internal Asterisk audio frames.
532     -# <b>Set up Translation:</b> If the encoding of the audio data in the file does not
533        match what the channel is expecting, the file API will use the codec translation
534        API to set up a translation path.  The translate API will invoke the appropriate
535        codec translation interface(s) to get from the source to the destination format
536        in the most efficient way available.
537     -# <b>Feed Audio to the Caller:</b> The file API will invoke the timer API to know
538        how to send out audio frames from the file in proper intervals.  At the same time,
539        Asterisk must also continuously service the incoming audio from the channel since
540        it will continue to arrive in real time.  However, in this scenario, it will just
541        get thrown away.
542  -# <b>Hang up the Call:</b> Once the <code>Playback()</code> application has finished,
543     the dialplan execution loop continues to the next step in the dialplan, which is
544     <code>Hangup()</code>.  This operates in a very similar manner to <code>Answer()</code>
545     in that it handles channel type agnostic hangup handling, and then calls down into
546     the SIP channel interface to handle SIP specific hangup processing.  At this point,
547     even if there were more steps in the dialplan, processing would stop since the channel
548     has been hung up.  The channel thread will exit the dialplan processing loop and
549     destroy the ast_channel data structure.
550
551 \subsection ArchCodeFlowBridge SIP to IAX2 Bridged Call
552
553 This example consists of a call that comes in to Asterisk via the SIP protocol.  Asterisk
554 then makes an outbound call via the IAX2 protocol.  When the far end over IAX2 answers,
555 the call is bridged.
556
557 Example dialplan:
558
559 <code>exten => 5551212,n,Dial(IAX2/mypeer)</code><br/>
560
561  -# <b>Call Setup:</b> An incoming SIP INVITE begins this scenario.  It is received by
562     the SIP channel driver (chan_sip.c).  Specifically, the monitor thread in chan_sip
563     is responsible for handling this incoming request.  Further, the monitor thread
564     is responsible for completing any handshake necessary to complete the call setup
565     process.
566  -# <b>Accept Call:</b> Once the SIP channel driver has completed the call setup process,
567     it accepts the call and initiates the call handling process in Asterisk.  To do so,
568     it must allocate an instance of an abstract channel (ast_channel) using the
569     ast_channel_alloc() API call.  This instance of an ast_channel will be referred to
570     as a SIP channel.  The SIP channel driver will take care of SIP specific channel
571     initialization.  Once the channel has been created and initialized, a channel thread
572     is created to handle the call (ast_pbx_start()).
573  -# <b>Run the Dialplan:</b>: The main loop that runs in the channel thread is the code
574     responsible for looking for the proper extension and then executing it.  This loop
575     lives in ast_pbx_run() in main/pbx.c.
576  -# <b>Execute Dial()</b>: The only step in this dialplan is to execute the
577     <code>Dial()</code> application.
578     -# <b>Create an Outbound Channel:</b> The <code>Dial()</code> application needs to
579        create an outbound ast_channel.  It does this by first using the ast_request()
580        API call to request a channel called <code>IAX2/mypeer</code>.  This API call
581        is a part of the core channel API (include/asterisk/channel.h).  It will find
582        a channel driver of type <code>IAX2</code> and then execute the request callback
583        in the appropriate ast_channel_tech interface.  In this case, it is iax2_request()
584        in channels/chan_iax2.c.  This asks the IAX2 channel driver to allocate an
585        ast_channel of type IAX2 and initialize it.  The <code>Dial()</code> application
586        will then execute the ast_call() API call for this new ast_channel.  This will
587        call into the call callback of the ast_channel_tech, iax2_call(), which requests
588        that the IAX2 channel driver initiate the outbound call.
589     -# <b>Wait for Answer:</b> At this point, the Dial() application waits for the
590        outbound channel to answer the call.  While it does this, it must continue to
591        service the incoming audio on both the inbound and outbound channels.  The loop
592        that does this is very similar to every other channel servicing loop in Asterisk.
593        The core features of a channel servicing loop include ast_waitfor() to wait for
594        frames on a channel, and then ast_read() on a channel once frames are available.
595     -# <b>Handle Answer:</b> Once the far end answers the call, the <code>Dial()</code>
596        application will communicate this back to the inbound SIP channel.  It does this
597        by calling the ast_answer() core channel API call.
598     -# <b>Make Channels Compatible:</b> Before the two ends of the call can be connected,
599        Asterisk must make them compatible to talk to each other.  Specifically, the two
600        channels may be sending and expecting to receive audio in a different format than
601        the other channel.  The API call ast_channel_make_compatible() sets up translation
602        paths for each channel by instantiating codec translators as necessary.
603     -# <b>Bridge the Channels:</b> Now that both the inbound and outbound channels are
604        fully established, they can be connected together.  This connection between the
605        two channels so that they can pass audio and signaling back and forth is referred
606        to as a bridge.  The API call that handles the bridge is ast_channel_bridge().
607        In this case, the main loop of the bridge is a generic bridge, ast_generic_bridge(),
608        which is the type of bridge that works regardless of the two channel types.  A
609        generic bridge will almost always be used if the two channels are not of the same
610        type.  The core functionality of a bridge loop is ast_waitfor() on both channels.
611        Then, when frames arrive on a channel, they are read using ast_read().  After reading
612        a frame, they are written to the other channel using ast_write().
613     -# <b>Breaking the Bridge</b>: This bridge will continue until some event occurs that
614        causes the bridge to be broken, and control to be returned back down to the
615        <code>Dial()</code> application.  For example, if one side of the call hangs up,
616        the bridge will stop.
617  -# <b>Hanging Up:</b>: After the bridge stops, control will return to the
618     <code>Dial()</code> application.  The application owns the outbound channel since
619     that is where it was created.  So, the outbound IAX2 channel will be destroyed
620     before <code>Dial()</code> is complete.  Destroying the channel is done by using
621     the ast_hangup() API call.  The application will return back to the dialplan
622     processing loop.  From there, the loop will see that there is nothing else to
623     execute, so it will hangup on the inbound channel as well using the ast_hangup()
624     function.  ast_hangup() performs a number of channel type independent hangup
625     tasks, but also executes the hangup callback of ast_channel_tech (sip_hangup()).
626     Finally, the channel thread exits.
627
628
629 \section ArchDataStructures Asterisk Data Structures
630
631 Asterisk provides generic implementations of a number of data structures.
632
633 \subsection ArchAstobj2 Astobj2
634
635 Astobj2 stands for the Asterisk Object model, version 2.  The API is defined in
636 include/asterisk/astobj2.h.  Some internal implementation details for astobj2 can
637 be found in main/astobj2.c.  There is a version 1, and it still exists in the
638 source tree.  However, it is considered deprecated.
639
640 Astobj2 provides reference counted object handling.  It also provides a container
641 interface for astobj2 objects.  The container provided is a hash table.
642
643 See the astobj2 API for more details about how to use it.  Examples can be found
644 all over the code base.
645
646 \subsection ArchLinkedLists Linked Lists
647
648 Asterisk provides a set of macros for handling linked lists.  They are defined in
649 include/asterisk/linkedlists.h.
650
651 \subsection ArchDLinkedLists Doubly Linked Lists
652
653 Asterisk provides a set of macros for handling doubly linked lists, as well.  They
654 are defined in include/asterisk/dlinkedlists.h.
655
656 \subsection ArchHeap Heap
657
658 Asterisk provides an implementation of the max heap data structure.  The API is defined
659 in include/asterisk/heap.h.  The internal implementation details can be found in
660 main/heap.c.
661
662
663 \section ArchDebugging Asterisk Debugging Tools
664
665 Asterisk includes a %number of built in debugging tools to help in diagnosing common
666 types of problems.
667
668 \subsection ArchThreadDebugging Thread Debugging
669
670 Asterisk keeps track of a list of all active threads on the system.  A list of threads
671 can be viewed from the Asterisk CLI by running the command
672 <code>core show threads</code>.
673
674 Asterisk has a compile time option called <code>DEBUG_THREADS</code>.  When this is on,
675 the pthread wrapper API in Asterisk keeps track of additional information related to
676 threads and locks to aid in debugging.  In addition to just keeping a list of threads,
677 Asterisk also maintains information about every lock that is currently held by any
678 thread on the system.  It also knows when a thread is blocking while attempting to
679 acquire a lock.  All of this information is extremely useful when debugging a deadlock.
680 This data can be acquired from the Asterisk CLI by running the
681 <code>core show locks</code> CLI command.
682
683 The definitions of these wrappers can be found in <code>include/asterisk/lock.h</code>
684 and <code>include/asterisk/utils.h</code>.  Most of the implementation details can be
685 found in <code>main/utils.c</code>.
686
687 \subsection ArchMemoryDebugging Memory debugging
688
689 Dynamic memory management in Asterisk is handled through a %number of wrappers defined
690 in <code>include/asterisk/utils.h</code>.  By default, all of these wrappers use the
691 standard C library malloc(), free(), etc. functions.  However, if Asterisk is compiled
692 with the MALLOC_DEBUG option enabled, additional memory debugging is included.
693
694 The Asterisk memory debugging system provides the following features:
695
696  - Track all current allocations including their size and the file, function, and line
697    %number where they were initiated.
698  - When releasing memory, do some basic fence checking to see if anything wrote into the
699    few bytes immediately surrounding an allocation.
700  - Get notified when attempting to free invalid memory.
701
702 A %number of CLI commands are provided to access data on the current set of memory
703 allocations.  Those are:
704
705  - <code>memory show summary</code>
706  - <code>memory show allocations</code>
707
708 The implementation of this memory debugging system can be found in
709 <code>main/astmm.c</code>.
710
711
712 <hr>
713 Return to the \ref ArchTOC
714  */
715