coherence/lang/AbstractHeapAnalyzer.hpp

/*
* AbstractHeapAnalyzer.hpp
*
* Copyright 2001-2008 by Oracle. All rights reserved.
*
* Oracle is a registered trademarks of Oracle Corporation and/or its
* affiliates.
*
* This software is the confidential and proprietary information of Oracle
* Corporation. You shall not disclose such confidential and proprietary
* information and shall use it only in accordance with the terms of the
* license agreement you entered into with Oracle.
*
* This notice may not be removed or altered.
*/
#ifndef COH_ABSTRACT_HEAP_ANALYZER_HPP
#define COH_ABSTRACT_HEAP_ANALYZER_HPP

#include "coherence/lang/compatibility.hpp"


#include "coherence/lang/abstract_spec.hpp"
#include "coherence/lang/HeapAnalyzer.hpp"

#include <ostream>

COH_OPEN_NAMESPACE2(coherence,native)
class NativeThreadLocal;
COH_CLOSE_NAMESPACE2

COH_OPEN_NAMESPACE2(coherence,lang)

using coherence::native::NativeThreadLocal;


/**
* AbstractHeapAnalyzer provides a starting point for writting custom heap
* analyzers. Most notibly it includes support for detecting analyzer
* reentrance so that analyzers can avoid endlessly recursing if they create
* objects as part of the registration process.
*
* @author mf  2008.04.27
*/
class COH_EXPORT AbstractHeapAnalyzer
    : public abstract_spec<AbstractHeapAnalyzer,
        extends<Object>,
        implements<HeapAnalyzer> >
    {
    // ----- constructor ----------------------------------------------------

    protected:
        /**
        * @internal
        */
        AbstractHeapAnalyzer();

        /**
        * @internal
        */
        virtual ~AbstractHeapAnalyzer();


    // ----- AbstractHeapAnalyzer methods -----------------------------------

    protected:
        /**
        * Registers an object with the heap analyzer.
        *
        * @param o  the object to register
        */
        virtual void safeRegisterObject(const Object& o) = 0;

        /**
        * Unregisters an object with the heap analyzer.
        *
        * @param o  the object to unregister
        */
        virtual void safeUnregisterObject(const Object& o) = 0;


    // ----- HeapAnalyzer interface -----------------------------------------

    protected:
        /**
        * {@inheritDoc}
        *
        * If the calling thread is reentering this method return immediatley
        * otherwise delegates to safeRegisterObject.
        */
        virtual void registerObject(const Object& o);

        /**
        * {@inheritDoc}
        *
        * If the calling thread is reentering this method return immediatley
        * otherwise delegates to safeUnregisterObject.
        */
        virtual void unregisterObject(const Object& o);


    // ----- Object interface -----------------------------------------------

    public:
        /**
        * Capture a snapshot and output it to the supplied stream.
        *
        * @param out  the stream to output to
        */
        virtual void toStream(std::ostream& out) const;


    // ----- data members ---------------------------------------------------

    private:
        /**
        * Tracks if the calling thread is within the analyzer.
        *
        * The use of ThreadLocalReference here is not suitable, as it is a
        * managed object, and causes recursion into the HeapAnalyzer.
        */
        NativeThreadLocal* const m_pTLContext;
    };

COH_CLOSE_NAMESPACE2

#endif // COH_ABSTRACT_HEAP_ANALYZER_HPP

Copyright (c) 2000-2008 Oracle. All rights reserved.