sim/serialize.hh

/*
 * Copyright (c) 2003 The Regents of The University of Michigan
 * 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 copyright holders 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
 * OWNER 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.
 */

/* @file
 * Serialization Interface Declarations
 */

#ifndef __SERIALIZE_HH__
#define __SERIALIZE_HH__


#include <list>
#include <iostream>

#include "sim/host.hh"
#include "sim/configfile.hh"

class IniFile;

/*
 * Basic support for object serialization.
 */
class Serializeable
{
  public:
    // To allow other classes to do some of the serialization work.
    class Proxy {
      private:
        Serializeable *obj;

        // Make it so only Serializables can construct one of these.
        Proxy(Serializeable *o) : obj(o) {};

        friend class Serializeable;

      public:
        template <class T>
        void paramOut(const std::string &name, const T& param) const {
            obj->paramOut(name, param);
        };
    };

    friend class Serializer;
    friend class Proxy;

  private:
    Proxy proxy;

  protected:
    const Proxy &getProxy() { return(proxy); };

    // object name: should be unique
    std::string objName;

    bool serialized;
    static Serializer *serializer;

    void mark();
    void nameOut();
    void nameOut(const std::string &_name);
    void childOut(const std::string &name, Serializeable *child);
    template <class T>
    void paramOut(const std::string &name, const T& param);

    std::ostream &out() const;

  public:
    Serializeable(const std::string &n);
    virtual ~Serializeable();

    void setName(const std::string &name);

    // return name
    const std::string &name() const { return objName; }

    virtual void nameChildren() {}
    virtual void serialize() {}
    virtual void unserialize(IniFile &db, const std::string &category,
                             ConfigNode *node = NULL)
    {
        std::cout << name() << " is being unserialized" << std::endl;
    }
};

class Serializer
{
    friend class Serializeable;

  protected:
    typedef std::list<Serializeable *> serlist_t;
    serlist_t objects;
    std::string file;
    std::ostream *output;
    std::ostream &out() const;

  public:
    Serializer();
    virtual ~Serializer();

  private:
    void add_object(Serializeable *obj);
    void add_objects();

  public:
    void serialize(const std::string &file);
    const std::string &filename() const { return file; }
};

template <class T>
inline void
Serializeable::paramOut(const std::string &name, const T& param)
{
    out() << name << "=" << param << "\n";
}

template <> void
Serializeable::paramOut(const std::string &name, const uint64_t& param);


//
// A SerializeableBuilder serves as an evaluation context for a set of
// parameters that describe a specific instance of a Serializeable.  This
// evaluation context corresponds to a section in the .ini file (as
// with the base ParamContext) plus an optional node in the
// configuration hierarchy (the configNode member) for resolving
// Serializeable references.  SerializeableBuilder is an abstract superclass;
// derived classes specialize the class for particular subclasses of
// Serializeable (e.g., BaseCache).
//
// For typical usage, see the definition of
// SerializeableClass::createObject().
//
class SerializeableBuilder
{
  public:

    SerializeableBuilder() {}

    virtual ~SerializeableBuilder() {}

    // Create the actual Serializeable corresponding to the parameter
    // values in this context.  This function is overridden in derived
    // classes to call a specific constructor for a particular
    // subclass of Serializeable.
    virtual Serializeable *create() = 0;
};

//
// An instance of SerializeableClass corresponds to a class derived from
// Serializeable.  The SerializeableClass instance serves to bind the string
// name (found in the config file) to a function that creates an
// instance of the appropriate derived class.
//
// This would be much cleaner in Smalltalk or Objective-C, where types
// are first-class objects themselves.
//
class SerializeableClass
{
  public:

    // Type CreateFunc is a pointer to a function that creates a new
    // simulation object builder based on a .ini-file parameter
    // section (specified by the first string argument), a unique name
    // for the object (specified by the second string argument), and
    // an optional config hierarchy node (specified by the third
    // argument).  A pointer to the new SerializeableBuilder is returned.
    typedef SerializeableBuilder *(*CreateFunc)();

    static std::map<std::string,CreateFunc> *classMap;

    // Constructor.  For example:
    //
    // SerializeableClass baseCacheSerializeableClass("BaseCacheSerializeable",
    //                         newBaseCacheSerializeableBuilder);
    //
    SerializeableClass(const std::string &className, CreateFunc createFunc);

    // create Serializeable given name of class and pointer to
    // configuration hierarchy node
    static Serializeable *createObject(IniFile &configDB,
                                       const std::string &configClassName);

};

//
// Macros to encapsulate the magic of declaring & defining
// SerializeableBuilder and SerializeableClass objects
//

#define CREATE_SERIALIZEABLE(OBJ_CLASS)				\
OBJ_CLASS *OBJ_CLASS##Builder::create()

#define REGISTER_SERIALIZEABLE(CLASS_NAME, OBJ_CLASS)		\
class OBJ_CLASS##Builder : public SerializeableBuilder		\
{								\
  public: 							\
                                                                \
    OBJ_CLASS##Builder() {}					\
    virtual ~OBJ_CLASS##Builder() {}				\
                                                                \
    OBJ_CLASS *create();					\
};								\
                                                                \
                                                                \
SerializeableBuilder *						\
new##OBJ_CLASS##Builder()					\
{								\
    return new OBJ_CLASS##Builder();				\
}								\
                                                                \
SerializeableClass the##OBJ_CLASS##Class(CLASS_NAME,		\
                                     new##OBJ_CLASS##Builder);



#endif // __SERIALIZE_HH__