drain.cc revision 11937:e6621fafa62d
14826Ssaidi@eecs.umich.edu/* 24826Ssaidi@eecs.umich.edu * Copyright (c) 2012, 2015, 2017 ARM Limited 34826Ssaidi@eecs.umich.edu * All rights reserved 44826Ssaidi@eecs.umich.edu * 54826Ssaidi@eecs.umich.edu * The license below extends only to copyright in the software and shall 64826Ssaidi@eecs.umich.edu * not be construed as granting a license to any other intellectual 74826Ssaidi@eecs.umich.edu * property including but not limited to intellectual property relating 84826Ssaidi@eecs.umich.edu * to a hardware implementation of the functionality of the software 94826Ssaidi@eecs.umich.edu * licensed hereunder. You may use the software subject to the license 104826Ssaidi@eecs.umich.edu * terms below provided that you ensure that this notice is replicated 114826Ssaidi@eecs.umich.edu * unmodified and in its entirety in all distributions of the software, 124826Ssaidi@eecs.umich.edu * modified or unmodified, in source code or in binary form. 134826Ssaidi@eecs.umich.edu * 144826Ssaidi@eecs.umich.edu * Redistribution and use in source and binary forms, with or without 154826Ssaidi@eecs.umich.edu * modification, are permitted provided that the following conditions are 164826Ssaidi@eecs.umich.edu * met: redistributions of source code must retain the above copyright 174826Ssaidi@eecs.umich.edu * notice, this list of conditions and the following disclaimer; 184826Ssaidi@eecs.umich.edu * redistributions in binary form must reproduce the above copyright 194826Ssaidi@eecs.umich.edu * notice, this list of conditions and the following disclaimer in the 204826Ssaidi@eecs.umich.edu * documentation and/or other materials provided with the distribution; 214826Ssaidi@eecs.umich.edu * neither the name of the copyright holders nor the names of its 224826Ssaidi@eecs.umich.edu * contributors may be used to endorse or promote products derived from 234826Ssaidi@eecs.umich.edu * this software without specific prior written permission. 244826Ssaidi@eecs.umich.edu * 254826Ssaidi@eecs.umich.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 264826Ssaidi@eecs.umich.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 274826Ssaidi@eecs.umich.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 284826Ssaidi@eecs.umich.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 294826Ssaidi@eecs.umich.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 304826Ssaidi@eecs.umich.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 314826Ssaidi@eecs.umich.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 324826Ssaidi@eecs.umich.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 334826Ssaidi@eecs.umich.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 344826Ssaidi@eecs.umich.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 354826Ssaidi@eecs.umich.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 364826Ssaidi@eecs.umich.edu * 374826Ssaidi@eecs.umich.edu * Authors: Andreas Sandberg 384826Ssaidi@eecs.umich.edu */ 394826Ssaidi@eecs.umich.edu 404826Ssaidi@eecs.umich.edu#include "sim/drain.hh" 414826Ssaidi@eecs.umich.edu 424826Ssaidi@eecs.umich.edu#include <algorithm> 434826Ssaidi@eecs.umich.edu 444826Ssaidi@eecs.umich.edu#include "base/misc.hh" 454826Ssaidi@eecs.umich.edu#include "base/trace.hh" 464826Ssaidi@eecs.umich.edu#include "debug/Drain.hh" 474826Ssaidi@eecs.umich.edu#include "sim/sim_exit.hh" 484826Ssaidi@eecs.umich.edu#include "sim/sim_object.hh" 494826Ssaidi@eecs.umich.edu 504826Ssaidi@eecs.umich.eduDrainManager DrainManager::_instance; 514826Ssaidi@eecs.umich.edu 524826Ssaidi@eecs.umich.eduDrainManager::DrainManager() 534826Ssaidi@eecs.umich.edu : _count(0), 544826Ssaidi@eecs.umich.edu _state(DrainState::Running) 554826Ssaidi@eecs.umich.edu{ 564826Ssaidi@eecs.umich.edu} 574826Ssaidi@eecs.umich.edu 584826Ssaidi@eecs.umich.eduDrainManager::~DrainManager() 594826Ssaidi@eecs.umich.edu{ 604826Ssaidi@eecs.umich.edu} 614826Ssaidi@eecs.umich.edu 624826Ssaidi@eecs.umich.edubool 634826Ssaidi@eecs.umich.eduDrainManager::tryDrain() 644826Ssaidi@eecs.umich.edu{ 65 panic_if(_state == DrainState::Drained, 66 "Trying to drain a drained system\n"); 67 68 panic_if(_count != 0, 69 "Drain counter must be zero at the start of a drain cycle\n"); 70 71 DPRINTF(Drain, "Trying to drain %u objects.\n", drainableCount()); 72 _state = DrainState::Draining; 73 for (auto *obj : _allDrainable) { 74 DrainState status = obj->dmDrain(); 75 if (DTRACE(Drain) && status != DrainState::Drained) { 76 SimObject *temp = dynamic_cast<SimObject*>(obj); 77 if (temp) 78 DPRINTF(Drain, "Failed to drain %s\n", temp->name()); 79 } 80 _count += status == DrainState::Drained ? 0 : 1; 81 } 82 83 if (_count == 0) { 84 DPRINTF(Drain, "Drain done.\n"); 85 _state = DrainState::Drained; 86 return true; 87 } else { 88 DPRINTF(Drain, "Need another drain cycle. %u/%u objects not ready.\n", 89 _count, drainableCount()); 90 return false; 91 } 92} 93 94void 95DrainManager::resume() 96{ 97 panic_if(_state == DrainState::Running, 98 "Trying to resume a system that is already running\n"); 99 100 warn_if(_state == DrainState::Draining, 101 "Resuming a system that isn't fully drained, this is untested and " 102 "likely to break\n"); 103 104 panic_if(_state == DrainState::Resuming, 105 "Resuming a system that is already trying to resume. This should " 106 "never happen.\n"); 107 108 panic_if(_count != 0, 109 "Resume called in the middle of a drain cycle. %u objects " 110 "left to drain.\n", _count); 111 112 // At this point in time the DrainManager and all objects will be 113 // in the the Drained state. New objects (i.e., objects created 114 // while resuming) will inherit the Resuming state from the 115 // DrainManager, which means we have to resume objects until all 116 // objects are in the Running state. 117 _state = DrainState::Resuming; 118 119 do { 120 DPRINTF(Drain, "Resuming %u objects.\n", drainableCount()); 121 for (auto *obj : _allDrainable) { 122 if (obj->drainState() != DrainState::Running) { 123 assert(obj->drainState() == DrainState::Drained || 124 obj->drainState() == DrainState::Resuming); 125 obj->dmDrainResume(); 126 } 127 } 128 } while (!allInState(DrainState::Running)); 129 130 _state = DrainState::Running; 131} 132 133void 134DrainManager::preCheckpointRestore() 135{ 136 panic_if(_state != DrainState::Running, 137 "preCheckpointRestore() called on a system that isn't in the " 138 "Running state.\n"); 139 140 DPRINTF(Drain, "Applying pre-restore fixes to %u objects.\n", 141 drainableCount()); 142 _state = DrainState::Drained; 143 for (auto *obj : _allDrainable) 144 obj->_drainState = DrainState::Drained; 145} 146 147void 148DrainManager::signalDrainDone() 149{ 150 assert(_count > 0); 151 if (--_count == 0) { 152 DPRINTF(Drain, "All %u objects drained..\n", drainableCount()); 153 exitSimLoop("Finished drain", 0); 154 } 155} 156 157 158void 159DrainManager::registerDrainable(Drainable *obj) 160{ 161 std::lock_guard<std::mutex> lock(globalLock); 162 assert(std::find(_allDrainable.begin(), _allDrainable.end(), obj) == 163 _allDrainable.end()); 164 _allDrainable.push_back(obj); 165} 166 167void 168DrainManager::unregisterDrainable(Drainable *obj) 169{ 170 std::lock_guard<std::mutex> lock(globalLock); 171 auto o = std::find(_allDrainable.begin(), _allDrainable.end(), obj); 172 assert(o != _allDrainable.end()); 173 _allDrainable.erase(o); 174} 175 176bool 177DrainManager::allInState(DrainState state) const 178{ 179 for (const auto *obj : _allDrainable) { 180 if (obj->drainState() != state) 181 return false; 182 } 183 184 return true; 185} 186 187size_t 188DrainManager::drainableCount() const 189{ 190 std::lock_guard<std::mutex> lock(globalLock); 191 return _allDrainable.size(); 192} 193 194 195 196Drainable::Drainable() 197 : _drainManager(DrainManager::instance()), 198 _drainState(_drainManager.state()) 199{ 200 _drainManager.registerDrainable(this); 201} 202 203Drainable::~Drainable() 204{ 205 _drainManager.unregisterDrainable(this); 206} 207 208DrainState 209Drainable::dmDrain() 210{ 211 _drainState = DrainState::Draining; 212 _drainState = drain(); 213 assert(_drainState == DrainState::Draining || 214 _drainState == DrainState::Drained); 215 216 return _drainState; 217} 218 219void 220Drainable::dmDrainResume() 221{ 222 panic_if(_drainState != DrainState::Drained && 223 _drainState != DrainState::Resuming, 224 "Trying to resume an object that hasn't been drained\n"); 225 226 _drainState = DrainState::Running; 227 drainResume(); 228} 229