diff options
Diffstat (limited to 'Source')
| -rw-r--r-- | Source/charon/daemon.c | 52 | ||||
| -rw-r--r-- | Source/charon/daemon.h | 73 |
2 files changed, 73 insertions, 52 deletions
diff --git a/Source/charon/daemon.c b/Source/charon/daemon.c index 560856863..a80e04374 100644 --- a/Source/charon/daemon.c +++ b/Source/charon/daemon.c @@ -1,7 +1,7 @@ /** * @file daemon.c * - * @brief Main of IKEv2-Daemon + * @brief Implementation of daemon_t and main of IKEv2-Daemon. * */ @@ -26,69 +26,73 @@ #include "daemon.h" - #include <types.h> #include <utils/allocator.h> #include <queues/jobs/initiate_ike_sa_job.h> - - typedef struct private_daemon_t private_daemon_t; /** - * Private additions to daemon_t, contains - * threads and internal functions. + * Private additions to daemon_t, contains threads and internal functions. */ struct private_daemon_t { /** - * public members of daemon_t + * Public members of daemon_t. */ daemon_t public; /** - * logger_t object assigned for daemon things + * A logger_t object assigned for daemon things. */ logger_t *logger; /** - * Signal set used for signal handling + * Signal set used for signal handling. */ sigset_t signal_set; /** - * thread_id of main-thread + * The thread_id of main-thread. */ pthread_t main_thread_id; /** - * main loop + * Main loop function. + * + * @param this calling object */ void (*run) (private_daemon_t *this); /** - * a routine to add jobs for testing + * A routine to add jobs for testing. + * + * @param this calling object */ void (*build_test_jobs) (private_daemon_t *this); /** - * initializing daemon + * Initialize the daemon. + * + * @param this calling object */ void (*initialize) (private_daemon_t *this); /** - * destroy the daemon + * Destroy the daemon. + * + * @param this calling object */ void (*destroy) (private_daemon_t *this); }; /** - * instance of the daemon + * One and only instance of the daemon. */ daemon_t *charon; /** - * Loop of the main thread, waits for signals + * Implementation of private_daemon_t.run. */ static void run(private_daemon_t *this) { @@ -112,11 +116,11 @@ static void run(private_daemon_t *this) } case SIGINT: { - this->logger->log(this->logger, CONTROL, "Signal of type SIGINT received. Exit main loop."); + this->logger->log(this->logger, CONTROL, "Signal of type SIGINT received. Exit main loop"); return; } case SIGTERM: - this->logger->log(this->logger, CONTROL, "Signal of type SIGTERM received. Exit main loop."); + this->logger->log(this->logger, CONTROL, "Signal of type SIGTERM received. Exit main loop"); return; default: { @@ -128,12 +132,12 @@ static void run(private_daemon_t *this) } /** - * Initialize the destruction of the daemon + * Implementation of daemon_t.kill. */ static void kill_daemon(private_daemon_t *this, char *reason) { /* we send SIGTERM, so the daemon can cleanly shut down */ - this->logger->log(this->logger, ERROR, "Killing daemon: %s", reason); + this->logger->log(this->logger, CONTROL, "Killing daemon: %s", reason); if (this->main_thread_id == pthread_self()) { /* initialization failed, terminate daemon */ @@ -150,7 +154,7 @@ static void kill_daemon(private_daemon_t *this, char *reason) } /** - * build some jobs to test daemon functionality + * Implementation of private_daemon_t.build_test_jobs. */ static void build_test_jobs(private_daemon_t *this) { @@ -164,7 +168,7 @@ static void build_test_jobs(private_daemon_t *this) } /** - * Initialize global objects and threads + * Implementation of private_daemon_t.initialize. */ static void initialize(private_daemon_t *this) { @@ -178,7 +182,7 @@ static void initialize(private_daemon_t *this) this->public.sender = sender_create(); this->public.receiver = receiver_create(); this->public.scheduler = scheduler_create(); - this->public.prime_pool = prime_pool_create(10); + this->public.prime_pool = prime_pool_create(PRIME_PRE_COMPUTATION_LIMIT); this->public.thread_pool = thread_pool_create(NUMBER_OF_WORKING_THREADS); } @@ -283,7 +287,7 @@ private_daemon_t *daemon_create() } /** - * Main function, manages the daemon + * Main function, manages the daemon. */ int main(int argc, char *argv[]) { diff --git a/Source/charon/daemon.h b/Source/charon/daemon.h index 406e78a27..14afdc75d 100644 --- a/Source/charon/daemon.h +++ b/Source/charon/daemon.h @@ -1,7 +1,7 @@ /** * @file daemon.h * - * @brief Main of IKEv2-Daemon + * @brief Interface of daemon_t. * */ @@ -23,28 +23,26 @@ #ifndef DAEMON_H_ #define DAEMON_H_ - - #include <threads/sender.h> #include <threads/receiver.h> #include <threads/scheduler.h> -#include <threads/thread_pool.h> #include <threads/prime_pool.h> +#include <threads/thread_pool.h> +#include <network/socket.h> #include <sa/ike_sa_manager.h> #include <queues/send_queue.h> #include <queues/job_queue.h> -#include <network/socket.h> #include <queues/event_queue.h> #include <utils/logger_manager.h> #include <config/configuration_manager.h> /** - * Name of the daemon + * Name of the daemon. */ #define DAEMON_NAME "charon" /** - * Number of threads in the thread pool + * @brief Number of threads in the thread pool. * * There are several other threads, this defines * only the number of threads in thread_pool_t. @@ -52,13 +50,14 @@ #define NUMBER_OF_WORKING_THREADS 4 /** - * Port on which the daemon will - * listen for incoming traffic. + * UDP Port on which the daemon will listen for incoming traffic. */ #define IKEV2_UDP_PORT 500 /** - * First retransmit timeout in milliseconds. + * @brief First retransmit timeout in milliseconds. + * + * Timeout value is increasing in each retransmit round. */ #define RETRANSMIT_TIMEOUT 3000 @@ -68,79 +67,97 @@ #define HALF_OPEN_IKE_SA_TIMEOUT 30000 /** - * Max retransmit count. 0 for infinite. + * @brief Max retransmit count. + * + * 0 for infinite. The max time a half open IKE_SA is alive is set by + * RETRANSMIT_TIMEOUT. */ #define MAX_RETRANSMIT_COUNT 0 + +/** + * Max number of primes to precompute per prime type. + */ +#define PRIME_PRE_COMPUTATION_LIMIT 5 + /** - * Default loglevel to use. This is the - * maximum allowed level for ever context, the definiton + * @brief Default loglevel for every logger context. + * + * This is the maximum allowed level for ever context, the definiton * of the context may be less verbose. */ #define DEFAULT_LOGLEVEL CONTROL | ERROR + typedef struct daemon_t daemon_t; /** - * @brief Main class of daemon, contains some globals + * @brief Main class of daemon, contains some globals. */ struct daemon_t { /** - * socket_t instance + * A socket_t instance. */ socket_t *socket; + /** - * send_queue_t instance + * A send_queue_t instance. */ + send_queue_t *send_queue; + /** - * job_queue_t instance + * A job_queue_t instance. */ job_queue_t *job_queue; + /** - * event_queue_t instance + * A event_queue_t instance. */ event_queue_t *event_queue; + /** - * logger_manager_t instance + * A logger_manager_t instance. */ logger_manager_t *logger_manager; + /** - * ike_sa_manager_t instance + * A ike_sa_manager_t instance. */ ike_sa_manager_t *ike_sa_manager; + /** - * configuration_manager_t instance + * A configuration_manager_t instance. */ configuration_manager_t *configuration_manager; /** - * Sender-Thread + * The Sender-Thread. */ sender_t *sender; /** - * Receiver-Thread + * The Receiver-Thread. */ receiver_t *receiver; /** - * Scheduler-Thread + * The Scheduler-Thread. */ scheduler_t *scheduler; /** - * Thread pool holding the worker threads + * The Thread pool managing the worker threads. */ thread_pool_t *thread_pool; /** - * Low-priority thread which generates primes + * Low-priority thread which generates primes. */ prime_pool_t *prime_pool; /** - * @brief shut down the daemon + * @brief Shut down the daemon. * * @param this the daemon to kill * @param reason describition why it will be killed @@ -149,7 +166,7 @@ struct daemon_t { }; /** - * one and only instance of the daemon + * One and only instance of the daemon. */ extern daemon_t *charon; |