← Back to branch summary

~ubuntu-branches/ubuntu/wily/sflphone/wily

« back to all changes in this revision

Viewing changes to daemon/libs/pjproject-2.1.0/pjnath/src/pjnath/turn_sock.c

  • Committer: Package Import Robot
  • Author(s): Mark Purcell
  • Date: 2014-01-28 18:23:36 UTC
  • mfrom: (1.1.11)
  • mto: This revision was merged to the branch mainline in revision 24.
  • Revision ID: package-import@ubuntu.com-20140128182336-3xenud1kbnwmf3mz
http://bugs.debian.org/735846
http://bugs.debian.org/727164
http://bugs.debian.org/718178
http://bugs.debian.org/736583
http://bugs.debian.org/722040
http://bugs.debian.org/736746
* New upstream release 
  - Fixes "New Upstream Release" (Closes: #735846)
  - Fixes "Ringtone does not stop" (Closes: #727164)
  - Fixes "[sflphone-kde] crash on startup" (Closes: #718178)
  - Fixes "sflphone GUI crashes when call is hung up" (Closes: #736583)
* Build-Depends: ensure GnuTLS 2.6
  - libucommon-dev (>= 6.0.7-1.1), libccrtp-dev (>= 2.0.6-3)
  - Fixes "FTBFS Build-Depends libgnutls{26,28}-dev" (Closes: #722040)
* Fix "boost 1.49 is going away" unversioned Build-Depends: (Closes: #736746)
* Add Build-Depends: libsndfile-dev, nepomuk-core-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
daemon/libs/pjproject-2.1.0/pjnath/src/pjnath/turn_sock.c
 
1
/* $Id: turn_sock.c 4360 2013-02-21 11:26:35Z bennylp $ */
 
2
/* 
 
3
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 
4
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
 
5
 *
 
6
 * This program is free software; you can redistribute it and/or modify
 
7
 * it under the terms of the GNU General Public License as published by
 
8
 * the Free Software Foundation; either version 2 of the License, or
 
9
 * (at your option) any later version.
 
10
 *
 
11
 * This program is distributed in the hope that it will be useful,
 
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
 * GNU General Public License for more details.
 
15
 *
 
16
 * You should have received a copy of the GNU General Public License
 
17
 * along with this program; if not, write to the Free Software
 
18
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 
19
 */
 
20
#include <pjnath/turn_sock.h>
 
21
#include <pj/activesock.h>
 
22
#include <pj/assert.h>
 
23
#include <pj/errno.h>
 
24
#include <pj/lock.h>
 
25
#include <pj/log.h>
 
26
#include <pj/pool.h>
 
27
#include <pj/ioqueue.h>
 
28
 
 
29
enum
 
30
{
 
31
    TIMER_NONE,
 
32
    TIMER_DESTROY
 
33
};
 
34
 
 
35
 
 
36
enum { MAX_BIND_RETRY = 100 };
 
37
 
 
38
 
 
39
#define INIT    0x1FFFFFFF
 
40
 
 
41
struct pj_turn_sock
 
42
{
 
43
    pj_pool_t           *pool;
 
44
    const char          *obj_name;
 
45
    pj_turn_session     *sess;
 
46
    pj_turn_sock_cb      cb;
 
47
    void                *user_data;
 
48
 
 
49
    pj_bool_t            is_destroying;
 
50
    pj_grp_lock_t       *grp_lock;
 
51
 
 
52
    pj_turn_alloc_param  alloc_param;
 
53
    pj_stun_config       cfg;
 
54
    pj_turn_sock_cfg     setting;
 
55
 
 
56
    pj_timer_entry       timer;
 
57
 
 
58
    int                  af;
 
59
    pj_turn_tp_type      conn_type;
 
60
    pj_activesock_t     *active_sock;
 
61
    pj_ioqueue_op_key_t  send_key;
 
62
};
 
63
 
 
64
 
 
65
/*
 
66
 * Callback prototypes.
 
67
 */
 
68
static pj_status_t turn_on_send_pkt(pj_turn_session *sess,
 
69
                                    const pj_uint8_t *pkt,
 
70
                                    unsigned pkt_len,
 
71
                                    const pj_sockaddr_t *dst_addr,
 
72
                                    unsigned dst_addr_len);
 
73
static void turn_on_channel_bound(pj_turn_session *sess,
 
74
                                  const pj_sockaddr_t *peer_addr,
 
75
                                  unsigned addr_len,
 
76
                                  unsigned ch_num);
 
77
static void turn_on_rx_data(pj_turn_session *sess,
 
78
                            void *pkt,
 
79
                            unsigned pkt_len,
 
80
                            const pj_sockaddr_t *peer_addr,
 
81
                            unsigned addr_len);
 
82
static void turn_on_state(pj_turn_session *sess, 
 
83
                          pj_turn_state_t old_state,
 
84
                          pj_turn_state_t new_state);
 
85
 
 
86
static pj_bool_t on_data_read(pj_activesock_t *asock,
 
87
                              void *data,
 
88
                              pj_size_t size,
 
89
                              pj_status_t status,
 
90
                              pj_size_t *remainder);
 
91
static pj_bool_t on_connect_complete(pj_activesock_t *asock,
 
92
                                     pj_status_t status);
 
93
 
 
94
 
 
95
 
 
96
static void turn_sock_on_destroy(void *comp);
 
97
static void destroy(pj_turn_sock *turn_sock);
 
98
static void timer_cb(pj_timer_heap_t *th, pj_timer_entry *e);
 
99
 
 
100
 
 
101
/* Init config */
 
102
PJ_DEF(void) pj_turn_sock_cfg_default(pj_turn_sock_cfg *cfg)
 
103
{
 
104
    pj_bzero(cfg, sizeof(*cfg));
 
105
    cfg->max_pkt_size = PJ_TURN_MAX_PKT_LEN;
 
106
    cfg->qos_type = PJ_QOS_TYPE_BEST_EFFORT;
 
107
    cfg->qos_ignore_error = PJ_TRUE;
 
108
}
 
109
 
 
110
 
 
111
/*
 
112
 * Create.
 
113
 */
 
114
PJ_DEF(pj_status_t) pj_turn_sock_create(pj_stun_config *cfg,
 
115
                                        int af,
 
116
                                        pj_turn_tp_type conn_type,
 
117
                                        const pj_turn_sock_cb *cb,
 
118
                                        const pj_turn_sock_cfg *setting,
 
119
                                        void *user_data,
 
120
                                        pj_turn_sock **p_turn_sock)
 
121
{
 
122
    pj_turn_sock *turn_sock;
 
123
    pj_turn_session_cb sess_cb;
 
124
    pj_turn_sock_cfg default_setting;
 
125
    pj_pool_t *pool;
 
126
    const char *name_tmpl;
 
127
    pj_status_t status;
 
128
 
 
129
    PJ_ASSERT_RETURN(cfg && p_turn_sock, PJ_EINVAL);
 
130
    PJ_ASSERT_RETURN(af==pj_AF_INET() || af==pj_AF_INET6(), PJ_EINVAL);
 
131
    PJ_ASSERT_RETURN(conn_type!=PJ_TURN_TP_TCP || PJ_HAS_TCP, PJ_EINVAL);
 
132
 
 
133
    if (!setting) {
 
134
        pj_turn_sock_cfg_default(&default_setting);
 
135
        setting = &default_setting;
 
136
    }
 
137
 
 
138
    switch (conn_type) {
 
139
    case PJ_TURN_TP_UDP:
 
140
        name_tmpl = "udprel%p";
 
141
        break;
 
142
    case PJ_TURN_TP_TCP:
 
143
        name_tmpl = "tcprel%p";
 
144
        break;
 
145
    default:
 
146
        PJ_ASSERT_RETURN(!"Invalid TURN conn_type", PJ_EINVAL);
 
147
        name_tmpl = "tcprel%p";
 
148
        break;
 
149
    }
 
150
 
 
151
    /* Create and init basic data structure */
 
152
    pool = pj_pool_create(cfg->pf, name_tmpl, PJNATH_POOL_LEN_TURN_SOCK,
 
153
                          PJNATH_POOL_INC_TURN_SOCK, NULL);
 
154
    turn_sock = PJ_POOL_ZALLOC_T(pool, pj_turn_sock);
 
155
    turn_sock->pool = pool;
 
156
    turn_sock->obj_name = pool->obj_name;
 
157
    turn_sock->user_data = user_data;
 
158
    turn_sock->af = af;
 
159
    turn_sock->conn_type = conn_type;
 
160
 
 
161
    /* Copy STUN config (this contains ioqueue, timer heap, etc.) */
 
162
    pj_memcpy(&turn_sock->cfg, cfg, sizeof(*cfg));
 
163
 
 
164
    /* Copy setting (QoS parameters etc */
 
165
    pj_memcpy(&turn_sock->setting, setting, sizeof(*setting));
 
166
 
 
167
    /* Set callback */
 
168
    if (cb) {
 
169
        pj_memcpy(&turn_sock->cb, cb, sizeof(*cb));
 
170
    }
 
171
 
 
172
    /* Session lock */
 
173
    if (setting && setting->grp_lock) {
 
174
        turn_sock->grp_lock = setting->grp_lock;
 
175
    } else {
 
176
        status = pj_grp_lock_create(pool, NULL, &turn_sock->grp_lock);
 
177
        if (status != PJ_SUCCESS) {
 
178
            pj_pool_release(pool);
 
179
            return status;
 
180
        }
 
181
    }
 
182
 
 
183
    pj_grp_lock_add_ref(turn_sock->grp_lock);
 
184
    pj_grp_lock_add_handler(turn_sock->grp_lock, pool, turn_sock,
 
185
                            &turn_sock_on_destroy);
 
186
 
 
187
    /* Init timer */
 
188
    pj_timer_entry_init(&turn_sock->timer, TIMER_NONE, turn_sock, &timer_cb);
 
189
 
 
190
    /* Init TURN session */
 
191
    pj_bzero(&sess_cb, sizeof(sess_cb));
 
192
    sess_cb.on_send_pkt = &turn_on_send_pkt;
 
193
    sess_cb.on_channel_bound = &turn_on_channel_bound;
 
194
    sess_cb.on_rx_data = &turn_on_rx_data;
 
195
    sess_cb.on_state = &turn_on_state;
 
196
    status = pj_turn_session_create(cfg, pool->obj_name, af, conn_type,
 
197
                                    turn_sock->grp_lock, &sess_cb, 0,
 
198
                                    turn_sock, &turn_sock->sess);
 
199
    if (status != PJ_SUCCESS) {
 
200
        destroy(turn_sock);
 
201
        return status;
 
202
    }
 
203
 
 
204
    /* Note: socket and ioqueue will be created later once the TURN server
 
205
     * has been resolved.
 
206
     */
 
207
 
 
208
    *p_turn_sock = turn_sock;
 
209
    return PJ_SUCCESS;
 
210
}
 
211
 
 
212
/*
 
213
 * Destroy.
 
214
 */
 
215
static void turn_sock_on_destroy(void *comp)
 
216
{
 
217
    pj_turn_sock *turn_sock = (pj_turn_sock*) comp;
 
218
 
 
219
    if (turn_sock->pool) {
 
220
        pj_pool_t *pool = turn_sock->pool;
 
221
        PJ_LOG(4,(turn_sock->obj_name, "TURN socket destroyed"));
 
222
        turn_sock->pool = NULL;
 
223
        pj_pool_release(pool);
 
224
    }
 
225
}
 
226
 
 
227
static void destroy(pj_turn_sock *turn_sock)
 
228
{
 
229
    PJ_LOG(4,(turn_sock->obj_name, "TURN socket destroy request, ref_cnt=%d",
 
230
              pj_grp_lock_get_ref(turn_sock->grp_lock)));
 
231
 
 
232
    pj_grp_lock_acquire(turn_sock->grp_lock);
 
233
    if (turn_sock->is_destroying) {
 
234
        pj_grp_lock_release(turn_sock->grp_lock);
 
235
        return;
 
236
    }
 
237
 
 
238
    turn_sock->is_destroying = PJ_TRUE;
 
239
    if (turn_sock->sess)
 
240
        pj_turn_session_shutdown(turn_sock->sess);
 
241
    if (turn_sock->active_sock)
 
242
        pj_activesock_close(turn_sock->active_sock);
 
243
    pj_grp_lock_dec_ref(turn_sock->grp_lock);
 
244
    pj_grp_lock_release(turn_sock->grp_lock);
 
245
}
 
246
 
 
247
PJ_DEF(void) pj_turn_sock_destroy(pj_turn_sock *turn_sock)
 
248
{
 
249
    pj_grp_lock_acquire(turn_sock->grp_lock);
 
250
    if (turn_sock->is_destroying) {
 
251
        pj_grp_lock_release(turn_sock->grp_lock);
 
252
        return;
 
253
    }
 
254
 
 
255
    if (turn_sock->sess) {
 
256
        pj_turn_session_shutdown(turn_sock->sess);
 
257
        /* This will ultimately call our state callback, and when
 
258
         * session state is DESTROYING we will schedule a timer to
 
259
         * destroy ourselves.
 
260
         */
 
261
    } else {
 
262
        destroy(turn_sock);
 
263
    }
 
264
 
 
265
    pj_grp_lock_release(turn_sock->grp_lock);
 
266
}
 
267
 
 
268
 
 
269
/* Timer callback */
 
270
static void timer_cb(pj_timer_heap_t *th, pj_timer_entry *e)
 
271
{
 
272
    pj_turn_sock *turn_sock = (pj_turn_sock*)e->user_data;
 
273
    int eid = e->id;
 
274
 
 
275
    PJ_UNUSED_ARG(th);
 
276
 
 
277
    e->id = TIMER_NONE;
 
278
 
 
279
    switch (eid) {
 
280
    case TIMER_DESTROY:
 
281
        destroy(turn_sock);
 
282
        break;
 
283
    default:
 
284
        pj_assert(!"Invalid timer id");
 
285
        break;
 
286
    }
 
287
}
 
288
 
 
289
 
 
290
/* Display error */
 
291
static void show_err(pj_turn_sock *turn_sock, const char *title,
 
292
                     pj_status_t status)
 
293
{
 
294
    PJ_PERROR(4,(turn_sock->obj_name, status, title));
 
295
}
 
296
 
 
297
/* On error, terminate session */
 
298
static void sess_fail(pj_turn_sock *turn_sock, const char *title,
 
299
                      pj_status_t status)
 
300
{
 
301
    show_err(turn_sock, title, status);
 
302
    if (turn_sock->sess) {
 
303
        pj_turn_session_destroy(turn_sock->sess, status);
 
304
    }
 
305
}
 
306
 
 
307
/*
 
308
 * Set user data.
 
309
 */
 
310
PJ_DEF(pj_status_t) pj_turn_sock_set_user_data( pj_turn_sock *turn_sock,
 
311
                                               void *user_data)
 
312
{
 
313
    PJ_ASSERT_RETURN(turn_sock, PJ_EINVAL);
 
314
    turn_sock->user_data = user_data;
 
315
    return PJ_SUCCESS;
 
316
}
 
317
 
 
318
/*
 
319
 * Get user data.
 
320
 */
 
321
PJ_DEF(void*) pj_turn_sock_get_user_data(pj_turn_sock *turn_sock)
 
322
{
 
323
    PJ_ASSERT_RETURN(turn_sock, NULL);
 
324
    return turn_sock->user_data;
 
325
}
 
326
 
 
327
/**
 
328
 * Get info.
 
329
 */
 
330
PJ_DEF(pj_status_t) pj_turn_sock_get_info(pj_turn_sock *turn_sock,
 
331
                                          pj_turn_session_info *info)
 
332
{
 
333
    PJ_ASSERT_RETURN(turn_sock && info, PJ_EINVAL);
 
334
 
 
335
    if (turn_sock->sess) {
 
336
        return pj_turn_session_get_info(turn_sock->sess, info);
 
337
    } else {
 
338
        pj_bzero(info, sizeof(*info));
 
339
        info->state = PJ_TURN_STATE_NULL;
 
340
        return PJ_SUCCESS;
 
341
    }
 
342
}
 
343
 
 
344
/**
 
345
 * Lock the TURN socket. Application may need to call this function to
 
346
 * synchronize access to other objects to avoid deadlock.
 
347
 */
 
348
PJ_DEF(pj_status_t) pj_turn_sock_lock(pj_turn_sock *turn_sock)
 
349
{
 
350
    return pj_grp_lock_acquire(turn_sock->grp_lock);
 
351
}
 
352
 
 
353
/**
 
354
 * Unlock the TURN socket.
 
355
 */
 
356
PJ_DEF(pj_status_t) pj_turn_sock_unlock(pj_turn_sock *turn_sock)
 
357
{
 
358
    return pj_grp_lock_release(turn_sock->grp_lock);
 
359
}
 
360
 
 
361
/*
 
362
 * Set STUN message logging for this TURN session. 
 
363
 */
 
364
PJ_DEF(void) pj_turn_sock_set_log( pj_turn_sock *turn_sock,
 
365
                                   unsigned flags)
 
366
{
 
367
    pj_turn_session_set_log(turn_sock->sess, flags);
 
368
}
 
369
 
 
370
/*
 
371
 * Set software name
 
372
 */
 
373
PJ_DEF(pj_status_t) pj_turn_sock_set_software_name( pj_turn_sock *turn_sock,
 
374
                                                    const pj_str_t *sw)
 
375
{
 
376
    return pj_turn_session_set_software_name(turn_sock->sess, sw);
 
377
}
 
378
 
 
379
/*
 
380
 * Initialize.
 
381
 */
 
382
PJ_DEF(pj_status_t) pj_turn_sock_alloc(pj_turn_sock *turn_sock,
 
383
                                       const pj_str_t *domain,
 
384
                                       int default_port,
 
385
                                       pj_dns_resolver *resolver,
 
386
                                       const pj_stun_auth_cred *cred,
 
387
                                       const pj_turn_alloc_param *param)
 
388
{
 
389
    pj_status_t status;
 
390
 
 
391
    PJ_ASSERT_RETURN(turn_sock && domain, PJ_EINVAL);
 
392
    PJ_ASSERT_RETURN(turn_sock->sess, PJ_EINVALIDOP);
 
393
 
 
394
    pj_grp_lock_acquire(turn_sock->grp_lock);
 
395
 
 
396
    /* Copy alloc param. We will call session_alloc() only after the 
 
397
     * server address has been resolved.
 
398
     */
 
399
    if (param) {
 
400
        pj_turn_alloc_param_copy(turn_sock->pool, &turn_sock->alloc_param, param);
 
401
    } else {
 
402
        pj_turn_alloc_param_default(&turn_sock->alloc_param);
 
403
    }
 
404
 
 
405
    /* Set credental */
 
406
    if (cred) {
 
407
        status = pj_turn_session_set_credential(turn_sock->sess, cred);
 
408
        if (status != PJ_SUCCESS) {
 
409
            sess_fail(turn_sock, "Error setting credential", status);
 
410
            pj_grp_lock_release(turn_sock->grp_lock);
 
411
            return status;
 
412
        }
 
413
    }
 
414
 
 
415
    /* Resolve server */
 
416
    status = pj_turn_session_set_server(turn_sock->sess, domain, default_port,
 
417
                                        resolver);
 
418
    if (status != PJ_SUCCESS) {
 
419
        sess_fail(turn_sock, "Error setting TURN server", status);
 
420
        pj_grp_lock_release(turn_sock->grp_lock);
 
421
        return status;
 
422
    }
 
423
 
 
424
    /* Done for now. The next work will be done when session state moved
 
425
     * to RESOLVED state.
 
426
     */
 
427
    pj_grp_lock_release(turn_sock->grp_lock);
 
428
    return PJ_SUCCESS;
 
429
}
 
430
 
 
431
/*
 
432
 * Install permission
 
433
 */
 
434
PJ_DEF(pj_status_t) pj_turn_sock_set_perm( pj_turn_sock *turn_sock,
 
435
                                           unsigned addr_cnt,
 
436
                                           const pj_sockaddr addr[],
 
437
                                           unsigned options)
 
438
{
 
439
    if (turn_sock->sess == NULL)
 
440
        return PJ_EINVALIDOP;
 
441
 
 
442
    return pj_turn_session_set_perm(turn_sock->sess, addr_cnt, addr, options);
 
443
}
 
444
 
 
445
/*
 
446
 * Send packet.
 
447
 */ 
 
448
PJ_DEF(pj_status_t) pj_turn_sock_sendto( pj_turn_sock *turn_sock,
 
449
                                        const pj_uint8_t *pkt,
 
450
                                        unsigned pkt_len,
 
451
                                        const pj_sockaddr_t *addr,
 
452
                                        unsigned addr_len)
 
453
{
 
454
    PJ_ASSERT_RETURN(turn_sock && addr && addr_len, PJ_EINVAL);
 
455
 
 
456
    if (turn_sock->sess == NULL)
 
457
        return PJ_EINVALIDOP;
 
458
 
 
459
    return pj_turn_session_sendto(turn_sock->sess, pkt, pkt_len, 
 
460
                                  addr, addr_len);
 
461
}
 
462
 
 
463
/*
 
464
 * Bind a peer address to a channel number.
 
465
 */
 
466
PJ_DEF(pj_status_t) pj_turn_sock_bind_channel( pj_turn_sock *turn_sock,
 
467
                                              const pj_sockaddr_t *peer,
 
468
                                              unsigned addr_len)
 
469
{
 
470
    PJ_ASSERT_RETURN(turn_sock && peer && addr_len, PJ_EINVAL);
 
471
    PJ_ASSERT_RETURN(turn_sock->sess != NULL, PJ_EINVALIDOP);
 
472
 
 
473
    return pj_turn_session_bind_channel(turn_sock->sess, peer, addr_len);
 
474
}
 
475
 
 
476
 
 
477
/*
 
478
 * Notification when outgoing TCP socket has been connected.
 
479
 */
 
480
static pj_bool_t on_connect_complete(pj_activesock_t *asock,
 
481
                                     pj_status_t status)
 
482
{
 
483
    pj_turn_sock *turn_sock;
 
484
 
 
485
    turn_sock = (pj_turn_sock*) pj_activesock_get_user_data(asock);
 
486
    if (!turn_sock)
 
487
        return PJ_FALSE;
 
488
 
 
489
    pj_grp_lock_acquire(turn_sock->grp_lock);
 
490
 
 
491
    /* TURN session may have already been destroyed here.
 
492
     * See ticket #1557 (http://trac.pjsip.org/repos/ticket/1557).
 
493
     */
 
494
    if (!turn_sock->sess) {
 
495
        sess_fail(turn_sock, "TURN session already destroyed", status);
 
496
        pj_grp_lock_release(turn_sock->grp_lock);
 
497
        return PJ_FALSE;
 
498
    }
 
499
 
 
500
    if (status != PJ_SUCCESS) {
 
501
        sess_fail(turn_sock, "TCP connect() error", status);
 
502
        pj_grp_lock_release(turn_sock->grp_lock);
 
503
        return PJ_FALSE;
 
504
    }
 
505
 
 
506
    if (turn_sock->conn_type != PJ_TURN_TP_UDP) {
 
507
        PJ_LOG(5,(turn_sock->obj_name, "TCP connected"));
 
508
    }
 
509
 
 
510
    /* Kick start pending read operation */
 
511
    status = pj_activesock_start_read(asock, turn_sock->pool, 
 
512
                                      turn_sock->setting.max_pkt_size, 0);
 
513
 
 
514
    /* Init send_key */
 
515
    pj_ioqueue_op_key_init(&turn_sock->send_key, sizeof(turn_sock->send_key));
 
516
 
 
517
    /* Send Allocate request */
 
518
    status = pj_turn_session_alloc(turn_sock->sess, &turn_sock->alloc_param);
 
519
    if (status != PJ_SUCCESS) {
 
520
        sess_fail(turn_sock, "Error sending ALLOCATE", status);
 
521
        pj_grp_lock_release(turn_sock->grp_lock);
 
522
        return PJ_FALSE;
 
523
    }
 
524
 
 
525
    pj_grp_lock_release(turn_sock->grp_lock);
 
526
    return PJ_TRUE;
 
527
}
 
528
 
 
529
static pj_uint16_t GETVAL16H(const pj_uint8_t *buf, unsigned pos)
 
530
{
 
531
    return (pj_uint16_t) ((buf[pos + 0] << 8) | \
 
532
                          (buf[pos + 1] << 0));
 
533
}
 
534
 
 
535
/* Quick check to determine if there is enough packet to process in the
 
536
 * incoming buffer. Return the packet length, or zero if there's no packet.
 
537
 */
 
538
static unsigned has_packet(pj_turn_sock *turn_sock, const void *buf, pj_size_t bufsize)
 
539
{
 
540
    pj_bool_t is_stun;
 
541
 
 
542
    if (turn_sock->conn_type == PJ_TURN_TP_UDP)
 
543
        return bufsize;
 
544
 
 
545
    /* Quickly check if this is STUN message, by checking the first two bits and
 
546
     * size field which must be multiple of 4 bytes
 
547
     */
 
548
    is_stun = ((((pj_uint8_t*)buf)[0] & 0xC0) == 0) &&
 
549
              ((GETVAL16H((const pj_uint8_t*)buf, 2) & 0x03)==0);
 
550
 
 
551
    if (is_stun) {
 
552
        pj_size_t msg_len = GETVAL16H((const pj_uint8_t*)buf, 2);
 
553
        return (msg_len+20 <= bufsize) ? msg_len+20 : 0;
 
554
    } else {
 
555
        /* This must be ChannelData. */
 
556
        pj_turn_channel_data cd;
 
557
 
 
558
        if (bufsize < 4)
 
559
            return 0;
 
560
 
 
561
        /* Decode ChannelData packet */
 
562
        pj_memcpy(&cd, buf, sizeof(pj_turn_channel_data));
 
563
        cd.length = pj_ntohs(cd.length);
 
564
 
 
565
        if (bufsize >= cd.length+sizeof(cd)) 
 
566
            return (cd.length+sizeof(cd)+3) & (~3);
 
567
        else
 
568
            return 0;
 
569
    }
 
570
}
 
571
 
 
572
/*
 
573
 * Notification from ioqueue when incoming UDP packet is received.
 
574
 */
 
575
static pj_bool_t on_data_read(pj_activesock_t *asock,
 
576
                              void *data,
 
577
                              pj_size_t size,
 
578
                              pj_status_t status,
 
579
                              pj_size_t *remainder)
 
580
{
 
581
    pj_turn_sock *turn_sock;
 
582
    pj_bool_t ret = PJ_TRUE;
 
583
 
 
584
    turn_sock = (pj_turn_sock*) pj_activesock_get_user_data(asock);
 
585
    pj_grp_lock_acquire(turn_sock->grp_lock);
 
586
 
 
587
    if (status == PJ_SUCCESS && turn_sock->sess && !turn_sock->is_destroying) {
 
588
        /* Report incoming packet to TURN session, repeat while we have
 
589
         * "packet" in the buffer (required for stream-oriented transports)
 
590
         */
 
591
        unsigned pkt_len;
 
592
 
 
593
        //PJ_LOG(5,(turn_sock->pool->obj_name, 
 
594
        //        "Incoming data, %lu bytes total buffer", size));
 
595
 
 
596
        while ((pkt_len=has_packet(turn_sock, data, size)) != 0) {
 
597
            pj_size_t parsed_len;
 
598
            //const pj_uint8_t *pkt = (const pj_uint8_t*)data;
 
599
 
 
600
            //PJ_LOG(5,(turn_sock->pool->obj_name, 
 
601
            //        "Packet start: %02X %02X %02X %02X", 
 
602
            //        pkt[0], pkt[1], pkt[2], pkt[3]));
 
603
 
 
604
            //PJ_LOG(5,(turn_sock->pool->obj_name, 
 
605
            //        "Processing %lu bytes packet of %lu bytes total buffer",
 
606
            //        pkt_len, size));
 
607
 
 
608
            parsed_len = (unsigned)size;
 
609
            pj_turn_session_on_rx_pkt(turn_sock->sess, data,  size, &parsed_len);
 
610
 
 
611
            /* parsed_len may be zero if we have parsing error, so use our
 
612
             * previous calculation to exhaust the bad packet.
 
613
             */
 
614
            if (parsed_len == 0)
 
615
                parsed_len = pkt_len;
 
616
 
 
617
            if (parsed_len < (unsigned)size) {
 
618
                *remainder = size - parsed_len;
 
619
                pj_memmove(data, ((char*)data)+parsed_len, *remainder);
 
620
            } else {
 
621
                *remainder = 0;
 
622
            }
 
623
            size = *remainder;
 
624
 
 
625
            //PJ_LOG(5,(turn_sock->pool->obj_name, 
 
626
            //        "Buffer size now %lu bytes", size));
 
627
        }
 
628
    } else if (status != PJ_SUCCESS && 
 
629
               turn_sock->conn_type != PJ_TURN_TP_UDP) 
 
630
    {
 
631
        sess_fail(turn_sock, "TCP connection closed", status);
 
632
        ret = PJ_FALSE;
 
633
        goto on_return;
 
634
    }
 
635
 
 
636
on_return:
 
637
    pj_grp_lock_release(turn_sock->grp_lock);
 
638
 
 
639
    return ret;
 
640
}
 
641
 
 
642
 
 
643
/*
 
644
 * Callback from TURN session to send outgoing packet.
 
645
 */
 
646
static pj_status_t turn_on_send_pkt(pj_turn_session *sess,
 
647
                                    const pj_uint8_t *pkt,
 
648
                                    unsigned pkt_len,
 
649
                                    const pj_sockaddr_t *dst_addr,
 
650
                                    unsigned dst_addr_len)
 
651
{
 
652
    pj_turn_sock *turn_sock = (pj_turn_sock*) 
 
653
                              pj_turn_session_get_user_data(sess);
 
654
    pj_ssize_t len = pkt_len;
 
655
    pj_status_t status;
 
656
 
 
657
    if (turn_sock == NULL || turn_sock->is_destroying) {
 
658
        /* We've been destroyed */
 
659
        // https://trac.pjsip.org/repos/ticket/1316
 
660
        //pj_assert(!"We should shutdown gracefully");
 
661
        return PJ_EINVALIDOP;
 
662
    }
 
663
 
 
664
    PJ_UNUSED_ARG(dst_addr);
 
665
    PJ_UNUSED_ARG(dst_addr_len);
 
666
 
 
667
    status = pj_activesock_send(turn_sock->active_sock, &turn_sock->send_key,
 
668
                                pkt, &len, 0);
 
669
    if (status != PJ_SUCCESS && status != PJ_EPENDING) {
 
670
        show_err(turn_sock, "socket send()", status);
 
671
    }
 
672
 
 
673
    return status;
 
674
}
 
675
 
 
676
 
 
677
/*
 
678
 * Callback from TURN session when a channel is successfully bound.
 
679
 */
 
680
static void turn_on_channel_bound(pj_turn_session *sess,
 
681
                                  const pj_sockaddr_t *peer_addr,
 
682
                                  unsigned addr_len,
 
683
                                  unsigned ch_num)
 
684
{
 
685
    PJ_UNUSED_ARG(sess);
 
686
    PJ_UNUSED_ARG(peer_addr);
 
687
    PJ_UNUSED_ARG(addr_len);
 
688
    PJ_UNUSED_ARG(ch_num);
 
689
}
 
690
 
 
691
 
 
692
/*
 
693
 * Callback from TURN session upon incoming data.
 
694
 */
 
695
static void turn_on_rx_data(pj_turn_session *sess,
 
696
                            void *pkt,
 
697
                            unsigned pkt_len,
 
698
                            const pj_sockaddr_t *peer_addr,
 
699
                            unsigned addr_len)
 
700
{
 
701
    pj_turn_sock *turn_sock = (pj_turn_sock*) 
 
702
                           pj_turn_session_get_user_data(sess);
 
703
    if (turn_sock == NULL || turn_sock->is_destroying) {
 
704
        /* We've been destroyed */
 
705
        return;
 
706
    }
 
707
 
 
708
    if (turn_sock->cb.on_rx_data) {
 
709
        (*turn_sock->cb.on_rx_data)(turn_sock, pkt, pkt_len, 
 
710
                                  peer_addr, addr_len);
 
711
    }
 
712
}
 
713
 
 
714
 
 
715
/*
 
716
 * Callback from TURN session when state has changed
 
717
 */
 
718
static void turn_on_state(pj_turn_session *sess, 
 
719
                          pj_turn_state_t old_state,
 
720
                          pj_turn_state_t new_state)
 
721
{
 
722
    pj_turn_sock *turn_sock = (pj_turn_sock*) 
 
723
                           pj_turn_session_get_user_data(sess);
 
724
    pj_status_t status;
 
725
 
 
726
    if (turn_sock == NULL) {
 
727
        /* We've been destroyed */
 
728
        return;
 
729
    }
 
730
 
 
731
    /* Notify app first */
 
732
    if (turn_sock->cb.on_state) {
 
733
        (*turn_sock->cb.on_state)(turn_sock, old_state, new_state);
 
734
    }
 
735
 
 
736
    /* Make sure user hasn't destroyed us in the callback */
 
737
    if (turn_sock->sess && new_state == PJ_TURN_STATE_RESOLVED) {
 
738
        pj_turn_session_info info;
 
739
        pj_turn_session_get_info(turn_sock->sess, &info);
 
740
        new_state = info.state;
 
741
    }
 
742
 
 
743
    if (turn_sock->sess && new_state == PJ_TURN_STATE_RESOLVED) {
 
744
        /*
 
745
         * Once server has been resolved, initiate outgoing TCP
 
746
         * connection to the server.
 
747
         */
 
748
        pj_turn_session_info info;
 
749
        char addrtxt[PJ_INET6_ADDRSTRLEN+8];
 
750
        int sock_type;
 
751
        pj_sock_t sock;
 
752
        pj_activesock_cfg asock_cfg;
 
753
        pj_activesock_cb asock_cb;
 
754
        pj_sockaddr bound_addr, *cfg_bind_addr;
 
755
        pj_uint16_t max_bind_retry;
 
756
 
 
757
        /* Close existing connection, if any. This happens when
 
758
         * we're switching to alternate TURN server when either TCP
 
759
         * connection or ALLOCATE request failed.
 
760
         */
 
761
        if (turn_sock->active_sock) {
 
762
            pj_activesock_close(turn_sock->active_sock);
 
763
            turn_sock->active_sock = NULL;
 
764
        }
 
765
 
 
766
        /* Get server address from session info */
 
767
        pj_turn_session_get_info(sess, &info);
 
768
 
 
769
        if (turn_sock->conn_type == PJ_TURN_TP_UDP)
 
770
            sock_type = pj_SOCK_DGRAM();
 
771
        else
 
772
            sock_type = pj_SOCK_STREAM();
 
773
 
 
774
        /* Init socket */
 
775
        status = pj_sock_socket(turn_sock->af, sock_type, 0, &sock);
 
776
        if (status != PJ_SUCCESS) {
 
777
            pj_turn_sock_destroy(turn_sock);
 
778
            return;
 
779
        }
 
780
 
 
781
        /* Bind socket */
 
782
        cfg_bind_addr = &turn_sock->setting.bound_addr;
 
783
        max_bind_retry = MAX_BIND_RETRY;
 
784
        if (turn_sock->setting.port_range &&
 
785
            turn_sock->setting.port_range < max_bind_retry)
 
786
        {
 
787
            max_bind_retry = turn_sock->setting.port_range;
 
788
        }
 
789
        pj_sockaddr_init(turn_sock->af, &bound_addr, NULL, 0);
 
790
        if (cfg_bind_addr->addr.sa_family == pj_AF_INET() || 
 
791
            cfg_bind_addr->addr.sa_family == pj_AF_INET6())
 
792
        {
 
793
            pj_sockaddr_cp(&bound_addr, cfg_bind_addr);
 
794
        }
 
795
        status = pj_sock_bind_random(sock, &bound_addr,
 
796
                                     turn_sock->setting.port_range,
 
797
                                     max_bind_retry);
 
798
        if (status != PJ_SUCCESS) {
 
799
            pj_turn_sock_destroy(turn_sock);
 
800
            return;
 
801
        }
 
802
 
 
803
        /* Apply QoS, if specified */
 
804
        status = pj_sock_apply_qos2(sock, turn_sock->setting.qos_type,
 
805
                                    &turn_sock->setting.qos_params, 
 
806
                                    (turn_sock->setting.qos_ignore_error?2:1),
 
807
                                    turn_sock->pool->obj_name, NULL);
 
808
        if (status != PJ_SUCCESS && !turn_sock->setting.qos_ignore_error) {
 
809
            pj_turn_sock_destroy(turn_sock);
 
810
            return;
 
811
        }
 
812
 
 
813
        /* Create active socket */
 
814
        pj_activesock_cfg_default(&asock_cfg);
 
815
        asock_cfg.grp_lock = turn_sock->grp_lock;
 
816
 
 
817
        pj_bzero(&asock_cb, sizeof(asock_cb));
 
818
        asock_cb.on_data_read = &on_data_read;
 
819
        asock_cb.on_connect_complete = &on_connect_complete;
 
820
        status = pj_activesock_create(turn_sock->pool, sock,
 
821
                                      sock_type, &asock_cfg,
 
822
                                      turn_sock->cfg.ioqueue, &asock_cb, 
 
823
                                      turn_sock,
 
824
                                      &turn_sock->active_sock);
 
825
        if (status != PJ_SUCCESS) {
 
826
            pj_turn_sock_destroy(turn_sock);
 
827
            return;
 
828
        }
 
829
 
 
830
        PJ_LOG(5,(turn_sock->pool->obj_name,
 
831
                  "Connecting to %s", 
 
832
                  pj_sockaddr_print(&info.server, addrtxt, 
 
833
                                    sizeof(addrtxt), 3)));
 
834
 
 
835
        /* Initiate non-blocking connect */
 
836
#if PJ_HAS_TCP
 
837
        status=pj_activesock_start_connect(turn_sock->active_sock, 
 
838
                                           turn_sock->pool,
 
839
                                           &info.server, 
 
840
                                           pj_sockaddr_get_len(&info.server));
 
841
        if (status == PJ_SUCCESS) {
 
842
            on_connect_complete(turn_sock->active_sock, PJ_SUCCESS);
 
843
        } else if (status != PJ_EPENDING) {
 
844
            pj_turn_sock_destroy(turn_sock);
 
845
            return;
 
846
        }
 
847
#else
 
848
        on_connect_complete(turn_sock->active_sock, PJ_SUCCESS);
 
849
#endif
 
850
 
 
851
        /* Done for now. Subsequent work will be done in 
 
852
         * on_connect_complete() callback.
 
853
         */
 
854
    }
 
855
 
 
856
    if (new_state >= PJ_TURN_STATE_DESTROYING && turn_sock->sess) {
 
857
        pj_time_val delay = {0, 0};
 
858
 
 
859
        turn_sock->sess = NULL;
 
860
        pj_turn_session_set_user_data(sess, NULL);
 
861
 
 
862
        pj_timer_heap_cancel_if_active(turn_sock->cfg.timer_heap,
 
863
                                       &turn_sock->timer, 0);
 
864
        pj_timer_heap_schedule_w_grp_lock(turn_sock->cfg.timer_heap,
 
865
                                          &turn_sock->timer,
 
866
                                          &delay, TIMER_DESTROY,
 
867
                                          turn_sock->grp_lock);
 
868
    }
 
869
}
 
870
 
 
871