gem5/util/m5/m5ops.h
Michael LeBeane dc16c1ceb8 dev: Add m5 op to toggle synchronization for dist-gem5.
This patch adds the ability for an application to request dist-gem5 to begin/
end synchronization using an m5 op. When toggling on sync, all nodes agree
on the next sync point based on the maximum of all nodes' ticks. CPUs are
suspended until the sync point to avoid sending network messages until sync has
been enabled. Toggling off sync acts like a global execution barrier, where
all CPUs are disabled until every node reaches the toggle off point. This
avoids tricky situations such as one node hitting a toggle off followed by a
toggle on before the other nodes hit the first toggle off.
2016-10-26 22:48:40 -04:00

145 lines
6.4 KiB
C

/*
* Copyright (c) 2016 ARM Limited
* All rights reserved
*
* The license below extends only to copyright in the software and shall
* not be construed as granting a license to any other intellectual
* property including but not limited to intellectual property relating
* to a hardware implementation of the functionality of the software
* licensed hereunder. You may use the software subject to the license
* terms below provided that you ensure that this notice is replicated
* unmodified and in its entirety in all distributions of the software,
* modified or unmodified, in source code or in binary form.
*
* Copyright (c) 2003-2006 The Regents of The University of Michigan
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met: redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer;
* redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution;
* neither the name of the copyright holders nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Authors: Nathan Binkert
* Ali Saidi
* Andreas Sandberg
*/
#define arm_func 0x00
#define quiesce_func 0x01
#define quiescens_func 0x02
#define quiescecycle_func 0x03
#define quiescetime_func 0x04
#define rpns_func 0x07
#define wakecpu_func 0x09
#define deprecated1_func 0x10 // obsolete ivlb
#define deprecated2_func 0x11 // obsolete ivle
#define deprecated3_func 0x20 // deprecated exit function
#define exit_func 0x21
#define fail_func 0x22
#define initparam_func 0x30
#define loadsymbol_func 0x31
#define resetstats_func 0x40
#define dumpstats_func 0x41
#define dumprststats_func 0x42
#define ckpt_func 0x43
#define writefile_func 0x4F
#define readfile_func 0x50
#define debugbreak_func 0x51
#define switchcpu_func 0x52
#define addsymbol_func 0x53
#define panic_func 0x54
#define reserved2_func 0x56 // Reserved for user
#define reserved3_func 0x57 // Reserved for user
#define reserved4_func 0x58 // Reserved for user
#define reserved5_func 0x59 // Reserved for user
#define work_begin_func 0x5a
#define work_end_func 0x5b
#define syscall_func 0x60 // Reserved for user
#define pagefault_func 0x61 // Reserved for user
#define togglesync_func 0x62
// These operations are for critical path annotation
#define annotate_func 0x55
#define an_bsm 0x1
#define an_esm 0x2
#define an_begin 0x3
#define an_end 0x4
#define an_q 0x6
#define an_dq 0x7
#define an_wf 0x8
#define an_we 0x9
#define an_rq 0xA
#define an_ws 0xB
#define an_sq 0xC
#define an_aq 0xD
#define an_pq 0xE
#define an_l 0xF
#define an_identify 0x10
#define an_getid 0x11
#define FOREACH_M5OP \
M5OP(arm, arm_func, 0); \
M5OP(quiesce, quiesce_func, 0); \
M5OP(quiesceNs, quiescens_func, 0); \
M5OP(quiesceCycle, quiescecycle_func, 0); \
M5OP(quiesceTime, quiescetime_func, 0); \
M5OP(rpns, rpns_func, 0); \
M5OP(wakeCPU, wakecpu_func, 0); \
M5OP(m5_exit, exit_func, 0); \
M5OP(m5_fail, fail_func, 0); \
M5OP(m5_initparam, initparam_func, 0); \
M5OP(m5_loadsymbol, loadsymbol_func, 0); \
M5OP(m5_reset_stats, resetstats_func, 0); \
M5OP(m5_dump_stats, dumpstats_func, 0); \
M5OP(m5_dumpreset_stats, dumprststats_func, 0); \
M5OP(m5_checkpoint, ckpt_func, 0); \
M5OP(m5_readfile, readfile_func, 0); \
M5OP(m5_writefile, writefile_func, 0); \
M5OP(m5_debugbreak, debugbreak_func, 0); \
M5OP(m5_switchcpu, switchcpu_func, 0); \
M5OP(m5_addsymbol, addsymbol_func, 0); \
M5OP(m5_panic, panic_func, 0); \
M5OP(m5_work_begin, work_begin_func, 0); \
M5OP(m5_work_end, work_end_func, 0); \
M5OP(m5_togglesync, togglesync_func, 0);
#define FOREACH_M5_ANNOTATION \
M5_ANNOTATION(m5a_bsm, an_bsm); \
M5_ANNOTATION(m5a_esm, an_esm); \
M5_ANNOTATION(m5a_begin, an_begin); \
M5_ANNOTATION(m5a_end, an_end); \
M5_ANNOTATION(m5a_q, an_q); \
M5_ANNOTATION(m5a_dq, an_dq); \
M5_ANNOTATION(m5a_wf, an_wf); \
M5_ANNOTATION(m5a_we, an_we); \
M5_ANNOTATION(m5a_rq, an_rq); \
M5_ANNOTATION(m5a_ws, an_ws); \
M5_ANNOTATION(m5a_sq, an_sq); \
M5_ANNOTATION(m5a_aq, an_aq); \
M5_ANNOTATION(m5a_pq, an_pq); \
M5_ANNOTATION(m5a_l, an_l); \
M5_ANNOTATION(m5a_identify, an_identify); \
M5_ANNOTATION(m5a_getid, an_getid);