1 /* Copyright (C) 2006-2019 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
;
136 /* Predefined types. */
150 TDESC_TYPE_IEEE_SINGLE
,
151 TDESC_TYPE_IEEE_DOUBLE
,
152 TDESC_TYPE_ARM_FPA_EXT
,
155 /* Types defined by a target feature. */
163 struct tdesc_type
: tdesc_element
165 tdesc_type (const std::string
&name_
, enum tdesc_type_kind kind_
)
166 : name (name_
), kind (kind_
)
169 virtual ~tdesc_type () = default;
171 DISABLE_COPY_AND_ASSIGN (tdesc_type
);
173 /* The name of this type. */
176 /* Identify the kind of this type. */
177 enum tdesc_type_kind kind
;
179 bool operator== (const tdesc_type
&other
) const
181 return name
== other
.name
&& kind
== other
.kind
;
184 bool operator!= (const tdesc_type
&other
) const
186 return !(*this == other
);
190 typedef std::unique_ptr
<tdesc_type
> tdesc_type_up
;
192 struct tdesc_type_builtin
: tdesc_type
194 tdesc_type_builtin (const std::string
&name
, enum tdesc_type_kind kind
)
195 : tdesc_type (name
, kind
)
198 void accept (tdesc_element_visitor
&v
) const override
204 /* tdesc_type for vector types. */
206 struct tdesc_type_vector
: tdesc_type
208 tdesc_type_vector (const std::string
&name
, tdesc_type
*element_type_
,
210 : tdesc_type (name
, TDESC_TYPE_VECTOR
),
211 element_type (element_type_
), count (count_
)
214 void accept (tdesc_element_visitor
&v
) const override
219 struct tdesc_type
*element_type
;
223 /* A named type from a target description. */
225 struct tdesc_type_field
227 tdesc_type_field (const std::string
&name_
, tdesc_type
*type_
,
228 int start_
, int end_
)
229 : name (name_
), type (type_
), start (start_
), end (end_
)
233 struct tdesc_type
*type
;
234 /* For non-enum-values, either both are -1 (non-bitfield), or both are
235 not -1 (bitfield). For enum values, start is the value (which could be
240 /* tdesc_type for struct, union, flags, and enum types. */
242 struct tdesc_type_with_fields
: tdesc_type
244 tdesc_type_with_fields (const std::string
&name
, tdesc_type_kind kind
,
246 : tdesc_type (name
, kind
), size (size_
)
249 void accept (tdesc_element_visitor
&v
) const override
254 std::vector
<tdesc_type_field
> fields
;
258 /* A feature from a target description. Each feature is a collection
259 of other elements, e.g. registers and types. */
261 struct tdesc_feature
: tdesc_element
263 tdesc_feature (const std::string
&name_
)
267 virtual ~tdesc_feature () = default;
269 DISABLE_COPY_AND_ASSIGN (tdesc_feature
);
271 /* The name of this feature. It may be recognized by the architecture
275 /* The registers associated with this feature. */
276 std::vector
<tdesc_reg_up
> registers
;
278 /* The types associated with this feature. */
279 std::vector
<tdesc_type_up
> types
;
281 void accept (tdesc_element_visitor
&v
) const override
;
283 bool operator== (const tdesc_feature
&other
) const;
285 bool operator!= (const tdesc_feature
&other
) const
287 return !(*this == other
);
291 typedef std::unique_ptr
<tdesc_feature
> tdesc_feature_up
;
293 /* Allocate a new target_desc. */
294 target_desc
*allocate_target_description (void);
296 /* Set TARGET_DESC's architecture by NAME. */
297 void set_tdesc_architecture (target_desc
*target_desc
,
300 /* Return the architecture associated with this target description as a string,
301 or NULL if no architecture was specified. */
302 const char *tdesc_architecture_name (const struct target_desc
*target_desc
);
304 /* Set TARGET_DESC's osabi by NAME. */
305 void set_tdesc_osabi (target_desc
*target_desc
, const char *name
);
307 /* Return the osabi associated with this target description as a string,
308 or NULL if no osabi was specified. */
309 const char *tdesc_osabi_name (const struct target_desc
*target_desc
);
311 /* Return the type associated with ID in the context of FEATURE, or
313 struct tdesc_type
*tdesc_named_type (const struct tdesc_feature
*feature
,
316 /* Return the created feature named NAME in target description TDESC. */
317 struct tdesc_feature
*tdesc_create_feature (struct target_desc
*tdesc
,
320 /* Return the created vector tdesc_type named NAME in FEATURE. */
321 struct tdesc_type
*tdesc_create_vector (struct tdesc_feature
*feature
,
323 struct tdesc_type
*field_type
,
326 /* Return the created struct tdesc_type named NAME in FEATURE. */
327 tdesc_type_with_fields
*tdesc_create_struct (struct tdesc_feature
*feature
,
330 /* Return the created union tdesc_type named NAME in FEATURE. */
331 tdesc_type_with_fields
*tdesc_create_union (struct tdesc_feature
*feature
,
334 /* Return the created flags tdesc_type named NAME in FEATURE. */
335 tdesc_type_with_fields
*tdesc_create_flags (struct tdesc_feature
*feature
,
339 /* Return the created enum tdesc_type named NAME in FEATURE. */
340 tdesc_type_with_fields
*tdesc_create_enum (struct tdesc_feature
*feature
,
344 /* Add a new field to TYPE. FIELD_NAME is its name, and FIELD_TYPE is
346 void tdesc_add_field (tdesc_type_with_fields
*type
, const char *field_name
,
347 struct tdesc_type
*field_type
);
349 /* Add a new bitfield to TYPE, with range START to END. FIELD_NAME is its name,
350 and FIELD_TYPE is its type. */
351 void tdesc_add_typed_bitfield (tdesc_type_with_fields
*type
,
352 const char *field_name
,
354 struct tdesc_type
*field_type
);
356 /* Set the total length of TYPE. Structs which contain bitfields may
357 omit the reserved bits, so the end of the last field may not
359 void tdesc_set_struct_size (tdesc_type_with_fields
*type
, int size
);
361 /* Add a new untyped bitfield to TYPE.
362 Untyped bitfields become either uint32 or uint64 depending on the size
363 of the underlying type. */
364 void tdesc_add_bitfield (tdesc_type_with_fields
*type
, const char *field_name
,
367 /* A flag is just a typed(bool) single-bit bitfield.
368 This function is kept to minimize changes in generated files. */
369 void tdesc_add_flag (tdesc_type_with_fields
*type
, int start
,
370 const char *flag_name
);
372 /* Add field with VALUE and NAME to the enum TYPE. */
373 void tdesc_add_enum_value (tdesc_type_with_fields
*type
, int value
,
376 /* Create a register in feature FEATURE. */
377 void tdesc_create_reg (struct tdesc_feature
*feature
, const char *name
,
378 int regnum
, int save_restore
, const char *group
,
379 int bitsize
, const char *type
);
381 /* Return the tdesc in string XML format. */
383 const char *tdesc_get_features_xml (const target_desc
*tdesc
);
385 /* Print target description as xml. */
387 class print_xml_feature
: public tdesc_element_visitor
390 print_xml_feature (std::string
*buffer_
)
394 void visit_pre (const target_desc
*e
) override
;
395 void visit_post (const target_desc
*e
) override
;
396 void visit_pre (const tdesc_feature
*e
) override
;
397 void visit_post (const tdesc_feature
*e
) override
;
398 void visit (const tdesc_type_builtin
*type
) override
;
399 void visit (const tdesc_type_vector
*type
) override
;
400 void visit (const tdesc_type_with_fields
*type
) override
;
401 void visit (const tdesc_reg
*reg
) override
;
404 std::string
*m_buffer
;
407 #endif /* COMMON_TDESC_H */
This page took 0.040499 seconds and 4 git commands to generate.