1 #ifndef GDBSTUB_H 2 #define GDBSTUB_H 3 4 typedef struct GDBFeature { 5 const char *xmlname; 6 const char *xml; 7 const char *name; 8 const char * const *regs; 9 int num_regs; 10 } GDBFeature; 11 12 typedef struct GDBFeatureBuilder { 13 GDBFeature *feature; 14 GPtrArray *xml; 15 GPtrArray *regs; 16 int base_reg; 17 } GDBFeatureBuilder; 18 19 20 /* Get or set a register. Returns the size of the register. */ 21 typedef int (*gdb_get_reg_cb)(CPUState *cpu, GByteArray *buf, int reg); 22 typedef int (*gdb_set_reg_cb)(CPUState *cpu, uint8_t *buf, int reg); 23 24 /** 25 * gdb_init_cpu(): Initialize the CPU for gdbstub. 26 * @cpu: The CPU to be initialized. 27 */ 28 void gdb_init_cpu(CPUState *cpu); 29 30 /** 31 * gdb_register_coprocessor() - register a supplemental set of registers 32 * @cpu - the CPU associated with registers 33 * @get_reg - get function (gdb reading) 34 * @set_reg - set function (gdb modifying) 35 * @num_regs - number of registers in set 36 * @xml - xml name of set 37 * @gpos - non-zero to append to "general" register set at @gpos 38 */ 39 void gdb_register_coprocessor(CPUState *cpu, 40 gdb_get_reg_cb get_reg, gdb_set_reg_cb set_reg, 41 const GDBFeature *feature, int g_pos); 42 43 /** 44 * gdb_unregister_coprocessor_all() - unregisters supplemental set of registers 45 * @cpu - the CPU associated with registers 46 */ 47 void gdb_unregister_coprocessor_all(CPUState *cpu); 48 49 /** 50 * gdbserver_start: start the gdb server 51 * @port_or_device: connection spec for gdb 52 * 53 * For CONFIG_USER this is either a tcp port or a path to a fifo. For 54 * system emulation you can use a full chardev spec for your gdbserver 55 * port. 56 */ 57 int gdbserver_start(const char *port_or_device); 58 59 /** 60 * gdb_feature_builder_init() - Initialize GDBFeatureBuilder. 61 * @builder: The builder to be initialized. 62 * @feature: The feature to be filled. 63 * @name: The name of the feature. 64 * @xmlname: The name of the XML. 65 * @base_reg: The base number of the register ID. 66 */ 67 void gdb_feature_builder_init(GDBFeatureBuilder *builder, GDBFeature *feature, 68 const char *name, const char *xmlname, 69 int base_reg); 70 71 /** 72 * gdb_feature_builder_append_tag() - Append a tag. 73 * @builder: The builder. 74 * @format: The format of the tag. 75 * @...: The values to be formatted. 76 */ 77 void G_GNUC_PRINTF(2, 3) 78 gdb_feature_builder_append_tag(const GDBFeatureBuilder *builder, 79 const char *format, ...); 80 81 /** 82 * gdb_feature_builder_append_reg() - Append a register. 83 * @builder: The builder. 84 * @name: The register's name; it must be unique within a CPU. 85 * @bitsize: The register's size, in bits. 86 * @regnum: The offset of the register's number in the feature. 87 * @type: The type of the register. 88 * @group: The register group to which this register belongs; it can be NULL. 89 */ 90 void gdb_feature_builder_append_reg(const GDBFeatureBuilder *builder, 91 const char *name, 92 int bitsize, 93 int regnum, 94 const char *type, 95 const char *group); 96 97 /** 98 * gdb_feature_builder_end() - End building GDBFeature. 99 * @builder: The builder. 100 */ 101 void gdb_feature_builder_end(const GDBFeatureBuilder *builder); 102 103 /** 104 * gdb_find_static_feature() - Find a static feature. 105 * @xmlname: The name of the XML. 106 * 107 * Return: The static feature. 108 */ 109 const GDBFeature *gdb_find_static_feature(const char *xmlname); 110 111 /** 112 * gdb_read_register() - Read a register associated with a CPU. 113 * @cpu: The CPU associated with the register. 114 * @buf: The buffer that the read register will be appended to. 115 * @reg: The register's number returned by gdb_find_feature_register(). 116 * 117 * Return: The number of read bytes. 118 */ 119 int gdb_read_register(CPUState *cpu, GByteArray *buf, int reg); 120 121 /** 122 * typedef GDBRegDesc - a register description from gdbstub 123 */ 124 typedef struct { 125 int gdb_reg; 126 const char *name; 127 const char *feature_name; 128 } GDBRegDesc; 129 130 /** 131 * gdb_get_register_list() - Return list of all registers for CPU 132 * @cpu: The CPU being searched 133 * 134 * Returns a GArray of GDBRegDesc, caller frees array but not the 135 * const strings. 136 */ 137 GArray *gdb_get_register_list(CPUState *cpu); 138 139 void gdb_set_stop_cpu(CPUState *cpu); 140 141 /* in gdbstub-xml.c, generated by scripts/feature_to_c.py */ 142 extern const GDBFeature gdb_static_features[]; 143 144 #endif /* GDBSTUB_H */ 145