forked from cocotb/cocotb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
__init__.py
192 lines (150 loc) · 6.02 KB
/
__init__.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
''' Copyright (c) 2013 Potential Ventures Ltd
Copyright (c) 2013 SolarFlare Communications Inc
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of Potential Ventures Ltd,
SolarFlare Communications Inc nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. '''
"""
Cocotb is a coroutine, cosimulation framework for writing testbenches in Python.
See http://cocotb.readthedocs.org for full documentation
"""
import os
import sys
import logging
import threading
import random
import time
import cocotb.handle
from cocotb.scheduler import Scheduler
from cocotb.log import SimLogFormatter, SimBaseLog, SimLog
from cocotb.regression import RegressionManager
# Things we want in the cocotb namespace
from cocotb.decorators import test, coroutine, function, external
# Singleton scheduler instance
# NB this cheekily ensures a singleton since we're replacing the reference
# so that cocotb.scheduler gives you the singleton instance and not the
# scheduler package
# GPI logging instance
# For autodocumentation don't need the extension modules
if "SPHINX_BUILD" not in os.environ:
import simulator
logging.basicConfig()
logging.setLoggerClass(SimBaseLog)
log = SimLog('cocotb')
level = os.getenv("COCOTB_LOG_LEVEL", "INFO")
try:
_default_log = getattr(logging, level)
except AttributeError as e:
log.error("Unable to set loging level to %s" % level)
_default_log = logging.INFO
log.setLevel(_default_log)
loggpi = SimLog('cocotb.gpi')
# Notify GPI of log level
simulator.log_level(_default_log)
scheduler = Scheduler()
regression = None
plusargs = {}
# To save typing provide an alias to scheduler.add
fork = scheduler.add
# FIXME is this really required?
_rlock = threading.RLock()
def mem_debug(port):
import cocotb.memdebug
cocotb.memdebug.start(port)
def _initialise_testbench(root_name):
"""
This function is called after the simulator has elaborated all
entities and is ready to run the test.
The test must be defined by the environment variables
MODULE
TESTCASE
"""
_rlock.acquire()
memcheck_port = os.getenv('MEMCHECK')
if memcheck_port is not None:
mem_debug(int(memcheck_port))
exec_path = os.getenv('SIM_ROOT')
if exec_path is None:
exec_path = 'Unknown'
version = os.getenv('VERSION')
if version is None:
log.info("Unable to determine Cocotb version from %s" % exec_path)
else:
log.info("Running tests with Cocotb v%s from %s" %
(version, exec_path))
# Create the base handle type
process_plusargs()
# Seed the Python random number generator to make this repeatable
seed = os.getenv('RANDOM_SEED')
if seed is None:
if 'ntb_random_seed' in plusargs:
seed = eval(plusargs['ntb_random_seed'])
elif 'seed' in plusargs:
seed = eval(plusargs['seed'])
else:
seed = int(time.time())
log.info("Seeding Python random module with %d" % (seed))
else:
seed = int(seed)
log.info("Seeding Python random module with supplied seed %d" % (seed))
random.seed(seed)
module_str = os.getenv('MODULE')
test_str = os.getenv('TESTCASE')
if not module_str:
raise ImportError("Environment variables defining the module(s) to \
execute not defined. MODULE=\"%s\"\"" % (module_str))
modules = module_str.split(',')
global regression
regression = RegressionManager(root_name, modules, tests=test_str)
regression.initialise()
regression.execute()
_rlock.release()
return True
def _sim_event(level, message):
"""Function that can be called externally to signal an event"""
SIM_INFO = 0
SIM_TEST_FAIL = 1
SIM_FAIL = 2
from cocotb.result import TestFailure, SimFailure
if level is SIM_TEST_FAIL:
scheduler.log.error("Failing test at simulator request")
scheduler.finish_test(TestFailure("Failure from external source: %s" %
message))
elif level is SIM_FAIL:
# We simply return here as the simulator will exit
# so no cleanup is needed
msg = ("Failing test at simulator request before test run completion: "
"%s" % message)
scheduler.log.error(msg)
scheduler.finish_scheduler(SimFailure(msg))
else:
scheduler.log.error("Unsupported sim event")
return True
def process_plusargs():
global plusargs
plusargs = {}
for option in cocotb.argv:
if option.startswith('+'):
if option.find('=') != -1:
(name, value) = option[1:].split('=')
plusargs[name] = value
else:
plusargs[option[1:]] = True