module.hh revision 12982 
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 <set>
35
36#include "systemc/core/object.hh"
37#include "systemc/ext/core/sc_module.hh"
38
39namespace sc_gem5
40{
41
42class Module
43{
44  private:
45    const char *_name;
46    sc_core::sc_module *_sc_mod;
47    Object *_obj;
48
49  public:
50
51    Module(const char *name);
52    ~Module();
53
54    void finish(Object *this_obj);
55
56    const char *name() const { return _name; }
57
58    sc_core::sc_module *
59    sc_mod() const
60    {
61        assert(_sc_mod);
62        return _sc_mod;
63    }
64
65    void
66    sc_mod(sc_core::sc_module *sc_mod)
67    {
68        assert(!_sc_mod);
69        _sc_mod = sc_mod;
70    }
71
72    Object *
73    obj()
74    {
75        assert(_obj);
76        return _obj;
77    }
78
79    void pop();
80};
81
82Module *currentModule();
83Module *newModule();
84
85extern std::set<Module *> allModules;
86
87} // namespace sc_gem5
88
89#endif  //__SYSTEMC_CORE_MODULE_HH__
90