su_root.c 29.1 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 25
 * 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
 *
 */

/**@ingroup su_wait
26 27
 * @CFILE su_root.c
 * OS-independent synchronization interface.
Pekka Pessi's avatar
Pekka Pessi committed
28 29 30
 * @internal
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
31
 *
Pekka Pessi's avatar
Pekka Pessi committed
32 33 34 35 36 37 38 39 40
 * @date Created: Tue Sep 14 15:51:04 1999 ppessi
 */

#include "config.h"

#include <stdlib.h>
#include <assert.h>
#include <stdio.h>
#include <string.h>
Pekka Pessi's avatar
Pekka Pessi committed
41
#include <errno.h>
Pekka Pessi's avatar
Pekka Pessi committed
42

43
#include "sofia-sip/su.h"
Pekka Pessi's avatar
Pekka Pessi committed
44 45 46 47 48 49 50 51 52 53 54 55

#if SU_HAVE_PTHREADS
#include <pthread.h>
#endif

struct su_root_s;

#define SU_ROOT_MAGIC_T struct su_root_magic_s
#define SU_WAKEUP_ARG_T struct su_wakeup_arg_s
#define SU_TIMER_ARG_T  struct su_timer_arg_s

#include "su_port.h"
56
#include "sofia-sip/su_alloc.h"
Pekka Pessi's avatar
Pekka Pessi committed
57 58

/**@ingroup su_wait
59
 *
Pekka Pessi's avatar
Pekka Pessi committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
 * @page su_root_t Tasks and root objects
 *
 * A task is the basic execution unit for the Sofia event-driven programming
 * model. According to the model, the program can ask that the event loop
 * invokes a callback function when a certain event occurs. Such events
 * include @ref su_root_register "I/O activity", @ref su_timer_t "timers" or
 * a @ref su_msg_t "message" from other task. The event loop is run with
 * function su_root_run() or su_root_step().
 *
 * Root object gives access to the task control. The root object represents
 * the task to the code running within task. Through the root, the task code
 * can access its context object (magic) and thread-synchronization features
 * like wait objects, timers, and messages.
 *
 * When a message is sent between tasks, a task reference #su_task_r is used
 * to reprent the task address. Reference counting is used to make sure that
 * the task references stay valid.
 *
 * The public API contains following functions:
 *    - su_root_create() [Do not call from cloned task]
 *    - su_root_destroy() [Do not call from cloned task]
 *    - su_root_magic()
 *    - su_root_register()
 *    - su_root_deregister()
 *    - su_root_unregister()
 *    - su_root_threading()
 *    - su_root_run() [Do not call from cloned task]
 *    - su_root_break() [Do not call from cloned task]
 *    - su_root_step() [Do not call from cloned task]
 *    - su_root_task()
 *
 * New tasks can be created via su_clone_start() function.
 */

94 95
/**@ingroup su_wait
 *
Pekka Pessi's avatar
Pekka Pessi committed
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
 * @page su_root_register Registering Wait Objects
 *
 * When application expects I/O events, it can create a wait object and
 * register it, a callback function and a context pointer to the #su_root_t
 * object using the su_root_register() function. Whenever the wait object
 * receives an event, the registered @link ::su_wakeup_f callback function
 * @endlink is invoked.
 *
 * When successful, the su_root_register() returns an small non-negative
 * integer representing the registration. The registration can be
 * manipulated with su_root_eventmask() function, for instance, when sending
 * through a socket block, the application can add SU_WAIT_OUT event to the
 * mask.
 *
 * The registration can be removed using su_root_deregister() function.
 */

/**@ingroup su_wait
114 115
 *
 * Contains hint of number of sockets supported by su_root_t */
Pekka Pessi's avatar
Pekka Pessi committed
116 117 118 119 120 121
int su_root_size_hint = 64;

/* =========================================================================
 * Tasks
 */

122
su_task_r const su_task_null = SU_TASK_R_INIT;
Pekka Pessi's avatar
Pekka Pessi committed
123 124 125

#define SU_TASK_ZAP(t, f) \
  while (t->sut_port) { \
126
   su_port_decref(t->sut_port, #f); t->sut_port = NULL; break; }
Pekka Pessi's avatar
Pekka Pessi committed
127 128 129

#define SU_TASK_ZAPP(t, f) \
  do { if (t->sut_port) { \
130
   su_port_decref(t->sut_port, #f); t->sut_port = NULL; } \
Pekka Pessi's avatar
Pekka Pessi committed
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
   t->sut_root = NULL; } while(0)

/**
 * Initialize a task handle with su_task_null.
 *
 * @param task task handle
 *
 * @return A reference to the initialized task handle.
 */
_su_task_r su_task_init(su_task_r task)
{
  assert(task);

  memset(task, 0, sizeof(task));
  return task;
}

/**
 * Destroy a task handle
 *
 * @param task task handle
 */
void su_task_deinit(su_task_r task)
{
  assert(task);

  SU_TASK_ZAP(task, su_task_deinit);
  task->sut_root = NULL;
}

/**
 * Create a new task handle.
 *
 * @param task task reference
 * @param root pointer to root object
 * @param port pointer to port object
 *
 * @return New task handle.
 */
_su_task_r su_task_new(su_task_r task, su_root_t *root, su_port_t *port)
{
  assert(task);

  task->sut_root = root;
  if ((task->sut_port = port)) {
176
    su_port_incref(port, "su_task_new");
Pekka Pessi's avatar
Pekka Pessi committed
177 178 179 180 181 182 183 184 185 186 187 188 189
  }
  return task;
}

/**
 * Duplicates a task handle.
 *
 * @param  dst      destination task reference
 * @param  src      source task reference
 */
void su_task_copy(su_task_r dst, su_task_r const src)
{
  su_port_t *port;
190

Pekka Pessi's avatar
Pekka Pessi committed
191 192 193 194 195 196
  assert(src); assert(dst);

  SU_TASK_ZAP(dst, su_task_copy);

  port = src->sut_port;
  if (port) {
197
    su_port_incref(port, "su_task_copy");
Pekka Pessi's avatar
Pekka Pessi committed
198 199 200 201 202 203
  }

  dst[0] = src[0];
}

#define SU_TASK_COPY(d, s, by) (void)((d)[0]=(s)[0], \
204
  (s)->sut_port?(void)su_port_incref(s->sut_port, #by):(void)0)
Pekka Pessi's avatar
Pekka Pessi committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220

/**
 * Moves a task handle.
 *
 * @param  dst      destination task reference
 * @param  src      source task reference
 */
void su_task_move(su_task_r dst, su_task_r src)
{
  SU_TASK_ZAP(dst, su_task_move);
  dst[0] = src[0];
  src->sut_port = 0;
  src->sut_root = 0;
}

/**
Pekka Pessi's avatar
Pekka Pessi committed
221
 * Compare two tasks with each other.
222
 *
Pekka Pessi's avatar
Pekka Pessi committed
223 224
 * @param a  First task
 * @param b  Second task
225
 *
226 227 228
 * @retval negative number, if a < b
 * @retval positive number, if a > b
 * @retval 0, if a == b.
Pekka Pessi's avatar
Pekka Pessi committed
229
 */
230
int su_task_cmp(su_task_r const a, su_task_r const b)
Pekka Pessi's avatar
Pekka Pessi committed
231
{
232 233 234 235
  intptr_t retval = (char *)a->sut_port - (char *)b->sut_port;

  if (retval == 0)
    retval = (char *)a->sut_root - (char *)b->sut_root;
236 237 238 239 240 241 242

  if (sizeof(retval) != sizeof(int)) {
    if (retval < 0)
      retval = -1;
    else if (retval > 0)
      retval = 1;
  }
Pekka Pessi's avatar
Pekka Pessi committed
243

244
  return (int)retval;
Pekka Pessi's avatar
Pekka Pessi committed
245 246 247
}

/**
Pekka Pessi's avatar
Pekka Pessi committed
248
 * Tests if a task is running.
Pekka Pessi's avatar
Pekka Pessi committed
249 250 251
 *
 * @param task  task handle
 *
252
 * @retval true (nonzero) if task is not stopped,
Pekka Pessi's avatar
Pekka Pessi committed
253 254 255 256
 * @retval zero if it is null or stopped.
 */
int su_task_is_running(su_task_r const task)
{
257 258 259
  return
    task &&
    task->sut_port &&
Pekka Pessi's avatar
Pekka Pessi committed
260 261 262 263 264 265 266 267
    task->sut_root;
}

/** @internal
 * Attach a root object to the task handle.
 *
 * @param self task handle
 * @param root pointer to the root object
268
 *
Pekka Pessi's avatar
Pekka Pessi committed
269 270 271 272 273 274 275 276 277
 * @retval 0 if successful,
 * @retval -1 otherwise.
 */
int su_task_attach(su_task_r self, su_root_t *root)
{
  if (self->sut_port) {
    self->sut_root = root;
    return 0;
  }
278
  else
Pekka Pessi's avatar
Pekka Pessi committed
279 280 281
    return -1;
}

282
/**
Pekka Pessi's avatar
Pekka Pessi committed
283 284 285 286
 * Get root pointer attached to a task handle.
 *
 * @param self task handle
 *
287
 * @return
288 289
 * A pointer to root object attached to the task handle, or NULL if no root
 * object has been attached.
Pekka Pessi's avatar
Pekka Pessi committed
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
 */
su_root_t *su_task_root(su_task_r const self)
{
  if (self->sut_port) return self->sut_root; else return NULL;
}

#if 0
/** @internal
 * Detach a root pointer from task handle.
 * @bug Not used anymore.
 */
int su_task_detach(su_task_r self)
{
  self->sut_root = NULL;
  return 0;
}
#endif

/**
 * Return the timer list associated with given task.
310
 *
Pekka Pessi's avatar
Pekka Pessi committed
311 312
 * @param task task handle
 *
313 314
 * @return A timer list of the task. If there are no timers, it returns
 * NULL.
Pekka Pessi's avatar
Pekka Pessi committed
315
 */
316
su_timer_queue_t *su_task_timers(su_task_r const task)
Pekka Pessi's avatar
Pekka Pessi committed
317
{
318
  return task->sut_port ? su_port_timers(task->sut_port) : NULL;
Pekka Pessi's avatar
Pekka Pessi committed
319 320
}

321
/** Execute the @a function by @a task thread.
Pekka Pessi's avatar
Pekka Pessi committed
322 323 324 325 326 327 328 329
 *
 * @retval 0 if successful
 * @retval -1 upon an error
 */
int su_task_execute(su_task_r const task,
		    int (*function)(void *), void *arg,
		    int *return_value)
{
330 331
  int dummy;

332 333
  if (function == NULL)
    return (errno = EFAULT), -1;
Pekka Pessi's avatar
Pekka Pessi committed
334

335 336 337
  if (return_value == NULL)
    return_value = &dummy;

Pekka Pessi's avatar
Pekka Pessi committed
338
  if (!su_port_own_thread(task->sut_port)) {
339
    return su_port_execute(task, function, arg, return_value);
Pekka Pessi's avatar
Pekka Pessi committed
340
  }
341 342
  else {
    int value = function(arg);
Pekka Pessi's avatar
Pekka Pessi committed
343

344 345 346 347 348
    if (return_value)
      *return_value = value;

    return 0;
  }
Pekka Pessi's avatar
Pekka Pessi committed
349 350
}

Pekka Pessi's avatar
Pekka Pessi committed
351 352 353 354 355 356 357 358 359 360 361 362
_su_task_r su_task_new(su_task_r task, su_root_t *root, su_port_t *port);
int su_task_attach(su_task_r self, su_root_t *root);
int su_task_detach(su_task_r self);

int su_timer_reset_all(su_timer_t **t0, su_task_r);

/* Note that is *not* necessary same as su_root_t,
 * as su_root_t can be extended */

#define sur_port sur_task->sut_port
#define sur_root sur_task->sut_root

363
#define SU_ROOT_OWN_THREAD(r) (r->sur_port && su_port_own_thread(r->sur_port))
Pekka Pessi's avatar
Pekka Pessi committed
364 365 366 367 368 369 370 371 372 373 374 375 376 377

/** Create a reactor object.
 *
 * Allocate and initialize the instance of su_root_t.
 *
 * @param magic     pointer to user data
 *
 * @return A pointer to allocated su_root_t instance, NULL on error.
 */
su_root_t *su_root_create(su_root_magic_t *magic)
{
  return su_root_create_with_port(magic, su_port_create());
}

378
/**@internal
Pekka Pessi's avatar
Pekka Pessi committed
379
 *
380 381 382 383 384
 * Create a reactor object using given message port.
 *
 * Allocate and initialize the instance of su_root_t. Note that this
 * function always uses a reference to su_port_t, even when creating the
 * root fails.
Pekka Pessi's avatar
Pekka Pessi committed
385 386 387 388 389 390 391 392 393 394 395 396 397 398
 *
 * @param magic     pointer to user data
 * @param port      pointer to a message port
 *
 * @return A pointer to allocated su_root_t instance, NULL on error.
 */
su_root_t *su_root_create_with_port(su_root_magic_t *magic,
				    su_port_t *port)
{
  su_root_t *self;

  if (!port)
    return NULL;

399
  self = su_salloc(su_port_home(port), sizeof(struct su_root_s));
Pekka Pessi's avatar
Pekka Pessi committed
400 401 402

  if (self) {
    self->sur_magic = magic;
403
#if SU_HAVE_PTHREADS
Pekka Pessi's avatar
Pekka Pessi committed
404
    self->sur_threading = SU_HAVE_PTHREADS;
405 406 407
#else
    self->sur_threading = 0;
#endif
408
    /* This one creates a new reference to port */
Pekka Pessi's avatar
Pekka Pessi committed
409
    su_task_new(self->sur_task, self, port);
410
    /* ... so we zap the old one below */
411
  }
412 413

  su_port_decref(port, "su_root_create_with_port");
Pekka Pessi's avatar
Pekka Pessi committed
414 415 416 417

  return self;
}

418
/** Destroy a root object.
419
 *
Pekka Pessi's avatar
Pekka Pessi committed
420 421 422 423 424 425
 *  Stop and free an instance of su_root_t
 *
 * @param self     pointer to a root object.
 */
void su_root_destroy(su_root_t *self)
{
426 427 428 429 430 431 432
  su_port_t *port;
  int unregistered, reset;

  if (!self)
    return;

  assert(SU_ROOT_OWN_THREAD(self));
Pekka Pessi's avatar
Pekka Pessi committed
433 434 435 436 437 438 439 440 441 442

  self->sur_deiniting = 1;

  if (self->sur_deinit) {
    su_root_deinit_f deinit = self->sur_deinit;
    su_root_magic_t *magic = self->sur_magic;
    self->sur_deinit = NULL;
    deinit(self, magic);
  }

443
  port = self->sur_port; assert(port);
Pekka Pessi's avatar
Pekka Pessi committed
444

445 446 447 448 449 450 451 452 453
  unregistered = su_port_unregister_all(port, self);
  reset = su_timer_reset_all(su_task_timers(self->sur_task), self->sur_task);

  if (unregistered || reset)
    SU_DEBUG_1(("su_root_destroy: "
		"%u registered waits, %u timers\n",
		unregistered, reset));

  SU_TASK_ZAP(self->sur_parent, su_root_destroy);
Pekka Pessi's avatar
Pekka Pessi committed
454

455 456 457
  su_free(su_port_home(port), self);

  su_port_decref(port, "su_root_destroy");
Pekka Pessi's avatar
Pekka Pessi committed
458 459
}

460 461 462 463 464 465
/** Get instance name.
 *
 * @param self      pointer to a root object
 *
 * @return Instance name (e.g., "epoll", "devpoll", "select").
 *
Pekka Pessi's avatar
Pekka Pessi committed
466
 * @NEW_1_12_6.
467 468 469
 */
char const *su_root_name(su_root_t *self)
{
470 471 472 473
  if (!self)
    return (void)(errno = EFAULT), NULL;
  assert(self->sur_port);
  return su_port_name(self->sur_task->sut_port);
474 475
}

Pekka Pessi's avatar
Pekka Pessi committed
476 477 478 479 480 481 482 483 484 485 486 487
/** Set the context pointer.
 *
 *  Set the context pointer (magic) of a root object.
 *
 * @param self      pointer to a root object
 * @param magic     pointer to user data
 *
 * @retval 0  when successful,
 * @retval -1 upon error.
 */
int su_root_set_magic(su_root_t *self, su_root_magic_t *magic)
{
488 489
  if (self == NULL)
    return (void)(errno = EFAULT), -1;
Pekka Pessi's avatar
Pekka Pessi committed
490
  assert(SU_ROOT_OWN_THREAD(self));
491
  self->sur_magic = magic;
Pekka Pessi's avatar
Pekka Pessi committed
492 493 494 495 496 497 498 499 500 501 502 503 504 505
  return 0;
}

/** Set threading option.
 *
 *   Controls whether su_clone_start() creates a new thread.
 *
 * @param self      pointer to a root object
 * @param enable    if true, enable threading, if false, disable threading
 *
 * @return True if threading is enabled.
 */
int su_root_threading(su_root_t *self, int enable)
{
506 507 508
  if (self == NULL)
    return (void)(errno = EFAULT), -1;
  assert(SU_ROOT_OWN_THREAD(self));
Pekka Pessi's avatar
Pekka Pessi committed
509
#if SU_HAVE_PTHREADS
510 511 512
  self->sur_threading = enable = enable != 0;
  return enable;
#else
Pekka Pessi's avatar
Pekka Pessi committed
513
  return 0;
514
#endif
Pekka Pessi's avatar
Pekka Pessi committed
515 516 517 518 519 520 521 522 523 524 525 526 527
}

/** Get context pointer.
 *
 *  The function su_root_magic() returns the user context pointer that was
 *  given input to su_root_create() or su_root_set_magic().
 *
 * @param self      pointer to a root object
 *
 * @return A pointer to user data
 */
su_root_magic_t *su_root_magic(su_root_t *self)
{
528 529 530 531
  if (!self)
    return (void)(errno = EFAULT), NULL;

  return self->sur_magic;
Pekka Pessi's avatar
Pekka Pessi committed
532 533 534 535 536
}

/** Get a GSource */
struct _GSource *su_root_gsource(su_root_t *self)
{
537 538 539 540 541
  if (!self)
    return (void)(errno = EFAULT), NULL;
  assert(self->sur_port);

  return su_port_gsource(self->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
542 543
}

544
/** Register a su_wait_t object.
Pekka Pessi's avatar
Pekka Pessi committed
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
 *
 *  The function su_root_register() registers a su_wait_t object. The wait
 *  object, a callback function and a argument are stored to the root
 *  object. The callback function is called, when the wait object is
 *  signaled.
 *
 *  Please note if identical wait objects are inserted, only first one is
 *  ever signalled.
 *
 * @param self      pointer to root object
 * @param wait      pointer to wait object
 * @param callback  callback function pointer
 * @param arg       argument given to callback function when it is invoked
 * @param priority  relative priority of the wait object
 *                  (0 is normal, 1 important, 2 realtime)
 *
 * @return Nonzero index of the wait object, or -1 upon an error.
 */
int su_root_register(su_root_t *self,
		     su_wait_t *wait,
		     su_wakeup_f callback,
		     su_wakeup_arg_t *arg,
		     int priority)
{
569 570 571
  if (!self || !wait)
    return (void)(errno = EFAULT), -1;
  assert(self->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594

  return su_port_register(self->sur_port, self, wait, callback, arg, priority);
}

/** Unregister a su_wait_t object.
 *
 *  The function su_root_unregister() unregisters a su_wait_t object. The
 *  wait object, a callback function and a argument are removed from the
 *  root object.
 *
 * @param self      pointer to root object
 * @param wait      pointer to wait object
 * @param callback  callback function pointer (may be NULL)
 * @param arg       argument given to callback function when it is invoked
 *                  (may be NULL)
 *
 * @return Nonzero index of the wait object, or -1 upon an error.
 */
int su_root_unregister(su_root_t *self,
		       su_wait_t *wait,
		       su_wakeup_f callback, /* XXX - ignored */
		       su_wakeup_arg_t *arg)
{
595 596 597
  if (!self || !wait)
    return (void)(errno = EFAULT), -1;
  assert(self->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
598 599 600 601 602 603 604 605 606 607 608

  return su_port_unregister(self->sur_port, self, wait, callback, arg);
}

/** Remove a su_wait_t registration.
 *
 *  The function su_root_deregister() deregisters a su_wait_t object. The
 *  wait object, a callback function and a argument are removed from the
 *  root object. The wait object is destroyed.
 *
 * @param self      pointer to root object
609
 * @param index     registration index
Pekka Pessi's avatar
Pekka Pessi committed
610 611 612
 *
 * @return Index of the wait object, or -1 upon an error.
 */
613
int su_root_deregister(su_root_t *self, int index)
Pekka Pessi's avatar
Pekka Pessi committed
614
{
615 616 617 618 619
  if (!self)
    return (void)(errno = EFAULT), -1;
  if (index == 0 || index == -1)
    return (void)(errno = EINVAL), -1;
  assert(self->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
620

621
  return su_port_deregister(self->sur_port, index);
Pekka Pessi's avatar
Pekka Pessi committed
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
}

/** Set mask for a registered event.
 *
 * The function su_root_eventmask() sets the mask describing events that can
 * signal the registered callback.
 *
 * @param self   pointer to root object
 * @param index  registration index
 * @param socket socket
 * @param events new event mask
 *
 * @retval 0 when successful,
 * @retval -1 upon an error.
 */
int su_root_eventmask(su_root_t *self, int index, int socket, int events)
{
639 640 641 642 643
  if (!self)
    return (void)(errno = EFAULT), -1;
  if (index == 0 || index == -1)
    return (void)(errno = EINVAL), -1;
  assert(self->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657

  return su_port_eventmask(self->sur_port, index, socket, events);
}

/** Set multishot mode.
 *
 * The function su_root_multishot() enables, disables or queries the
 * multishot mode for the root. The multishot mode determines how the events
 * are scheduled by root. If multishot mode is enabled, root serves all the
 * sockets that have received network events. If it is disables, only first
 * socket event is served.
 *
 * @param self      pointer to root object
 * @param multishot multishot mode (0 => disables, 1 => enables, -1 => query)
658
 *
Pekka Pessi's avatar
Pekka Pessi committed
659 660 661 662 663 664
 * @retval 0 multishot mode is disabled
 * @retval 1 multishot mode is enabled
 * @retval -1 an error occurred
 */
int su_root_multishot(su_root_t *self, int multishot)
{
665 666 667 668
  if (!self)
    return (void)(errno = EFAULT), -1;
  assert(self->sur_port);
  return su_port_multishot(self->sur_port, multishot);
Pekka Pessi's avatar
Pekka Pessi committed
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
}

/** Run event and message loop.
 *
 * The function su_root_run() runs the root main loop. The root loop waits
 * for wait objects and the timers associated with the root object. When any
 * wait object is signaled or timer is expired, it invokes the callbacks,
 * and returns waiting.
 *
 * This function returns when su_root_break() is called from a callback.
 *
 * @param self      pointer to root object
 *
 */
void su_root_run(su_root_t *self)
{
685 686 687
  if (!self)
    return /* (void)(errno = EFAULT), -1 */;
  assert(self->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
688

689
  /* return */ su_port_run(self->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
690 691 692 693 694 695 696 697 698 699 700
}

/** Terminate event loop.
 *
 *   The function su_root_break() is used to terminate execution of
 *   su_root_run(). It can be called from a callback function.
 *
 * @param self      pointer to root object
 */
void su_root_break(su_root_t *self)
{
701 702 703
  if (!self)
    return /* (void)(errno = EFAULT), -1 */;
  assert(self->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
704

705
  /* return */ su_port_break(self->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
706 707 708 709 710 711 712 713 714 715 716 717 718 719
}

/** Process events, timers and messages.
 *
 *   The function su_root_step() waits for wait objects and the timers
 *   associated with the root object.  When any wait object is signaled or
 *   timer is expired, it invokes the callbacks.
 *
 *   This function returns when a callback has been invoked or tout
 *   milliseconds is elapsed.
 *
 * @param self      pointer to root object
 * @param tout      timeout in milliseconds
 *
720 721
 * @return Milliseconds to the next invocation of timer
 * @retval SU_WAIT_FOREVER if there are no active timers or if there was an error
Pekka Pessi's avatar
Pekka Pessi committed
722 723 724
 */
su_duration_t su_root_step(su_root_t *self, su_duration_t tout)
{
725 726 727
  if (self == NULL)
    return (void)(errno = EFAULT), SU_WAIT_FOREVER;
  assert(self->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
728 729 730 731 732 733 734 735 736 737 738 739
  return su_port_step(self->sur_port, tout);
}

/**Run event and message loop for given duration.
 *
 * The function su_root_sleep() runs event loop for @a duration milliseconds.
 * The event loop waits for wait objects and the timers associated with the
 * @a root object.  When any wait object is signaled, timer is expired, or
 * message is received, it invokes the callbacks and returns waiting.
 *
 * @param self      pointer to root object
 * @param duration  milliseconds to run event loop
740 741
 *
 * @retval milliseconds until next timer expiration
Pekka Pessi's avatar
Pekka Pessi committed
742 743 744 745
 */
su_duration_t su_root_sleep(su_root_t *self, su_duration_t duration)
{
  su_duration_t retval, accrued = 0;
746
  su_time_t started;
Pekka Pessi's avatar
Pekka Pessi committed
747

748 749 750 751 752
  if (self == NULL)
    return (void)(errno = EFAULT), SU_WAIT_FOREVER;

  assert(self->sur_port);
  started = su_now();
Pekka Pessi's avatar
Pekka Pessi committed
753 754 755 756 757 758 759 760 761

  do {
    retval = su_port_step(self->sur_port, duration - accrued);
    accrued = su_duration(su_now(), started);
  } while (accrued < duration);

  return retval;
}

762 763 764 765 766 767 768 769
/** Check wait events in callbacks that take lots of time
 *
 * This function does a 0 timeout poll() and runs wait objects
 *
 * @param self pointer to root object
 */
int su_root_yield(su_root_t *self)
{
770 771 772 773
  if (self == NULL)
    return (void)(errno = EFAULT), SU_WAIT_FOREVER;
  assert(self->sur_port);

774
  return su_port_wait_events(self->sur_port, 0);
775 776
}

Pekka Pessi's avatar
Pekka Pessi committed
777 778
/** Get task reference.
 *
779
 * Retrieve the task reference related with the root object.
Pekka Pessi's avatar
Pekka Pessi committed
780 781 782
 *
 * @param self      a pointer to a root object
 *
783
 * @return A reference to the task object.
Pekka Pessi's avatar
Pekka Pessi committed
784 785 786 787 788 789 790 791 792 793 794
 */
_su_task_r su_root_task(su_root_t const *self)
{
  if (self)
    return self->sur_task;
  else
    return su_task_null;
}

/** Get parent task reference.
 *
795 796
 * Retrieve the task reference of the parent task associated with the root
 * object.
Pekka Pessi's avatar
Pekka Pessi committed
797
 *
798
 * @param self a pointer to a root object
Pekka Pessi's avatar
Pekka Pessi committed
799
 *
800
 * @return A reference to the parent task object.
Pekka Pessi's avatar
Pekka Pessi committed
801 802 803 804 805 806 807 808 809
 */
_su_task_r su_root_parent(su_root_t const *self)
{
  if (self)
    return self->sur_parent;
  else
    return su_task_null;
}

810
/** Add a pre-poll callback. */
811 812
int su_root_add_prepoll(su_root_t *root,
			su_prepoll_f *callback,
Pekka Pessi's avatar
Pekka Pessi committed
813 814
			su_prepoll_magic_t *magic)
{
815 816 817
  if (root == NULL)
    return (void)(errno = EFAULT), -1;
  assert(root->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
818 819 820 821 822 823 824

  return su_port_add_prepoll(root->sur_port, root, callback, magic);
}

/** Remove a pre-poll callback */
int su_root_remove_prepoll(su_root_t *root)
{
825 826 827
  if (root == NULL)
    return (void)(errno = EFAULT), -1;
  assert(root->sur_port);
Pekka Pessi's avatar
Pekka Pessi committed
828 829 830 831

  return su_port_remove_prepoll(root->sur_port, root);
}

832 833 834 835 836 837 838 839 840 841 842
/** Release the root port for other threads.
 *
 * @NEW_1_12_7
 */
int su_root_release(su_root_t *root)
{
  if (root == NULL || root->sur_port == NULL)
    return (void)(errno = EFAULT), -1;
  return su_port_release(root->sur_port);
}

843
/** Obtain the root port from other thread.
844 845 846 847 848 849 850
 *
 * @param root pointer to root object
 *
 * @retval 0 if successful
 * @retval -1 upon an error
 *
 * @ERRORS
851
 * @ERROR EFAULT
852 853 854 855 856 857 858 859 860
 * @NEW_1_12_7
 */
int su_root_obtain(su_root_t *root)
{
  if (root == NULL || root->sur_port == NULL)
    return (void)(errno = EFAULT), -1;
  return su_port_obtain(root->sur_port);
}

861
/**Check if a thread has obtained the root.
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
 *
 * @param root a pointer to root object
 *
 * @retval 2 if current thread has obtained the root
 * @retval 1 if an another thread  has obtained the root
 * @retval 0 if no thread has obtained the root
 * @retval -1 upon an error
 *
 * @NEW_1_12_7
 */
int su_root_has_thread(su_root_t *root)
{
  if (root == NULL || root->sur_port == NULL)
    return (void)(errno = EFAULT), -1;
  return su_port_has_thread(root->sur_port);
}

Pekka Pessi's avatar
Pekka Pessi committed
879 880 881 882
/* =========================================================================
 * Messages
 */

883 884 885
/**
 * Allocate a su message of given size.
 *
886
 * Allocate a su message with given data size.
887 888 889 890 891
 *
 * @param  rmsg   handle to the new message (may be uninitialized prior calling)
 * @param  size   size of the message data
 *
 * @retval  0 if successful,
892
 * @retval -1 if message allocation fails.
893 894
 *
 * @NEW_1_12_8
895 896 897 898 899 900 901 902 903 904 905 906 907 908
 */
int su_msg_new(su_msg_r rmsg, size_t size)
{
  su_msg_t *msg;
  size_t total = sizeof(*msg) + (size_t)size;

  *rmsg = msg = su_zalloc(NULL, (isize_t)total);
  if (!*rmsg)
    return -1;

  msg->sum_size = total;
  return 0;
}

Pekka Pessi's avatar
Pekka Pessi committed
909 910 911 912 913 914 915 916 917 918 919 920 921
/**
 * Allocates a message of given size.
 *
 * The function @c su_msg_create() allocates a message with given data size.
 * If successful, it moves the new message handle to the @c rmsg.
 *
 * @param  rmsg   handle to the new message (may be uninitialized prior calling)
 * @param  to     the recipient task
 * @param  from   the sender task
 * @param  wakeup function that is called when message is delivered
 * @param  size   size of the message data
 *
 * @retval  0 if successful,
922
 * @retval -1 if message allocation fails.
Pekka Pessi's avatar
Pekka Pessi committed
923 924 925 926 927
 */
int su_msg_create(su_msg_r        rmsg,
		  su_task_r const to,
		  su_task_r const from,
		  su_msg_f        wakeup,
928
		  isize_t         size)
Pekka Pessi's avatar
Pekka Pessi committed
929
{
930 931 932 933
  if (su_msg_new(rmsg, (size_t) size) == 0) {
    SU_TASK_COPY(rmsg[0]->sum_to, to, su_msg_create);
    SU_TASK_COPY(rmsg[0]->sum_from, from, su_msg_create);
    rmsg[0]->sum_func = wakeup;
Pekka Pessi's avatar
Pekka Pessi committed
934
    return 0;
935
  }
936 937

  return -1;
Pekka Pessi's avatar
Pekka Pessi committed
938 939
}

940
/** Add a delivery report function to a message.
941
 *
942 943
 * The delivery report funcgtion gets called by the sending task after the
 * message was delivered and the message function was executed. (The
944 945
 * su_root_t message delivery loop calls su_msg_delivery_report()
 *
Pekka Pessi's avatar
Pekka Pessi committed
946 947 948 949 950 951 952 953 954 955 956 957
 */
int su_msg_report(su_msg_r msg,
		  su_msg_f report)
{
  if (msg && msg[0] && msg[0]->sum_report == NULL) {
    msg[0]->sum_report = report;
    return 0;
  }

  return -1;
}

958 959 960 961 962 963 964 965 966
/** Add a deinitializer function to a message.
 *
 * The deinitializer function is called when the message gets destroyed. It
 * is called even if the message was never delivered. Note that the thread
 * destroying the message and calling the deinit function is not necessarily
 * the same that sent the message nor the original recipient.
 *
 * @param rmsg   message reference
 * @param deinit pointer to deinitializer function
967 968
 *
 * @NEW_1_12_8
969 970
 */
int su_msg_deinitializer(su_msg_r rmsg,
971
			 su_msg_deinit_function *deinit)
972 973 974 975 976 977 978 979
{
  if (rmsg && rmsg[0]) {
    rmsg[0]->sum_deinit = deinit;
    return 0;
  }
  return -1;
}

Pekka Pessi's avatar
Pekka Pessi committed
980 981 982 983
/**
 * Allocates a reply message of given size.
 *
 * @param reply     handle to the new message (may be uninitialized prior calling)
984
 * @param rmsg       the incoming message
Pekka Pessi's avatar
Pekka Pessi committed
985 986 987 988 989 990 991
 * @param wakeup    function that is called when message is delivered
 * @param size      size of the message data
 *
 * @retval 0 if successful,
 * @retval -1 otherwise.
 */

992
int su_msg_reply(su_msg_r reply, su_msg_cr rmsg,
993
		 su_msg_f wakeup, isize_t size)
Pekka Pessi's avatar
Pekka Pessi committed
994
{
995
  su_msg_r rmsg0;
Pekka Pessi's avatar
Pekka Pessi committed
996

997
  assert(rmsg != reply);
Pekka Pessi's avatar
Pekka Pessi committed
998

999
  *rmsg0 = *(su_msg_t **) rmsg;
Pekka Pessi's avatar
Pekka Pessi committed
1000 1001
  *reply = NULL;

1002
  return su_msg_create(reply, su_msg_from(rmsg0), su_msg_to(rmsg0), wakeup, size);
Pekka Pessi's avatar
Pekka Pessi committed
1003 1004 1005
}


1006 1007 1008 1009 1010 1011
/** Send a delivery report.
 *
 * If the sender has attached a delivery report function to message with
 * su_msg_report(), the message is returned to the message queue of the
 * sending task. The sending task calls the delivery report function when it
 * has received the message.
Pekka Pessi's avatar
Pekka Pessi committed
1012
 */
1013
void su_msg_delivery_report(su_msg_r rmsg)
Pekka Pessi's avatar
Pekka Pessi committed
1014 1015 1016
{
  su_task_r swap;

1017
  if (!rmsg || !rmsg[0])
1018 1019
    return;

1020 1021
  if (!rmsg[0]->sum_report) {
    su_msg_destroy(rmsg);
1022 1023 1024
    return;
  }

1025 1026 1027
  *swap = *rmsg[0]->sum_from;
  *rmsg[0]->sum_from = *rmsg[0]->sum_to;
  *rmsg[0]->sum_to = *swap;
Pekka Pessi's avatar
Pekka Pessi committed
1028

1029 1030 1031
  rmsg[0]->sum_func = rmsg[0]->sum_report;
  rmsg[0]->sum_report = NULL;
  su_msg_send(rmsg);
Pekka Pessi's avatar
Pekka Pessi committed
1032 1033
}

1034
/** Save a message. */
1035
void su_msg_save(su_msg_r save, su_msg_r rmsg)
Pekka Pessi's avatar
Pekka Pessi committed
1036 1037
{
  if (save) {
1038 1039
    if (rmsg)
      save[0] = rmsg[0];
Pekka Pessi's avatar
Pekka Pessi committed
1040 1041 1042
    else
      save[0] = NULL;
  }
1043 1044
  if (rmsg)
    rmsg[0] = NULL;
Pekka Pessi's avatar
Pekka Pessi committed
1045 1046 1047 1048 1049 1050 1051 1052 1053
}

/**
 * Destroys an unsent message.
 *
 * @param rmsg       message handle.
 */
void su_msg_destroy(su_msg_r rmsg)
{
1054 1055
  su_msg_t *msg;

Pekka Pessi's avatar
Pekka Pessi committed
1056 1057
  assert(rmsg);

1058
  msg = rmsg[0], rmsg[0] = NULL;
Pekka Pessi's avatar
Pekka Pessi committed
1059

1060 1061 1062
  if (msg) {
    SU_TASK_ZAP(msg->sum_to, su_msg_destroy);
    SU_TASK_ZAP(msg->sum_from, su_msg_destroy);
1063

1064 1065
    if (msg->sum_deinit)
      msg->sum_deinit(msg->sum_data);
Pekka Pessi's avatar
Pekka Pessi committed
1066

1067 1068
    su_free(NULL, msg);
  }
Pekka Pessi's avatar
Pekka Pessi committed
1069 1070
}

1071
/** Gets a pointer to the message data area.
Pekka Pessi's avatar
Pekka Pessi committed
1072 1073 1074 1075 1076 1077 1078
 *
 * The function @c su_msg_data() returns a pointer to the message data
 * area. If @c rmsg contains a @c NULL handle, or message size is 0, @c NULL
 * pointer is returned.
 *
 * @param rmsg       message handle
 *
1079
 * @return A pointer to the message data area is returned.
Pekka Pessi's avatar
Pekka Pessi committed
1080
 */
1081
su_msg_arg_t *su_msg_data(su_msg_cr rmsg)
Pekka Pessi's avatar
Pekka Pessi committed
1082 1083 1084 1085 1086 1087 1088 1089
{
  if (rmsg[0] && rmsg[0]->sum_size > sizeof(su_msg_t))
    return rmsg[0]->sum_data;
  else
    return NULL;
}

/** Get size of message data area. */
1090
isize_t su_msg_size(su_msg_cr rmsg)
Pekka Pessi's avatar
Pekka Pessi committed
1091 1092 1093 1094 1095 1096
{
  return rmsg[0] ? rmsg[0]->sum_size - sizeof(su_msg_t) : 0;
}

/** Get sending task.
 *
1097
 * Returns the task handle belonging to the sender of the message.
Pekka Pessi's avatar
Pekka Pessi committed
1098 1099 1100 1101
 *
 * If the message handle contains NULL the function @c su_msg_from
 * returns NULL.
 *
1102
 * @param rmsg       message handle
Pekka Pessi's avatar
Pekka Pessi committed
1103
 *
1104
 * @return The task handle of the sender is returned.
Pekka Pessi's avatar
Pekka Pessi committed
1105
 */
1106
_su_task_r su_msg_from(su_msg_cr rmsg)
Pekka Pessi's avatar
Pekka Pessi committed
1107
{
1108
  return rmsg[0] ? rmsg[0]->sum_from : NULL;
Pekka Pessi's avatar
Pekka Pessi committed
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
}

/** Get destination task.
 *
 * The function @c su_msg_from returns the task handle belonging to the
 * recipient of the message.
 *
 * If the message handle contains NULL the function @c su_msg_to
 * returns NULL.
 *
1119
 * @param rmsg       message handle
Pekka Pessi's avatar
Pekka Pessi committed
1120
 *
1121
 * @return The task handle of the recipient is returned.
Pekka Pessi's avatar
Pekka Pessi committed
1122
 */
1123
_su_task_r su_msg_to(su_msg_cr rmsg)
Pekka Pessi's avatar
Pekka Pessi committed
1124
{
1125
  return rmsg[0] ? rmsg[0]->sum_to : NULL;
Pekka Pessi's avatar
Pekka Pessi committed
1126 1127
}

1128
/** Remove references to 'from' and 'to' tasks from a message.
1129
 *
1130
 * @param rmsg       message handle
1131
 */
1132
void su_msg_remove_refs(su_msg_cr rmsg)
1133
{
1134 1135 1136
  if (rmsg[0]) {
    su_task_deinit(rmsg[0]->sum_to);
    su_task_deinit(rmsg[0]->sum_from);
1137 1138 1139
  }
}

1140
/**Send a message.
Pekka Pessi's avatar
Pekka Pessi committed
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
 *
 * The function @c su_msg_send() sends the message. The message is added to
 * the recipients message queue, and recipient is waken up. The caller may
 * not alter the message or the data associated with it after the message
 * has been sent.
 *
 * @param rmsg message handle
 *
 * @retval 0 if signal was sent successfully or handle was @c NULL,
 * @retval -1 otherwise.
 */
int su_msg_send(su_msg_r rmsg)
{
  assert(rmsg);

  if (rmsg[0]) {
    su_msg_t *msg = rmsg[0];
1158

1159
    if (msg->sum_to->sut_port)
1160 1161 1162 1163 1164
      return su_port_send(msg->sum_to->sut_port, rmsg);

    su_msg_destroy(rmsg);
    errno = EINVAL;
    return -1;
Pekka Pessi's avatar
Pekka Pessi committed
1165 1166
  }

1167
  return 0;
Pekka Pessi's avatar
Pekka Pessi committed
1168
}
1169

1170 1171 1172 1173
/** Send message to the @a to_task and mark @a from_task as sender.
 *
 * @NEW_1_12_8
 */
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
SOFIAPUBFUN int su_msg_send_to(su_msg_r rmsg,
			       su_task_r const to_task,
			       su_msg_f wakeup)
{
  assert(rmsg); assert(to_task);

  if (rmsg[0]) {
    su_msg_t *msg = rmsg[0];

    if (wakeup)
      msg->sum_func = wakeup;

1186
    if (msg->sum_to->sut_port &&
1187
	msg->sum_to->sut_port != to_task->sut_port) {
1188
      SU_TASK_ZAP(msg->sum_to, "su_msg_send_to");
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
    }

    if (to_task->sut_port != NULL) {
      msg->sum_to->sut_port = NULL;
      msg->sum_to->sut_root = to_task->sut_root;

      return su_port_send(to_task->sut_port, rmsg);
    }

    su_msg_destroy(rmsg);
    errno = EINVAL;
    return -1;
  }

  return 0;
}