strongswan/Source/charon/utils/logger_manager.c

/**
 * @file logger_manager.c
 *
 * @brief Logger manager. Manages globaly all logger objects
 *
 */

/*
 * Copyright (C) 2005 Jan Hutter, Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program 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 General Public License
 * for more details.
 */
 
 
#include "logger_manager.h"
 
#include "allocator.h"
#include "linked_list.h"

/** 
 * Maximum length of a logger name
 */
#define MAX_LOGGER_NAME 30

typedef struct private_logger_manager_s private_logger_manager_t;
struct private_logger_manager_s { 	
	/**
	 * Public data.
	 */
	logger_manager_t public;

	/**
	 * Managed loggers.
	 */
	linked_list_t *loggers;
	
	/**
	 * Log Levels.
	 */
	linked_list_t *logger_levels;
	
	/**
	 * Used to manage logger list.
	 */
	pthread_mutex_t mutex;
	
	/**
	 * Default logger level for a created logger used if no specific logger_level is set
	 */
	logger_level_t default_log_level;
	
	/**
	 * Sets set logger_level of a specific context.
	 * @param this 			calling object
	 * @param context 		context to set level
 	 * @param logger_level 	logger_level to set
 	 * @param enable 		enable specific level or disable it
 	 * @return SUCCESS
	 */
	status_t (*set_logger_level) (private_logger_manager_t *this, logger_context_t context,logger_level_t logger_level,bool enable);
	
};

/**
 * Entry in the logger_levels linked list
 */
typedef struct logger_levels_entry_s logger_levels_entry_t;

struct logger_levels_entry_s{
	logger_context_t context;
	logger_level_t level;
};

/**
 * Entry in the loggers linked list
 */
typedef struct loggers_entry_s loggers_entry_t;

struct loggers_entry_s{
	logger_context_t context;
	logger_t *logger;
};

/**
 * Implements logger_manager_t-function create_logger.
 * @see logger_manager_s.create_logger.
 */
static logger_t *create_logger(private_logger_manager_t *this, logger_context_t context, char * name)
{
	
	char * context_name;
	FILE * output = NULL;
	char buffer[MAX_LOGGER_NAME];
	loggers_entry_t *entry;
	logger_t *logger;
	logger_level_t logger_level = this->public.get_logger_level(&(this->public),context);

	switch(context)
	{
		case PARSER:
			context_name = "PARSER";
			break;
		case GENERATOR:
			context_name = "GENERATOR";
			break;
		case IKE_SA:
			context_name = "IKE_SA";
			break;
		case MESSAGE:
			context_name = "MESSAGE";
			break;
		case WORKER_THREAD:
			context_name = "WORKER_THREAD";
			break;
		case EVENT_THREAD:
			context_name = "EVENT_THREAD";
			break;
		case SENDER_THREAD:
			context_name = "SENDER_THREAD";
			break;
		case RECEIVER_THREAD:
			context_name = "RECEIVER_THREAD";
			break;
		case THREAD_POOL:
			context_name = "THREAD_POOL";
			break;
		case TESTER:
			context_name = "TESTER";
			output = stdout;
			break;
		default:
			context_name = "NO CONTEXT";
			break;		
	}
	
	pthread_mutex_lock(&(this->mutex));
	if (name != NULL)
	{
		snprintf(buffer, MAX_LOGGER_NAME, "%s - %s",context_name,name);
			/* create logger with default log_level */
		logger = logger_create(buffer,logger_level,output);
	}
	else
	{
		logger = logger_create(context_name,logger_level,output);
	}
	
	
	if (logger == NULL)
	{
		pthread_mutex_unlock(&(this->mutex));		
		return NULL;
	}

	entry = allocator_alloc_thing(loggers_entry_t);
	
	if (entry == NULL)
	{
		logger->destroy(logger);
		pthread_mutex_unlock(&(this->mutex));		
		return NULL;
	}

	entry->context = context;
	entry->logger = logger;

	if (this->loggers->insert_last(this->loggers,entry) != SUCCESS)
	{
		allocator_free(entry);
		logger->destroy(logger);
		pthread_mutex_unlock(&(this->mutex));		
		return NULL;
	}

	pthread_mutex_unlock(&(this->mutex));
	return logger;
	
}

static logger_level_t get_logger_level (private_logger_manager_t *this, logger_context_t context)
{
	linked_list_iterator_t *iterator;
	logger_level_t logger_level = this->default_log_level;

	pthread_mutex_lock(&(this->mutex));

	if (this->logger_levels->create_iterator(this->logger_levels,&iterator,TRUE) != SUCCESS)
	{
		pthread_mutex_unlock(&(this->mutex));
		return logger_level;
	}
	while (iterator->has_next(iterator))
	{
		
		logger_levels_entry_t * entry;
		if (iterator->current(iterator,(void **)&entry) != SUCCESS)
		{	
			break;
		}
		if (entry->context == context)
		{
			logger_level = entry->level;
			break;
		}
	}
	
	iterator->destroy(iterator);

	pthread_mutex_unlock(&(this->mutex));
	return logger_level;
}

/**
 * Implements logger_manager_t-function destroy_logger.
 * @see logger_manager_s.destroy_logger.
 */
static status_t destroy_logger (private_logger_manager_t *this,logger_t *logger)
{
	
	linked_list_iterator_t *iterator;
	status_t status;
	
	pthread_mutex_lock(&(this->mutex));
	if (this->loggers->create_iterator(this->loggers,&iterator,TRUE) != SUCCESS)
	{
		pthread_mutex_unlock(&(this->mutex));
		return OUT_OF_RES;
	}

	while (iterator->has_next(iterator))
	{
		
		loggers_entry_t * entry;
		status = iterator->current(iterator,(void **)&entry);
		if (status != SUCCESS)
		{	
			break;
		}
		status = NOT_FOUND;
		if (entry->logger == logger)
		{
			this->loggers->remove(this->loggers,iterator);
			allocator_free(entry);
			logger->destroy(logger);
			status = SUCCESS;
			break; 
		}
	}
	iterator->destroy(iterator);
	pthread_mutex_unlock(&(this->mutex));
	return status;
}

/**
 * Implements private_logger_manager_t-function set_logger_level.
 * @see private_logger_manager_s.set_logger_level.
 */
static status_t set_logger_level (private_logger_manager_t *this, logger_context_t context,logger_level_t logger_level,bool enable)
{
	
	linked_list_iterator_t *iterator;
	status_t status;
	
	pthread_mutex_lock(&(this->mutex));
	if (this->logger_levels->create_iterator(this->logger_levels,&iterator,TRUE) != SUCCESS)
	{
		pthread_mutex_unlock(&(this->mutex));
		return OUT_OF_RES;
	}

	status = NOT_FOUND;
	while (iterator->has_next(iterator))
	{	
		logger_levels_entry_t * entry;
		status = iterator->current(iterator,(void **)&entry);
		if (status != SUCCESS)
		{	
			iterator->destroy(iterator);
			pthread_mutex_unlock(&(this->mutex));
			return status;
		}
		status = NOT_FOUND;
		if (entry->context == context)
		{
			if (enable)
			{
				entry->level |= logger_level;
			}
			else
			{
				entry->level &= ~logger_level;
			}

			status = SUCCESS;
			break; 
		}
	}
	iterator->destroy(iterator);
	
	if (status == NOT_FOUND)
	{

		logger_levels_entry_t *entry = allocator_alloc_thing(logger_levels_entry_t);
		if (entry == NULL)
		{
			pthread_mutex_unlock(&(this->mutex));
			return OUT_OF_RES;
		}
		entry->context = context;
		entry->level = 	(enable) ? logger_level : this->default_log_level;

		status = this->logger_levels->insert_last(this->logger_levels,entry);
		if (status != SUCCESS)
		{
			pthread_mutex_unlock(&(this->mutex));
			return status;
		}
	}
	
	if (this->loggers->create_iterator(this->loggers,&iterator,TRUE) != SUCCESS)
	{
		pthread_mutex_unlock(&(this->mutex));
		return OUT_OF_RES;
	}

	while (iterator->has_next(iterator))
	{
		
		loggers_entry_t * entry;
		status = iterator->current(iterator,(void **)&entry);
		if (status != SUCCESS)
		{	
			iterator->destroy(iterator);
			pthread_mutex_unlock(&(this->mutex));
			return status;
		}
		if (entry->context == context)
		{
			if (enable)
			{
				status = entry->logger->enable_level(entry->logger,logger_level);
			}
			else
			{
				status = entry->logger->disable_level(entry->logger,logger_level);
			}
			
		}
	}

	iterator->destroy(iterator);
	pthread_mutex_unlock(&(this->mutex));
	return SUCCESS;
}

/**
 * Implements logger_manager_t-function enable_logger_level.
 * @see logger_manager_s.enable_logger_level.
 */
static status_t enable_logger_level (private_logger_manager_t *this, logger_context_t context,logger_level_t logger_level)
{
	return set_logger_level(this,context,logger_level,TRUE);
}

/**
 * Implements logger_manager_t-function disable_logger_level.
 * @see logger_manager_s.disable_logger_level.
 */
static status_t disable_logger_level (private_logger_manager_t *this, logger_context_t context,logger_level_t logger_level)
{
	return set_logger_level(this,context,logger_level,FALSE);
}

/**
 * Implements logger_manager_t-function destroy.
 * @see logger_manager_s.destroy.
 */
static status_t destroy(private_logger_manager_t *this)
{
	while (this->loggers->get_count(this->loggers) > 0)
	{
		loggers_entry_t *current_entry;
		
		this->loggers->remove_first(this->loggers,(void **)&current_entry);
		
		/* destroy logger object */
		current_entry->logger->destroy(current_entry->logger);
		
		/* entry can be destroyed */
		allocator_free(current_entry);		
	}
	
	while (this->logger_levels->get_count(this->logger_levels) > 0)
	{
		logger_levels_entry_t *current_entry;
		
		this->logger_levels->remove_first(this->logger_levels,(void **)&current_entry);
		
		/* entry can be destroyed */
		allocator_free(current_entry);
	}
	
	this->loggers->destroy(this->loggers);
	this->logger_levels->destroy(this->logger_levels);
	pthread_mutex_destroy(&(this->mutex));
	
	allocator_free(this);
	return SUCCESS;
}

/*
 * Described in header
 */
logger_manager_t *logger_manager_create(logger_level_t default_log_level)
{
	private_logger_manager_t *this = allocator_alloc_thing(private_logger_manager_t);
		
	if (this == NULL)
	{
		return NULL;	
	}

	this->public.create_logger = (logger_t *(*)(logger_manager_t*,logger_context_t context, char *))create_logger;
	this->public.destroy_logger = (status_t(*)(logger_manager_t*,logger_t *logger))destroy_logger;
	this->public.destroy = (status_t(*)(logger_manager_t*))destroy;
	this->public.get_logger_level = (logger_level_t (*)(logger_manager_t *, logger_context_t)) get_logger_level;
	this->public.enable_logger_level = (status_t (*)(logger_manager_t *, logger_context_t,logger_level_t)) enable_logger_level;
	this->public.disable_logger_level = (status_t (*)(logger_manager_t *, logger_context_t,logger_level_t)) disable_logger_level;
	this->set_logger_level = (status_t (*)(private_logger_manager_t *, logger_context_t,logger_level_t,bool)) set_logger_level;
	
	/* private variables */
	this->loggers = linked_list_create();
	
	if (this->loggers == NULL)
	{
		allocator_free(this);
		return NULL;
	}
	this->logger_levels = linked_list_create();
	if (this->logger_levels == NULL)
	{
		this->loggers->destroy(this->loggers);
		allocator_free(this);
		return NULL;
	}
	this->default_log_level = default_log_level;
	
	pthread_mutex_init(&(this->mutex), NULL);

	return (logger_manager_t*)this;
}