cocotb 2.0.0rc2__cp311-cp311-macosx_11_0_arm64.whl

cocotb/result.py

@@ -0,0 +1,38 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+import warnings
+
+
+def __getattr__(name: str) -> object:
+    if name == "TestSuccess":
+        warnings.warn(
+            "`raise TestSuccess` is deprecated. Use `cocotb.pass_test()` instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        from cocotb._test_functions import TestSuccess  # noqa: PLC0415
+
+        return TestSuccess
+
+    elif name == "SimFailure":
+        warnings.warn(
+            "SimFailure was moved to `cocotb.regression`.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        from cocotb.regression import SimFailure  # noqa: PLC0415
+
+        return SimFailure
+
+    elif name == "SimTimeoutError":
+        warnings.warn(
+            "SimTimeoutError was moved from `cocotb.result` to `cocotb.triggers`.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        from cocotb.triggers import SimTimeoutError  # noqa: PLC0415
+
+        return SimTimeoutError
+
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

cocotb/share/def/.gitignore

@@ -0,0 +1,2 @@
+# Generated import libraries on Windows
+*.a

cocotb/share/def/README.md

@@ -0,0 +1,4 @@
+This directory contains module-definition files (`.def`).
+On Windows these are used to generate import libraries (`.a`, but not regular static libraries), which means we can compile our libraries without having the simulator binaries available.
+They are not needed on other platforms.
+More details on `.def` files can be found at http://www.mingw.org/wiki/msvc_and_mingw_dlls

cocotb/share/def/aldec.def

@@ -0,0 +1,61 @@
+LIBRARY "aldecpli.dll"
+EXPORTS
+vpi_chk_error
+vpi_compare_objects
+vpi_control
+vpi_flush
+vpi_fopen
+vpi_free_object
+vpi_get
+vpi_get_delays
+vpi_get_file
+vpi_get_str
+vpi_get_systf_info
+vpi_get_time
+vpi_get_userdata
+vpi_get_value
+vpi_get_vlog_info
+vpi_handle
+vpi_handle_by_index
+vpi_handle_by_name
+vpi_iterate
+vpi_mcd_close
+vpi_mcd_flush
+vpi_mcd_name
+vpi_mcd_open
+vpi_mcd_printf
+vpi_mcd_vprintf
+vpi_printf
+vpi_put_delays
+vpi_put_userdata
+vpi_put_value
+vpi_register_cb
+vpi_register_systf
+vpi_remove_cb
+vpi_scan
+vpi_sim_control
+vpi_sim_vcontrol
+vpi_vprintf
+vpip_count_drivers
+vpip_format_strength
+vpip_make_systf_system_defined
+vpip_mcd_rawwrite
+vpip_set_return_value
+vhpi_check_error
+vhpi_control
+vhpi_disable_cb
+vhpi_enable_cb
+vhpi_get
+vhpi_get_phys
+vhpi_get_str
+vhpi_get_time
+vhpi_get_value
+vhpi_handle
+vhpi_handle_by_index
+vhpi_handle_by_name
+vhpi_iterator
+vhpi_put_value
+vhpi_register_cb
+vhpi_release_handle
+vhpi_remove_cb
+vhpi_scan

cocotb/share/def/ghdl.def

@@ -0,0 +1,43 @@
+LIBRARY "libghdlvpi.dll"
+EXPORTS
+vpi_compare_objects
+vpi_control
+vpi_flush
+vpi_fopen
+vpi_free_object
+vpi_get
+vpi_get_delays
+vpi_get_file
+vpi_get_str
+vpi_get_systf_info
+vpi_get_time
+vpi_get_userdata
+vpi_get_value
+vpi_get_vlog_info
+vpi_handle
+vpi_handle_by_index
+vpi_handle_by_name
+vpi_iterate
+vpi_mcd_close
+vpi_mcd_flush
+vpi_mcd_name
+vpi_mcd_printf
+vpi_mcd_vprintf
+vpi_printf
+vpi_put_delays
+vpi_put_userdata
+vpi_put_value
+vpi_register_cb
+vpi_register_systf
+vpi_remove_cb
+vpi_scan
+vpi_sim_control
+vpi_sim_vcontrol
+vpi_mcd_open
+vpi_vprintf
+vpip_count_drivers
+vpip_format_strength
+vpip_make_systf_system_defined
+vpip_mcd_rawwrite
+vpip_set_return_value
+vpi_chk_error

cocotb/share/def/icarus.def

@@ -0,0 +1,43 @@
+LIBRARY "vvp.exe"
+EXPORTS
+vpi_compare_objects
+vpi_control
+vpi_flush
+vpi_fopen
+vpi_free_object
+vpi_get
+vpi_get_delays
+vpi_get_file
+vpi_get_str
+vpi_get_systf_info
+vpi_get_time
+vpi_get_userdata
+vpi_get_value
+vpi_get_vlog_info
+vpi_handle
+vpi_handle_by_index
+vpi_handle_by_name
+vpi_iterate
+vpi_mcd_close
+vpi_mcd_flush
+vpi_mcd_name
+vpi_mcd_printf
+vpi_mcd_vprintf
+vpi_printf
+vpi_put_delays
+vpi_put_userdata
+vpi_put_value
+vpi_register_cb
+vpi_register_systf
+vpi_remove_cb
+vpi_scan
+vpi_sim_control
+vpi_sim_vcontrol
+vpi_mcd_open
+vpi_vprintf
+vpip_count_drivers
+vpip_format_strength
+vpip_make_systf_system_defined
+vpip_mcd_rawwrite
+vpip_set_return_value
+vpi_chk_error

cocotb/share/def/modelsim.def

@@ -0,0 +1,138 @@
+LIBRARY "mtipli.dll"
+EXPORTS
+vpi_chk_error
+vpi_compare_objects
+vpi_control
+vpi_flush
+vpi_fopen
+vpi_free_object
+vpi_get
+vpi_get_delays
+vpi_get_file
+vpi_get_str
+vpi_get_systf_info
+vpi_get_time
+vpi_get_userdata
+vpi_get_value
+vpi_get_vlog_info
+vpi_handle
+vpi_handle_by_index
+vpi_handle_by_name
+vpi_iterate
+vpi_mcd_close
+vpi_mcd_flush
+vpi_mcd_name
+vpi_mcd_open
+vpi_mcd_printf
+vpi_mcd_vprintf
+vpi_printf
+vpi_put_delays
+vpi_put_userdata
+vpi_put_value
+vpi_register_cb
+vpi_register_systf
+vpi_remove_cb
+vpi_scan
+vpi_sim_control
+vpi_sim_vcontrol
+vpi_vprintf
+vpip_count_drivers
+vpip_format_strength
+vpip_make_systf_system_defined
+vpip_mcd_rawwrite
+vpip_set_return_value
+acc_fetch_fullname
+acc_fetch_fulltype
+acc_fetch_name
+acc_fetch_type
+acc_fetch_type_str
+mti_AddLoadDoneCB
+mti_AddQuitCB
+mti_Break
+mti_CreateProcess
+mti_CreateProcessWithPriority
+mti_Delta
+mti_Desensitize
+mti_FindRegion
+mti_FindSignal
+mti_FindVar
+mti_FirstLowerRegion
+mti_FirstLowerRegion
+mti_FirstSignal
+mti_FirstVarByRegion
+mti_ForceSignal
+mti_GetArrayElementType
+mti_GetArraySignalValue
+mti_GetArrayVarValue
+mti_GetEnumValues
+mti_GetNumRecordElements
+mti_GetPrimaryName
+mti_GetProductVersion
+mti_GetRegionFullName
+mti_GetRegionName
+mti_GetRegionSourceName
+mti_GetResolutionLimit
+mti_GetSignalName
+mti_GetSignalNameIndirect
+mti_GetSignalSubelements
+mti_GetSignalType
+mti_GetSignalValue
+mti_GetSignalValueIndirect
+mti_GetTopRegion
+mti_GetTypeKind
+mti_GetVarKind
+mti_GetVarName
+mti_GetVarSubelements
+mti_GetVarType
+mti_GetVarValue
+mti_GetVarValueIndirect
+mti_NextRegion
+mti_NextSignal
+mti_NextVar
+mti_Now
+mti_NowUpper
+mti_Quit
+mti_ReleaseSignal
+mti_RemoveLoadDoneCB
+mti_RemoveQuitCB
+mti_ScheduleWakeup
+mti_ScheduleWakeup64
+mti_Sensitize
+mti_SetSignalValue
+mti_SetVarValue
+mti_TickDir
+mti_TickLeft
+mti_TickLength
+mti_TickRight
+mti_VsimFree
+mti_Interp
+mti_Cmd
+Tcl_GetStringResult
+Tcl_ResetResult
+Tcl_GetObjResult
+Tcl_ResetResult
+Tcl_ListObjGetElements
+Tcl_GetStringResult
+TclFreeObj
+Tcl_ResetResult
+Tcl_ResetResult
+Tcl_GetString
+TclFreeObj
+vhpi_check_error
+vhpi_control
+vhpi_disable_cb
+vhpi_enable_cb
+vhpi_get
+vhpi_get_phys
+vhpi_get_str
+vhpi_get_time
+vhpi_get_value
+vhpi_handle
+vhpi_handle_by_index
+vhpi_handle_by_name
+vhpi_iterator
+vhpi_put_value
+vhpi_register_cb
+vhpi_release_handle
+vhpi_remove_cb
+vhpi_scan

cocotb/share/include/cocotb_utils.h

@@ -0,0 +1,70 @@
+// Copyright cocotb contributors
+// Copyright (c) 2013 Potential Ventures Ltd
+// Copyright (c) 2013 SolarFlare Communications Inc
+// Licensed under the Revised BSD License, see LICENSE for details.
+// SPDX-License-Identifier: BSD-3-Clause
+
+#ifndef COCOTB_UTILS_H_
+#define COCOTB_UTILS_H_
+
+#include <exports.h>
+#ifdef COCOTBUTILS_EXPORTS
+#define COCOTBUTILS_EXPORT COCOTB_EXPORT
+#else
+#define COCOTBUTILS_EXPORT COCOTB_IMPORT
+#endif
+
+#include <gpi_logging.h>
+
+#define xstr(a) str(a)
+#define str(a) #a
+
+extern "C" COCOTBUTILS_EXPORT void *utils_dyn_open(const char *lib_name);
+extern "C" COCOTBUTILS_EXPORT void *utils_dyn_sym(void *handle,
+                                                  const char *sym_name);
+extern "C" COCOTBUTILS_EXPORT int is_python_context;
+
+// to_python and to_simulator are implemented as macros instead of functions so
+// that the logs reference the user's lineno and filename
+
+#define to_python()                                      \
+    do {                                                 \
+        if (is_python_context) {                         \
+            LOG_ERROR("FATAL: We are calling up again"); \
+            exit(1);                                     \
+        }                                                \
+        ++is_python_context;                             \
+        LOG_TRACE("Returning to Python");                \
+    } while (0)
+
+#define to_simulator()                                              \
+    do {                                                            \
+        if (!is_python_context) {                                   \
+            LOG_ERROR("FATAL: We have returned twice from Python"); \
+            exit(1);                                                \
+        }                                                           \
+        --is_python_context;                                        \
+        LOG_TRACE("Returning to simulator");                        \
+    } while (0)
+
+template <typename F>
+class Deferable {
+  public:
+    constexpr Deferable(F f) : f_(f) {};
+    ~Deferable() { f_(); }
+
+  private:
+    F f_;
+};
+
+template <typename F>
+constexpr Deferable<F> make_deferable(F f) {
+    return Deferable<F>(f);
+}
+
+#define DEFER1(a, b) a##b
+#define DEFER0(a, b) DEFER1(a, b)
+#define DEFER(statement) \
+    auto DEFER0(_defer, __COUNTER__) = make_deferable([&]() { statement; });
+
+#endif /* COCOTB_UTILS_H_ */

cocotb/share/include/embed.h

@@ -0,0 +1,33 @@
+// Copyright cocotb contributors
+// Copyright (c) 2013 Potential Ventures Ltd
+// Copyright (c) 2013 SolarFlare Communications Inc
+// Licensed under the Revised BSD License, see LICENSE for details.
+// SPDX-License-Identifier: BSD-3-Clause
+
+#ifndef COCOTB_EMBED_H_
+#define COCOTB_EMBED_H_
+
+#include <exports.h>
+#ifdef COCOTB_EMBED_EXPORTS
+#define COCOTB_EMBED_EXPORT COCOTB_EXPORT
+#else
+#define COCOTB_EMBED_EXPORT COCOTB_IMPORT
+#endif
+
+#include <gpi.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+extern COCOTB_EMBED_EXPORT void embed_init_python(void);
+extern COCOTB_EMBED_EXPORT void embed_sim_cleanup(void);
+extern COCOTB_EMBED_EXPORT int embed_sim_init(int argc,
+                                              char const *const *argv);
+extern COCOTB_EMBED_EXPORT void embed_sim_event(const char *msg);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* COCOTB_EMBED_H_ */

cocotb/share/include/exports.h

@@ -0,0 +1,20 @@
+// Copyright cocotb contributors
+// Licensed under the Revised BSD License, see LICENSE for details.
+// SPDX-License-Identifier: BSD-3-Clause
+
+#ifndef COCOTB_EXPORTS_H_
+#define COCOTB_EXPORTS_H_
+
+// Make cocotb work correctly when the default visibility is changed to hidden
+// Changing the default visibility to hidden has the advantage of significantly
+// reducing the code size and load times, as well as letting the optimizer
+// produce better code.
+#if _WIN32
+#define COCOTB_EXPORT __declspec(dllexport)
+#define COCOTB_IMPORT __declspec(dllimport)
+#else
+#define COCOTB_EXPORT __attribute__((visibility("default")))
+#define COCOTB_IMPORT
+#endif
+
+#endif