1 /* Copyright (C) 2006-2020 Free Software Foundation, Inc.
3 This file is part of GDB.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
18 #ifndef COMMON_TDESC_H
19 #define COMMON_TDESC_H
23 struct tdesc_type_builtin
;
24 struct tdesc_type_vector
;
25 struct tdesc_type_with_fields
;
29 /* The interface to visit different elements of target description. */
31 class tdesc_element_visitor
34 virtual void visit_pre (const target_desc
*e
)
37 virtual void visit_post (const target_desc
*e
)
40 virtual void visit_pre (const tdesc_feature
*e
)
43 virtual void visit_post (const tdesc_feature
*e
)
46 virtual void visit (const tdesc_type_builtin
*e
)
49 virtual void visit (const tdesc_type_vector
*e
)
52 virtual void visit (const tdesc_type_with_fields
*e
)
55 virtual void visit (const tdesc_reg
*e
)
62 virtual void accept (tdesc_element_visitor
&v
) const = 0;
65 /* An individual register from a target description. */
67 struct tdesc_reg
: tdesc_element
69 tdesc_reg (struct tdesc_feature
*feature
, const std::string
&name_
,
70 int regnum
, int save_restore_
, const char *group_
,
71 int bitsize_
, const char *type_
);
73 virtual ~tdesc_reg () = default;
75 DISABLE_COPY_AND_ASSIGN (tdesc_reg
);
77 /* The name of this register. In standard features, it may be
78 recognized by the architecture support code, or it may be purely
82 /* The register number used by this target to refer to this
83 register. This is used for remote p/P packets and to determine
84 the ordering of registers in the remote g/G packets. */
87 /* If this flag is set, GDB should save and restore this register
88 around calls to an inferior function. */
91 /* The name of the register group containing this register, or empty
92 if the group should be automatically determined from the
93 register's type. If this is "general", "float", or "vector", the
94 corresponding "info" command should display this register's
95 value. It can be an arbitrary string, but should be limited to
96 alphanumeric characters and internal hyphens. Currently other
97 strings are ignored (treated as empty). */
100 /* The size of the register, in bits. */
103 /* The type of the register. This string corresponds to either
104 a named type from the target description or a predefined
108 /* The target-described type corresponding to TYPE, if found. */
109 struct tdesc_type
*tdesc_type
;
111 void accept (tdesc_element_visitor
&v
) const override
116 bool operator== (const tdesc_reg
&other
) const
118 return (name
== other
.name
119 && target_regnum
== other
.target_regnum
120 && save_restore
== other
.save_restore
121 && bitsize
== other
.bitsize
122 && group
== other
.group
123 && type
== other
.type
);
126 bool operator!= (const tdesc_reg
&other
) const
128 return !(*this == other
);
132 typedef std::unique_ptr
<tdesc_reg
> tdesc_reg_up
;
134 /* Declaration of a structure that holds information about one
135 "compatibility" entry within a target description. */
137 struct tdesc_compatible_info
;
139 /* A pointer to a single piece of compatibility information. */
141 typedef std::unique_ptr
<tdesc_compatible_info
> tdesc_compatible_info_up
;
143 /* Return a vector of compatibility information pointers from the target
144 description TARGET_DESC. */
146 const std::vector
<tdesc_compatible_info_up
> &tdesc_compatible_info_list
147 (const target_desc
*target_desc
);
149 /* Return the architecture name from a compatibility information
152 const char *tdesc_compatible_info_arch_name
153 (const tdesc_compatible_info_up
&compatible
);
157 /* Predefined types. */
171 TDESC_TYPE_IEEE_HALF
,
172 TDESC_TYPE_IEEE_SINGLE
,
173 TDESC_TYPE_IEEE_DOUBLE
,
174 TDESC_TYPE_ARM_FPA_EXT
,
177 /* Types defined by a target feature. */
185 struct tdesc_type
: tdesc_element
187 tdesc_type (const std::string
&name_
, enum tdesc_type_kind kind_
)
188 : name (name_
), kind (kind_
)
191 virtual ~tdesc_type () = default;
193 DISABLE_COPY_AND_ASSIGN (tdesc_type
);
195 /* The name of this type. */
198 /* Identify the kind of this type. */
199 enum tdesc_type_kind kind
;
201 bool operator== (const tdesc_type
&other
) const
203 return name
== other
.name
&& kind
== other
.kind
;
206 bool operator!= (const tdesc_type
&other
) const
208 return !(*this == other
);
212 typedef std::unique_ptr
<tdesc_type
> tdesc_type_up
;
214 struct tdesc_type_builtin
: tdesc_type
216 tdesc_type_builtin (const std::string
&name
, enum tdesc_type_kind kind
)
217 : tdesc_type (name
, kind
)
220 void accept (tdesc_element_visitor
&v
) const override
226 /* tdesc_type for vector types. */
228 struct tdesc_type_vector
: tdesc_type
230 tdesc_type_vector (const std::string
&name
, tdesc_type
*element_type_
,
232 : tdesc_type (name
, TDESC_TYPE_VECTOR
),
233 element_type (element_type_
), count (count_
)
236 void accept (tdesc_element_visitor
&v
) const override
241 struct tdesc_type
*element_type
;
245 /* A named type from a target description. */
247 struct tdesc_type_field
249 tdesc_type_field (const std::string
&name_
, tdesc_type
*type_
,
250 int start_
, int end_
)
251 : name (name_
), type (type_
), start (start_
), end (end_
)
255 struct tdesc_type
*type
;
256 /* For non-enum-values, either both are -1 (non-bitfield), or both are
257 not -1 (bitfield). For enum values, start is the value (which could be
262 /* tdesc_type for struct, union, flags, and enum types. */
264 struct tdesc_type_with_fields
: tdesc_type
266 tdesc_type_with_fields (const std::string
&name
, tdesc_type_kind kind
,
268 : tdesc_type (name
, kind
), size (size_
)
271 void accept (tdesc_element_visitor
&v
) const override
276 std::vector
<tdesc_type_field
> fields
;
280 /* A feature from a target description. Each feature is a collection
281 of other elements, e.g. registers and types. */
283 struct tdesc_feature
: tdesc_element
285 tdesc_feature (const std::string
&name_
)
289 virtual ~tdesc_feature () = default;
291 DISABLE_COPY_AND_ASSIGN (tdesc_feature
);
293 /* The name of this feature. It may be recognized by the architecture
297 /* The registers associated with this feature. */
298 std::vector
<tdesc_reg_up
> registers
;
300 /* The types associated with this feature. */
301 std::vector
<tdesc_type_up
> types
;
303 void accept (tdesc_element_visitor
&v
) const override
;
305 bool operator== (const tdesc_feature
&other
) const;
307 bool operator!= (const tdesc_feature
&other
) const
309 return !(*this == other
);
313 typedef std::unique_ptr
<tdesc_feature
> tdesc_feature_up
;
315 /* Allocate a new target_desc. */
316 target_desc
*allocate_target_description (void);
318 /* Set TARGET_DESC's architecture by NAME. */
319 void set_tdesc_architecture (target_desc
*target_desc
,
322 /* Return the architecture associated with this target description as a string,
323 or NULL if no architecture was specified. */
324 const char *tdesc_architecture_name (const struct target_desc
*target_desc
);
326 /* Set TARGET_DESC's osabi by NAME. */
327 void set_tdesc_osabi (target_desc
*target_desc
, const char *name
);
329 /* Return the osabi associated with this target description as a string,
330 or NULL if no osabi was specified. */
331 const char *tdesc_osabi_name (const struct target_desc
*target_desc
);
333 /* Return the type associated with ID in the context of FEATURE, or
335 struct tdesc_type
*tdesc_named_type (const struct tdesc_feature
*feature
,
338 /* Return the created feature named NAME in target description TDESC. */
339 struct tdesc_feature
*tdesc_create_feature (struct target_desc
*tdesc
,
342 /* Return the created vector tdesc_type named NAME in FEATURE. */
343 struct tdesc_type
*tdesc_create_vector (struct tdesc_feature
*feature
,
345 struct tdesc_type
*field_type
,
348 /* Return the created struct tdesc_type named NAME in FEATURE. */
349 tdesc_type_with_fields
*tdesc_create_struct (struct tdesc_feature
*feature
,
352 /* Return the created union tdesc_type named NAME in FEATURE. */
353 tdesc_type_with_fields
*tdesc_create_union (struct tdesc_feature
*feature
,
356 /* Return the created flags tdesc_type named NAME in FEATURE. */
357 tdesc_type_with_fields
*tdesc_create_flags (struct tdesc_feature
*feature
,
361 /* Return the created enum tdesc_type named NAME in FEATURE. */
362 tdesc_type_with_fields
*tdesc_create_enum (struct tdesc_feature
*feature
,
366 /* Add a new field to TYPE. FIELD_NAME is its name, and FIELD_TYPE is
368 void tdesc_add_field (tdesc_type_with_fields
*type
, const char *field_name
,
369 struct tdesc_type
*field_type
);
371 /* Add a new bitfield to TYPE, with range START to END. FIELD_NAME is its name,
372 and FIELD_TYPE is its type. */
373 void tdesc_add_typed_bitfield (tdesc_type_with_fields
*type
,
374 const char *field_name
,
376 struct tdesc_type
*field_type
);
378 /* Set the total length of TYPE. Structs which contain bitfields may
379 omit the reserved bits, so the end of the last field may not
381 void tdesc_set_struct_size (tdesc_type_with_fields
*type
, int size
);
383 /* Add a new untyped bitfield to TYPE.
384 Untyped bitfields become either uint32 or uint64 depending on the size
385 of the underlying type. */
386 void tdesc_add_bitfield (tdesc_type_with_fields
*type
, const char *field_name
,
389 /* A flag is just a typed(bool) single-bit bitfield.
390 This function is kept to minimize changes in generated files. */
391 void tdesc_add_flag (tdesc_type_with_fields
*type
, int start
,
392 const char *flag_name
);
394 /* Add field with VALUE and NAME to the enum TYPE. */
395 void tdesc_add_enum_value (tdesc_type_with_fields
*type
, int value
,
398 /* Create a register in feature FEATURE. */
399 void tdesc_create_reg (struct tdesc_feature
*feature
, const char *name
,
400 int regnum
, int save_restore
, const char *group
,
401 int bitsize
, const char *type
);
403 /* Return the tdesc in string XML format. */
405 const char *tdesc_get_features_xml (const target_desc
*tdesc
);
407 /* Print target description as xml. */
409 class print_xml_feature
: public tdesc_element_visitor
412 print_xml_feature (std::string
*buffer_
)
413 : m_buffer (buffer_
),
417 void visit_pre (const target_desc
*e
) override
;
418 void visit_post (const target_desc
*e
) override
;
419 void visit_pre (const tdesc_feature
*e
) override
;
420 void visit_post (const tdesc_feature
*e
) override
;
421 void visit (const tdesc_type_builtin
*type
) override
;
422 void visit (const tdesc_type_vector
*type
) override
;
423 void visit (const tdesc_type_with_fields
*type
) override
;
424 void visit (const tdesc_reg
*reg
) override
;
428 /* Called with a positive value of ADJUST when we move inside an element,
429 for example inside <target>, and with a negative value when we leave
430 the element. In this class this function does nothing, but a
431 sub-class can override this to track the current level of nesting. */
432 void indent (int adjust
)
434 m_depth
+= (adjust
* 2);
437 /* Functions to add lines to the output buffer M_BUFFER. Each of these
438 functions appends a newline, so don't include one in the strings being
440 void add_line (const std::string
&str
);
441 void add_line (const char *fmt
, ...);
443 /* The buffer we are writing too. */
444 std::string
*m_buffer
;
446 /* The current indentation depth. */
450 #endif /* COMMON_TDESC_H */