xref: /netbsd-src/external/gpl3/gdb/dist/sim/igen/gen-icache.h (revision 71f621822dbfd5073a314948bec169b7bb05f7be)
1 /* The IGEN simulator generator for GDB, the GNU Debugger.
2 
3    Copyright 2002-2024 Free Software Foundation, Inc.
4 
5    Contributed by Andrew Cagney.
6 
7    This file is part of GDB.
8 
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13 
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18 
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
21 
22 #ifndef IGEN_GEN_ICACHE_H
23 #define IGEN_GEN_ICACHE_H
24 
25 /* Output code to manipulate the instruction cache: either create it
26    or reference it */
27 
28 typedef enum
29 {
30   declare_variables,
31   define_variables,
32   undef_variables,
33 }
34 icache_decl_type;
35 
36 typedef enum
37 {
38   do_not_use_icache = 0,
39   get_values_from_icache = 0x1,
40   put_values_in_icache = 0x2,
41   both_values_and_icache = 0x3,
42 }
43 icache_body_type;
44 
45 extern void print_icache_body
46   (lf *file,
47    const insn_entry *instruction,
48    const opcode_bits *expanded_bits,
49    cache_entry *cache_rules,
50    icache_decl_type what_to_declare,
51    icache_body_type what_to_do, int nr_prefetched_words);
52 
53 
54 /* Output an instruction cache decode function */
55 
56 extern void print_icache_declaration
57   (lf *file,
58    const insn_entry *insn,
59    const opcode_bits *expanded_bits,
60    const insn_opcodes *opcodes,
61    int nr_prefetched_words);
62 
63 extern void print_icache_definition
64   (lf *file,
65    const insn_entry *insn,
66    const opcode_bits *expanded_bits,
67    const insn_opcodes *opcodes,
68    cache_entry *cache_rules, int nr_prefetched_words);
69 
70 
71 /* Output an instruction cache support function */
72 
73 extern function_entry_handler print_icache_internal_function_declaration;
74 extern function_entry_handler print_icache_internal_function_definition;
75 
76 
77 /* Output the instruction cache table data structure */
78 
79 extern void print_icache_struct
80   (lf *file, const insn_table *instructions, cache_entry *cache_rules);
81 
82 
83 /* Output a single instructions decoder */
84 
85 #endif /* IGEN_GEN_ICACHE_H */
86