MemoryBank.hpp

Go to the documentation of this file.

/*CXXR $Id: MemoryBank.hpp 1348 2013-02-25 17:49:03Z arr $
 *CXXR
 *CXXR This file is part of CXXR, a project to refactor the R interpreter
 *CXXR into C++.  It may consist in whole or in part of program code and
 *CXXR documentation taken from the R project itself, incorporated into
 *CXXR CXXR (and possibly MODIFIED) under the terms of the GNU General Public
 *CXXR Licence.
 *CXXR 
 *CXXR CXXR is Copyright (C) 2008-13 Andrew R. Runnalls, subject to such other
 *CXXR copyrights and copyright restrictions as may be stated below.
 *CXXR 
 *CXXR CXXR is not part of the R project, and bugs and other issues should
 *CXXR not be reported via r-bugs or other R project channels; instead refer
 *CXXR to the CXXR website.
 *CXXR */

/*
 *  R : A Computer Language for Statistical Data Analysis
 *
 *  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.1 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, a copy is available at
 *  http://www.r-project.org/Licenses/
 */

#ifndef MEMORYBANK_HPP
#define MEMORYBANK_HPP

#include <cstring>
#include "config.h"
#include "CXXR/CellPool.hpp"
#include "CXXR/SchwarzCounter.hpp"

namespace CXXR {
    class MemoryBank {
    public:
#ifdef __GNUC__
        __attribute__((hot,fastcall))
#endif
        static void* allocate(size_t bytes) throw (std::bad_alloc);

        static size_t blocksAllocated() {return s_blocks_allocated;}

        static size_t bytesAllocated() {return s_bytes_allocated;}

        static void check();

        static void deallocate(void* p, size_t bytes)
        {
            if (!p) return;
#ifdef FILL55
            // This helps to diagnose premature GC:
            memset(p, 0x55, bytes);
#endif
            // Assumes sizeof(double) == 8:
            if (bytes > s_max_cell_size)
                ::operator delete(p);
            else s_pools[s_pooltab[(bytes + 7) >> 3]].deallocate(p);
            --s_blocks_allocated;
            s_bytes_allocated -= bytes;
        }

        static void defragment();

#ifdef R_MEMORY_PROFILING

        static void setMonitor(void (*monitor)(size_t) = 0,
                               size_t threshold = 0);
#endif
    private:
        typedef CellPool Pool;
        static const size_t s_num_pools = 10;
        static const size_t s_max_cell_size;
        static size_t s_blocks_allocated;
        static size_t s_bytes_allocated;
        static Pool* s_pools;
        static const unsigned char s_pooltab[];
#ifdef R_MEMORY_PROFILING
        static void (*s_monitor)(size_t);
        static size_t s_monitor_threshold;
#endif

        // Not implemented.  Declared to stop the compiler generating
        // a constructor.
        MemoryBank();

        // Free memory used by the static data members:
        static void cleanup() {}

        // Initialize the static data members:
        static void initialize();

        friend class SchwarzCounter<MemoryBank>;
    };
}

namespace {
    CXXR::SchwarzCounter<CXXR::MemoryBank> memorybank_schwarz_ctr;
}

#endif /* MEMORYBANK_HPP */