1/*
2 * Copyright (c) 2017 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2008 The Hewlett-Packard Development Company
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Nathan Binkert
41 */
42
43#ifndef __SIM_INIT_HH__
44#define __SIM_INIT_HH__
45
46#include "pybind11/pybind11.h"
47
48#include <list>
49#include <map>
50#include <string>
51
52#include <inttypes.h>
53
54#ifndef PyObject_HEAD
55struct _object;
56typedef _object PyObject;
57#endif
58
59/*
60 * Data structure describing an embedded python file.
61 */
62struct EmbeddedPython
63{
64    const char *filename;
65    const char *abspath;
66    const char *modpath;
67    const uint8_t *code;
68    int zlen;
69    int len;
70
71    EmbeddedPython(const char *filename, const char *abspath,
72                   const char *modpath, const uint8_t *code, int zlen, int len);
73
74    PyObject *getCode() const;
75    bool addModule() const;
76
77    static EmbeddedPython *importer;
78    static PyObject *importerModule;
79    static std::list<EmbeddedPython *> &getList();
80    static int initAll();
81};
82
83class EmbeddedPyBind
84{
85  public:
86    EmbeddedPyBind(const char *_name,
87                   void (*init_func)(pybind11::module &),
88                   const char *_base);
89
90    EmbeddedPyBind(const char *_name,
91                   void (*init_func)(pybind11::module &));
92
93#if PY_MAJOR_VERSION >= 3
94    static PyObject *initAll();
95#else
96    static void initAll();
97#endif
98
99  private:
100    void (*initFunc)(pybind11::module &);
101
102    bool depsReady() const;
103    void init(pybind11::module &m);
104
105    bool registered;
106    const std::string name;
107    const std::string base;
108
109    static std::map<std::string, EmbeddedPyBind *> &getMap();
110};
111
112void registerNativeModules();
113
114int m5Main(int argc, char **argv);
115
116#endif // __SIM_INIT_HH__
117