src/mem/ruby/network/simple/SimpleLink.hh

/*
 * Copyright (c) 2021 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.
 *
 * Copyright (c) 2011 Advanced Micro Devices, 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 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 __MEM_RUBY_NETWORK_SIMPLE_SIMPLELINK_HH__
#define __MEM_RUBY_NETWORK_SIMPLE_SIMPLELINK_HH__

#include <iostream>
#include <string>
#include <vector>

#include "params/SimpleExtLink.hh"
#include "params/SimpleIntLink.hh"
#include "mem/ruby/network/BasicLink.hh"

namespace gem5
{

namespace ruby
{

class SimpleExtLink : public BasicExtLink
{
  public:
    PARAMS(SimpleExtLink);
    SimpleExtLink(const Params &p);

    friend class Topology;
    void print(std::ostream& out) const;

    int m_bw_multiplier;
};

inline std::ostream&
operator<<(std::ostream& out, const SimpleExtLink& obj)
{
    obj.print(out);
    out << std::flush;
    return out;
}

class SimpleIntLink : public BasicIntLink
{
  public:
    PARAMS(SimpleIntLink);
    SimpleIntLink(const Params &p);

    friend class Topology;
    void print(std::ostream& out) const;

    int m_bw_multiplier;
    const std::vector<MessageBuffer*> m_buffers;
};

inline std::ostream&
operator<<(std::ostream& out, const SimpleIntLink& obj)
{
    obj.print(out);
    out << std::flush;
    return out;
}

} // namespace ruby
} // namespace gem5

#endif //__MEM_RUBY_NETWORK_SIMPLE_SIMPLELINK_HH__