src/mem/ruby/network/BasicLink.hh

   1 /*
   2  * Copyright (c) 2011 Advanced Micro Devices, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef __MEM_RUBY_NETWORK_BASIC_LINK_HH__
  30 #define __MEM_RUBY_NETWORK_BASIC_LINK_HH__
  31
  32 #include <iostream>
  33 #include <string>
  34 #include <vector>
  35
  36 #include "params/BasicExtLink.hh"
  37 #include "params/BasicIntLink.hh"
  38 #include "params/BasicLink.hh"
  39 #include "mem/ruby/network/BasicRouter.hh"
  40 #include "mem/ruby/network/Topology.hh"
  41 #include "mem/ruby/slicc_interface/AbstractController.hh"
  42 #include "sim/sim_object.hh"
  43
  44 class BasicLink : public SimObject
  45 {
  46   public:
  47     typedef BasicLinkParams Params;
  48     BasicLink(const Params *p);
  49     const Params *params() const { return (const Params *)_params; }
  50
  51     void init();
  52
  53     void print(std::ostream& out) const;
  54
  55     int m_latency;
  56     int m_bandwidth_factor;
  57     int m_weight;
  58 };
  59
  60 inline std::ostream&
  61 operator<<(std::ostream& out, const BasicLink& obj)
  62 {
  63     obj.print(out);
  64     out << std::flush;
  65     return out;
  66 }
  67
  68 class BasicExtLink : public BasicLink
  69 {
  70   public:
  71     typedef BasicExtLinkParams Params;
  72     BasicExtLink(const Params *p);
  73     const Params *params() const { return (const Params *)_params; }
  74
  75     friend class Topology;
  76
  77   protected:
  78     BasicRouter* m_int_node;
  79     AbstractController* m_ext_node;
  80 };
  81
  82 class BasicIntLink : public BasicLink
  83 {
  84   public:
  85     typedef BasicIntLinkParams Params;
  86     BasicIntLink(const Params *p);
  87     const Params *params() const { return (const Params *)_params; }
  88
  89     friend class Topology;
  90
  91   protected:
  92     BasicRouter* m_node_a;
  93     BasicRouter* m_node_b;
  94 };
  95
  96 #endif // __MEM_RUBY_NETWORK_BASIC_LINK_HH__