nua_common.c 12.3 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3 4 5 6 7
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
8
 * This library is free software; you can redistribute it and/or
Pekka Pessi's avatar
Pekka Pessi committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

25
/**@CFILE nua_common.c
26 27
 * @brief Function common to both stack and application side.
 *
Pekka Pessi's avatar
Pekka Pessi committed
28
 * @author Pekka.Pessi@nokia.com
29
 *
Pekka Pessi's avatar
Pekka Pessi committed
30
 * @date Created: Tue Apr 26 13:23:17 2005 ppessi
31
 *
Pekka Pessi's avatar
Pekka Pessi committed
32 33 34 35 36 37 38 39 40 41
 */

#include "config.h"

#include <stddef.h>
#include <stdlib.h>
#include <string.h>

#include <assert.h>

42 43 44
#include <sofia-sip/su_tag_class.h>
#include <sofia-sip/su_tag_class.h>
#include <sofia-sip/su_tagarg.h>
45
#include <sofia-sip/su_uniqueid.h>
Pekka Pessi's avatar
Pekka Pessi committed
46 47 48

#include <stdio.h>

49
#include <sofia-sip/su_tag_io.h>
Pekka Pessi's avatar
Pekka Pessi committed
50 51

#define SU_LOG (nua_log)
52
#include <sofia-sip/su_debug.h>
Pekka Pessi's avatar
Pekka Pessi committed
53 54 55

#define SU_ROOT_MAGIC_T   struct nua_s

56
#include <sofia-sip/su_wait.h>
Pekka Pessi's avatar
Pekka Pessi committed
57

58
#include <sofia-sip/su_string.h>
59
#include <sofia-sip/su_strlst.h>
Pekka Pessi's avatar
Pekka Pessi committed
60

61 62
#include "sofia-sip/nua.h"
#include "sofia-sip/nua_tag.h"
Pekka Pessi's avatar
Pekka Pessi committed
63

64 65 66
#include <sofia-sip/sip_protos.h>
#include <sofia-sip/nta.h>
#include <sofia-sip/nea.h>
Pekka Pessi's avatar
Pekka Pessi committed
67

68
#include <sofia-sip/auth_client.h>
Pekka Pessi's avatar
Pekka Pessi committed
69 70 71 72
#if HAVE_SMIME 		/* Start NRC Boston */
#include "smimec.h"
#endif                  /* End NRC Boston */

73
#include <sofia-sip/sdp.h>
Pekka Pessi's avatar
Pekka Pessi committed
74 75 76

#include "nua_stack.h"

77 78
static void nh_destructor(void *arg);

79
/**@internal
80
 * Create an operation handle
Pekka Pessi's avatar
Pekka Pessi committed
81 82 83 84 85 86 87 88 89 90 91
 *
 * Allocates a new operation handle and associated storage.
 *
 * @param nua         Pointer to NUA stack object
 * @param hmagic      Pointer to callback context
 * @param tags        List of tagged parameters
 *
 * @retval non-NULL  Pointer to operation handle
 * @retval NULL    Creation failed
 *
 * @par Related tags:
92
 *     Creates a copy of the provided tags which will
Pekka Pessi's avatar
Pekka Pessi committed
93 94 95 96 97 98 99 100
 *     be used with every operation.
 *
 * @par Events:
 *     none
 *
 * @note
 * This function is called by both stack and application sides.
 */
101 102
nua_handle_t *nh_create_handle(nua_t *nua,
			       nua_hmagic_t *hmagic,
Pekka Pessi's avatar
Pekka Pessi committed
103 104 105
			       tagi_t *tags)
{
  nua_handle_t *nh;
106
  static int8_t _handle_lifetime = 1;
Pekka Pessi's avatar
Pekka Pessi committed
107 108 109 110 111 112

  enter;

  assert(nua->nua_home);

  if ((nh = su_home_clone(nua->nua_home, sizeof(*nh)))) {
113
    nh->nh_valid = nua_valid_handle_cookie;
Pekka Pessi's avatar
Pekka Pessi committed
114 115
    nh->nh_nua = nua;
    nh->nh_magic = hmagic;
116
    nh->nh_prefs = nua->nua_dhandle->nh_prefs;
117
    nh->nh_ds->ds_owner = nh;
118

119
    if (nua_handle_save_tags(nh, tags) < 0) {
120 121
      SU_DEBUG_5(("nua(%p): creating handle %p failed\n",
		  (void *)nua, (void *)nh));
122 123
      su_home_unref(nh->nh_home), nh = NULL;
    }
124

125
    if (nh && su_home_is_threadsafe(nua->nua_home)) {
126 127 128 129 130
      if (su_home_threadsafe(nh->nh_home) < 0) {
	su_home_unref(nh->nh_home);
	nh = NULL;
      }
    }
131

132
    if (nh && _handle_lifetime) {
133
      /* This far, we have nothing real to destruct but
134
       * when _NUA_HANDLE_DEBUG is set, we add destructor
135
       * and get more entertaining debugging output */
136 137
      if (_handle_lifetime == 1 && !getenv("_NUA_HANDLE_DEBUG")) {
	_handle_lifetime = 0;
138
      }
139 140
      else {
	_handle_lifetime = 2;
141
	SU_DEBUG_0(("nh_handle_create(%p)\n", (void *)nh));
142
	su_home_destructor(nh->nh_home, nh_destructor);
143 144
      }
    }
Pekka Pessi's avatar
Pekka Pessi committed
145 146
  }

147 148 149
  return nh;
}

150 151 152 153 154 155 156 157
/**@var _NUA_HANDLE_DEBUG
 *
 * If this environment variable is set, nua stack logs a message whenever a
 * handle is created and when it is destroyed. This is mainly useful when
 * debugging #nua_handle_t leaks.
 *
 * @sa nua_handle(), nua_handle_destroy()
 */
158
extern char const _NUA_HANDLE_DEBUG[];
159

160 161 162 163
/* nua handle destructor. It does nothing. */
static void nh_destructor(void *arg)
{
  nua_handle_t *nh = arg;
164
  SU_DEBUG_0(("nh_destructor(%p)\n", (void *)nh));
165 166
}

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
#if HAVE_MEMLEAK_LOG

nua_handle_t *
_nua_handle_ref_by(nua_handle_t *nh,
		   char const *file, unsigned line,
		   char const *function)
{
  if (nh)
    SU_DEBUG_0(("%p - nua_handle_ref() => "MOD_ZU" by %s:%u: %s()\n",
		nh, su_home_refcount((su_home_t *)nh) + 1, file, line, by));
  return (nua_handle_t *)su_home_ref((su_home_t *)nh);
}

int
_nua_handle_unref_by(nua_handle_t *nh,
		    char const *file, unsigned line,
		    char const *function)
{
  if (nh) {
    size_t refcount = su_home_refcount((su_home_t *)nh) - 1;
    int freed =  su_home_unref((su_home_t *)nh);
    if (freed) refcount = 0;
    SU_DEBUG_0(("%p - nua_handle_unref() => "MOD_ZU" by %s:%u: %s()\n",
		nh, refcount, file, line, by));
    return freed;
  }

  return 0;
}

nua_handle_t *nua_handle_ref(nua_handle_t *nh)
{
  return _nua_handle_ref_by(nh, "<app>", 0, "<app>")
}

int nua_handle_unref(nua_handle_t *nh)
{
  return _nua_handle_unref_by(nh, "<app>", 0, "<app>")
}

#else
208

209
/** Make a new reference to handle.
210 211 212 213 214 215
 *
 * The handles use reference counting for memory management. In addition to
 * the memory management, there is protocol state associated with the
 * handles. The protocol state is terminated with nua_handle_destroy(). In
 * order to make it more convenient for programmer, nua_handle_destroy()
 * decreases the reference count, too.
216 217
 *
 * @note All handle references are destroyed when the nua object is destroyed.
218 219
 *
 * @sa nua_handle_unref(), nua_handle(), nua_handle_destroy().
220 221 222 223
 */
nua_handle_t *nua_handle_ref(nua_handle_t *nh)
{
  return (nua_handle_t *)su_home_ref(nh->nh_home);
Pekka Pessi's avatar
Pekka Pessi committed
224
}
225

226
/** Destroy reference to handle.
227 228 229 230 231 232 233 234 235
 *
 * The handles use reference counting for memory management. In addition to
 * the memory management, there is protocol state associated with the
 * handles. The protocol state is terminated with nua_handle_destroy(). In
 * order to make it more convenient for programmer, nua_handle_destroy()
 * decreases the reference count, too.
 *
 * @sa nua_handle_ref(), nua_handle(), nua_handle_destroy().
 */
236 237 238 239 240
int nua_handle_unref(nua_handle_t *nh)
{
  return su_home_unref(nh->nh_home);
}

241 242
#endif

243
/** Generate an instance identifier. */
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
char const *nua_generate_instance_identifier(su_home_t *home)
{
  char str[su_guid_strlen + 1];
  su_guid_t guid[1];

  su_guid_generate(guid);
  /*
   * Guid looks like "NNNNNNNN-NNNN-NNNN-NNNN-XXXXXXXXXXXX"
   * where NNNNNNNN-NNNN-NNNN-NNNN is timestamp and XX is MAC address
   * (but we use usually random ID for MAC because we do not have
   *  guid generator available for all processes within node)
   */
  su_guid_sprintf(str, su_guid_strlen + 1, guid);

  return su_strdup(home, str);
}
260

261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
/** Check if event is a request that can be responded with nua_respond().
 *
 * Note that if event status is 200 or greater, it already has been
 * responded. This function is provided for compatibility with future
 * versions of nua. An unknown event can always be handled in the event
 * callback like this:
 * @code
 * switch (event) {
 *   ...
 *   default:
 *     if (status < 200 && nua_event_is_incoming_request(event))
 *       nua_respond(nh, SIP_501_NOT_IMPLEMENTED,
 *                   NUTAG_WITH_THIS(nua), TAG_END());
 *     if (hmagic == NULL)
 *       nua_handle_destroy(nh);
 *     return;
 *   ...
 * @endcode
 *
280
 * @sa nua_respond(), #nua_event_e, #nua_event_t, nua_event_name()
281
 *
Pekka Pessi's avatar
Pekka Pessi committed
282
 * @NEW_1_12_6.
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
 */
int nua_event_is_incoming_request(nua_event_t event)
{
  switch (event) {
  case nua_i_invite: return 1;
  case nua_i_cancel: return 1;
  case nua_i_register: return 1;
  case nua_i_bye: return 1;
  case nua_i_options: return 1;
  case nua_i_refer: return 1;
  case nua_i_publish: return 1;
  case nua_i_prack: return 1;
  case nua_i_info: return 1;
  case nua_i_update: return 1;
  case nua_i_message: return 1;
  case nua_i_subscribe: return 1;
  case nua_i_notify: return 1;
  case nua_i_method: return 1;
  default: return 0;
  }
}

305
/** Get name for a NUA event.
306 307 308
 *
 * @sa #nua_event_e, #nua_event_t, nua_callstate_name(), nua_substate_name()
 */
309 310 311
char const *nua_event_name(nua_event_t event)
{
  switch (event) {
312 313
  case nua_i_none: return "nua_i_none";

314 315
  case nua_i_error: return "nua_i_error";
  case nua_i_invite: return "nua_i_invite";
316 317 318
  case nua_i_cancel: return "nua_i_cancel";
  case nua_i_ack: return "nua_i_ack";

Michael Jerris's avatar
Michael Jerris committed
319
  case nua_i_register: return "nua_i_register";
320 321 322 323
  case nua_i_fork: return "nua_i_fork";
  case nua_i_active: return "nua_i_active";
  case nua_i_terminated: return "nua_i_terminated";
  case nua_i_state: return "nua_i_state";
Pekka Pessi's avatar
Pekka Pessi committed
324
  case nua_i_outbound: return "nua_i_outbound";
325 326 327 328 329 330 331 332 333 334 335

  case nua_i_bye: return "nua_i_bye";
  case nua_i_options: return "nua_i_options";
  case nua_i_refer: return "nua_i_refer";
  case nua_i_publish: return "nua_i_publish";
  case nua_i_prack: return "nua_i_prack";
  case nua_i_info: return "nua_i_info";
  case nua_i_update: return "nua_i_update";
  case nua_i_message: return "nua_i_message";
  case nua_i_chat: return "nua_i_chat";
  case nua_i_subscribe: return "nua_i_subscribe";
336
  case nua_i_subscription: return "nua_i_subscription";
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
  case nua_i_notify: return "nua_i_notify";
  case nua_i_method: return "nua_i_method";

  case nua_i_media_error: return "nua_i_media_error";

  /* Responses */
  case nua_r_get_params: return "nua_r_get_params";
  case nua_r_shutdown: return "nua_r_shutdown";
  case nua_r_notifier: return "nua_r_notifier";
  case nua_r_terminate: return "nua_r_terminate";

  case nua_r_register: return "nua_r_register";
  case nua_r_unregister: return "nua_r_unregister";
  case nua_r_invite: return "nua_r_invite";
  case nua_r_bye: return "nua_r_bye";
  case nua_r_options: return "nua_r_options";
  case nua_r_refer: return "nua_r_refer";
  case nua_r_publish: return "nua_r_publish";
  case nua_r_unpublish: return "nua_r_unpublish";
  case nua_r_info: return "nua_r_info";
357
  case nua_r_prack: return "nua_r_prack";
358 359 360 361 362 363 364 365 366 367
  case nua_r_update: return "nua_r_update";
  case nua_r_message: return "nua_r_message";
  case nua_r_chat: return "nua_r_chat";
  case nua_r_subscribe: return "nua_r_subscribe";
  case nua_r_unsubscribe: return "nua_r_unsubscribe";
  case nua_r_notify: return "nua_r_notify";
  case nua_r_method: return "nua_r_method";

  case nua_r_cancel: return "nua_r_cancel";
  case nua_r_authenticate: return "nua_r_authenticate";
368
  case nua_r_authorize: return "nua_r_authorize";
369 370 371 372 373 374 375 376 377
  case nua_r_redirect: return "nua_r_redirect";
  case nua_r_destroy: return "nua_r_destroy";
  case nua_r_respond: return "nua_r_respond";
  case nua_r_nit_respond: return "nua_r_nit_respond";
  case nua_r_set_params: return "nua_r_set_params";
  case nua_r_ack: return "nua_r_ack";
  default: return "NUA_UNKNOWN";
  }
}
378

379
/** Return name of call state.
380
 *
381 382
 * @sa enum #nua_callstate, nua_event_name(), nua_substate_name()
 */
383 384 385 386
char const *nua_callstate_name(enum nua_callstate state)
{
  switch (state) {
  case nua_callstate_init: return "init";
387
  case nua_callstate_authenticating: return "authenticating";
388 389
  case nua_callstate_calling: return "calling";
  case nua_callstate_proceeding: return "proceeding";
390
  case nua_callstate_completing: return "completing";
391 392
  case nua_callstate_received: return "received";
  case nua_callstate_early: return "early";
393
  case nua_callstate_completed: return "completed";
394 395 396 397 398 399
  case nua_callstate_ready: return "ready";
  case nua_callstate_terminating: return "terminating";
  case nua_callstate_terminated: return "terminated";
  default: return "UNKNOWN";
  }
}
400

401
/** Return name of subscription state. @NEW_1_12_5.
402 403 404
 *
 * @sa enum #nua_substate, nua_event_name(), nua_callstate_name()
 */
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
char const *nua_substate_name(enum nua_substate substate)
{
  switch (substate) {
  case nua_substate_embryonic:
      /*FALLTHROUGH*/
  case nua_substate_pending:
    return "pending";
  case nua_substate_terminated:
    return "terminated";
  case nua_substate_active:
      /*FALLTHROUGH*/
  default:
    return "active";
  }
}

/** Convert string to enum nua_substate. @NEW_1_12_5. */
enum nua_substate nua_substate_make(char const *sip_substate)
{
  if (sip_substate == NULL)
    return nua_substate_active;
426
  else if (su_casematch(sip_substate, "terminated"))
427
    return nua_substate_terminated;
428
  else if (su_casematch(sip_substate, "pending"))
429
    return nua_substate_pending;
430
  else /* if (su_casematch(sip_substate, "active")) */
431 432 433
    return nua_substate_active;
}