sim_object.hh revision 1762 
1/*
2 * Copyright (c) 2001-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/* @file
30 * User Console Definitions
31 */
32
33#ifndef __SIM_OBJECT_HH__
34#define __SIM_OBJECT_HH__
35
36#include <map>
37#include <list>
38#include <vector>
39#include <iostream>
40
41#include "sim/serialize.hh"
42#include "sim/startup.hh"
43
44/*
45 * Abstract superclass for simulation objects.  Represents things that
46 * correspond to physical components and can be specified via the
47 * config file (CPUs, caches, etc.).
48 */
49class SimObject : public Serializable, protected StartupCallback
50{
51  public:
52    struct Params {
53        std::string name;
54    };
55
56  protected:
57    Params *_params;
58
59  public:
60    const Params *params() const { return _params; }
61
62  private:
63    friend class Serializer;
64
65    typedef std::vector<SimObject *> SimObjectList;
66
67    // list of all instantiated simulation objects
68    static SimObjectList simObjectList;
69
70  public:
71    SimObject(Params *_params);
72    SimObject(const std::string &_name);
73
74    virtual ~SimObject() {}
75
76    virtual const std::string name() const { return params()->name; }
77
78    // initialization pass of all objects.
79    // Gets invoked after construction, before unserialize.
80    virtual void init();
81    static void initAll();
82
83    // register statistics for this object
84    virtual void regStats();
85    virtual void regFormulas();
86    virtual void resetStats();
87
88    // static: call reg_stats on all SimObjects
89    static void regAllStats();
90
91    // static: call resetStats on all SimObjects
92    static void resetAllStats();
93
94    // static: call nameOut() & serialize() on all SimObjects
95    static void serializeAll(std::ostream &);
96
97#ifdef DEBUG
98  public:
99    bool doDebugBreak;
100    static void debugObjectBreak(const std::string &objs);
101#endif
102
103  public:
104    bool doRecordEvent;
105    void recordEvent(const std::string &stat);
106};
107
108#endif // __SIM_OBJECT_HH__
109