// Aqsis
// Copyright (C) 2001, Paul C. Gregory and the other authors and contributors
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
// * Neither the name of the software's owners nor the names of its
//   contributors may be used to endorse or promote products derived from this
//   software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// (This is the New BSD license)

/// \file Memory profiling tools
/// \author Chris Foster  chris42f (at) gmail (dot) com

#ifndef AQSIS_MEMDEBUG_H_INCLUDED
#define AQSIS_MEMDEBUG_H_INCLUDED

#include <fstream>

namespace Aqsis {

/// Simple class for logging the amount of heap memory used to a file.
///
/// This class is a no-op unless AQSIS_MEMORY_DEBUGGING is enabled when the
/// associated source file is compiled.  (Note that obtaining a log record
/// from the allocator is a relatively time hungry operation.)
class MemoryLog
{
    public:
        /// Create a log file with the given name
        explicit MemoryLog(const char* fileName = "mallinfo.txt");

        /// Save current memory usage to the file
        ///
        /// According to malloc.h, fields in the output are:
        ///
        /// arena     - non-mmapped space allocated from system
        /// ordblks   - number of free chunks
        /// hblks     - number of mmapped regions
        /// hblkhd    - space in mmapped regions
        /// uordblks  - total allocated space
        /// fordblks  - total free space
        /// keepcost  - top-most, releasable (via malloc_trim) space
        ///
        /// The fields of most interest seem to be arena, uordblks, fordblks.
        void log();

    private:
        std::ofstream m_outFile;
};


} // namespace Aqsis

#endif // AQSIS_MEMDEBUG_H_INCLUDED
