Fix a file descriptor leak in off nominal path
[asterisk/asterisk.git] / channels / sig_ss7.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010 Digium, Inc.
5  *
6  * Richard Mudgett <rmudgett@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  * \brief Interface header for SS7 signaling module.
22  *
23  * \author Matthew Fredrickson <creslin@digium.com>
24  * \author Richard Mudgett <rmudgett@digium.com>
25  *
26  * See Also:
27  * \arg \ref AstCREDITS
28  */
29
30 #ifndef _ASTERISK_SIG_SS7_H
31 #define _ASTERISK_SIG_SS7_H
32
33 #include "asterisk/channel.h"
34 #include <libss7.h>
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 /* ------------------------------------------------------------------- */
41
42 /*! SS7 debug message flags when SS7 debugging is turned on at the command line. */
43 #define SIG_SS7_DEBUG   \
44         (SS7_DEBUG_MTP2 | SS7_DEBUG_MTP3 | SS7_DEBUG_ISUP)
45
46 #if 0
47 /*! SS7 debug message flags set on initial startup. */
48 #define SIG_SS7_DEBUG_DEFAULT   SIG_SS7_DEBUG
49 #else
50 /*! SS7 debug message flags set on initial startup. */
51 #define SIG_SS7_DEBUG_DEFAULT   0
52 #endif
53
54 /* ------------------------------------------------------------------- */
55
56 #define SIG_SS7_NUM_DCHANS              4               /*!< No more than 4 d-channels */
57 #define SIG_SS7_MAX_CHANNELS    672             /*!< No more than a DS3 per trunk group */
58
59 #define SIG_SS7         (0x1000000 | DAHDI_SIG_CLEAR)
60
61 #define LINKSTATE_INALARM       (1 << 0)
62 #define LINKSTATE_STARTING      (1 << 1)
63 #define LINKSTATE_UP            (1 << 2)
64 #define LINKSTATE_DOWN          (1 << 3)
65
66 #define SS7_NAI_DYNAMIC         -1
67
68 #define LINKSET_FLAG_EXPLICITACM (1 << 0)
69
70
71 enum sig_ss7_tone {
72         SIG_SS7_TONE_RINGTONE = 0,
73         SIG_SS7_TONE_STUTTER,
74         SIG_SS7_TONE_CONGESTION,
75         SIG_SS7_TONE_DIALTONE,
76         SIG_SS7_TONE_DIALRECALL,
77         SIG_SS7_TONE_INFO,
78         SIG_SS7_TONE_BUSY,
79 };
80
81 enum sig_ss7_law {
82         SIG_SS7_DEFLAW = 0,
83         SIG_SS7_ULAW,
84         SIG_SS7_ALAW
85 };
86
87 /*! Call establishment life cycle level for simple comparisons. */
88 enum sig_ss7_call_level {
89         /*! Call does not exist. */
90         SIG_SS7_CALL_LEVEL_IDLE,
91         /*!
92          * Call is allocated to the channel.
93          * We have not sent or responded to IAM yet.
94          */
95         SIG_SS7_CALL_LEVEL_ALLOCATED,
96         /*!
97          * Call is performing continuity check after receiving IAM.
98          * We are waiting for COT to proceed further.
99          */
100         SIG_SS7_CALL_LEVEL_CONTINUITY,
101         /*!
102          * Call is present.
103          * We have not seen a response or sent further call progress to an IAM yet.
104          */
105         SIG_SS7_CALL_LEVEL_SETUP,
106         /*!
107          * Call routing is happening.
108          * We have sent or received ACM.
109          */
110         SIG_SS7_CALL_LEVEL_PROCEEDING,
111         /*!
112          * Called party is being alerted of the call.
113          * We have sent or received CPG(ALERTING)/ACM(ALERTING).
114          */
115         SIG_SS7_CALL_LEVEL_ALERTING,
116         /*!
117          * Call is connected/answered.
118          * We have sent or received CON/ANM.
119          */
120         SIG_SS7_CALL_LEVEL_CONNECT,
121         /*! Call has collided with incoming call. */
122         SIG_SS7_CALL_LEVEL_GLARE,
123 };
124
125 struct sig_ss7_linkset;
126
127 struct sig_ss7_callback {
128         /* Unlock the private in the signaling private structure. */
129         void (* const unlock_private)(void *pvt);
130         /* Lock the private in the signaling private structure. */
131         void (* const lock_private)(void *pvt);
132         /* Do deadlock avoidance for the private signaling structure lock.  */
133         void (* const deadlock_avoidance_private)(void *pvt);
134
135         int (* const set_echocanceller)(void *pvt, int enable);
136         void (* const set_loopback)(void *pvt, int enable);
137
138         struct ast_channel * (* const new_ast_channel)(void *pvt, int state, enum sig_ss7_law law, char *exten, const struct ast_channel *requestor);
139         int (* const play_tone)(void *pvt, enum sig_ss7_tone tone);
140
141         void (* const handle_link_exception)(struct sig_ss7_linkset *linkset, int which);
142         void (* const set_alarm)(void *pvt, int in_alarm);
143         void (* const set_dialing)(void *pvt, int is_dialing);
144         void (* const set_digital)(void *pvt, int is_digital);
145         void (* const set_outgoing)(void *pvt, int is_outgoing);
146         void (* const set_inservice)(void *pvt, int is_inservice);
147         void (* const set_locallyblocked)(void *pvt, int is_blocked);
148         void (* const set_remotelyblocked)(void *pvt, int is_blocked);
149         void (* const set_callerid)(void *pvt, const struct ast_party_caller *caller);
150         void (* const set_dnid)(void *pvt, const char *dnid);
151
152         void (* const queue_control)(void *pvt, int subclass);
153         void (* const open_media)(void *pvt);
154 };
155
156 /*! Global sig_ss7 callbacks to the upper layer. */
157 extern struct sig_ss7_callback sig_ss7_callbacks;
158
159 struct sig_ss7_chan {
160         void *chan_pvt;                                 /*!< Private structure of the user of this module. */
161         struct sig_ss7_linkset *ss7;
162         struct ast_channel *owner;
163
164         /*! \brief Opaque libss7 call control structure */
165         struct isup_call *ss7call;
166
167         /*! Call establishment life cycle level for simple comparisons. */
168         enum sig_ss7_call_level call_level;
169
170         int channel;                                    /*!< Channel Number */
171         int cic;                                                /*!< CIC associated with channel */
172         unsigned int dpc;                               /*!< CIC's DPC */
173
174         /* Options to be set by user */
175         /*!
176          * \brief Number of most significant digits/characters to strip from the dialed number.
177          * \note Feature is deprecated.  Use dialplan logic.
178          */
179         int stripmsd;
180         /*!
181          * \brief TRUE if the outgoing caller ID is blocked/hidden.
182          */
183         unsigned int hidecallerid:1;
184         /*! \brief TRUE if caller ID is used on this channel. */
185         unsigned int use_callerid:1;
186         /*!
187          * \brief TRUE if we will use the calling presentation setting
188          * from the Asterisk channel for outgoing calls.
189          */
190         unsigned int use_callingpres:1;
191         unsigned int immediate:1;               /*!< Answer before getting digits? */
192
193         /*! \brief TRUE if the channel is locally blocked.  Set by user and link. */
194         unsigned int locallyblocked:1;
195         /*! \brief TRUE if the channel is remotely blocked.  Set by user and link. */
196         unsigned int remotelyblocked:1;
197
198         char context[AST_MAX_CONTEXT];
199         char mohinterpret[MAX_MUSICCLASS];
200
201         /* Options to be checked by user */
202         int cid_ani2;                                   /*!< Automatic Number Identification number (Alternate PRI caller ID number) */
203         int cid_ton;                                    /*!< Type Of Number (TON) */
204         int callingpres;                                /*!< The value of calling presentation that we're going to use when placing a PRI call */
205         char cid_num[AST_MAX_EXTENSION];
206         char cid_subaddr[AST_MAX_EXTENSION];/*!< XXX SS7 may not support. */
207         char cid_name[AST_MAX_EXTENSION];
208         char cid_ani[AST_MAX_EXTENSION];
209         char exten[AST_MAX_EXTENSION];
210
211         /* Options to be checked by user that are stuffed into channel variables. */
212         char charge_number[50];
213         char gen_add_number[50];
214         char gen_dig_number[50];
215         char orig_called_num[50];
216         char redirecting_num[50];
217         char generic_name[50];
218         unsigned char gen_add_num_plan;
219         unsigned char gen_add_nai;
220         unsigned char gen_add_pres_ind;
221         unsigned char gen_add_type;
222         unsigned char gen_dig_type;
223         unsigned char gen_dig_scheme;
224         char jip_number[50];
225 #if 0
226         unsigned char lspi_type;
227         unsigned char lspi_scheme;
228         unsigned char lspi_context;
229 #endif
230         char lspi_ident[50];
231         unsigned int call_ref_ident;
232         unsigned int call_ref_pc;
233         unsigned char calling_party_cat;
234
235         /*
236          * Channel status bits.
237          */
238         /*! TRUE if channel is associated with a link that is down. */
239         unsigned int inalarm:1;
240         /*! TRUE if this channel is being used for an outgoing call. */
241         unsigned int outgoing:1;
242         /*! \brief TRUE if the call has seen inband-information progress through the network. */
243         unsigned int progress:1;
244         /*! \brief TRUE if the call has already gone/hungup */
245         unsigned int alreadyhungup:1;
246         /*! \brief XXX BOOLEAN Purpose??? */
247         unsigned int rlt:1;
248         /*! TRUE if this channel is in loopback. */
249         unsigned int loopedback:1;
250 };
251
252 struct sig_ss7_linkset {
253         pthread_t master;                                       /*!< Thread of master */
254         ast_mutex_t lock;                                       /*!< libss7 access lock */
255         struct ss7 *ss7;
256         struct sig_ss7_chan *pvts[SIG_SS7_MAX_CHANNELS];/*!< Member channel pvt structs */
257         int fds[SIG_SS7_NUM_DCHANS];
258         int numsigchans;
259         int linkstate[SIG_SS7_NUM_DCHANS];
260         int numchans;
261         int span;                                                       /*!< span number put into user output messages */
262         int debug;                                                      /*!< set to true if to dump SS7 event info */
263         enum {
264                 LINKSET_STATE_DOWN = 0,
265                 LINKSET_STATE_UP
266         } state;
267
268         /* Options to be set by user */
269         int flags;                                                      /*!< Linkset flags (LINKSET_FLAG_EXPLICITACM) */
270         int type;                                                       /*!< SS7 type ITU/ANSI. Used for companding selection. */
271         char called_nai;                                        /*!< Called Nature of Address Indicator */
272         char calling_nai;                                       /*!< Calling Nature of Address Indicator */
273         char internationalprefix[10];           /*!< country access code ('00' for european dialplans) */
274         char nationalprefix[10];                        /*!< area access code ('0' for european dialplans) */
275         char subscriberprefix[20];                      /*!< area access code + area code ('0'+area code for european dialplans) */
276         char unknownprefix[20];                         /*!< for unknown dialplans */
277 };
278
279 void sig_ss7_set_alarm(struct sig_ss7_chan *p, int in_alarm);
280
281 void *ss7_linkset(void *data);
282
283 void sig_ss7_link_alarm(struct sig_ss7_linkset *linkset, int which);
284 void sig_ss7_link_noalarm(struct sig_ss7_linkset *linkset, int which);
285 int sig_ss7_add_sigchan(struct sig_ss7_linkset *linkset, int which, int ss7type, int transport, int inalarm, int networkindicator, int pointcode, int adjpointcode);
286
287 int sig_ss7_available(struct sig_ss7_chan *p);
288 int sig_ss7_call(struct sig_ss7_chan *p, struct ast_channel *ast, const char *rdest);
289 int sig_ss7_hangup(struct sig_ss7_chan *p, struct ast_channel *ast);
290 int sig_ss7_answer(struct sig_ss7_chan *p, struct ast_channel *ast);
291 void sig_ss7_fixup(struct ast_channel *oldchan, struct ast_channel *newchan, struct sig_ss7_chan *pchan);
292 int sig_ss7_indicate(struct sig_ss7_chan *p, struct ast_channel *chan, int condition, const void *data, size_t datalen);
293 struct ast_channel *sig_ss7_request(struct sig_ss7_chan *p, enum sig_ss7_law law, const struct ast_channel *requestor, int transfercapability);
294 void sig_ss7_chan_delete(struct sig_ss7_chan *doomed);
295 struct sig_ss7_chan *sig_ss7_chan_new(void *pvt_data, struct sig_ss7_linkset *ss7);
296 void sig_ss7_init_linkset(struct sig_ss7_linkset *ss7);
297
298 void sig_ss7_cli_show_channels_header(int fd);
299 void sig_ss7_cli_show_channels(int fd, struct sig_ss7_linkset *linkset);
300
301
302 /* ------------------------------------------------------------------- */
303
304 #ifdef __cplusplus
305 }
306 #endif
307
308 #endif  /* _ASTERISK_SIG_SS7_H */
309 /* ------------------------------------------------------------------- */
310 /* end sig_ss7.h */