src/mem/ruby/network/BasicRouter.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_ROUTER_HH__
  30 #define __MEM_RUBY_NETWORK_BASIC_ROUTER_HH__
  31
  32 #include <iostream>
  33 #include <string>
  34 #include <vector>
  35
  36 #include "params/BasicRouter.hh"
  37 #include "sim/clocked_object.hh"
  38
  39 class BasicRouter : public ClockedObject
  40 {
  41   public:
  42     typedef BasicRouterParams Params;
  43     BasicRouter(const Params *p);
  44     const Params *params() const { return (const Params *)_params; }
  45
  46     void init();
  47
  48     void print(std::ostream& out) const;
  49   protected:
  50     //
  51     // ID in relation to other routers in the system
  52     //
  53     uint32_t m_id;
  54 };
  55
  56 inline std::ostream&
  57 operator<<(std::ostream& out, const BasicRouter& obj)
  58 {
  59     obj.print(out);
  60     out << std::flush;
  61     return out;
  62 }
  63
  64 #endif // __MEM_RUBY_NETWORK_BASIC_ROUTER_HH__