Add private lock deadlock avoidance callback to PRI and SS7.
[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         /*! Call is present but has no response yet. (SETUP) */
92         SIG_SS7_CALL_LEVEL_SETUP,
93         /*! Call routing is happening. (PROCEEDING) */
94         SIG_SS7_CALL_LEVEL_PROCEEDING,
95         /*! Called party is being alerted of the call. (ALERTING) */
96         SIG_SS7_CALL_LEVEL_ALERTING,
97         /*! Call is connected/answered. (CONNECT) */
98         SIG_SS7_CALL_LEVEL_CONNECT,
99 };
100
101 struct sig_ss7_linkset;
102
103 struct sig_ss7_callback {
104         /* Unlock the private in the signaling private structure. */
105         void (* const unlock_private)(void *pvt);
106         /* Lock the private in the signaling private structure. */
107         void (* const lock_private)(void *pvt);
108         /* Do deadlock avoidance for the private signaling structure lock.  */
109         void (* const deadlock_avoidance_private)(void *pvt);
110
111         int (* const set_echocanceller)(void *pvt, int enable);
112         void (* const set_loopback)(void *pvt, int enable);
113
114         struct ast_channel * (* const new_ast_channel)(void *pvt, int state, enum sig_ss7_law law, char *exten, const struct ast_channel *requestor);
115         int (* const play_tone)(void *pvt, enum sig_ss7_tone tone);
116
117         void (* const handle_link_exception)(struct sig_ss7_linkset *linkset, int which);
118         void (* const set_alarm)(void *pvt, int in_alarm);
119         void (* const set_dialing)(void *pvt, int is_dialing);
120         void (* const set_digital)(void *pvt, int is_digital);
121         void (* const set_inservice)(void *pvt, int is_inservice);
122         void (* const set_locallyblocked)(void *pvt, int is_blocked);
123         void (* const set_remotelyblocked)(void *pvt, int is_blocked);
124         void (* const set_callerid)(void *pvt, const struct ast_party_caller *caller);
125         void (* const set_dnid)(void *pvt, const char *dnid);
126
127         void (* const queue_control)(void *pvt, int subclass);
128 };
129
130 struct sig_ss7_chan {
131         struct sig_ss7_callback *calls;
132         void *chan_pvt;                                 /*!< Private structure of the user of this module. */
133         struct sig_ss7_linkset *ss7;
134         struct ast_channel *owner;
135
136         /*! \brief Opaque libss7 call control structure */
137         struct isup_call *ss7call;
138
139         /*! Call establishment life cycle level for simple comparisons. */
140         enum sig_ss7_call_level call_level;
141
142         int channel;                                    /*!< Channel Number */
143         int cic;                                                /*!< CIC associated with channel */
144         unsigned int dpc;                               /*!< CIC's DPC */
145
146         /* Options to be set by user */
147         /*!
148          * \brief Number of most significant digits/characters to strip from the dialed number.
149          * \note Feature is deprecated.  Use dialplan logic.
150          */
151         int stripmsd;
152         /*!
153          * \brief TRUE if the outgoing caller ID is blocked/hidden.
154          */
155         unsigned int hidecallerid:1;
156         /*! \brief TRUE if caller ID is used on this channel. */
157         unsigned int use_callerid:1;
158         /*!
159          * \brief TRUE if we will use the calling presentation setting
160          * from the Asterisk channel for outgoing calls.
161          */
162         unsigned int use_callingpres:1;
163         unsigned int immediate:1;               /*!< Answer before getting digits? */
164
165         /*! \brief TRUE if the channel is locally blocked.  Set by user and link. */
166         unsigned int locallyblocked:1;
167         /*! \brief TRUE if the channel is remotely blocked.  Set by user and link. */
168         unsigned int remotelyblocked:1;
169
170         char context[AST_MAX_CONTEXT];
171         char mohinterpret[MAX_MUSICCLASS];
172
173         /* Options to be checked by user */
174         int cid_ani2;                                   /*!< Automatic Number Identification number (Alternate PRI caller ID number) */
175         int cid_ton;                                    /*!< Type Of Number (TON) */
176         int callingpres;                                /*!< The value of calling presentation that we're going to use when placing a PRI call */
177         char cid_num[AST_MAX_EXTENSION];
178         char cid_subaddr[AST_MAX_EXTENSION];/*!< XXX SS7 may not support. */
179         char cid_name[AST_MAX_EXTENSION];
180         char cid_ani[AST_MAX_EXTENSION];
181         char exten[AST_MAX_EXTENSION];
182
183         /* Options to be checked by user that are stuffed into channel variables. */
184         char charge_number[50];
185         char gen_add_number[50];
186         char gen_dig_number[50];
187         char orig_called_num[50];
188         char redirecting_num[50];
189         char generic_name[50];
190         unsigned char gen_add_num_plan;
191         unsigned char gen_add_nai;
192         unsigned char gen_add_pres_ind;
193         unsigned char gen_add_type;
194         unsigned char gen_dig_type;
195         unsigned char gen_dig_scheme;
196         char jip_number[50];
197 #if 0
198         unsigned char lspi_type;
199         unsigned char lspi_scheme;
200         unsigned char lspi_context;
201 #endif
202         char lspi_ident[50];
203         unsigned int call_ref_ident;
204         unsigned int call_ref_pc;
205         unsigned char calling_party_cat;
206
207         /*
208          * Channel status bits.
209          */
210         /*! TRUE if channel is associated with a link that is down. */
211         unsigned int inalarm:1;
212         /*! TRUE if this channel is being used for an outgoing call. */
213         unsigned int outgoing:1;
214         /*! \brief TRUE if the call has seen inband-information progress through the network. */
215         unsigned int progress:1;
216         /*! \brief TRUE if the call has already gone/hungup */
217         unsigned int alreadyhungup:1;
218         /*! \brief XXX BOOLEAN Purpose??? */
219         unsigned int rlt:1;
220         /*! TRUE if this channel is in loopback. */
221         unsigned int loopedback:1;
222 };
223
224 struct sig_ss7_linkset {
225         pthread_t master;                                       /*!< Thread of master */
226         ast_mutex_t lock;                                       /*!< libss7 access lock */
227         struct sig_ss7_callback *calls;
228         struct ss7 *ss7;
229         struct sig_ss7_chan *pvts[SIG_SS7_MAX_CHANNELS];/*!< Member channel pvt structs */
230         int fds[SIG_SS7_NUM_DCHANS];
231         int numsigchans;
232         int linkstate[SIG_SS7_NUM_DCHANS];
233         int numchans;
234         int span;                                                       /*!< span number put into user output messages */
235         enum {
236                 LINKSET_STATE_DOWN = 0,
237                 LINKSET_STATE_UP
238         } state;
239
240         /* Options to be set by user */
241         int flags;                                                      /*!< Linkset flags (LINKSET_FLAG_EXPLICITACM) */
242         int type;                                                       /*!< SS7 type ITU/ANSI. Used for companding selection. */
243         char called_nai;                                        /*!< Called Nature of Address Indicator */
244         char calling_nai;                                       /*!< Calling Nature of Address Indicator */
245         char internationalprefix[10];           /*!< country access code ('00' for european dialplans) */
246         char nationalprefix[10];                        /*!< area access code ('0' for european dialplans) */
247         char subscriberprefix[20];                      /*!< area access code + area code ('0'+area code for european dialplans) */
248         char unknownprefix[20];                         /*!< for unknown dialplans */
249 };
250
251 void sig_ss7_set_alarm(struct sig_ss7_chan *p, int in_alarm);
252
253 void *ss7_linkset(void *data);
254
255 void sig_ss7_link_alarm(struct sig_ss7_linkset *linkset, int which);
256 void sig_ss7_link_noalarm(struct sig_ss7_linkset *linkset, int which);
257 int sig_ss7_add_sigchan(struct sig_ss7_linkset *linkset, int which, int ss7type, int transport, int inalarm, int networkindicator, int pointcode, int adjpointcode);
258
259 int sig_ss7_available(struct sig_ss7_chan *p);
260 int sig_ss7_call(struct sig_ss7_chan *p, struct ast_channel *ast, char *rdest);
261 int sig_ss7_hangup(struct sig_ss7_chan *p, struct ast_channel *ast);
262 int sig_ss7_answer(struct sig_ss7_chan *p, struct ast_channel *ast);
263 void sig_ss7_fixup(struct ast_channel *oldchan, struct ast_channel *newchan, struct sig_ss7_chan *pchan);
264 int sig_ss7_indicate(struct sig_ss7_chan *p, struct ast_channel *chan, int condition, const void *data, size_t datalen);
265 struct ast_channel *sig_ss7_request(struct sig_ss7_chan *p, enum sig_ss7_law law, const struct ast_channel *requestor, int transfercapability);
266 void sig_ss7_chan_delete(struct sig_ss7_chan *doomed);
267 struct sig_ss7_chan *sig_ss7_chan_new(void *pvt_data, struct sig_ss7_callback *callback, struct sig_ss7_linkset *ss7);
268 void sig_ss7_init_linkset(struct sig_ss7_linkset *ss7);
269
270
271 /* ------------------------------------------------------------------- */
272
273 #ifdef __cplusplus
274 }
275 #endif
276
277 #endif  /* _ASTERISK_SIG_SS7_H */
278 /* ------------------------------------------------------------------- */
279 /* end sig_ss7.h */