util/m5/m5op.h

   1 /*
   2  * Copyright (c) 2003-2006 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Nathan Binkert
  29  *          Ali Saidi
  30  */
  31
  32 #ifndef __M5OP_H__
  33 #define __M5OP_H__
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 #include <stdint.h>
  40
  41 void arm(uint64_t address);
  42 void quiesce(void);
  43 void quiesceNs(uint64_t ns);
  44 void quiesceCycle(uint64_t cycles);
  45 uint64_t quiesceTime(void);
  46 uint64_t rpns();
  47 void wakeCPU(uint64_t cpuid);
  48
  49 void m5_exit(uint64_t ns_delay);
  50 void m5_fail(uint64_t ns_delay, uint64_t code);
  51 uint64_t m5_initparam(uint64_t key_str1, uint64_t key_str2);
  52 void m5_checkpoint(uint64_t ns_delay, uint64_t ns_period);
  53 void m5_reset_stats(uint64_t ns_delay, uint64_t ns_period);
  54 void m5_dump_stats(uint64_t ns_delay, uint64_t ns_period);
  55 void m5_dumpreset_stats(uint64_t ns_delay, uint64_t ns_period);
  56 uint64_t m5_readfile(void *buffer, uint64_t len, uint64_t offset);
  57 uint64_t m5_writefile(void *buffer, uint64_t len, uint64_t offset, const char *filename);
  58 void m5_debugbreak(void);
  59 void m5_switchcpu(void);
  60 void m5_togglesync(void);
  61 void m5_addsymbol(uint64_t addr, char *symbol);
  62 void m5_panic(void);
  63 void m5_work_begin(uint64_t workid, uint64_t threadid);
  64 void m5_work_end(uint64_t workid, uint64_t threadid);
  65
  66 // These operations are for critical path annotation
  67 void m5a_bsm(char *sm, const void *id, int flags);
  68 void m5a_esm(char *sm);
  69 void m5a_begin(int flags, char *st);
  70 void m5a_end(void);
  71 void m5a_q(const void *id, char *q, int count);
  72 void m5a_dq(const void *id, char *q, int count);
  73 void m5a_wf(const void *id, char *q, char *sm, int count);
  74 void m5a_we(const void *id, char *q, char *sm, int count);
  75 void m5a_ws(const void *id, char *q, char *sm);
  76 void m5a_sq(const void *id, char *q, int count, int flags);
  77 void m5a_aq(const void *id, char *q, int count);
  78 void m5a_pq(const void *id, char *q, int count);
  79 void m5a_l(char *lsm, const void *id, char *sm);
  80 void m5a_identify(uint64_t id);
  81 uint64_t m5a_getid(void);
  82
  83 #define M5_AN_FL_NONE   0x0
  84 #define M5_AN_FL_BAD    0x2
  85 #define M5_AN_FL_LINK   0x10
  86 #define M5_AN_FL_RESET  0x20
  87
  88 #ifdef __cplusplus
  89 }
  90 #endif
  91 #endif // __M5OP_H__