summaryrefslogtreecommitdiff
path: root/src/charon/bus
diff options
context:
space:
mode:
authorRene Mayrhofer <rene@mayrhofer.eu.org>2008-12-05 16:44:41 +0000
committerRene Mayrhofer <rene@mayrhofer.eu.org>2008-12-05 16:44:41 +0000
commit2db1ef4ac8928944958712923b9c89c263a337d2 (patch)
tree700043d9d97b7e7ba344b448918728af0a8be8d1 /src/charon/bus
parent5dc75410286b0e3a16845b44dd696ba0f40df573 (diff)
downloadvyos-strongswan-2db1ef4ac8928944958712923b9c89c263a337d2.tar.gz
vyos-strongswan-2db1ef4ac8928944958712923b9c89c263a337d2.zip
- Updated to new upstream.
Diffstat (limited to 'src/charon/bus')
-rw-r--r--src/charon/bus/bus.c335
-rw-r--r--src/charon/bus/bus.h376
-rw-r--r--src/charon/bus/listeners/file_logger.c45
-rw-r--r--src/charon/bus/listeners/file_logger.h14
-rw-r--r--src/charon/bus/listeners/sys_logger.c39
-rw-r--r--src/charon/bus/listeners/sys_logger.h16
6 files changed, 498 insertions, 327 deletions
diff --git a/src/charon/bus/bus.c b/src/charon/bus/bus.c
index a102a3984..504947465 100644
--- a/src/charon/bus/bus.c
+++ b/src/charon/bus/bus.c
@@ -12,20 +12,18 @@
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
- * $Id: bus.c 4198 2008-07-21 14:23:43Z martin $
+ * $Id: bus.c 4622 2008-11-11 10:52:37Z martin $
*/
#include "bus.h"
#include <pthread.h>
+#include <stdint.h>
#include <daemon.h>
#include <utils/mutex.h>
-ENUM(signal_names, SIG_ANY, SIG_MAX,
- /** should not get printed */
- "SIG_ANY",
- /** debugging message types */
+ENUM(debug_names, DBG_DMN, DBG_LIB,
"DMN",
"MGR",
"IKE",
@@ -36,19 +34,19 @@ ENUM(signal_names, SIG_ANY, SIG_MAX,
"NET",
"ENC",
"LIB",
- /** should not get printed */
- "SIG_DBG_MAX",
- /** all level0 signals are AUDIT signals */
- "AUD", "AUD", "AUD",
- "AUD", "AUD", "AUD",
- "AUD", "AUD", "AUD",
- "AUD", "AUD", "AUD",
- "AUD", "AUD", "AUD",
- "AUD", "AUD", "AUD",
- "AUD", "AUD", "AUD",
- "AUD", "AUD", "AUD",
- /** should not get printed */
- "SIG_MAX",
+);
+
+ENUM(debug_lower_names, DBG_DMN, DBG_LIB,
+ "dmn",
+ "mgr",
+ "ike",
+ "chd",
+ "job",
+ "cfg",
+ "knl",
+ "net",
+ "enc",
+ "lib",
);
typedef struct private_bus_t private_bus_t;
@@ -93,7 +91,7 @@ struct entry_t {
/**
* registered listener interface
*/
- bus_listener_t *listener;
+ listener_t *listener;
/**
* is this a active listen() call with a blocking thread
@@ -103,7 +101,7 @@ struct entry_t {
/**
* are we currently calling this listener
*/
- bool calling;
+ int calling;
/**
* condvar where active listeners wait
@@ -114,13 +112,13 @@ struct entry_t {
/**
* create a listener entry
*/
-static entry_t *entry_create(bus_listener_t *listener, bool blocker)
+static entry_t *entry_create(listener_t *listener, bool blocker)
{
entry_t *this = malloc_thing(entry_t);
this->listener = listener;
this->blocker = blocker;
- this->calling = FALSE;
+ this->calling = 0;
this->condvar = condvar_create(CONDVAR_DEFAULT);
return this;
@@ -140,12 +138,12 @@ static void entry_destroy(entry_t *entry)
* pthread_self returns large and ugly numbers, use this function
* for logging; these numbers are incremental starting at 1
*/
-static int get_thread_number(private_bus_t *this)
+static u_int get_thread_number(private_bus_t *this)
{
- static long current_num = 0;
- long stored_num;
+ static uintptr_t current_num = 0;
+ uintptr_t stored_num;
- stored_num = (long)pthread_getspecific(this->thread_id);
+ stored_num = (uintptr_t)pthread_getspecific(this->thread_id);
if (stored_num == 0)
{ /* first call of current thread */
pthread_setspecific(this->thread_id, (void*)++current_num);
@@ -160,7 +158,7 @@ static int get_thread_number(private_bus_t *this)
/**
* Implementation of bus_t.add_listener.
*/
-static void add_listener(private_bus_t *this, bus_listener_t *listener)
+static void add_listener(private_bus_t *this, listener_t *listener)
{
this->mutex->lock(this->mutex);
this->listeners->insert_last(this->listeners, entry_create(listener, FALSE));
@@ -170,23 +168,23 @@ static void add_listener(private_bus_t *this, bus_listener_t *listener)
/**
* Implementation of bus_t.remove_listener.
*/
-static void remove_listener(private_bus_t *this, bus_listener_t *listener)
+static void remove_listener(private_bus_t *this, listener_t *listener)
{
- iterator_t *iterator;
+ enumerator_t *enumerator;
entry_t *entry;
this->mutex->lock(this->mutex);
- iterator = this->listeners->create_iterator(this->listeners, TRUE);
- while (iterator->iterate(iterator, (void**)&entry))
+ enumerator = this->listeners->create_enumerator(this->listeners);
+ while (enumerator->enumerate(enumerator, &entry))
{
if (entry->listener == listener)
{
- iterator->remove(iterator);
+ this->listeners->remove_at(this->listeners, enumerator);
entry_destroy(entry);
break;
}
}
- iterator->destroy(iterator);
+ enumerator->destroy(enumerator);
this->mutex->unlock(this->mutex);
}
@@ -207,26 +205,14 @@ struct cleanup_data_t {
*/
static void listener_cleanup(cleanup_data_t *data)
{
- iterator_t *iterator;
- entry_t *entry;
-
- iterator = data->this->listeners->create_iterator(data->this->listeners, TRUE);
- while (iterator->iterate(iterator, (void**)&entry))
- {
- if (entry == data->entry)
- {
- iterator->remove(iterator);
- entry_destroy(entry);
- break;
- }
- }
- iterator->destroy(iterator);
+ data->this->listeners->remove(data->this->listeners, data->entry, NULL);
+ entry_destroy(data->entry);
}
/**
* Implementation of bus_t.listen.
*/
-static void listen_(private_bus_t *this, bus_listener_t *listener, job_t *job)
+static void listen_(private_bus_t *this, listener_t *listener, job_t *job)
{
int old;
cleanup_data_t data;
@@ -267,33 +253,31 @@ typedef struct {
ike_sa_t *ike_sa;
/** invoking thread */
long thread;
- /** signal type */
- signal_t signal;
- /** signal level */
+ /** debug group */
+ debug_t group;
+ /** debug level */
level_t level;
- /** signal specific user data */
- void *user;
/** format string */
char *format;
/** argument list */
va_list args;
-} signal_data_t;
+} log_data_t;
/**
- * listener invocation as a list remove callback
+ * listener->log() invocation as a list remove callback
*/
-static bool signal_cb(entry_t *entry, signal_data_t *data)
+static bool log_cb(entry_t *entry, log_data_t *data)
{
va_list args;
- if (entry->calling)
+ if (entry->calling || !entry->listener->log)
{ /* avoid recursive calls */
return FALSE;
}
- entry->calling = TRUE;
+ entry->calling++;
va_copy(args, data->args);
- if (!entry->listener->signal(entry->listener, data->signal, data->level,
- data->thread, data->ike_sa, data->user, data->format, args))
+ if (!entry->listener->log(entry->listener, data->group, data->level,
+ data->thread, data->ike_sa, data->format, args))
{
if (entry->blocker)
{
@@ -305,52 +289,238 @@ static bool signal_cb(entry_t *entry, signal_data_t *data)
entry_destroy(entry);
}
va_end(args);
- entry->calling = FALSE;
+ entry->calling--;
return TRUE;
}
va_end(args);
- entry->calling = FALSE;
+ entry->calling--;
return FALSE;
}
/**
- * Implementation of bus_t.vsignal.
+ * Implementation of bus_t.vlog.
*/
-static void vsignal(private_bus_t *this, signal_t signal, level_t level,
- void *user, char* format, va_list args)
+static void vlog(private_bus_t *this, debug_t group, level_t level,
+ char* format, va_list args)
{
- signal_data_t data;
+ log_data_t data;
data.ike_sa = pthread_getspecific(this->thread_sa);
data.thread = get_thread_number(this);
- data.signal = signal;
+ data.group = group;
data.level = level;
- data.user = user;
data.format = format;
va_copy(data.args, args);
this->mutex->lock(this->mutex);
- /* we use the remove() method to invoke all listeners with small overhead */
- this->listeners->remove(this->listeners, &data, (void*)signal_cb);
+ /* We use the remove() method to invoke all listeners. This is cheap and
+ * does not require an allocation for this performance critical function. */
+ this->listeners->remove(this->listeners, &data, (void*)log_cb);
this->mutex->unlock(this->mutex);
va_end(data.args);
}
/**
- * Implementation of bus_t.signal.
+ * Implementation of bus_t.log.
*/
-static void signal_(private_bus_t *this, signal_t signal, level_t level,
- void* data, char* format, ...)
+static void log_(private_bus_t *this, debug_t group, level_t level,
+ char* format, ...)
{
va_list args;
va_start(args, format);
- vsignal(this, signal, level, data, format, args);
+ vlog(this, group, level, format, args);
va_end(args);
}
/**
+ * unregister a listener
+ */
+static void unregister_listener(private_bus_t *this, entry_t *entry,
+ enumerator_t *enumerator)
+{
+ if (entry->blocker)
+ {
+ entry->blocker = FALSE;
+ entry->condvar->signal(entry->condvar);
+ }
+ else
+ {
+ entry_destroy(entry);
+ }
+ this->listeners->remove_at(this->listeners, enumerator);
+}
+
+/**
+ * Implementation of bus_t.ike_state_change
+ */
+static void ike_state_change(private_bus_t *this, ike_sa_t *ike_sa,
+ ike_sa_state_t state)
+{
+ enumerator_t *enumerator;
+ entry_t *entry;
+ bool keep;
+
+ this->mutex->lock(this->mutex);
+ enumerator = this->listeners->create_enumerator(this->listeners);
+ while (enumerator->enumerate(enumerator, &entry))
+ {
+ if (entry->calling || !entry->listener->ike_state_change)
+ {
+ continue;
+ }
+ entry->calling++;
+ keep = entry->listener->ike_state_change(entry->listener, ike_sa, state);
+ entry->calling--;
+ if (!keep)
+ {
+ unregister_listener(this, entry, enumerator);
+ break;
+ }
+ }
+ enumerator->destroy(enumerator);
+ this->mutex->unlock(this->mutex);
+}
+
+/**
+ * Implementation of bus_t.child_state_change
+ */
+static void child_state_change(private_bus_t *this, child_sa_t *child_sa,
+ child_sa_state_t state)
+{
+ enumerator_t *enumerator;
+ ike_sa_t *ike_sa;
+ entry_t *entry;
+ bool keep;
+
+ ike_sa = pthread_getspecific(this->thread_sa);
+
+ this->mutex->lock(this->mutex);
+ enumerator = this->listeners->create_enumerator(this->listeners);
+ while (enumerator->enumerate(enumerator, &entry))
+ {
+ if (entry->calling || !entry->listener->child_state_change)
+ {
+ continue;
+ }
+ entry->calling++;
+ keep = entry->listener->child_state_change(entry->listener, ike_sa,
+ child_sa, state);
+ entry->calling--;
+ if (!keep)
+ {
+ unregister_listener(this, entry, enumerator);
+ break;
+ }
+ }
+ enumerator->destroy(enumerator);
+ this->mutex->unlock(this->mutex);
+}
+
+/**
+ * Implementation of bus_t.message
+ */
+static void message(private_bus_t *this, message_t *message, bool incoming)
+{
+ enumerator_t *enumerator;
+ ike_sa_t *ike_sa;
+ entry_t *entry;
+ bool keep;
+
+ ike_sa = pthread_getspecific(this->thread_sa);
+
+ this->mutex->lock(this->mutex);
+ enumerator = this->listeners->create_enumerator(this->listeners);
+ while (enumerator->enumerate(enumerator, &entry))
+ {
+ if (entry->calling || !entry->listener->message)
+ {
+ continue;
+ }
+ entry->calling++;
+ keep = entry->listener->message(entry->listener, ike_sa,
+ message, incoming);
+ entry->calling--;
+ if (!keep)
+ {
+ unregister_listener(this, entry, enumerator);
+ break;
+ }
+ }
+ enumerator->destroy(enumerator);
+ this->mutex->unlock(this->mutex);
+}
+
+/**
+ * Implementation of bus_t.ike_keys
+ */
+static void ike_keys(private_bus_t *this, ike_sa_t *ike_sa,
+ diffie_hellman_t *dh, chunk_t nonce_i, chunk_t nonce_r,
+ ike_sa_t *rekey)
+{
+ enumerator_t *enumerator;
+ entry_t *entry;
+ bool keep;
+
+ this->mutex->lock(this->mutex);
+ enumerator = this->listeners->create_enumerator(this->listeners);
+ while (enumerator->enumerate(enumerator, &entry))
+ {
+ if (entry->calling || !entry->listener->ike_keys)
+ {
+ continue;
+ }
+ entry->calling++;
+ keep = entry->listener->ike_keys(entry->listener, ike_sa, dh,
+ nonce_i, nonce_r, rekey);
+ entry->calling--;
+ if (!keep)
+ {
+ unregister_listener(this, entry, enumerator);
+ break;
+ }
+ }
+ enumerator->destroy(enumerator);
+ this->mutex->unlock(this->mutex);
+}
+
+/**
+ * Implementation of bus_t.child_keys
+ */
+static void child_keys(private_bus_t *this, child_sa_t *child_sa,
+ diffie_hellman_t *dh, chunk_t nonce_i, chunk_t nonce_r)
+{
+ enumerator_t *enumerator;
+ ike_sa_t *ike_sa;
+ entry_t *entry;
+ bool keep;
+
+ ike_sa = pthread_getspecific(this->thread_sa);
+
+ this->mutex->lock(this->mutex);
+ enumerator = this->listeners->create_enumerator(this->listeners);
+ while (enumerator->enumerate(enumerator, &entry))
+ {
+ if (entry->calling || !entry->listener->child_keys)
+ {
+ continue;
+ }
+ entry->calling++;
+ keep = entry->listener->child_keys(entry->listener, ike_sa, child_sa,
+ dh, nonce_i, nonce_r);
+ entry->calling--;
+ if (!keep)
+ {
+ unregister_listener(this, entry, enumerator);
+ break;
+ }
+ }
+ enumerator->destroy(enumerator);
+ this->mutex->unlock(this->mutex);
+}
+
+/**
* Implementation of bus_t.destroy.
*/
static void destroy(private_bus_t *this)
@@ -367,16 +537,21 @@ bus_t *bus_create()
{
private_bus_t *this = malloc_thing(private_bus_t);
- this->public.add_listener = (void(*)(bus_t*,bus_listener_t*))add_listener;
- this->public.remove_listener = (void(*)(bus_t*,bus_listener_t*))remove_listener;
- this->public.listen = (void(*)(bus_t*, bus_listener_t *listener, job_t *job))listen_;
+ this->public.add_listener = (void(*)(bus_t*,listener_t*))add_listener;
+ this->public.remove_listener = (void(*)(bus_t*,listener_t*))remove_listener;
+ this->public.listen = (void(*)(bus_t*, listener_t *listener, job_t *job))listen_;
this->public.set_sa = (void(*)(bus_t*,ike_sa_t*))set_sa;
- this->public.signal = (void(*)(bus_t*,signal_t,level_t,void*,char*,...))signal_;
- this->public.vsignal = (void(*)(bus_t*,signal_t,level_t,void*,char*,va_list))vsignal;
+ this->public.log = (void(*)(bus_t*,debug_t,level_t,char*,...))log_;
+ this->public.vlog = (void(*)(bus_t*,debug_t,level_t,char*,va_list))vlog;
+ this->public.ike_state_change = (void(*)(bus_t*,ike_sa_t*,ike_sa_state_t))ike_state_change;
+ this->public.child_state_change = (void(*)(bus_t*,child_sa_t*,child_sa_state_t))child_state_change;
+ this->public.message = (void(*)(bus_t*, message_t *message, bool incoming))message;
+ this->public.ike_keys = (void(*)(bus_t*, ike_sa_t *ike_sa, diffie_hellman_t *dh, chunk_t nonce_i, chunk_t nonce_r, ike_sa_t *rekey))ike_keys;
+ this->public.child_keys = (void(*)(bus_t*, child_sa_t *child_sa, diffie_hellman_t *dh, chunk_t nonce_i, chunk_t nonce_r))child_keys;
this->public.destroy = (void(*)(bus_t*)) destroy;
this->listeners = linked_list_create();
- this->mutex = mutex_create(MUTEX_DEFAULT);
+ this->mutex = mutex_create(MUTEX_RECURSIVE);
pthread_key_create(&this->thread_id, NULL);
pthread_key_create(&this->thread_sa, NULL);
diff --git a/src/charon/bus/bus.h b/src/charon/bus/bus.h
index db417064f..383678488 100644
--- a/src/charon/bus/bus.h
+++ b/src/charon/bus/bus.h
@@ -12,7 +12,7 @@
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
- * $Id: bus.h 4192 2008-07-18 15:51:40Z martin $
+ * $Id: bus.h 4622 2008-11-11 10:52:37Z martin $
*/
/**
@@ -23,9 +23,9 @@
#ifndef BUS_H_
#define BUS_H_
-typedef enum signal_t signal_t;
+typedef enum debug_t debug_t;
typedef enum level_t level_t;
-typedef struct bus_listener_t bus_listener_t;
+typedef struct listener_t listener_t;
typedef struct bus_t bus_t;
#include <stdarg.h>
@@ -34,145 +34,87 @@ typedef struct bus_t bus_t;
#include <sa/child_sa.h>
#include <processing/jobs/job.h>
-
/**
- * signals emitted by the daemon.
- *
- * Signaling is for different purporses. First, it allows debugging via
- * "debugging signal messages", sencondly, it allows to follow certain
- * mechanisms currently going on in the daemon. As we are multithreaded,
- * and multiple transactions are involved, it's not possible to follow
- * one connection setup without further infrastructure. These infrastructure
- * is provided by the bus and the signals the daemon emits to the bus.
- *
- * There are different scenarios to follow these signals, but all have
- * the same scheme. First, a START signal is emitted to indicate the daemon
- * has started to do something. After a start signal, a SUCCESS or a FAILED
- * signal of the same type follows. This allows to track the operation. Any
- * Debug signal betwee a START and a SUCCESS/FAILED belongs to that operation
- * if the IKE_SA is the same. The thread may change, as multiple threads
- * may be involved in a complex scenario.
+ * Debug message group.
*/
-enum signal_t {
- /** pseudo signal, representing any other signal */
- SIG_ANY,
-
- /** debugging message from daemon main loop */
+enum debug_t {
+ /** daemon main loop */
DBG_DMN,
- /** debugging message from IKE_SA_MANAGER */
+ /** IKE_SA_MANAGER */
DBG_MGR,
- /** debugging message from an IKE_SA */
+ /** IKE_SA */
DBG_IKE,
- /** debugging message from a CHILD_SA */
+ /** CHILD_SA */
DBG_CHD,
- /** debugging message from job processing */
+ /** job processing */
DBG_JOB,
- /** debugging message from configuration backends */
+ /** configuration backends */
DBG_CFG,
- /** debugging message from kernel interface */
+ /** kernel interface */
DBG_KNL,
- /** debugging message from networking */
+ /** networking/sockets */
DBG_NET,
- /** debugging message from message encoding/decoding */
+ /** message encoding/decoding */
DBG_ENC,
- /** debugging message from libstrongswan via logging hook */
+ /** libstrongswan via logging hook */
DBG_LIB,
-
- /** number of debug signals */
+ /** number of groups */
DBG_MAX,
-
- /** signals for IKE_SA establishment */
- IKE_UP_START,
- IKE_UP_SUCCESS,
- IKE_UP_FAILED,
-
- /** signals for IKE_SA delete */
- IKE_DOWN_START,
- IKE_DOWN_SUCCESS,
- IKE_DOWN_FAILED,
-
- /** signals for IKE_SA rekeying */
- IKE_REKEY_START,
- IKE_REKEY_SUCCESS,
- IKE_REKEY_FAILED,
-
- /** signals for CHILD_SA establishment */
- CHD_UP_START,
- CHD_UP_SUCCESS,
- CHD_UP_FAILED,
-
- /** signals for CHILD_SA delete */
- CHD_DOWN_START,
- CHD_DOWN_SUCCESS,
- CHD_DOWN_FAILED,
-
- /** signals for CHILD_SA rekeying */
- CHD_REKEY_START,
- CHD_REKEY_SUCCESS,
- CHD_REKEY_FAILED,
-
- /** signals for CHILD_SA routing */
- CHD_ROUTE_START,
- CHD_ROUTE_SUCCESS,
- CHD_ROUTE_FAILED,
-
- /** signals for CHILD_SA routing */
- CHD_UNROUTE_START,
- CHD_UNROUTE_SUCCESS,
- CHD_UNROUTE_FAILED,
-
- SIG_MAX
+ /** pseudo group with all groups */
+ DBG_ANY = DBG_MAX,
};
/**
- * short names of signals using 3 chars
+ * short names of debug message group.
*/
-extern enum_name_t *signal_names;
+extern enum_name_t *debug_names;
/**
- * Signal levels used to control output verbosity.
+ * short names of debug message group, lower case.
+ */
+extern enum_name_t *debug_lower_names;
+
+/**
+ * Debug levels used to control output verbosity.
*/
enum level_t {
- /** numerical levels from 0 to 4 */
- LEVEL_0 = 0,
- LEVEL_1 = 1,
- LEVEL_2 = 2,
- LEVEL_3 = 3,
- LEVEL_4 = 4,
- /** absolutely silent, no signal is emitted with this level */
- LEVEL_SILENT = -1,
- /** alias for numberical levels */
- LEVEL_AUDIT = LEVEL_0,
- LEVEL_CTRL = LEVEL_1,
- LEVEL_CTRLMORE = LEVEL_2,
- LEVEL_RAW = LEVEL_3,
- LEVEL_PRIVATE = LEVEL_4,
+ /** absolutely silent */
+ LEVEL_SILENT = -1,
+ /** most important auditing logs */
+ LEVEL_AUDIT = 0,
+ /** control flow */
+ LEVEL_CTRL = 1,
+ /** diagnose problems */
+ LEVEL_DIAG = 2,
+ /** raw binary blobs */
+ LEVEL_RAW = 3,
+ /** including sensitive data (private keys) */
+ LEVEL_PRIVATE = 4,
};
#ifndef DEBUG_LEVEL
# define DEBUG_LEVEL 4
#endif /* DEBUG_LEVEL */
+#if DEBUG_LEVEL >= 0
+#define DBG0(group, format, ...) charon->bus->log(charon->bus, group, 0, format, ##__VA_ARGS__)
+#endif /* DEBUG_LEVEL >= 0 */
#if DEBUG_LEVEL >= 1
-/**
- * Log a debug message via the signal bus.
- *
- * @param signal signal_t signal description
- * @param format printf() style format string
- * @param ... printf() style agument list
- */
-# define DBG1(sig, format, ...) charon->bus->signal(charon->bus, sig, LEVEL_1, NULL, format, ##__VA_ARGS__)
-#endif /* DEBUG_LEVEL */
+#define DBG1(group, format, ...) charon->bus->log(charon->bus, group, 1, format, ##__VA_ARGS__)
+#endif /* DEBUG_LEVEL >= 1 */
#if DEBUG_LEVEL >= 2
-#define DBG2(sig, format, ...) charon->bus->signal(charon->bus, sig, LEVEL_2, NULL, format, ##__VA_ARGS__)
-#endif /* DEBUG_LEVEL */
+#define DBG2(group, format, ...) charon->bus->log(charon->bus, group, 2, format, ##__VA_ARGS__)
+#endif /* DEBUG_LEVEL >= 2 */
#if DEBUG_LEVEL >= 3
-#define DBG3(sig, format, ...) charon->bus->signal(charon->bus, sig, LEVEL_3, NULL, format, ##__VA_ARGS__)
-#endif /* DEBUG_LEVEL */
+#define DBG3(group, format, ...) charon->bus->log(charon->bus, group, 3, format, ##__VA_ARGS__)
+#endif /* DEBUG_LEVEL >= 3 */
#if DEBUG_LEVEL >= 4
-#define DBG4(sig, format, ...) charon->bus->signal(charon->bus, sig, LEVEL_4, NULL, format, ##__VA_ARGS__)
-#endif /* DEBUG_LEVEL */
+#define DBG4(group, format, ...) charon->bus->log(charon->bus, group, 4, format, ##__VA_ARGS__)
+#endif /* DEBUG_LEVEL >= 4 */
+#ifndef DBG0
+# define DBG0(...) {}
+#endif /* DBG0 */
#ifndef DBG1
# define DBG1(...) {}
#endif /* DBG1 */
@@ -186,101 +128,115 @@ enum level_t {
# define DBG4(...) {}
#endif /* DBG4 */
-/**
- * Raise a signal for an IKE_SA event.
- *
- * @param sig signal_t signal description
- * @param format printf() style format string
- * @param ... printf() style agument list
- */
-#define SIG_IKE(sig, format, ...) charon->bus->signal(charon->bus, IKE_##sig, LEVEL_0, NULL, format, ##__VA_ARGS__)
/**
- * Raise a signal for an IKE event.
- *
- * @param sig signal_t signal description
- * @param format printf() style format string
- * @param ... printf() style agument list
- */
-#define SIG_CHD(sig, chd, format, ...) charon->bus->signal(charon->bus, CHD_##sig, LEVEL_0, chd, format, ##__VA_ARGS__)
-
-/**
- * Get the type of a signal.
- *
- * A signal may be a debugging signal with a specific context. They have
- * a level specific for their context > 0. All audit signals use the
- * type 0. This allows filtering of singals by their type.
- *
- * @param signal signal to get the type from
- * @return type of the signal, between 0..(DBG_MAX-1)
- */
-#define SIG_TYPE(sig) (sig > DBG_MAX ? SIG_ANY : sig)
-
-
-/**
- * Interface for registering at the signal bus.
- *
- * To receive signals from the bus, the client implementing the
- * bus_listener_t interface registers itself at the signal bus.
+ * Listener interface, listens to events if registered to the bus.
*/
-struct bus_listener_t {
+struct listener_t {
/**
- * Send a signal to a bus listener.
+ * Log a debugging message.
*
- * A numerical identification for the thread is included, as the
- * associated IKE_SA, if any. Signal specifies the type of
- * the event occured. The format string specifies
- * an additional informational or error message with a printf() like
- * variable argument list. This is in the va_list form, as forwarding
- * a "..." parameters to functions is not (cleanly) possible.
* The implementing signal function returns TRUE to stay registered
* to the bus, or FALSE to unregister itself.
- * Calling bus_t.signal() inside of a registered listener is possible,
+ * Calling bus_t.log() inside of a registered listener is possible,
* but the bus does not invoke listeners recursively.
*
* @param singal kind of the signal (up, down, rekeyed, ...)
* @param level verbosity level of the signal
* @param thread ID of the thread raised this signal
* @param ike_sa IKE_SA associated to the event
- * @param data additional signal specific user data
* @param format printf() style format string
* @param args vprintf() style va_list argument list
" @return TRUE to stay registered, FALSE to unregister
*/
- bool (*signal) (bus_listener_t *this, signal_t signal, level_t level,
- int thread, ike_sa_t *ike_sa, void *data,
- char* format, va_list args);
+ bool (*log) (listener_t *this, debug_t group, level_t level, int thread,
+ ike_sa_t *ike_sa, char* format, va_list args);
+
+ /**
+ * Handle state changes in an IKE_SA.
+ *
+ * @param ike_sa IKE_SA which changes its state
+ * @param state new IKE_SA state this IKE_SA changes to
+ * @return TRUE to stay registered, FALSE to unregister
+ */
+ bool (*ike_state_change)(listener_t *this, ike_sa_t *ike_sa,
+ ike_sa_state_t state);
+
+ /**
+ * Handle state changes in a CHILD_SA.
+ *
+ * @param ike_sa IKE_SA containing the affected CHILD_SA
+ * @param child_sa CHILD_SA which changes its state
+ * @param state new CHILD_SA state this CHILD_SA changes to
+ * @return TRUE to stay registered, FALSE to unregister
+ */
+ bool (*child_state_change)(listener_t *this, ike_sa_t *ike_sa,
+ child_sa_t *child_sa, child_sa_state_t state);
+
+ /**
+ * Hook called for received/sent messages of an IKE_SA.
+ *
+ * @param ike_sa IKE_SA sending/receving a message
+ * @param message message object
+ * @param incoming TRUE for incoming messages, FALSE for outgoing
+ * @return TRUE to stay registered, FALSE to unregister
+ */
+ bool (*message)(listener_t *this, ike_sa_t *ike_sa, message_t *message,
+ bool incoming);
+
+ /**
+ * Hook called with IKE_SA key material.
+ *
+ * @param ike_sa IKE_SA this keymat belongs to
+ * @param dh diffie hellman shared secret
+ * @param nonce_i initiators nonce
+ * @param nonce_r responders nonce
+ * @param rekey IKE_SA we are rekeying, if any
+ * @return TRUE to stay registered, FALSE to unregister
+ */
+ bool (*ike_keys)(listener_t *this, ike_sa_t *ike_sa, diffie_hellman_t *dh,
+ chunk_t nonce_i, chunk_t nonce_r, ike_sa_t *rekey);
+
+ /**
+ * Hook called with CHILD_SA key material.
+ *
+ * @param ike_sa IKE_SA the child sa belongs to
+ * @param child_sa CHILD_SA this keymat is used for
+ * @param dh diffie hellman shared secret
+ * @param nonce_i initiators nonce
+ * @param nonce_r responders nonce
+ * @return TRUE to stay registered, FALSE to unregister
+ */
+ bool (*child_keys)(listener_t *this, ike_sa_t *ike_sa, child_sa_t *child_sa,
+ diffie_hellman_t *dh, chunk_t nonce_i, chunk_t nonce_r);
};
/**
- * Signal bus which sends signals to registered listeners.
+ * The bus receives events and sends them to all registered listeners.
*
- * The signal bus is not much more than a multiplexer. A listener interested
- * in receiving event signals registers at the bus. Any signals sent to
- * are delivered to all registered listeners.
- * To deliver signals to threads, the blocking listen() call may be used
- * to wait for a signal.
+ * Any events sent to are delivered to all registered listeners. Threads
+ * may wait actively to events using the blocking listen() call.
*/
struct bus_t {
/**
* Register a listener to the bus.
*
- * A registered listener receives all signals which are sent to the bus.
- * The listener is passive; the thread which emitted the signal
+ * A registered listener receives all events which are sent to the bus.
+ * The listener is passive; the thread which emitted the event
* processes the listener routine.
*
* @param listener listener to register.
*/
- void (*add_listener) (bus_t *this, bus_listener_t *listener);
+ void (*add_listener) (bus_t *this, listener_t *listener);
/**
* Unregister a listener from the bus.
*
* @param listener listener to unregister.
*/
- void (*remove_listener) (bus_t *this, bus_listener_t *listener);
+ void (*remove_listener) (bus_t *this, listener_t *listener);
/**
* Register a listener and block the calling thread.
@@ -288,69 +244,109 @@ struct bus_t {
* This call registers a listener and blocks the calling thread until
* its listeners function returns FALSE. This allows to wait for certain
* events. The associated job is executed after the listener has been
- * registered, this allows to listen on events we initiate with the job
- * without missing any signals.
+ * registered: This allows to listen on events we initiate with the job,
+ * without missing any events to job may fire.
*
* @param listener listener to register
* @param job job to execute asynchronously when registered, or NULL
*/
- void (*listen)(bus_t *this, bus_listener_t *listener, job_t *job);
+ void (*listen)(bus_t *this, listener_t *listener, job_t *job);
/**
* Set the IKE_SA the calling thread is using.
*
- * To associate an received signal to an IKE_SA without passing it as
- * parameter each time, the thread registers it's used IKE_SA each
- * time it checked it out. Before checking it in, the thread unregisters
- * the IKE_SA (by passing NULL). This IKE_SA is stored per-thread, so each
- * thread has one IKE_SA registered (or not).
+ * To associate an received log message to an IKE_SA without passing it as
+ * parameter each time, the thread registers the currenlty used IKE_SA
+ * during check-out. Before check-in, the thread unregisters the IKE_SA.
+ * This IKE_SA is stored per-thread, so each thread has its own IKE_SA
+ * registered.
*
* @param ike_sa ike_sa to register, or NULL to unregister
*/
void (*set_sa) (bus_t *this, ike_sa_t *ike_sa);
/**
- * Send a signal to the bus.
+ * Send a log message to the bus.
*
* The signal specifies the type of the event occured. The format string
* specifies an additional informational or error message with a
* printf() like variable argument list.
- * Some useful macros are available to shorten this call.
- * @see SIG(), DBG1()
+ * Use the DBG() macros.
*
- * @param singal kind of the signal (up, down, rekeyed, ...)
+ * @param group debugging group
* @param level verbosity level of the signal
- * @param data additional signal specific user data
* @param format printf() style format string
* @param ... printf() style argument list
*/
- void (*signal) (bus_t *this, signal_t signal, level_t level,
- void *data, char* format, ...);
+ void (*log)(bus_t *this, debug_t group, level_t level, char* format, ...);
/**
- * Send a signal to the bus using va_list arguments.
+ * Send a log message to the bus using va_list arguments.
*
* Same as bus_t.signal(), but uses va_list argument list.
*
- * @param singal kind of the signal (up, down, rekeyed, ...)
+ * @param group kind of the signal (up, down, rekeyed, ...)
* @param level verbosity level of the signal
- * @param data additional signal specific user data
* @param format printf() style format string
* @param args va_list arguments
*/
- void (*vsignal) (bus_t *this, signal_t signal, level_t level,
- void *data, char* format, va_list args);
+ void (*vlog)(bus_t *this, debug_t group, level_t level,
+ char* format, va_list args);
+ /**
+ * Send a IKE_SA state change event to the bus.
+ *
+ * @param ike_sa IKE_SA which changes its state
+ * @param state new state IKE_SA changes to
+ */
+ void (*ike_state_change)(bus_t *this, ike_sa_t *ike_sa,
+ ike_sa_state_t state);
+ /**
+ * Send a CHILD_SA state change event to the bus.
+ *
+ * @param child_sa CHILD_SA which changes its state
+ * @param state new state CHILD_SA changes to
+ */
+ void (*child_state_change)(bus_t *this, child_sa_t *child_sa,
+ child_sa_state_t state);
+ /**
+ * Message send/receive hook.
+ *
+ * @param message message to send/receive
+ * @param incoming TRUE for incoming messages, FALSE for outgoing
+ */
+ void (*message)(bus_t *this, message_t *message, bool incoming);
/**
- * Destroy the signal bus.
+ * IKE_SA keymat hook.
+ *
+ * @param ike_sa IKE_SA this keymat belongs to
+ * @param dh diffie hellman shared secret
+ * @param nonce_i initiators nonce
+ * @param nonce_r responders nonce
+ * @param rekey IKE_SA we are rekeying, if any
+ */
+ void (*ike_keys)(bus_t *this, ike_sa_t *ike_sa, diffie_hellman_t *dh,
+ chunk_t nonce_i, chunk_t nonce_r, ike_sa_t *rekey);
+ /**
+ * CHILD_SA keymat hook.
+ *
+ * @param child_sa CHILD_SA this keymat is used for
+ * @param dh diffie hellman shared secret
+ * @param nonce_i initiators nonce
+ * @param nonce_r responders nonce
+ */
+ void (*child_keys)(bus_t *this, child_sa_t *child_sa, diffie_hellman_t *dh,
+ chunk_t nonce_i, chunk_t nonce_r);
+ /**
+ * Destroy the event bus.
*/
void (*destroy) (bus_t *this);
};
/**
- * Create the signal bus which multiplexes signals to its listeners.
+ * Create the event bus which forwards events to its listeners.
*
- * @return signal bus instance
+ * @return event bus instance
*/
bus_t *bus_create();
diff --git a/src/charon/bus/listeners/file_logger.c b/src/charon/bus/listeners/file_logger.c
index 8a7f66360..4259630ec 100644
--- a/src/charon/bus/listeners/file_logger.c
+++ b/src/charon/bus/listeners/file_logger.c
@@ -12,7 +12,7 @@
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
- * $Id: file_logger.c 4192 2008-07-18 15:51:40Z martin $
+ * $Id: file_logger.c 4622 2008-11-11 10:52:37Z martin $
*/
#include <stdio.h>
@@ -39,20 +39,18 @@ struct private_file_logger_t {
FILE *out;
/**
- * Maximum level to log
+ * Maximum level to log, for each group
*/
level_t levels[DBG_MAX];
};
-
/**
- * Implementation of bus_listener_t.signal.
+ * Implementation of bus_listener_t.log.
*/
-static bool signal_(private_file_logger_t *this, signal_t signal, level_t level,
- int thread, ike_sa_t* ike_sa, void *data,
- char *format, va_list args)
+static bool log_(private_file_logger_t *this, debug_t group, level_t level,
+ int thread, ike_sa_t* ike_sa, char *format, va_list args)
{
- if (level <= this->levels[SIG_TYPE(signal)])
+ if (level <= this->levels[group])
{
char buffer[8192];
char *current = buffer, *next;
@@ -68,7 +66,8 @@ static bool signal_(private_file_logger_t *this, signal_t signal, level_t level,
{
*(next++) = '\0';
}
- fprintf(this->out, "%.2d[%N] %s\n", thread, signal_names, signal, current);
+ fprintf(this->out, "%.2d[%N] %s\n",
+ thread, debug_names, group, current);
current = next;
}
}
@@ -79,20 +78,18 @@ static bool signal_(private_file_logger_t *this, signal_t signal, level_t level,
/**
* Implementation of file_logger_t.set_level.
*/
-static void set_level(private_file_logger_t *this, signal_t signal, level_t level)
+static void set_level(private_file_logger_t *this, debug_t group, level_t level)
{
- if (signal == SIG_ANY)
+ if (group < DBG_ANY)
{
- int i;
- for (i = 0; i < DBG_MAX; i++)
- {
- this->levels[i] = level;
- }
+ this->levels[group] = level;
}
else
{
-
- this->levels[SIG_TYPE(signal)] = level;
+ for (group = 0; group < DBG_MAX; group++)
+ {
+ this->levels[group] = level;
+ }
}
}
@@ -101,6 +98,10 @@ static void set_level(private_file_logger_t *this, signal_t signal, level_t leve
*/
static void destroy(private_file_logger_t *this)
{
+ if (this->out != stdout && this->out != stderr)
+ {
+ fclose(this->out);
+ }
free(this);
}
@@ -112,13 +113,15 @@ file_logger_t *file_logger_create(FILE *out)
private_file_logger_t *this = malloc_thing(private_file_logger_t);
/* public functions */
- this->public.listener.signal = (bool(*)(bus_listener_t*,signal_t,level_t,int,ike_sa_t*,void*,char*,va_list))signal_;
- this->public.set_level = (void(*)(file_logger_t*,signal_t,level_t))set_level;
+ memset(&this->public.listener, 0, sizeof(listener_t));
+ this->public.listener.log = (bool(*)(listener_t*,debug_t,level_t,int,ike_sa_t*,char*,va_list))log_;
+ this->public.set_level = (void(*)(file_logger_t*,debug_t,level_t))set_level;
this->public.destroy = (void(*)(file_logger_t*))destroy;
/* private variables */
this->out = out;
- set_level(this, SIG_ANY, LEVEL_SILENT);
+ set_level(this, DBG_ANY, LEVEL_SILENT);
return &this->public;
}
+
diff --git a/src/charon/bus/listeners/file_logger.h b/src/charon/bus/listeners/file_logger.h
index 86b79c002..18a7c9765 100644
--- a/src/charon/bus/listeners/file_logger.h
+++ b/src/charon/bus/listeners/file_logger.h
@@ -12,7 +12,7 @@
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
- * $Id: file_logger.h 3589 2008-03-13 14:14:44Z martin $
+ * $Id: file_logger.h 4434 2008-10-14 08:52:13Z martin $
*/
/**
@@ -28,22 +28,22 @@ typedef struct file_logger_t file_logger_t;
#include <bus/bus.h>
/**
- * Logger to files which implements bus_listener_t.
+ * Logger to files which implements listener_t.
*/
struct file_logger_t {
/**
- * Implements the bus_listener_t interface.
+ * Implements the listener_t interface.
*/
- bus_listener_t listener;
+ listener_t listener;
/**
- * Set the loglevel for a signal type.
+ * Set the loglevel for a debug group.
*
- * @param singal type of signal
+ * @param group debug group to set
* @param level max level to log (0..4)
*/
- void (*set_level) (file_logger_t *this, signal_t signal, level_t level);
+ void (*set_level) (file_logger_t *this, debug_t group, level_t level);
/**
* Destroys a file_logger_t object.
diff --git a/src/charon/bus/listeners/sys_logger.c b/src/charon/bus/listeners/sys_logger.c
index 4f5b6fc3b..37dbce926 100644
--- a/src/charon/bus/listeners/sys_logger.c
+++ b/src/charon/bus/listeners/sys_logger.c
@@ -12,7 +12,7 @@
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
- * $Id: sys_logger.c 4192 2008-07-18 15:51:40Z martin $
+ * $Id: sys_logger.c 4434 2008-10-14 08:52:13Z martin $
*/
#include <stdio.h>
@@ -40,20 +40,18 @@ struct private_sys_logger_t {
int facility;
/**
- * Maximum level to log
+ * Maximum level to log, for each group
*/
level_t levels[DBG_MAX];
};
-
/**
- * Implementation of bus_listener_t.signal.
+ * Implementation of listener_t.log.
*/
-static bool signal_(private_sys_logger_t *this, signal_t signal, level_t level,
- int thread, ike_sa_t* ike_sa, void *data,
- char *format, va_list args)
+static bool log_(private_sys_logger_t *this, debug_t group, level_t level,
+ int thread, ike_sa_t* ike_sa, char *format, va_list args)
{
- if (level <= this->levels[SIG_TYPE(signal)])
+ if (level <= this->levels[group])
{
char buffer[8192];
char *current = buffer, *next;
@@ -70,7 +68,7 @@ static bool signal_(private_sys_logger_t *this, signal_t signal, level_t level,
*(next++) = '\0';
}
syslog(this->facility|LOG_INFO, "%.2d[%N] %s\n",
- thread, signal_names, signal, current);
+ thread, debug_names, group, current);
current = next;
}
}
@@ -81,20 +79,18 @@ static bool signal_(private_sys_logger_t *this, signal_t signal, level_t level,
/**
* Implementation of sys_logger_t.set_level.
*/
-static void set_level(private_sys_logger_t *this, signal_t signal, level_t level)
+static void set_level(private_sys_logger_t *this, debug_t group, level_t level)
{
- if (signal == SIG_ANY)
+ if (group < DBG_ANY)
{
- int i;
- for (i = 0; i < DBG_MAX; i++)
- {
- this->levels[i] = level;
- }
+ this->levels[group] = level;
}
else
{
-
- this->levels[SIG_TYPE(signal)] = level;
+ for (group = 0; group < DBG_MAX; group++)
+ {
+ this->levels[group] = level;
+ }
}
}
@@ -115,13 +111,14 @@ sys_logger_t *sys_logger_create(int facility)
private_sys_logger_t *this = malloc_thing(private_sys_logger_t);
/* public functions */
- this->public.listener.signal = (bool(*)(bus_listener_t*,signal_t,level_t,int,ike_sa_t*,void*,char*,va_list))signal_;
- this->public.set_level = (void(*)(sys_logger_t*,signal_t,level_t))set_level;
+ memset(&this->public.listener, 0, sizeof(listener_t));
+ this->public.listener.log = (bool(*)(listener_t*,debug_t,level_t,int,ike_sa_t*,char*,va_list))log_;
+ this->public.set_level = (void(*)(sys_logger_t*,debug_t,level_t))set_level;
this->public.destroy = (void(*)(sys_logger_t*))destroy;
/* private variables */
this->facility = facility;
- set_level(this, SIG_ANY, LEVEL_SILENT);
+ set_level(this, DBG_ANY, LEVEL_SILENT);
return &this->public;
}
diff --git a/src/charon/bus/listeners/sys_logger.h b/src/charon/bus/listeners/sys_logger.h
index 0aade375a..08cf4dd63 100644
--- a/src/charon/bus/listeners/sys_logger.h
+++ b/src/charon/bus/listeners/sys_logger.h
@@ -12,7 +12,7 @@
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
- * $Id: sys_logger.h 3589 2008-03-13 14:14:44Z martin $
+ * $Id: sys_logger.h 4434 2008-10-14 08:52:13Z martin $
*/
/**
@@ -30,22 +30,22 @@ typedef struct sys_logger_t sys_logger_t;
#include <bus/bus.h>
/**
- * Logger for syslog which implements bus_listener_t.
+ * Logger for syslog which implements listener_t.
*/
struct sys_logger_t {
/**
- * Implements the bus_listener_t interface.
+ * Implements the listener_t interface.
*/
- bus_listener_t listener;
+ listener_t listener;
/**
- * Set the loglevel for a signal type.
+ * Set the loglevel for a debug group.
*
- * @param singal type of signal
- * @param level max level to log
+ * @param group debug group to set
+ * @param level max level to log (0..4)
*/
- void (*set_level) (sys_logger_t *this, signal_t signal, level_t level);
+ void (*set_level) (sys_logger_t *this, debug_t group, level_t level);
/**
* Destroys a sys_logger_t object.