drain.cc revision 11417
19342SAndreas.Sandberg@arm.com/* 210910Sandreas.sandberg@arm.com * Copyright (c) 2012, 2015 ARM Limited 39342SAndreas.Sandberg@arm.com * All rights reserved 49342SAndreas.Sandberg@arm.com * 59342SAndreas.Sandberg@arm.com * The license below extends only to copyright in the software and shall 69342SAndreas.Sandberg@arm.com * not be construed as granting a license to any other intellectual 79342SAndreas.Sandberg@arm.com * property including but not limited to intellectual property relating 89342SAndreas.Sandberg@arm.com * to a hardware implementation of the functionality of the software 99342SAndreas.Sandberg@arm.com * licensed hereunder. You may use the software subject to the license 109342SAndreas.Sandberg@arm.com * terms below provided that you ensure that this notice is replicated 119342SAndreas.Sandberg@arm.com * unmodified and in its entirety in all distributions of the software, 129342SAndreas.Sandberg@arm.com * modified or unmodified, in source code or in binary form. 139342SAndreas.Sandberg@arm.com * 149342SAndreas.Sandberg@arm.com * Redistribution and use in source and binary forms, with or without 159342SAndreas.Sandberg@arm.com * modification, are permitted provided that the following conditions are 169342SAndreas.Sandberg@arm.com * met: redistributions of source code must retain the above copyright 179342SAndreas.Sandberg@arm.com * notice, this list of conditions and the following disclaimer; 189342SAndreas.Sandberg@arm.com * redistributions in binary form must reproduce the above copyright 199342SAndreas.Sandberg@arm.com * notice, this list of conditions and the following disclaimer in the 209342SAndreas.Sandberg@arm.com * documentation and/or other materials provided with the distribution; 219342SAndreas.Sandberg@arm.com * neither the name of the copyright holders nor the names of its 229342SAndreas.Sandberg@arm.com * contributors may be used to endorse or promote products derived from 239342SAndreas.Sandberg@arm.com * this software without specific prior written permission. 249342SAndreas.Sandberg@arm.com * 259342SAndreas.Sandberg@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 269342SAndreas.Sandberg@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 279342SAndreas.Sandberg@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 289342SAndreas.Sandberg@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 299342SAndreas.Sandberg@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 309342SAndreas.Sandberg@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 319342SAndreas.Sandberg@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 329342SAndreas.Sandberg@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 339342SAndreas.Sandberg@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 349342SAndreas.Sandberg@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 359342SAndreas.Sandberg@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 369342SAndreas.Sandberg@arm.com * 379342SAndreas.Sandberg@arm.com * Authors: Andreas Sandberg 389342SAndreas.Sandberg@arm.com */ 399342SAndreas.Sandberg@arm.com 409342SAndreas.Sandberg@arm.com#include "sim/drain.hh" 4110912Sandreas.sandberg@arm.com 4210912Sandreas.sandberg@arm.com#include "base/misc.hh" 4310912Sandreas.sandberg@arm.com#include "base/trace.hh" 4410912Sandreas.sandberg@arm.com#include "debug/Drain.hh" 459342SAndreas.Sandberg@arm.com#include "sim/sim_exit.hh" 4611417Ssascha.bischoff@arm.com#include "sim/sim_object.hh" 479342SAndreas.Sandberg@arm.com 4810912Sandreas.sandberg@arm.comDrainManager DrainManager::_instance; 4910912Sandreas.sandberg@arm.com 509342SAndreas.Sandberg@arm.comDrainManager::DrainManager() 5110912Sandreas.sandberg@arm.com : _count(0), 5210912Sandreas.sandberg@arm.com _state(DrainState::Running) 539342SAndreas.Sandberg@arm.com{ 549342SAndreas.Sandberg@arm.com} 559342SAndreas.Sandberg@arm.com 569342SAndreas.Sandberg@arm.comDrainManager::~DrainManager() 579342SAndreas.Sandberg@arm.com{ 589342SAndreas.Sandberg@arm.com} 599342SAndreas.Sandberg@arm.com 6010912Sandreas.sandberg@arm.combool 6110912Sandreas.sandberg@arm.comDrainManager::tryDrain() 629342SAndreas.Sandberg@arm.com{ 6310912Sandreas.sandberg@arm.com panic_if(_state == DrainState::Drained, 6410912Sandreas.sandberg@arm.com "Trying to drain a drained system\n"); 6510912Sandreas.sandberg@arm.com 6610912Sandreas.sandberg@arm.com panic_if(_count != 0, 6710912Sandreas.sandberg@arm.com "Drain counter must be zero at the start of a drain cycle\n"); 6810912Sandreas.sandberg@arm.com 6910912Sandreas.sandberg@arm.com DPRINTF(Drain, "Trying to drain %u objects.\n", drainableCount()); 7010912Sandreas.sandberg@arm.com _state = DrainState::Draining; 7111417Ssascha.bischoff@arm.com for (auto *obj : _allDrainable) { 7211417Ssascha.bischoff@arm.com DrainState status = obj->dmDrain(); 7311417Ssascha.bischoff@arm.com if (DTRACE(Drain) && status != DrainState::Drained) { 7411417Ssascha.bischoff@arm.com SimObject *temp = dynamic_cast<SimObject*>(obj); 7511417Ssascha.bischoff@arm.com if (temp) 7611417Ssascha.bischoff@arm.com DPRINTF(Drain, "Failed to drain %s\n", temp->name()); 7711417Ssascha.bischoff@arm.com } 7811417Ssascha.bischoff@arm.com _count += status == DrainState::Drained ? 0 : 1; 7911417Ssascha.bischoff@arm.com } 8010912Sandreas.sandberg@arm.com 8110912Sandreas.sandberg@arm.com if (_count == 0) { 8210912Sandreas.sandberg@arm.com DPRINTF(Drain, "Drain done.\n"); 8310912Sandreas.sandberg@arm.com _state = DrainState::Drained; 8410912Sandreas.sandberg@arm.com return true; 8510912Sandreas.sandberg@arm.com } else { 8610912Sandreas.sandberg@arm.com DPRINTF(Drain, "Need another drain cycle. %u/%u objects not ready.\n", 8710912Sandreas.sandberg@arm.com _count, drainableCount()); 8810912Sandreas.sandberg@arm.com return false; 8910912Sandreas.sandberg@arm.com } 909342SAndreas.Sandberg@arm.com} 919342SAndreas.Sandberg@arm.com 9210912Sandreas.sandberg@arm.comvoid 9310912Sandreas.sandberg@arm.comDrainManager::resume() 9410912Sandreas.sandberg@arm.com{ 9510912Sandreas.sandberg@arm.com panic_if(_state == DrainState::Running, 9610912Sandreas.sandberg@arm.com "Trying to resume a system that is already running\n"); 9710912Sandreas.sandberg@arm.com 9810912Sandreas.sandberg@arm.com warn_if(_state == DrainState::Draining, 9910912Sandreas.sandberg@arm.com "Resuming a system that isn't fully drained, this is untested and " 10010912Sandreas.sandberg@arm.com "likely to break\n"); 10110912Sandreas.sandberg@arm.com 10210912Sandreas.sandberg@arm.com panic_if(_count != 0, 10310912Sandreas.sandberg@arm.com "Resume called in the middle of a drain cycle. %u objects " 10410912Sandreas.sandberg@arm.com "left to drain.\n", _count); 10510912Sandreas.sandberg@arm.com 10610912Sandreas.sandberg@arm.com DPRINTF(Drain, "Resuming %u objects.\n", drainableCount()); 10710912Sandreas.sandberg@arm.com _state = DrainState::Running; 10810912Sandreas.sandberg@arm.com for (auto *obj : _allDrainable) 10910913Sandreas.sandberg@arm.com obj->dmDrainResume(); 11010912Sandreas.sandberg@arm.com} 11110912Sandreas.sandberg@arm.com 11210912Sandreas.sandberg@arm.comvoid 11310912Sandreas.sandberg@arm.comDrainManager::preCheckpointRestore() 11410912Sandreas.sandberg@arm.com{ 11510912Sandreas.sandberg@arm.com panic_if(_state != DrainState::Running, 11610912Sandreas.sandberg@arm.com "preCheckpointRestore() called on a system that isn't in the " 11710912Sandreas.sandberg@arm.com "Running state.\n"); 11810912Sandreas.sandberg@arm.com 11910912Sandreas.sandberg@arm.com DPRINTF(Drain, "Applying pre-restore fixes to %u objects.\n", 12010912Sandreas.sandberg@arm.com drainableCount()); 12110912Sandreas.sandberg@arm.com _state = DrainState::Drained; 12210912Sandreas.sandberg@arm.com for (auto *obj : _allDrainable) 12310912Sandreas.sandberg@arm.com obj->_drainState = DrainState::Drained; 12410912Sandreas.sandberg@arm.com} 12510912Sandreas.sandberg@arm.com 12610912Sandreas.sandberg@arm.comvoid 12710912Sandreas.sandberg@arm.comDrainManager::signalDrainDone() 12810912Sandreas.sandberg@arm.com{ 12910912Sandreas.sandberg@arm.com if (--_count == 0) { 13010912Sandreas.sandberg@arm.com DPRINTF(Drain, "All %u objects drained..\n", drainableCount()); 13110912Sandreas.sandberg@arm.com exitSimLoop("Finished drain", 0); 13210912Sandreas.sandberg@arm.com } 13310912Sandreas.sandberg@arm.com} 13410912Sandreas.sandberg@arm.com 13510912Sandreas.sandberg@arm.com 13610912Sandreas.sandberg@arm.comvoid 13710912Sandreas.sandberg@arm.comDrainManager::registerDrainable(Drainable *obj) 13810912Sandreas.sandberg@arm.com{ 13910912Sandreas.sandberg@arm.com std::lock_guard<std::mutex> lock(globalLock); 14010912Sandreas.sandberg@arm.com _allDrainable.insert(obj); 14110912Sandreas.sandberg@arm.com} 14210912Sandreas.sandberg@arm.com 14310912Sandreas.sandberg@arm.comvoid 14410912Sandreas.sandberg@arm.comDrainManager::unregisterDrainable(Drainable *obj) 14510912Sandreas.sandberg@arm.com{ 14610912Sandreas.sandberg@arm.com std::lock_guard<std::mutex> lock(globalLock); 14710912Sandreas.sandberg@arm.com _allDrainable.erase(obj); 14810912Sandreas.sandberg@arm.com} 14910912Sandreas.sandberg@arm.com 15010912Sandreas.sandberg@arm.comsize_t 15110912Sandreas.sandberg@arm.comDrainManager::drainableCount() const 15210912Sandreas.sandberg@arm.com{ 15310912Sandreas.sandberg@arm.com std::lock_guard<std::mutex> lock(globalLock); 15410912Sandreas.sandberg@arm.com return _allDrainable.size(); 15510912Sandreas.sandberg@arm.com} 15610912Sandreas.sandberg@arm.com 1579342SAndreas.Sandberg@arm.com 1589342SAndreas.Sandberg@arm.com 1599342SAndreas.Sandberg@arm.comDrainable::Drainable() 16010912Sandreas.sandberg@arm.com : _drainManager(DrainManager::instance()), 16110998Sandreas.sandberg@arm.com _drainState(_drainManager.state()) 1629342SAndreas.Sandberg@arm.com{ 16310912Sandreas.sandberg@arm.com _drainManager.registerDrainable(this); 1649342SAndreas.Sandberg@arm.com} 1659342SAndreas.Sandberg@arm.com 1669342SAndreas.Sandberg@arm.comDrainable::~Drainable() 1679342SAndreas.Sandberg@arm.com{ 16810912Sandreas.sandberg@arm.com _drainManager.unregisterDrainable(this); 1699342SAndreas.Sandberg@arm.com} 1709342SAndreas.Sandberg@arm.com 17110913Sandreas.sandberg@arm.comDrainState 17210913Sandreas.sandberg@arm.comDrainable::dmDrain() 17310913Sandreas.sandberg@arm.com{ 17410913Sandreas.sandberg@arm.com _drainState = DrainState::Draining; 17510913Sandreas.sandberg@arm.com _drainState = drain(); 17610913Sandreas.sandberg@arm.com assert(_drainState == DrainState::Draining || 17710913Sandreas.sandberg@arm.com _drainState == DrainState::Drained); 17810913Sandreas.sandberg@arm.com 17910913Sandreas.sandberg@arm.com return _drainState; 18010913Sandreas.sandberg@arm.com} 18110913Sandreas.sandberg@arm.com 1829342SAndreas.Sandberg@arm.comvoid 18310913Sandreas.sandberg@arm.comDrainable::dmDrainResume() 1849342SAndreas.Sandberg@arm.com{ 18510913Sandreas.sandberg@arm.com panic_if(_drainState != DrainState::Drained, 18610913Sandreas.sandberg@arm.com "Trying to resume an object that hasn't been drained\n"); 18710913Sandreas.sandberg@arm.com 18810910Sandreas.sandberg@arm.com _drainState = DrainState::Running; 18910913Sandreas.sandberg@arm.com drainResume(); 1909342SAndreas.Sandberg@arm.com} 191