sc_port.hh revision 13090:25d3d4a9affd
111723Sar4jc@virginia.edu/* 211723Sar4jc@virginia.edu * Copyright 2018 Google, Inc. 311723Sar4jc@virginia.edu * 411723Sar4jc@virginia.edu * Redistribution and use in source and binary forms, with or without 511723Sar4jc@virginia.edu * modification, are permitted provided that the following conditions are 611723Sar4jc@virginia.edu * met: redistributions of source code must retain the above copyright 711723Sar4jc@virginia.edu * notice, this list of conditions and the following disclaimer; 811723Sar4jc@virginia.edu * redistributions in binary form must reproduce the above copyright 911723Sar4jc@virginia.edu * notice, this list of conditions and the following disclaimer in the 1011723Sar4jc@virginia.edu * documentation and/or other materials provided with the distribution; 1111723Sar4jc@virginia.edu * neither the name of the copyright holders nor the names of its 1211723Sar4jc@virginia.edu * contributors may be used to endorse or promote products derived from 1311723Sar4jc@virginia.edu * this software without specific prior written permission. 1411723Sar4jc@virginia.edu * 1511723Sar4jc@virginia.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1611723Sar4jc@virginia.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1711723Sar4jc@virginia.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1811723Sar4jc@virginia.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1911723Sar4jc@virginia.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2011723Sar4jc@virginia.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2111723Sar4jc@virginia.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2211723Sar4jc@virginia.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2311723Sar4jc@virginia.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2411723Sar4jc@virginia.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2511723Sar4jc@virginia.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2611723Sar4jc@virginia.edu * 2711723Sar4jc@virginia.edu * Authors: Gabe Black 2811723Sar4jc@virginia.edu */ 2911723Sar4jc@virginia.edu 3011723Sar4jc@virginia.edu#ifndef __SYSTEMC_EXT_CORE_SC_PORT_HH__ 3111723Sar4jc@virginia.edu#define __SYSTEMC_EXT_CORE_SC_PORT_HH__ 3211723Sar4jc@virginia.edu 3311723Sar4jc@virginia.edu#include <vector> 3411723Sar4jc@virginia.edu 3511723Sar4jc@virginia.edu#include "../utils/sc_report_handler.hh" 3611723Sar4jc@virginia.edu#include "sc_module.hh" // for sc_gen_unique_name 3711723Sar4jc@virginia.edu#include "sc_object.hh" 3811723Sar4jc@virginia.edu 3911723Sar4jc@virginia.edunamespace sc_gem5 4011723Sar4jc@virginia.edu{ 4111723Sar4jc@virginia.edu 4211723Sar4jc@virginia.educlass BindInfo; 4311723Sar4jc@virginia.educlass PendingSensitivityPort; 4411723Sar4jc@virginia.edu 4511723Sar4jc@virginia.edu}; 4611723Sar4jc@virginia.edu 4711723Sar4jc@virginia.edunamespace sc_core 4811723Sar4jc@virginia.edu{ 4911723Sar4jc@virginia.edu 5011723Sar4jc@virginia.educlass sc_interface; 5111723Sar4jc@virginia.edu 5211723Sar4jc@virginia.eduenum sc_port_policy 5311723Sar4jc@virginia.edu{ 5411723Sar4jc@virginia.edu SC_ONE_OR_MORE_BOUND, // Default 5511723Sar4jc@virginia.edu SC_ZERO_OR_MORE_BOUND, 5611723Sar4jc@virginia.edu SC_ALL_BOUND 5711723Sar4jc@virginia.edu}; 5811723Sar4jc@virginia.edu 5911723Sar4jc@virginia.educlass sc_port_base : public sc_object 6011723Sar4jc@virginia.edu{ 6111723Sar4jc@virginia.edu public: 6211723Sar4jc@virginia.edu sc_port_base(const char *name, int n, sc_port_policy p); 6311723Sar4jc@virginia.edu 6411723Sar4jc@virginia.edu void warn_unimpl(const char *func) const; 6511723Sar4jc@virginia.edu 6611723Sar4jc@virginia.edu int maxSize() const; 6711723Sar4jc@virginia.edu int size() const; 6811723Sar4jc@virginia.edu 6911723Sar4jc@virginia.edu protected: 7011723Sar4jc@virginia.edu // Implementation defined, but depended on by the tests. 7111723Sar4jc@virginia.edu void bind(sc_interface &); 7211723Sar4jc@virginia.edu void bind(sc_port_base &); 7311723Sar4jc@virginia.edu 7411723Sar4jc@virginia.edu // Implementation defined, but depended on by the tests. 7511723Sar4jc@virginia.edu virtual int vbind(sc_interface &) = 0; 7611723Sar4jc@virginia.edu virtual int vbind(sc_port_base &) = 0; 7711723Sar4jc@virginia.edu 7811723Sar4jc@virginia.edu virtual void before_end_of_elaboration() = 0; 7911723Sar4jc@virginia.edu virtual void end_of_elaboration() = 0; 8011723Sar4jc@virginia.edu virtual void start_of_simulation() = 0; 8111723Sar4jc@virginia.edu virtual void end_of_simulation() = 0; 8211723Sar4jc@virginia.edu 8311723Sar4jc@virginia.edu private: 8411723Sar4jc@virginia.edu friend class ::sc_gem5::PendingSensitivityPort; 8511723Sar4jc@virginia.edu friend class ::sc_gem5::Kernel; 8611723Sar4jc@virginia.edu 8711723Sar4jc@virginia.edu void _gem5Finalize(); 8811723Sar4jc@virginia.edu 8911723Sar4jc@virginia.edu virtual sc_interface *_gem5Interface(int n) const = 0; 9011723Sar4jc@virginia.edu virtual void _gem5AddInterface(sc_interface *i) = 0; 9111723Sar4jc@virginia.edu 9211723Sar4jc@virginia.edu std::vector<::sc_gem5::BindInfo *> _gem5BindInfo; 9311723Sar4jc@virginia.edu int _maxSize; 9411723Sar4jc@virginia.edu int _size; 9511723Sar4jc@virginia.edu bool finalized; 9611723Sar4jc@virginia.edu}; 9711723Sar4jc@virginia.edu 9811723Sar4jc@virginia.edutemplate <class IF> 9911723Sar4jc@virginia.educlass sc_port_b : public sc_port_base 10011723Sar4jc@virginia.edu{ 10111723Sar4jc@virginia.edu public: 10211723Sar4jc@virginia.edu void operator () (IF &i) { bind(i); } 10311723Sar4jc@virginia.edu void operator () (sc_port_b<IF> &p) { bind(p); } 10411723Sar4jc@virginia.edu 10511723Sar4jc@virginia.edu virtual void bind(IF &i) { sc_port_base::bind(i); } 10611723Sar4jc@virginia.edu virtual void bind(sc_port_b<IF> &p) { sc_port_base::bind(p); } 10711723Sar4jc@virginia.edu 10811723Sar4jc@virginia.edu IF * 10911723Sar4jc@virginia.edu operator -> () 11011723Sar4jc@virginia.edu { 11111723Sar4jc@virginia.edu sc_assert(!_interfaces.empty()); 11211723Sar4jc@virginia.edu return _interfaces[0]; 11311723Sar4jc@virginia.edu } 11411723Sar4jc@virginia.edu const IF * 11511723Sar4jc@virginia.edu operator -> () const 11611723Sar4jc@virginia.edu { 11711723Sar4jc@virginia.edu sc_assert(!_interfaces.empty()); 11811723Sar4jc@virginia.edu return _interfaces[0]; 11911723Sar4jc@virginia.edu } 12011723Sar4jc@virginia.edu 12111723Sar4jc@virginia.edu IF * 122 operator [] (int n) 123 { 124 sc_assert(_interfaces.size() > n); 125 return _interfaces[n]; 126 } 127 const IF * 128 operator [] (int n) const 129 { 130 sc_assert(_interfaces.size() > n); 131 return _interfaces[n]; 132 } 133 134 sc_interface * 135 get_interface() 136 { 137 sc_assert(!_interfaces.empty()); 138 return _interfaces[0]; 139 } 140 const sc_interface * 141 get_interface() const 142 { 143 sc_assert(!_interfaces.empty()); 144 return _interfaces[0]; 145 } 146 147 protected: 148 void before_end_of_elaboration() {} 149 void end_of_elaboration() {} 150 void start_of_simulation() {} 151 void end_of_simulation() {} 152 153 explicit sc_port_b(int n, sc_port_policy p) : 154 sc_port_base(sc_gen_unique_name("port"), n, p) 155 {} 156 sc_port_b(const char *name, int n, sc_port_policy p) : 157 sc_port_base(name, n, p) 158 {} 159 virtual ~sc_port_b() {} 160 161 // Implementation defined, but depended on by the tests. 162 int 163 vbind(sc_interface &i) 164 { 165 IF *interface = dynamic_cast<IF *>(&i); 166 if (!interface) 167 return 2; 168 sc_port_base::bind(*interface); 169 return 0; 170 } 171 int 172 vbind(sc_port_base &pb) 173 { 174 sc_port_b<IF> *p = dynamic_cast<sc_port_b<IF> *>(&pb); 175 if (!p) 176 return 2; 177 sc_port_base::bind(*p); 178 return 0; 179 } 180 181 private: 182 std::vector<IF *> _interfaces; 183 184 sc_interface * 185 _gem5Interface(int n) const 186 { 187 sc_assert(_interfaces.size() > n); 188 return _interfaces[n]; 189 } 190 void 191 _gem5AddInterface(sc_interface *i) 192 { 193 IF *interface = dynamic_cast<IF *>(i); 194 sc_assert(interface); 195 _interfaces.push_back(interface); 196 } 197 198 // Disabled 199 sc_port_b() {} 200 sc_port_b(const sc_port_b<IF> &) {} 201 sc_port_b<IF> &operator = (const sc_port_b<IF> &) { return *this; } 202}; 203 204template <class IF, int N=1, sc_port_policy P=SC_ONE_OR_MORE_BOUND> 205class sc_port : public sc_port_b<IF> 206{ 207 public: 208 sc_port() : sc_port_b<IF>(N, P) {} 209 explicit sc_port(const char *name) : sc_port_b<IF>(name, N, P) {} 210 virtual ~sc_port() {} 211 212 // Deprecated binding constructors. 213 explicit sc_port(const IF &interface) : sc_port_b<IF>(N, P) 214 { 215 this->warn_unimpl(__PRETTY_FUNCTION__); 216 // Should warn that these are deprecated. See Accellera sc_port.h. 217 sc_port_b<IF>::bind(const_cast<IF &>(interface)); 218 } 219 sc_port(const char *name, const IF &interface) : sc_port_b<IF>(name, N, P) 220 { 221 this->warn_unimpl(__PRETTY_FUNCTION__); 222 // Should warn that these are deprecated. See Accellera sc_port.h. 223 sc_port_b<IF>::bind(const_cast<IF &>(interface)); 224 } 225 explicit sc_port(sc_port_b<IF> &parent) : sc_port_b<IF>(N, P) 226 { 227 this->warn_unimpl(__PRETTY_FUNCTION__); 228 // Should warn that these are deprecated. See Accellera sc_port.h. 229 sc_port_b<IF>::bind(parent); 230 } 231 sc_port(const char *name, sc_port_b<IF> &parent) : 232 sc_port_b<IF>(name, N, P) 233 { 234 this->warn_unimpl(__PRETTY_FUNCTION__); 235 // Should warn that these are deprecated. See Accellera sc_port.h. 236 sc_port_b<IF>::bind(parent); 237 } 238 explicit sc_port(sc_port<IF, N, P> &parent) : sc_port_b<IF>(N, P) 239 { 240 this->warn_unimpl(__PRETTY_FUNCTION__); 241 // Should warn that these are deprecated. See Accellera sc_port.h. 242 sc_port_b<IF>::bind(parent); 243 } 244 sc_port(const char *name, sc_port<IF, N, P> &parent) : 245 sc_port_b<IF>(name, N, P) 246 { 247 this->warn_unimpl(__PRETTY_FUNCTION__); 248 // Should warn that these are deprecated. See Accellera sc_port.h. 249 sc_port_b<IF>::bind(parent); 250 } 251 252 virtual const char *kind() const { return "sc_port"; } 253 254 private: 255 // Disabled 256 sc_port(const sc_port<IF, N, P> &) {} 257 sc_port<IF, N, P> &operator = (const sc_port<IF, N, P> &) { return *this; } 258}; 259 260} // namespace sc_core 261 262#endif //__SYSTEMC_EXT_CORE_SC_PORT_HH__ 263