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 * gdbserver_start: start the gdb server 45 * @port_or_device: connection spec for gdb 46 * 47 * For CONFIG_USER this is either a tcp port or a path to a fifo. For 48 * system emulation you can use a full chardev spec for your gdbserver 49 * port. 50 */ 51 int gdbserver_start(const char *port_or_device); 52 53 /** 54 * gdb_feature_builder_init() - Initialize GDBFeatureBuilder. 55 * @builder: The builder to be initialized. 56 * @feature: The feature to be filled. 57 * @name: The name of the feature. 58 * @xmlname: The name of the XML. 59 * @base_reg: The base number of the register ID. 60 */ 61 void gdb_feature_builder_init(GDBFeatureBuilder *builder, GDBFeature *feature, 62 const char *name, const char *xmlname, 63 int base_reg); 64 65 /** 66 * gdb_feature_builder_append_tag() - Append a tag. 67 * @builder: The builder. 68 * @format: The format of the tag. 69 * @...: The values to be formatted. 70 */ 71 void G_GNUC_PRINTF(2, 3) 72 gdb_feature_builder_append_tag(const GDBFeatureBuilder *builder, 73 const char *format, ...); 74 75 /** 76 * gdb_feature_builder_append_reg() - Append a register. 77 * @builder: The builder. 78 * @name: The register's name; it must be unique within a CPU. 79 * @bitsize: The register's size, in bits. 80 * @regnum: The offset of the register's number in the feature. 81 * @type: The type of the register. 82 * @group: The register group to which this register belongs; it can be NULL. 83 */ 84 void gdb_feature_builder_append_reg(const GDBFeatureBuilder *builder, 85 const char *name, 86 int bitsize, 87 int regnum, 88 const char *type, 89 const char *group); 90 91 /** 92 * gdb_feature_builder_end() - End building GDBFeature. 93 * @builder: The builder. 94 */ 95 void gdb_feature_builder_end(const GDBFeatureBuilder *builder); 96 97 /** 98 * gdb_find_static_feature() - Find a static feature. 99 * @xmlname: The name of the XML. 100 * 101 * Return: The static feature. 102 */ 103 const GDBFeature *gdb_find_static_feature(const char *xmlname); 104 105 /** 106 * gdb_read_register() - Read a register associated with a CPU. 107 * @cpu: The CPU associated with the register. 108 * @buf: The buffer that the read register will be appended to. 109 * @reg: The register's number returned by gdb_find_feature_register(). 110 * 111 * Return: The number of read bytes. 112 */ 113 int gdb_read_register(CPUState *cpu, GByteArray *buf, int reg); 114 115 /** 116 * typedef GDBRegDesc - a register description from gdbstub 117 */ 118 typedef struct { 119 int gdb_reg; 120 const char *name; 121 const char *feature_name; 122 } GDBRegDesc; 123 124 /** 125 * gdb_get_register_list() - Return list of all registers for CPU 126 * @cpu: The CPU being searched 127 * 128 * Returns a GArray of GDBRegDesc, caller frees array but not the 129 * const strings. 130 */ 131 GArray *gdb_get_register_list(CPUState *cpu); 132 133 void gdb_set_stop_cpu(CPUState *cpu); 134 135 /* in gdbstub-xml.c, generated by scripts/feature_to_c.py */ 136 extern const GDBFeature gdb_static_features[]; 137 138 #endif /* GDBSTUB_H */ 139