Log.cc

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * LSST Data Management System
 * Copyright 2013-2014 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * 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 3 of the License, or
 * (at your option) any later version.
 *
 * 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.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

// System headers
#include <mutex>
#include <pthread.h>
#include <stdexcept>
#include <stdio.h>
#include <stdlib.h>
#include <vector>

// Third-party headers
#include <log4cxx/basicconfigurator.h>
#include <log4cxx/consoleappender.h>
#include <log4cxx/helpers/bytearrayinputstream.h>
#include <log4cxx/patternlayout.h>
#include <log4cxx/propertyconfigurator.h>
#include <log4cxx/xml/domconfigurator.h>

// Local headers
#include "lsst/log/Log.h"
#include "lwpID.h"


// Max message length for varargs/printf style logging
#define MAX_LOG_MSG_LEN 1024

namespace {

// name of the env. variable pointing to logging config file
const char configEnv[] = "LSST_LOG_CONFIG";

// dafault message layout pattern
const char layoutPattern[] = "%c %p: %m%n";

/*
 * Configure LOG4CXX from file, file must exist. If file extension is .xml
 * then DOMConfigurator is used, otherwise PropertyConfigurator is called.
 *
 * If file parsing fails then error messages are printed to standard error,
 * but execution continues. LOG4CXX will likely stay un-configured in this
 * case.
 */
void configFromFile(std::string const& filename) {
    // find position of extension
    size_t dotpos = filename.find_last_of(".");
    if (dotpos != std::string::npos && filename.compare(dotpos, std::string::npos, ".xml") == 0) {
        log4cxx::xml::DOMConfigurator::configure(filename);
    } else {
        log4cxx::PropertyConfigurator::configure(filename);
    }
}

/*
 *  Default configuration.
 *
 *  If LSST_LOG_CONFIG envvar is defined and points to existing file then
 *  use that file to configure (can be either XML or Properties file).
 *  Otherwise use pre-defined configuration - add console appender to root
 *  logger using pattern layout with the above pattern, level set to INFO.
 *
 *  IF LOG4CXX was initialized already and you want to reset it then call
 *  `log4cxx::BasicConfigurator::resetConfiguration()` first.
 */
void defaultConfig() {

    // if LSST_LOG_CONFIG is set then use that file
    if (const char* env = getenv(::configEnv)) {
        if (env[0] and access(env, R_OK) == 0) {
            configFromFile(env);
            return;
        }
    }

    // use pre-defined configuration
    log4cxx::LogString pattern(layoutPattern);
    log4cxx::LayoutPtr layout(new log4cxx::PatternLayout(pattern));
    log4cxx::AppenderPtr appender(new log4cxx::ConsoleAppender(layout));
    auto root = log4cxx::Logger::getRootLogger();
    root->addAppender(appender);
    root->setLevel(log4cxx::Level::getInfo());
}

/*
 * This method is called exactly once to initialize LOG4CXX configuration.
 * If LOG4CXX is already initialized then `skipInit` should be set to true.
 */
log4cxx::LoggerPtr log4cxxInit(bool skipInit) {

    if (! skipInit) {
        ::defaultConfig();
    }

    // returns root logger to be used as default logger
    return log4cxx::Logger::getRootLogger();
}

// List of the MDC initialization functions
std::vector<std::function<void()>> mdcInitFunctions;
std::mutex mdcInitMutex;

// more efficient alternative to pthread_once
struct PthreadKey {
    PthreadKey() {
        // we don't need destructor for a key
        pthread_key_create(&key, nullptr);
    }
    pthread_key_t key;
} pthreadKey;

}


namespace lsst {
namespace log {


// Log class

log4cxx::LoggerPtr const& Log::_defaultLogger(log4cxx::LoggerPtr const& newDefault) {
    bool isNull = newDefault == log4cxx::LoggerPtr();

    // initialize on the first call (skip initialization if someone else did that)
    static log4cxx::LoggerPtr _default(::log4cxxInit(!isNull));

    if (!isNull) {
        _default = newDefault;
    }
    return _default;
}

void Log::configure() {

    // This removes all defined appenders, resets level to DEBUG,
    // existing loggers are not deleted, only reset.
    log4cxx::BasicConfigurator::resetConfiguration();

    // Do default configuration (only if not configured already?)
    ::defaultConfig();

    // reset default logger to the root logger
    _defaultLogger(log4cxx::Logger::getRootLogger());
}

void Log::configure(std::string const& filename) {
    // This removes all defined appenders, resets level to DEBUG,
    // existing loggers are not deleted, only reset.
    log4cxx::BasicConfigurator::resetConfiguration();

    ::configFromFile(filename);

    // reset default logger to the root logger
    _defaultLogger(log4cxx::Logger::getRootLogger());
}

void Log::configure_prop(std::string const& properties) {
    // This removes all defined appenders, resets level to DEBUG,
    // existing loggers are not deleted, only reset.
    log4cxx::BasicConfigurator::resetConfiguration();

    std::vector<unsigned char> data(properties.begin(), properties.end());
    log4cxx::helpers::InputStreamPtr inStream(new log4cxx::helpers::ByteArrayInputStream(data));
    log4cxx::helpers::Properties prop;
    prop.load(inStream);
    log4cxx::PropertyConfigurator::configure(prop);

    // reset default logger to the root logger
    _defaultLogger(log4cxx::Logger::getRootLogger());
}

std::string Log::getDefaultLoggerName() {
    return getDefaultLogger().getName();
}

std::string Log::getName() const {
    std::string name = _logger->getName();
    if (name == "root") {
        name.clear();
    }
    return name;
}

Log Log::getLogger(std::string const& loggername) {
    if (loggername.empty()){
        return getDefaultLogger();
    } else {
        return Log(log4cxx::Logger::getLogger(loggername));
    }
}

void Log::pushContext(std::string const& name) {
    // can't handle empty names
    if (name.empty()) {
        throw std::invalid_argument("lsst::log::Log::pushContext(): "
                "empty context name is not allowed");
    }
    // we do not allow multi-level context (logger1.logger2)
    if (name.find('.') != std::string::npos) {
        throw std::invalid_argument("lsst::log::Log::pushContext(): "
                "multi-level contexts are not allowed: " + name);
    }

    // Construct new default logger name
    std::string newName = _defaultLogger()->getName();
    if (newName == "root") {
        newName = name;
    } else {
        newName += ".";
        newName += name;
    }
    // Update defaultLogger
    _defaultLogger(log4cxx::Logger::getLogger(newName));
}

void Log::popContext() {
    // switch to parent logger, this assumes that loggers are not
    // re-parented between calls to push and pop
    log4cxx::LoggerPtr parent = _defaultLogger()->getParent();
    // root logger does not have parent, stay at root instead
    if (parent) {
        _defaultLogger(parent);
    }
}

void Log::MDC(std::string const& key, std::string const& value) {
    // put() does not remove existing mapping, to make it less confusing
    // for clients which expect that MDC() always overwrites existing mapping
    // we explicitly remove it first if it exists.
    log4cxx::MDC::remove(key);
    log4cxx::MDC::put(key, value);
}

void Log::MDCRemove(std::string const& key) {
    log4cxx::MDC::remove(key);
}

int Log::MDCRegisterInit(std::function<void()> function) {

    std::lock_guard<std::mutex> lock(mdcInitMutex);

    // logMsg may have been called already in this thread, to make sure that
    // this function is executed in this thread call it explicitly
    function();

    // store function for later use
    ::mdcInitFunctions.push_back(std::move(function));

    // return arbitrary number
    return 1;
}

void Log::setLevel(int level) {
    _logger->setLevel(log4cxx::Level::toLevel(level));
}

int Log::getLevel() const {
    log4cxx::LevelPtr level = _logger->getLevel();
    int levelno = -1;
    if (level != NULL) {
        levelno = level->toInt();
    }
    return levelno;
}

bool Log::isEnabledFor(int level) const {
    if (_logger->isEnabledFor(log4cxx::Level::toLevel(level))) {
        return true;
    } else {
        return false;
    }
}

void Log::log(log4cxx::LevelPtr level,     
              log4cxx::spi::LocationInfo const& location,  
              char const* fmt,             
              ...                          
             ) {
    va_list args;
    va_start(args, fmt);
    char msg[MAX_LOG_MSG_LEN];
    vsnprintf(msg, MAX_LOG_MSG_LEN, fmt, args);
    logMsg(level, location, msg);
}

void Log::logMsg(log4cxx::LevelPtr level,     
                 log4cxx::spi::LocationInfo const& location,  
                 std::string const& msg       
                 ) {

    // do one-time per-thread initialization, this was implemented
    // with thread_local initially but clang on OS X did not support it
    void *ptr = pthread_getspecific(::pthreadKey.key);
    if (ptr == nullptr) {

        // use pointer value as a flag, don't care where it points to
        ptr = static_cast<void*>(&::pthreadKey);
        pthread_setspecific(::pthreadKey.key, ptr);

        std::lock_guard<std::mutex> lock(mdcInitMutex);
                // call all functions in the MDC init list
        for (auto& fun: mdcInitFunctions) {
            fun();
        }
    }

    // forward everything to logger
    _logger->forcedLog(level, msg, location);
}

unsigned lwpID() {
    return detail::lwpID();
}

}} // namespace lsst::log