sim_object.hh revision 1127 
110915Sandreas.sandberg@arm.com/*
210915Sandreas.sandberg@arm.com * Copyright (c) 2001-2004 The Regents of The University of Michigan
310915Sandreas.sandberg@arm.com * All rights reserved.
410915Sandreas.sandberg@arm.com *
510915Sandreas.sandberg@arm.com * Redistribution and use in source and binary forms, with or without
610915Sandreas.sandberg@arm.com * modification, are permitted provided that the following conditions are
710915Sandreas.sandberg@arm.com * met: redistributions of source code must retain the above copyright
810915Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer;
910915Sandreas.sandberg@arm.com * redistributions in binary form must reproduce the above copyright
1010915Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer in the
1110915Sandreas.sandberg@arm.com * documentation and/or other materials provided with the distribution;
1210915Sandreas.sandberg@arm.com * neither the name of the copyright holders nor the names of its
1310915Sandreas.sandberg@arm.com * contributors may be used to endorse or promote products derived from
1410915Sandreas.sandberg@arm.com * this software without specific prior written permission.
1510915Sandreas.sandberg@arm.com *
1610915Sandreas.sandberg@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1710915Sandreas.sandberg@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1810915Sandreas.sandberg@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1910915Sandreas.sandberg@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
2010915Sandreas.sandberg@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
2110915Sandreas.sandberg@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
2210915Sandreas.sandberg@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2310915Sandreas.sandberg@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2410915Sandreas.sandberg@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2510915Sandreas.sandberg@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
2610915Sandreas.sandberg@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2710915Sandreas.sandberg@arm.com */
2810915Sandreas.sandberg@arm.com
2910915Sandreas.sandberg@arm.com/* @file
3010915Sandreas.sandberg@arm.com * User Console Definitions
3110915Sandreas.sandberg@arm.com */
3210915Sandreas.sandberg@arm.com
3310915Sandreas.sandberg@arm.com#ifndef __SIM_OBJECT_HH__
3410915Sandreas.sandberg@arm.com#define __SIM_OBJECT_HH__
3510915Sandreas.sandberg@arm.com
3610915Sandreas.sandberg@arm.com#include <map>
3710915Sandreas.sandberg@arm.com#include <list>
3810915Sandreas.sandberg@arm.com#include <vector>
3910915Sandreas.sandberg@arm.com#include <iostream>
4010915Sandreas.sandberg@arm.com
4110915Sandreas.sandberg@arm.com#include "sim/serialize.hh"
4210915Sandreas.sandberg@arm.com#include "sim/startup.hh"
4310915Sandreas.sandberg@arm.com
4410915Sandreas.sandberg@arm.com/*
4510915Sandreas.sandberg@arm.com * Abstract superclass for simulation objects.  Represents things that
4610915Sandreas.sandberg@arm.com * correspond to physical components and can be specified via the
4710915Sandreas.sandberg@arm.com * config file (CPUs, caches, etc.).
4810915Sandreas.sandberg@arm.com */
4910915Sandreas.sandberg@arm.comclass SimObject : public Serializable, protected StartupCallback
5010915Sandreas.sandberg@arm.com{
5110915Sandreas.sandberg@arm.com  protected:
5210915Sandreas.sandberg@arm.com    std::string objName;
5310915Sandreas.sandberg@arm.com
5410915Sandreas.sandberg@arm.com  private:
5510915Sandreas.sandberg@arm.com    friend class Serializer;
5610915Sandreas.sandberg@arm.com
5710915Sandreas.sandberg@arm.com    typedef std::vector<SimObject *> SimObjectList;
5810915Sandreas.sandberg@arm.com
5910915Sandreas.sandberg@arm.com    // list of all instantiated simulation objects
6010915Sandreas.sandberg@arm.com    static SimObjectList simObjectList;
6110915Sandreas.sandberg@arm.com
6210915Sandreas.sandberg@arm.com  public:
6310915Sandreas.sandberg@arm.com    SimObject(const std::string &_name);
6410915Sandreas.sandberg@arm.com
6510915Sandreas.sandberg@arm.com    virtual ~SimObject() {}
6610915Sandreas.sandberg@arm.com
6710915Sandreas.sandberg@arm.com    virtual const std::string name() const { return objName; }
6810915Sandreas.sandberg@arm.com
6910915Sandreas.sandberg@arm.com    // initialization pass of all objects.
7010915Sandreas.sandberg@arm.com    // Gets invoked after construction, before unserialize.
7110915Sandreas.sandberg@arm.com    virtual void init();
7210915Sandreas.sandberg@arm.com    static void initAll();
7310915Sandreas.sandberg@arm.com
7410915Sandreas.sandberg@arm.com    // register statistics for this object
7510915Sandreas.sandberg@arm.com    virtual void regStats();
7610915Sandreas.sandberg@arm.com    virtual void regFormulas();
7710915Sandreas.sandberg@arm.com    virtual void resetStats();
7810915Sandreas.sandberg@arm.com
7910915Sandreas.sandberg@arm.com    // static: call reg_stats on all SimObjects
8010915Sandreas.sandberg@arm.com    static void regAllStats();
8110915Sandreas.sandberg@arm.com
82    // static: call resetStats on all SimObjects
83    static void resetAllStats();
84
85    // static: call nameOut() & serialize() on all SimObjects
86    static void serializeAll(std::ostream &);
87
88#ifdef DEBUG
89  public:
90    bool doDebugBreak;
91    static void debugObjectBreak(const std::string &objs);
92#endif
93
94  public:
95    bool doRecordEvent;
96    void recordEvent(const std::string &stat);
97};
98
99#endif // __SIM_OBJECT_HH__
100