GCManager.hpp

Go to the documentation of this file.

/*CXXR $Id: GCManager.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
 *  Copyright (C) 1995, 1996  Robert Gentleman and Ross Ihaka
 *  Copyright (C) 1999-2006   The R Development Core Team.
 *
 *  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 GCMANAGER_HPP
#define GCMANAGER_HPP

#include <cstddef>
#include <iosfwd>

namespace CXXR {
    class GCManager {
    public:
        static void gc();

        static size_t maxBytes() {return s_max_bytes;}

        static size_t maxNodes() {return s_max_nodes;}

        static void resetMaxTallies();

        static void setGCThreshold(size_t initial_threshold);

        static void setMonitors(void (*pre_gc)() = 0,
                                void (*post_gc)() = 0)
        {
            s_pre_gc = pre_gc;
            s_post_gc = post_gc;
        }

        static std::ostream* setReporting(std::ostream* os = 0);

        static void torture(bool on) {}

        static size_t triggerLevel() {return s_threshold;}
    private:
        friend class GCNode;

        static size_t s_threshold;
        static size_t s_min_threshold;

        static size_t s_max_bytes;
        static size_t s_max_nodes;

        static std::ostream* s_os;  // Pointer to output stream for GC
                                    // reporting, or NULL.

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

        // Clean up static data associated with garbage collection.
        static void cleanup() {}

        // Callbacks e.g. for timing:
        static void (*s_pre_gc)();
        static void (*s_post_gc)();

        // Detailed control of the garbage collection is carried out
        // here.
        static void gcController();

        // Initialize static data associated with garbage collection.
        static void initialize();
    };
}  // namespace CXXR

#endif /* GCMANAGER_HPP */