cxx_config.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2014, 2025 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.
 */

 
#ifndef __SIM_CXX_CONFIG_HH__
#define __SIM_CXX_CONFIG_HH__
 
#include <map>
#include <string>
#include <vector>
 
#include "sim/sim_object.hh"
 
namespace gem5
{
 
class CxxConfigParams;

class CxxConfigDirectoryEntry
{
  public:
    /* Class to represent parameters and SimObject references within
     *  SimObjects */
    class ParamDesc
    {
      public:
        const std::string name;
 
        /* Is this a vector or singleton parameters/SimObject */
        const bool isVector;
 
        /* Is this a dictionary */
        const bool isDict;

        const bool isSimObject;
 
        ParamDesc(const std::string &name_,
            bool is_vector, bool is_dict, bool is_simobj)
          : name(name_), isVector(is_vector),
            isDict(is_dict), isSimObject(is_simobj)
        { }
    };

    class PortDesc
    {
      public:
        const std::string name;
 
        /* Is this a vector or singleton parameters/SimObject */
        const bool isVector;

        const bool isRequestor;
 
        PortDesc(const std::string &name_,
            bool isVector_, bool isRequestor_) :
            name(name_), isVector(isVector_), isRequestor(isRequestor_)
        { }
    };

    std::map<std::string, ParamDesc *> parameters;

    std::map<std::string, PortDesc *> ports;

    virtual CxxConfigParams *makeParamsObject() const { return NULL; }
 
    virtual ~CxxConfigDirectoryEntry() { }
};

std::map<std::string, CxxConfigDirectoryEntry *> &cxxConfigDirectory();

class CxxConfigParams
{
  private:
    static const std::string invalidName;
 
  protected:
    struct AddToConfigDir
    {
        AddToConfigDir(const std::string &name, CxxConfigDirectoryEntry *entry)
        {
            auto it_success = cxxConfigDirectory().insert({name, entry});
            panic_if(!it_success.second,
                    "Failed to insert config directory entry %s (duplicate?).",
                    name);
        }
    };
 
  public:
    typedef uint32_t FlagsType;
    typedef gem5::Flags<FlagsType> Flags;

    /* static const FlagsType MY_NEW_FLAG = 0x00000001; */
 
  public:
    virtual void setName(const std::string &name_) { }

    virtual const std::string &getName() { return invalidName; }

    virtual bool setSimObject(const std::string &name,
        SimObject *simObject)
    { return false; }

    virtual bool setSimObjectVector(const std::string &name,
        const std::vector<SimObject *> &simObjects)
    { return false; }

    virtual bool setParam(const std::string &name,
        const std::string &value, const Flags flags)
    { return false; }

    virtual bool setParamVector(const std::string &name,
        const std::vector<std::string> &values, const Flags flags)
    { return false; }

    virtual bool setParamDict(const std::string &name,
        const std::unordered_map<std::string, std::string> &values,
        const Flags flags)
    { return false; }

    virtual bool setPortConnectionCount(const std::string &name,
        unsigned int count)
    { return false; }

    virtual SimObject *simObjectCreate() { return NULL; }
 
    CxxConfigParams() { }
 
    virtual ~CxxConfigParams() { }
};

class CxxConfigFileBase
{
  public:
    CxxConfigFileBase() { }
    virtual ~CxxConfigFileBase() { }

    virtual bool getParam(const std::string &object_name,
        const std::string &param_name,
        std::string &value) const = 0;

    virtual bool getParamVector(const std::string &object_name,
        const std::string &param_name,
        std::vector<std::string> &values) const = 0;

    virtual bool getParamDict(const std::string &object_name,
        const std::string &param_name,
        std::unordered_map<std::string, std::string> &values) const = 0;

    virtual bool getPortPeers(const std::string &object_name,
        const std::string &port_name,
        std::vector<std::string> &peers) const = 0;

    virtual bool objectExists(const std::string &object_name) const = 0;

    virtual void getAllObjectNames(std::vector<std::string> &list) const = 0;

    virtual void getObjectChildren(const std::string &object_name,
        std::vector<std::string> &children,
        bool return_paths = false) const = 0;

    virtual bool load(const std::string &filename) = 0;

    virtual CxxConfigParams::Flags getFlags() const { return 0; }
};
 
} // namespace gem5
 
#endif // __SIM_CXX_CONFIG_HH__