BlockTimingLog.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 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/>.
 */
 
#ifndef LSST_PEX_LOGGING_BLOCKTIMINGLOG_H
#define LSST_PEX_LOGGING_BLOCKTIMINGLOG_H

#include "lsst/pex/logging/LogRecord.h"
#include "lsst/pex/logging/Log.h"

#include <sys/time.h>
#include <sys/resource.h>

#include <memory>
#include <string>

namespace lsst {
namespace pex {
namespace logging {

class BlockTimingLog : public Log {
public:

    enum usageData { 
        NOUDATA = 0,

        UTIME = 1,

        STIME = 2,

        SUTIME = 3,

        MEMSZ = 4,

        NSWAP = 16,

        BLKIN = 32,

        BLKOUT = 64,

        BLKIO = 96,

        MINFLT = 128, 

        MAJFLT = 256, 

        LINUXUDATA = 387,

        ALLUDATA = 511,

        PARENTUDATA = 8192
    };

    static const int INSTRUM;  // = Log::INFO - 3

    static const std::string STATUS;

    static const std::string START;

    static const std::string END;

    BlockTimingLog(const Log& parent, const std::string& name, 
                   int tracelev=BlockTimingLog::INSTRUM, 
                   int usageFlags=PARENTUDATA, const std::string& funcName="");

    BlockTimingLog(const BlockTimingLog& that) 
        : Log(*this), _tracelev(that._tracelev), _funcName(that._funcName)
    { }

    BlockTimingLog& operator=(const BlockTimingLog& that) {
        Log::operator=(that);
        _tracelev = that._tracelev;
        _funcName = that._funcName;
        return *this;
    }

    int getUsageFlags() const { return _usageFlags; }

    void setUsageFlags(int flags) { 
        _usageFlags = flags; 
        if ((flags & PARENTUDATA) > 0) _usageFlags |= _pusageFlags;
    }

    void addUsageFlags(int flags) { 
        _usageFlags |= flags; 
        if ((flags & PARENTUDATA) > 0) _usageFlags |= _pusageFlags;
    }

    BlockTimingLog *createForBlock(const std::string& name, 
                                   int tracelev=Log::INHERIT_THRESHOLD,
                                   const std::string& funcName="") 
    {
        BlockTimingLog *out = new BlockTimingLog(*this, name, tracelev, 
                                                 PARENTUDATA, funcName);
        // out->setShowAll(true);
        out->start();
        return out;
    }

    BlockTimingLog *timeBlock(const std::string& name, 
                               int tracelev=Log::INHERIT_THRESHOLD,
                               const std::string& funcName="") 
    {
        return createForBlock(name, tracelev, funcName);
    }

    virtual ~BlockTimingLog();

    void start() {
        if (sends(_tracelev)) {
            std::string msg("Starting ");
            msg += _funcName;

            LogRecord rec(getThreshold(), _tracelev, getPreamble(), 
                          willShowAll());
            rec.addComment(msg);
            rec.addProperty(STATUS, START);
            if (_usageFlags) addUsageProps(rec);
            send(rec);
        }
    }

    void start(const std::string& funcName) {
        if (funcName.length() > 0) _funcName = funcName;
        start();
    }

    void done() {
        if (sends(_tracelev)) {
            std::string msg("Ending ");
            msg += _funcName;

            LogRecord rec(getThreshold(), _tracelev, getPreamble(), 
                          willShowAll());
            rec.addComment(msg);
            rec.addProperty(STATUS, END);
            if (_usageFlags) addUsageProps(rec);
            send(rec);
        }
    }

    int getInstrumentationLevel() const { return _tracelev; }

    const std::string& getFunctionName() const { return _funcName; }

    void addUsageProps(LogRecord& rec);

private:
    int _tracelev;
    int _pusageFlags, _usageFlags;
    std::string _funcName;
    std::unique_ptr<struct rusage> _usage;
};

}}}     // end lsst::pex::logging
#endif  // end LSST_PEX_BLOCKTIMINGLOG_H