sc_time.cc revision 13263
1/* 2 * Copyright 2018 Google, Inc. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: redistributions of source code must retain the above copyright 7 * notice, this list of conditions and the following disclaimer; 8 * redistributions in binary form must reproduce the above copyright 9 * notice, this list of conditions and the following disclaimer in the 10 * documentation and/or other materials provided with the distribution; 11 * neither the name of the copyright holders nor the names of its 12 * contributors may be used to endorse or promote products derived from 13 * this software without specific prior written permission. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 * 27 * Authors: Gabe Black 28 */ 29 30#include <sstream> 31#include <vector> 32 33#include "base/logging.hh" 34#include "base/types.hh" 35#include "python/pybind11/pybind.hh" 36#include "sim/core.hh" 37#include "systemc/core/python.hh" 38#include "systemc/core/time.hh" 39#include "systemc/ext/core/sc_main.hh" 40#include "systemc/ext/core/sc_time.hh" 41#include "systemc/ext/utils/sc_report_handler.hh" 42 43namespace sc_core 44{ 45 46namespace 47{ 48 49bool timeFixed = false; 50bool pythonReady = false; 51 52struct SetInfo 53{ 54 SetInfo(::sc_core::sc_time *time, double d, ::sc_core::sc_time_unit tu) : 55 time(time), d(d), tu(tu) 56 {} 57 58 ::sc_core::sc_time *time; 59 double d; 60 ::sc_core::sc_time_unit tu; 61}; 62std::vector<SetInfo> toSet; 63 64void 65setWork(sc_time *time, double d, ::sc_core::sc_time_unit tu) 66{ 67 double scale = sc_gem5::TimeUnitScale[tu] * SimClock::Float::s; 68 // Accellera claims there is a linux bug, and that these next two 69 // lines work around them. 70 volatile double tmp = d * scale + 0.5; 71 *time = sc_time::from_value(static_cast<uint64_t>(tmp)); 72} 73 74void 75fixTime() 76{ 77 auto ticks = pybind11::module::import("m5.ticks"); 78 auto fix_global_frequency = ticks.attr("fixGlobalFrequency"); 79 fix_global_frequency(); 80 81 for (auto &t: toSet) 82 setWork(t.time, t.d, t.tu); 83 toSet.clear(); 84} 85 86void 87attemptToFixTime() 88{ 89 // Only fix time once. 90 if (!timeFixed) { 91 timeFixed = true; 92 93 // If we've run, python is working and we haven't fixed time yet. 94 if (pythonReady) 95 fixTime(); 96 } 97} 98 99void 100setGlobalFrequency(Tick ticks_per_second) 101{ 102 auto ticks = pybind11::module::import("m5.ticks"); 103 auto set_global_frequency = ticks.attr("setGlobalFrequency"); 104 set_global_frequency(ticks_per_second); 105 fixTime(); 106} 107 108void 109set(::sc_core::sc_time *time, double d, ::sc_core::sc_time_unit tu) 110{ 111 if (d != 0) 112 attemptToFixTime(); 113 if (pythonReady) { 114 // Time should be working. Set up this sc_time. 115 setWork(time, d, tu); 116 } else { 117 // Time isn't set up yet. Defer setting up this sc_time. 118 toSet.emplace_back(time, d, tu); 119 } 120} 121 122class TimeSetter : public ::sc_gem5::PythonReadyFunc 123{ 124 public: 125 TimeSetter() : ::sc_gem5::PythonReadyFunc() {} 126 127 void 128 run() override 129 { 130 // Record that we've run and python/pybind should be usable. 131 pythonReady = true; 132 133 // If time is already fixed, let python know. 134 if (timeFixed) 135 fixTime(); 136 } 137} timeSetter; 138 139double defaultUnit = 1.0e-9; 140 141} // anonymous namespace 142 143sc_time::sc_time() : val(0) {} 144 145sc_time::sc_time(double d, sc_time_unit tu) 146{ 147 val = 0; 148 set(this, d, tu); 149} 150 151sc_time::sc_time(const sc_time &t) 152{ 153 val = t.val; 154} 155 156sc_time::sc_time(double d, bool scale) 157{ 158 double scaler = scale ? defaultUnit : SimClock::Float::Hz; 159 set(this, d * scaler, SC_SEC); 160} 161 162sc_time::sc_time(sc_dt::uint64 v, bool scale) 163{ 164 double scaler = scale ? defaultUnit : SimClock::Float::Hz; 165 set(this, static_cast<double>(v) * scaler, SC_SEC); 166} 167 168sc_time & 169sc_time::operator = (const sc_time &t) 170{ 171 val = t.val; 172 return *this; 173} 174 175sc_dt::uint64 176sc_time::value() const 177{ 178 return val; 179} 180 181double 182sc_time::to_double() const 183{ 184 return static_cast<double>(val); 185} 186double 187sc_time::to_seconds() const 188{ 189 return to_double() * SimClock::Float::Hz; 190} 191 192const std::string 193sc_time::to_string() const 194{ 195 std::ostringstream ss; 196 print(ss); 197 return ss.str(); 198} 199 200bool 201sc_time::operator == (const sc_time &t) const 202{ 203 return val == t.val; 204} 205 206bool 207sc_time::operator != (const sc_time &t) const 208{ 209 return val != t.val; 210} 211 212bool 213sc_time::operator < (const sc_time &t) const 214{ 215 return val < t.val; 216} 217 218bool 219sc_time::operator <= (const sc_time &t) const 220{ 221 return val <= t.val; 222} 223 224bool 225sc_time::operator > (const sc_time &t) const 226{ 227 return val > t.val; 228} 229 230bool 231sc_time::operator >= (const sc_time &t) const 232{ 233 return val >= t.val; 234} 235 236sc_time & 237sc_time::operator += (const sc_time &t) 238{ 239 val += t.val; 240 return *this; 241} 242 243sc_time & 244sc_time::operator -= (const sc_time &t) 245{ 246 val -= t.val; 247 return *this; 248} 249 250sc_time & 251sc_time::operator *= (double d) 252{ 253 val = static_cast<int64_t>(static_cast<double>(val) * d + 0.5); 254 return *this; 255} 256 257sc_time & 258sc_time::operator /= (double d) 259{ 260 val = static_cast<int64_t>(static_cast<double>(val) / d + 0.5); 261 return *this; 262} 263 264void 265sc_time::print(std::ostream &os) const 266{ 267 os << sc_time_tuple(*this).to_string(); 268} 269 270sc_time 271sc_time::from_value(sc_dt::uint64 u) 272{ 273 if (u) 274 attemptToFixTime(); 275 sc_time t; 276 t.val = u; 277 return t; 278} 279 280sc_time 281sc_time::from_seconds(double d) 282{ 283 sc_time t; 284 set(&t, d, SC_SEC); 285 return t; 286} 287 288sc_time 289sc_time::from_string(const char *str) 290{ 291 warn("%s not implemented.\n", __PRETTY_FUNCTION__); 292 return sc_time(); 293} 294 295const sc_time 296operator + (const sc_time &a, const sc_time &b) 297{ 298 return sc_time::from_value(a.value() + b.value()); 299} 300 301const sc_time 302operator - (const sc_time &a, const sc_time &b) 303{ 304 return sc_time::from_value(a.value() - b.value()); 305} 306 307const sc_time 308operator * (const sc_time &t, double d) 309{ 310 volatile double tmp = static_cast<double>(t.value()) * d + 0.5; 311 return sc_time::from_value(static_cast<int64_t>(tmp)); 312} 313 314const sc_time 315operator * (double d, const sc_time &t) 316{ 317 volatile double tmp = d * static_cast<double>(t.value()) + 0.5; 318 return sc_time::from_value(static_cast<int64_t>(tmp)); 319} 320 321const sc_time 322operator / (const sc_time &t, double d) 323{ 324 volatile double tmp = static_cast<double>(t.value()) / d + 0.5; 325 return sc_time::from_value(static_cast<int64_t>(tmp)); 326} 327 328double 329operator / (const sc_time &t1, const sc_time &t2) 330{ 331 return t1.to_double() / t2.to_double(); 332} 333 334std::ostream & 335operator << (std::ostream &os, const sc_time &t) 336{ 337 t.print(os); 338 return os; 339} 340 341const sc_time SC_ZERO_TIME; 342 343void 344sc_set_time_resolution(double d, sc_time_unit tu) 345{ 346 if (d <= 0.0) { 347 SC_REPORT_ERROR("(E514) set time resolution failed", 348 "value not positive"); 349 } 350 double dummy; 351 if (modf(log10(d), &dummy) != 0.0) { 352 SC_REPORT_ERROR("(E514) set time resolution failed", 353 "value not a power of ten"); 354 } 355 if (sc_is_running()) { 356 SC_REPORT_ERROR("(E514) set time resolution failed", 357 "simulation running"); 358 } 359 static bool specified = false; 360 if (specified) { 361 SC_REPORT_ERROR("(E514) set time resolution failed", 362 "already specified"); 363 } 364 // This won't detect the timescale being fixed outside of systemc, but 365 // it's at least some protection. 366 if (timeFixed) { 367 SC_REPORT_ERROR("(E514) set time resolution failed", 368 "sc_time object(s) constructed"); 369 } 370 371 double seconds = d * sc_gem5::TimeUnitScale[tu]; 372 if (seconds < sc_gem5::TimeUnitScale[SC_FS]) { 373 SC_REPORT_ERROR("(E514) set time resolution failed", 374 "value smaller than 1 fs"); 375 } 376 377 if (seconds > defaultUnit) { 378 SC_REPORT_WARNING( 379 "(W516) default time unit changed to time resolution", ""); 380 defaultUnit = seconds; 381 } 382 383 // Get rid of fractional parts of d. 384 while (d < 1.0 && tu > SC_FS) { 385 d *= 1000; 386 tu = (sc_time_unit)(tu - 1); 387 } 388 389 Tick ticks_per_second = 390 sc_gem5::TimeUnitFrequency[tu] / static_cast<Tick>(d); 391 setGlobalFrequency(ticks_per_second); 392 specified = true; 393} 394 395sc_time 396sc_get_time_resolution() 397{ 398 return sc_time::from_value(1); 399} 400 401const sc_time & 402sc_max_time() 403{ 404 static const sc_time MaxScTime = sc_time::from_value(MaxTick); 405 return MaxScTime; 406} 407 408void 409sc_set_default_time_unit(double d, sc_time_unit tu) 410{ 411 if (d < 0.0) { 412 SC_REPORT_ERROR("(E515) set default time unit failed", 413 "value not positive"); 414 } 415 double dummy; 416 if (modf(log10(d), &dummy) != 0.0) { 417 SC_REPORT_ERROR("(E515) set default time unit failed", 418 "value not a power of ten"); 419 } 420 if (sc_is_running()) { 421 SC_REPORT_ERROR("(E515) set default time unit failed", 422 "simulation running"); 423 } 424 static bool specified = false; 425 if (specified) { 426 SC_REPORT_ERROR("(E515) set default time unit failed", 427 "already specified"); 428 } 429 // This won't detect the timescale being fixed outside of systemc, but 430 // it's at least some protection. 431 if (timeFixed) { 432 SC_REPORT_ERROR("(E515) set default time unit failed", 433 "sc_time object(s) constructed"); 434 } 435 436 // Normalize d to seconds. 437 defaultUnit = d * sc_gem5::TimeUnitScale[tu]; 438 specified = true; 439 440 double resolution = SimClock::Float::Hz; 441 if (resolution == 0.0) 442 resolution = sc_gem5::TimeUnitScale[SC_PS]; 443 if (defaultUnit < resolution) { 444 SC_REPORT_ERROR("(E515) set default time unit failed", 445 "value smaller than time resolution"); 446 } 447} 448 449sc_time 450sc_get_default_time_unit() 451{ 452 return sc_time(defaultUnit, SC_SEC); 453} 454 455sc_time_tuple::sc_time_tuple(const sc_time &t) : 456 _value(), _unit(SC_SEC), _set(true) 457{ 458 if (!t.value()) 459 return; 460 461 Tick frequency = SimClock::Frequency; 462 463 // Shrink the frequency by scaling down the time period, ie converting 464 // it from cycles per second to cycles per millisecond, etc. 465 while (_unit > 1 && (frequency % 1000 == 0)) { 466 _unit = (sc_time_unit)((int)_unit - 1); 467 frequency /= 1000; 468 } 469 470 // Convert the frequency into a period. 471 Tick period; 472 if (frequency > 1) { 473 _unit = (sc_time_unit)((int)_unit - 1); 474 period = 1000 / frequency; 475 } else { 476 period = frequency; 477 } 478 479 // Scale our integer value by the period. 480 _value = t.value() * period; 481 482 // Shrink the scaled time value by increasing the size of the units 483 // it's measured by, avoiding fractional parts. 484 while (_unit < SC_SEC && (_value % 1000) == 0) { 485 _unit = (sc_time_unit)((int)_unit + 1); 486 _value /= 1000; 487 } 488} 489 490bool 491sc_time_tuple::has_value() const 492{ 493 return _set; 494} 495 496sc_dt::uint64 sc_time_tuple::value() const { return _value; } 497 498const char * 499sc_time_tuple::unit_symbol() const 500{ 501 return sc_gem5::TimeUnitNames[_unit]; 502} 503 504double sc_time_tuple::to_double() const { return static_cast<double>(_value); } 505 506std::string 507sc_time_tuple::to_string() const 508{ 509 std::ostringstream ss; 510 ss << _value << ' ' << unit_symbol(); 511 return ss.str(); 512} 513 514} // namespace sc_core 515