module.hh revision 13045 
1/*
2 * Copyright 2018 Google, Inc.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met: redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer;
8 * redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution;
11 * neither the name of the copyright holders nor the names of its
12 * contributors may be used to endorse or promote products derived from
13 * this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * Authors: Gabe Black
28 */
29
30#ifndef __SYSTEMC_CORE_MODULE_HH__
31#define __SYSTEMC_CORE_MODULE_HH__
32
33#include <cassert>
34#include <map>
35#include <set>
36#include <sstream>
37#include <string>
38
39#include "systemc/core/object.hh"
40#include "systemc/ext/core/sc_module.hh"
41
42namespace sc_gem5
43{
44
45class UniqueNameGen
46{
47  private:
48    std::map<std::string, int> counts;
49    std::string buf;
50
51  public:
52    const char *
53    gen(std::string seed)
54    {
55        std::ostringstream os;
56        os << seed << "_" << counts[seed]++;
57        buf = os.str();
58        return buf.c_str();
59    }
60};
61
62class Module
63{
64  private:
65    const char *_name;
66    sc_core::sc_module *_sc_mod;
67    Object *_obj;
68
69    UniqueNameGen nameGen;
70
71  public:
72
73    Module(const char *name);
74    ~Module();
75
76    void finish(Object *this_obj);
77
78    const char *name() const { return _name; }
79
80    sc_core::sc_module *
81    sc_mod() const
82    {
83        assert(_sc_mod);
84        return _sc_mod;
85    }
86
87    void
88    sc_mod(sc_core::sc_module *sc_mod)
89    {
90        assert(!_sc_mod);
91        _sc_mod = sc_mod;
92    }
93
94    Object *
95    obj()
96    {
97        assert(_obj);
98        return _obj;
99    }
100
101    void pop();
102
103    const char *uniqueName(const char *seed) { return nameGen.gen(seed); }
104};
105
106Module *currentModule();
107Module *newModule();
108
109void callbackModule(Module *m);
110Module *callbackModule();
111
112extern std::set<Module *> allModules;
113
114} // namespace sc_gem5
115
116#endif  //__SYSTEMC_CORE_MODULE_HH__
117