src/cpu/testers/traffic_gen/pygen.cc

/*
 * Copyright (c) 2018 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * 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 the copyright holders 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 THE COPYRIGHT
 * OWNER OR CONTRIBUTORS 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.
 */
#include "cpu/testers/traffic_gen/pygen.hh"

#include "base/trace.hh"
#include "config/have_protobuf.hh"
#include "debug/TrafficGen.hh"
#include "params/PyTrafficGen.hh"
#include "sim/init.hh"

namespace py = pybind11;

namespace gem5
{

PyTrafficGen::PyTrafficGen(const PyTrafficGenParams &p)
    : BaseTrafficGen(p)
{
}

void
PyTrafficGen::start(pybind11::object meta_generator)
{
    metaGenerator = meta_generator.begin();
    BaseTrafficGen::start();
}

std::shared_ptr<BaseGen>
PyTrafficGen::nextGenerator()
{
    if (!metaGenerator)
        return std::shared_ptr<BaseGen>();

    if (metaGenerator == py::iterator::sentinel()) {
        DPRINTF(TrafficGen, "No more generators available.\n");
        return std::shared_ptr<BaseGen>();
    }

    try {
        DPRINTF(TrafficGen, "Casting to C++ base class.\n");
        std::shared_ptr<BaseGen> gen =
            metaGenerator->cast<std::shared_ptr<BaseGen>>();
        metaGenerator++;
        return gen;
    } catch (py::cast_error&) {
        fatal("Meta generator didn't return a valid trace generator\n");
    }
}

void
pybind_init_tracers(py::module_ &m_native)
{
    using namespace pybind11::literals;

    py::module_ m = m_native.def_submodule("trace");

    py::class_<BaseGen, std::shared_ptr<BaseGen>> c_base(m, "BaseGen");
}

static EmbeddedPyBind _py_tracers("trace", pybind_init_tracers);

} // namespace gem5