amxp_signal.c File Reference

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <fcntl.h>
#include <unistd.h>
#include <pthread.h>
#include <amxc/amxc.h>
#include <amxp/amxp.h>
#include "amxp_signal_priv.h"

Go to the source code of this file.

Data Structures
struct	_signal_ctrl
struct	_signal_queue_item

Macros
#define	_GNU_SOURCE

Typedefs
typedef struct _signal_ctrl	signal_ctrl_t
typedef struct _signal_queue_item	signal_queue_item_t

Functions
static int	amxp_signal_queue_lock (void)
static int	amxp_signal_queue_unlock (void)
void	amxp_free_slots (amxc_llist_it_t *it)
static void	amxp_free_signals (UNUSED const char *key, amxc_htable_it_t *it)
static void	amxp_free_queued_signals (amxc_lqueue_it_t *it)
static int	amxp_signal_queue (const amxp_signal_t *const signal, const amxc_var_t *const data)
static int	amxp_deferred_queue (amxp_signal_mngr_t *sigmngr, amxp_deferred_fn_t fn, const amxc_var_t *const data, void *priv)
static signal_queue_item_t *	amxp_signal_dequeue (void)
static int	amxp_signal_create_pipe (void)
static void	amxp_slot_trigger (const amxp_slot_t *const slot, const char *name, const amxc_var_t *const data)
static void	amxp_sigmngr_trigger_regexp (amxp_signal_mngr_t *sig_mngr, const char *name, const amxc_var_t *const data)
static void	amxp_signal_garbage_collect (amxp_signal_t *signal)
static void	amxp_sigmngr_garbage_collect (amxp_signal_mngr_t *sig_mngr)
amxp_signal_mngr_t *	amxp_get_sigmngr (amxp_signal_mngr_t *sig_mngr)
void	amxp_get_sigmngrs (amxc_llist_t **sigmngrs, amxc_llist_t **pending_sigmngrs)
const amxc_htable_t *	amxp_get_signals (const amxp_signal_mngr_t *sig_mngr)
int	amxp_sigmngr_new (amxp_signal_mngr_t **sig_mngr)
	Constructor function, creates a new signal manager instance. More...
int	amxp_sigmngr_delete (amxp_signal_mngr_t **sig_mngr)
	Destructor function, deletes a signal manager instance. More...
int	amxp_sigmngr_init (amxp_signal_mngr_t *sig_mngr)
	Initializing function, initializes members of the amxp_signal_mngr_t structure. More...
int	amxp_sigmngr_clean (amxp_signal_mngr_t *sig_mngr)
	Clean-up functions, cleans-up all members of a amxp_signal_mngr_t structure. More...
int	amxp_sigmngr_add_signal (amxp_signal_mngr_t *const sig_mngr, const char *name)
	Adds a signal to a signal manager. More...
int	amxp_sigmngr_remove_signal (amxp_signal_mngr_t *const sig_mngr, const char *name)
	Removes a signal from a signal manager. More...
amxp_signal_t *	amxp_sigmngr_find_signal (const amxp_signal_mngr_t *const sig_mngr, const char *name)
	Get the pointer to the signal. More...
void	amxp_sigmngr_trigger_signal (amxp_signal_mngr_t *const sig_mngr, const char *name, const amxc_var_t *const data)
	Triggers a signal. More...
int	amxp_sigmngr_emit_signal (const amxp_signal_mngr_t *const sig_mngr, const char *name, const amxc_var_t *const data)
	Emits a signal. More...
int	amxp_sigmngr_deferred_call (amxp_signal_mngr_t *const sig_mngr, amxp_deferred_fn_t fn, const amxc_var_t *const data, void *priv)
	Defers a function call. More...
int	amxp_sigmngr_enable (amxp_signal_mngr_t *const sig_mngr, bool enable)
	Enables or disables the signal manager. More...
int	amxp_sigmngr_suspend (amxp_signal_mngr_t *const sig_mngr)
	Suspends the handling of signals for the signal manager. More...
int	amxp_sigmngr_resume (amxp_signal_mngr_t *const sig_mngr)
	Resumes the handling of signals for the signal manager. More...
int	amxp_signal_new (amxp_signal_mngr_t *sig_mngr, amxp_signal_t **signal, const char *name)
	Constructor function, creates a new signal. More...
int	amxp_signal_delete (amxp_signal_t **const signal)
	Destructor function, deletes a signal. More...
void	amxp_signal_trigger (amxp_signal_t *const signal, const amxc_var_t *const data)
	Triggers a signal. More...
int	amxp_signal_emit (const amxp_signal_t *const signal, const amxc_var_t *const data)
	Emits a signal. More...
int	amxp_signal_read (void)
	Reads from the amxp signal file descriptor. More...
int	amxp_signal_disconnect_all (amxp_signal_t *const signal)
	Disconnects all slots from the signal. More...
const char *	amxp_signal_name (const amxp_signal_t *const signal)
	Gets the name of the signal. More...
bool	amxp_signal_has_slots (const amxp_signal_t *const signal)
	Checks if the signal has slots conencted. More...
int	amxp_signal_fd (void)
	Gets the amxp signal file descriptor. More...
	CONSTRUCTOR_LVL (101)
	DESTRUCTOR_LVL (101)

Variables
static signal_ctrl_t	amxp_sigctrl
static amxp_signal_mngr_t	amxp_sigmngr

Macro Definition Documentation

_GNU_SOURCE

#define _GNU_SOURCE

Definition at line 56 of file amxp_signal.c.

Typedef Documentation

signal_ctrl_t

typedef struct _signal_ctrl signal_ctrl_t

signal_queue_item_t

typedef struct _signal_queue_item signal_queue_item_t

Function Documentation

amxp_deferred_queue()

static int amxp_deferred_queue ( amxp_signal_mngr_t *  sigmngr, amxp_deferred_fn_t  fn, const amxc_var_t *const  data, void *  priv  )

static

Definition at line 151 of file amxp_signal.c.

                                           {
    int retval = -1;
    signal_queue_item_t* item = (signal_queue_item_t*) calloc(1, sizeof(signal_queue_item_t));
    when_null(item, exit);
 
    amxc_var_init(&item->sig_data);
    if(data != NULL) {
        when_failed(amxc_var_copy(&item->sig_data, data), exit);
    }
    item->fn = fn;
    item->priv = priv;
    amxc_lqueue_add(&sigmngr->signal_queue, &item->it);
 
    if(!sigmngr->suspended) {
        amxc_llist_append(&amxp_sigctrl.pending_sigmngrs, &sigmngr->it);
    }
 
    retval = 0;
 
exit:
    if((retval != 0) && (item != NULL)) {
        amxc_var_clean(&item->sig_data);
        free(item);
    }
    return retval;
}

amxp_free_queued_signals()

static void amxp_free_queued_signals ( amxc_lqueue_it_t *  it )

static

Definition at line 114 of file amxp_signal.c.

                                                           {
    signal_queue_item_t* item = amxc_llist_it_get_data(it, signal_queue_item_t, it);
    amxc_var_clean(&item->sig_data);
    free(item->sig_name);
    free(item);
}

amxp_free_signals()

static void amxp_free_signals ( UNUSED const char *  key, amxc_htable_it_t *  it  )

static

Definition at line 107 of file amxp_signal.c.

                                                    {
    amxp_signal_t* signal = amxc_htable_it_get_data(it, amxp_signal_t, hit);
    amxp_signal_disconnect_all(signal);
    free(signal);
}

amxp_free_slots()

void amxp_free_slots

(

amxc_llist_it_t *

it

)

Definition at line 99 of file amxp_signal.c.

                                          {
    amxp_slot_t* slot = amxc_llist_it_get_data(it, amxp_slot_t, it);
    amxc_llist_it_take(it);
    amxp_expr_delete(&slot->expr);
    free(slot->regexp);
    free(slot);
}

amxp_get_sigmngr()

amxp_signal_mngr_t* amxp_get_sigmngr

(

amxp_signal_mngr_t *

sig_mngr

)

Definition at line 315 of file amxp_signal.c.

                                                                   {
    return (sig_mngr == NULL) ? &amxp_sigmngr : sig_mngr;
}

amxp_get_sigmngrs()

void amxp_get_sigmngrs	(	amxc_llist_t **	sigmngrs,
		amxc_llist_t **	pending_sigmngrs
	)

Definition at line 319 of file amxp_signal.c.

                                                        {
    *sigmngrs = &amxp_sigctrl.sigmngrs;
    *pending_sigmngrs = &amxp_sigctrl.pending_sigmngrs;
}

amxp_get_signals()

const amxc_htable_t* amxp_get_signals

(

const amxp_signal_mngr_t *

sig_mngr

)

Definition at line 325 of file amxp_signal.c.

                                                                          {
    sig_mngr = (sig_mngr == NULL) ? &amxp_sigmngr : sig_mngr;
    return &sig_mngr->signals;
}

amxp_sigmngr_garbage_collect()

static void amxp_sigmngr_garbage_collect ( amxp_signal_mngr_t *  sig_mngr )

static

Definition at line 292 of file amxp_signal.c.

                                                                       {
    when_null(sig_mngr, exit);
 
    if(sig_mngr->deleted && (sig_mngr != &amxp_sigmngr)) {
        amxp_sigmngr_delete(&sig_mngr);
    } else {
        sig_mngr->deleted = false;
        amxc_htable_for_each(hit, &sig_mngr->signals) {
            amxp_signal_t* sig = amxc_container_of(hit, amxp_signal_t, hit);
            amxp_signal_garbage_collect(sig);
        }
        amxc_llist_for_each(it, &sig_mngr->regexp_slots) {
            amxp_slot_t* slot = amxc_llist_it_get_data(it, amxp_slot_t, it);
            if(slot->deleted) {
                amxc_llist_it_clean(it, amxp_free_slots);
            }
        }
    }
 
exit:
    return;
}

amxp_sigmngr_trigger_regexp()

static void amxp_sigmngr_trigger_regexp ( amxp_signal_mngr_t *  sig_mngr, const char *  name, const amxc_var_t *const  data  )

static

Definition at line 243 of file amxp_signal.c.

                                                                      {
    amxp_signal_t* signal = amxp_sigmngr_find_signal(sig_mngr, name);
    if(signal != NULL) {
        signal->triggered = true;
    }
 
    sig_mngr->triggered = true;
    amxc_llist_for_each(it, (&sig_mngr->regexp_slots)) {
        regex_t regexp;
        amxp_slot_t* slot = amxc_llist_it_get_data(it, amxp_slot_t, it);
        if(slot->deleted) {
            continue;
        }
        regcomp(&regexp, slot->regexp, REG_NOSUB | REG_EXTENDED);
        if(regexec(&regexp, name, 0, NULL, 0) == 0) {
            amxp_slot_trigger(slot, name, data);
        }
        regfree(&regexp);
        if(sig_mngr->deleted || !sig_mngr->enabled) {
            break;
        }
    }
 
    if(signal != NULL) {
        signal->triggered = false;
    }
    sig_mngr->triggered = false;
}

amxp_signal_create_pipe()

static int amxp_signal_create_pipe ( void  )

static

Definition at line 205 of file amxp_signal.c.

                                         {
    int flags = 0;
    int retval = pipe(amxp_sigctrl.sigpipe);
    when_true(retval != 0, exit);
 
    flags = fcntl(amxp_sigctrl.sigpipe[0], F_GETFL, 0);
    when_true(flags < 0, exit);
    when_true(fcntl(amxp_sigctrl.sigpipe[0], F_SETFL, flags | O_NONBLOCK) < 0, exit);
    when_true(fcntl(amxp_sigctrl.sigpipe[0], F_SETFD, amxp_sigctrl.sigpipe[0] | FD_CLOEXEC) < 0, exit);
    when_true(fcntl(amxp_sigctrl.sigpipe[1], F_SETFD, amxp_sigctrl.sigpipe[1] | FD_CLOEXEC) < 0, exit);
 
    retval = 0;
 
exit:
    if(retval != 0) {
        if(amxp_sigctrl.sigpipe[0] != -1) {
            close(amxp_sigctrl.sigpipe[0]);
            close(amxp_sigctrl.sigpipe[1]);
        }
        amxp_sigctrl.sigpipe[0] = -1;
        amxp_sigctrl.sigpipe[1] = -1;
    }
    return retval;
}

amxp_signal_dequeue()

static signal_queue_item_t* amxp_signal_dequeue ( void  )

static

Definition at line 181 of file amxp_signal.c.

                                                      {
    signal_queue_item_t* item = NULL;
    amxp_signal_mngr_t* sig_mngr = NULL;
    amxc_lqueue_it_t* sig_it = NULL;
 
    amxc_llist_it_t* it = amxc_llist_get_first(&amxp_sigctrl.pending_sigmngrs);
    when_null(it, exit);
 
    sig_mngr = amxc_llist_it_get_data(it, amxp_signal_mngr_t, it);
    amxc_llist_append(&amxp_sigctrl.pending_sigmngrs, &sig_mngr->it);
 
    sig_it = amxc_lqueue_remove(&sig_mngr->signal_queue);
    item = amxc_llist_it_get_data(sig_it, signal_queue_item_t, it);
 
    item->sig_mngr = sig_mngr;
 
    if(amxc_lqueue_is_empty(&sig_mngr->signal_queue)) {
        amxc_llist_append(&amxp_sigctrl.sigmngrs, it);
    }
 
exit:
    return item;
}

amxp_signal_garbage_collect()

static void amxp_signal_garbage_collect ( amxp_signal_t *  signal )

static

Definition at line 274 of file amxp_signal.c.

                                                               {
    when_null(signal, exit);
 
    if(signal->mngr == NULL) {
        amxc_htable_it_clean(&signal->hit, amxp_free_signals);
    } else {
        amxc_llist_for_each(it, (&signal->slots)) {
            amxp_slot_t* slot = amxc_llist_it_get_data(it, amxp_slot_t, it);
            if(slot->deleted) {
                amxc_llist_it_clean(it, amxp_free_slots);
            }
        }
    }
 
exit:
    return;
}

amxp_signal_queue()

static int amxp_signal_queue ( const amxp_signal_t *const  signal, const amxc_var_t *const  data  )

static

Definition at line 121 of file amxp_signal.c.

                                                           {
    int retval = -1;
    signal_queue_item_t* item = (signal_queue_item_t*) calloc(1, sizeof(signal_queue_item_t));
    when_null(item, exit);
    item->sig_name = (char*) calloc(1, strlen(signal->name) + 1);
    when_null(item->sig_name, exit);
 
    amxc_var_init(&item->sig_data);
    if(data != NULL) {
        when_failed(amxc_var_copy(&item->sig_data, data), exit);
    }
    strcpy(item->sig_name, signal->name);
    amxc_lqueue_add(&signal->mngr->signal_queue, &item->it);
 
    if(!signal->mngr->suspended) {
        amxc_llist_append(&amxp_sigctrl.pending_sigmngrs, &signal->mngr->it);
    }
 
    retval = 0;
 
exit:
    if((retval != 0) && (item != NULL)) {
        free(item->sig_name);
        amxc_var_clean(&item->sig_data);
        free(item);
    }
    return retval;
}

amxp_signal_queue_lock()

static int amxp_signal_queue_lock ( void  )

static

Definition at line 91 of file amxp_signal.c.

                                        {
    return pthread_mutex_lock(&amxp_sigctrl.mutex);
}

amxp_signal_queue_unlock()

static int amxp_signal_queue_unlock ( void  )

static

Definition at line 95 of file amxp_signal.c.

                                          {
    return pthread_mutex_unlock(&amxp_sigctrl.mutex);
}

amxp_slot_trigger()

static void amxp_slot_trigger ( const amxp_slot_t *const  slot, const char *  name, const amxc_var_t *const  data  )

static

Definition at line 230 of file amxp_signal.c.

                                                            {
    if(slot->expr != NULL) {
        amxp_expr_status_t status = amxp_expr_status_ok;
        if((data == NULL) || amxp_expr_eval_var(slot->expr, data, &status)) {
            slot->fn(name, data, slot->priv);
        }
    } else {
        slot->fn(name, data, slot->priv);
    }
}

CONSTRUCTOR_LVL()

CONSTRUCTOR_LVL

(

101

)

Definition at line 845 of file amxp_signal.c.

                                                         {
    amxp_signal_create_pipe();
    amxc_llist_init(&amxp_sigctrl.sigmngrs);
    amxc_lqueue_init(&amxp_sigctrl.pending_sigmngrs);
    amxp_sigmngr_init(&amxp_sigmngr);
    amxp_signal_new(&amxp_sigmngr, &amxp_sigctrl.sigall, "*");
    pthread_mutex_init(&amxp_sigctrl.mutex, NULL);
 
    amxp_sigmngr_add_signal(NULL, "connection-added");
    amxp_sigmngr_add_signal(NULL, "connection-wait-write");
    amxp_sigmngr_add_signal(NULL, "listen-added");
    amxp_sigmngr_add_signal(NULL, "listen-deleted");
    amxp_sigmngr_add_signal(NULL, "connection-deleted");
}

DESTRUCTOR_LVL()

DESTRUCTOR_LVL

(

101

)

Definition at line 860 of file amxp_signal.c.

                                                           {
    amxp_sigmngr_clean(&amxp_sigmngr);
    if(amxp_sigctrl.sigpipe[0] != -1) {
        close(amxp_sigctrl.sigpipe[0]);
    }
    if(amxp_sigctrl.sigpipe[1] != -1) {
        close(amxp_sigctrl.sigpipe[1]);
    }
    pthread_mutex_destroy(&amxp_sigctrl.mutex);
}

Variable Documentation

amxp_sigctrl

signal_ctrl_t amxp_sigctrl

static

Definition at line 88 of file amxp_signal.c.

amxp_sigmngr

amxp_signal_mngr_t amxp_sigmngr

static

Definition at line 89 of file amxp_signal.c.