m5ops.h revision 12423:97aad565ab2c 
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 __GEM5_M5OP_H__
33#define __GEM5_M5OP_H__
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39#include <stdint.h>
40
41#include <gem5/asm/generic/m5op_flags.h>
42
43void m5_arm(uint64_t address);
44void m5_quiesce(void);
45void m5_quiesce_ns(uint64_t ns);
46void m5_quiesce_cycle(uint64_t cycles);
47uint64_t m5_quiesce_time(void);
48uint64_t m5_rpns();
49void m5_wake_cpu(uint64_t cpuid);
50
51void m5_exit(uint64_t ns_delay);
52void m5_fail(uint64_t ns_delay, uint64_t code);
53uint64_t m5_init_param(uint64_t key_str1, uint64_t key_str2);
54void m5_checkpoint(uint64_t ns_delay, uint64_t ns_period);
55void m5_reset_stats(uint64_t ns_delay, uint64_t ns_period);
56void m5_dump_stats(uint64_t ns_delay, uint64_t ns_period);
57void m5_dump_reset_stats(uint64_t ns_delay, uint64_t ns_period);
58uint64_t m5_read_file(void *buffer, uint64_t len, uint64_t offset);
59uint64_t m5_write_file(void *buffer, uint64_t len, uint64_t offset,
60                       const char *filename);
61void m5_debug_break(void);
62void m5_switch_cpu(void);
63void m5_dist_toggle_sync(void);
64void m5_add_symbol(uint64_t addr, char *symbol);
65void m5_load_symbol();
66void m5_panic(void);
67void m5_work_begin(uint64_t workid, uint64_t threadid);
68void m5_work_end(uint64_t workid, uint64_t threadid);
69
70// These operations are for critical path annotation
71void m5a_bsm(char *sm, const void *id, int flags);
72void m5a_esm(char *sm);
73void m5a_begin(int flags, char *st);
74void m5a_end(void);
75void m5a_q(const void *id, char *q, int count);
76void m5a_dq(const void *id, char *q, int count);
77void m5a_wf(const void *id, char *q, char *sm, int count);
78void m5a_we(const void *id, char *q, char *sm, int count);
79void m5a_ws(const void *id, char *q, char *sm);
80void m5a_sq(const void *id, char *q, int count, int flags);
81void m5a_aq(const void *id, char *q, int count);
82void m5a_pq(const void *id, char *q, int count);
83void m5a_l(char *lsm, const void *id, char *sm);
84void m5a_identify(uint64_t id);
85uint64_t m5a_getid(void);
86
87#ifdef __cplusplus
88}
89#endif
90#endif // __GEM5_M5OP_H__
91