From: Zoran Zaric <zoran.zaric@amd.com>
To: <gdb-patches@sourceware.org>
Subject: [PATCH v3 18/28] Comments cleanup between expr.h and expr.c
Date: Thu, 14 Oct 2021 10:32:25 +0100 [thread overview]
Message-ID: <20211014093235.69756-19-zoran.zaric@amd.com> (raw)
In-Reply-To: <20211014093235.69756-1-zoran.zaric@amd.com>
From: Zoran Zaric <Zoran.Zaric@amd.com>
This is just a cosmetic cleanup of the expr.h and expr.c documentation.
gdb/ChangeLog:
* dwarf2/expr.c: Comments cleanup.
* dwarf2/expr.h: Comments cleanup.
---
gdb/dwarf2/expr.c | 42 +++++++++++++++---------------------
gdb/dwarf2/expr.h | 55 ++++++++++++++++++++++++++++++++++++++++++++---
2 files changed, 69 insertions(+), 28 deletions(-)
diff --git a/gdb/dwarf2/expr.c b/gdb/dwarf2/expr.c
index 871c558e1a8..d5ecc5b4a87 100644
--- a/gdb/dwarf2/expr.c
+++ b/gdb/dwarf2/expr.c
@@ -2394,7 +2394,7 @@ dwarf_expr_context::dwarf_expr_context (dwarf2_per_objfile *per_objfile,
{
}
-/* Push ENTRY onto the stack. */
+/* See expr.h. */
void
dwarf_expr_context::push (dwarf_entry_up entry)
@@ -2402,7 +2402,7 @@ dwarf_expr_context::push (dwarf_entry_up entry)
this->m_stack.emplace_back (std::move (entry));
}
-/* Push ADDR onto the stack. */
+/* See expr.h. */
void
dwarf_expr_context::push_address (CORE_ADDR addr, bool in_stack_memory)
@@ -2412,7 +2412,7 @@ dwarf_expr_context::push_address (CORE_ADDR addr, bool in_stack_memory)
}
-/* Pop the top item off of the stack. */
+/* See expr.h. */
dwarf_entry_up
dwarf_expr_context::pop ()
@@ -2425,7 +2425,7 @@ dwarf_expr_context::pop ()
return entry;
}
-/* Retrieve the N'th item on the stack. */
+/* See expr.h. */
dwarf_entry &
dwarf_expr_context::fetch (int n)
@@ -2653,7 +2653,7 @@ get_signed_type (struct gdbarch *gdbarch, struct type *type)
}
}
-/* Return true if the expression stack is empty. */
+/* See expr.h. */
bool
dwarf_expr_context::stack_empty_p () const
@@ -2661,7 +2661,7 @@ dwarf_expr_context::stack_empty_p () const
return this->m_stack.empty ();
}
-/* Add a new piece to the composite on top of the stack. */
+/* See expr.h. */
void
dwarf_expr_context::add_piece (ULONGEST bit_size, ULONGEST bit_offset)
@@ -2715,7 +2715,7 @@ dwarf_expr_context::add_piece (ULONGEST bit_size, ULONGEST bit_offset)
}
-/* Evaluate the expression at ADDR (LEN bytes long). */
+/* See expr.h. */
void
dwarf_expr_context::eval (const gdb_byte *addr, size_t len)
@@ -2729,7 +2729,7 @@ dwarf_expr_context::eval (const gdb_byte *addr, size_t len)
gdb_assert (this->m_recursion_depth == old_recursion_depth);
}
-/* Helper to read a uleb128 value or throw an error. */
+/* See expr.h. */
const gdb_byte *
safe_read_uleb128 (const gdb_byte *buf, const gdb_byte *buf_end,
@@ -2741,7 +2741,7 @@ safe_read_uleb128 (const gdb_byte *buf, const gdb_byte *buf_end,
return buf;
}
-/* Helper to read a sleb128 value or throw an error. */
+/* See expr.h. */
const gdb_byte *
safe_read_sleb128 (const gdb_byte *buf, const gdb_byte *buf_end,
@@ -2753,6 +2753,8 @@ safe_read_sleb128 (const gdb_byte *buf, const gdb_byte *buf_end,
return buf;
}
+/* See expr.h. */
+
const gdb_byte *
safe_skip_leb128 (const gdb_byte *buf, const gdb_byte *buf_end)
{
@@ -2762,9 +2764,7 @@ safe_skip_leb128 (const gdb_byte *buf, const gdb_byte *buf_end)
return buf;
}
-/* Check that the current operator is either at the end of an
- expression, or that it is followed by a composition operator or by
- DW_OP_GNU_uninit (which should terminate the expression). */
+/* See expr.h. */
void
dwarf_expr_require_composition (const gdb_byte *op_ptr, const gdb_byte *op_end,
@@ -2792,8 +2792,7 @@ base_types_equal_p (struct type *t1, struct type *t2)
return TYPE_LENGTH (t1) == TYPE_LENGTH (t2);
}
-/* If <BUF..BUF_END] contains DW_FORM_block* with single DW_OP_reg* return the
- DWARF register number. Otherwise return -1. */
+/* See expr.h. */
int
dwarf_block_to_dwarf_reg (const gdb_byte *buf, const gdb_byte *buf_end)
@@ -2833,10 +2832,7 @@ dwarf_block_to_dwarf_reg (const gdb_byte *buf, const gdb_byte *buf_end)
return dwarf_reg;
}
-/* If <BUF..BUF_END] contains DW_FORM_block* with just DW_OP_breg*(0) and
- DW_OP_deref* return the DWARF register number. Otherwise return -1.
- DEREF_SIZE_RETURN contains -1 for DW_OP_deref; otherwise it contains the
- size from DW_OP_deref_size. */
+/* See expr.h. */
int
dwarf_block_to_dwarf_reg_deref (const gdb_byte *buf, const gdb_byte *buf_end,
@@ -2894,8 +2890,7 @@ dwarf_block_to_dwarf_reg_deref (const gdb_byte *buf, const gdb_byte *buf_end,
return dwarf_reg;
}
-/* If <BUF..BUF_END] contains DW_FORM_block* with single DW_OP_fbreg(X) fill
- in FB_OFFSET_RETURN with the X offset and return 1. Otherwise return 0. */
+/* See expr.h. */
int
dwarf_block_to_fb_offset (const gdb_byte *buf, const gdb_byte *buf_end,
@@ -2920,9 +2915,7 @@ dwarf_block_to_fb_offset (const gdb_byte *buf, const gdb_byte *buf_end,
return 1;
}
-/* If <BUF..BUF_END] contains DW_FORM_block* with single DW_OP_bregSP(X) fill
- in SP_OFFSET_RETURN with the X offset and return 1. Otherwise return 0.
- The matched SP register number depends on GDBARCH. */
+/* See expr.h. */
int
dwarf_block_to_sp_offset (struct gdbarch *gdbarch, const gdb_byte *buf,
@@ -2962,8 +2955,7 @@ dwarf_block_to_sp_offset (struct gdbarch *gdbarch, const gdb_byte *buf,
return 1;
}
-/* The engine for the expression evaluator. Using the context in this
- object, evaluate the expression between OP_PTR and OP_END. */
+/* See expr.h. */
void
dwarf_expr_context::execute_stack_op (const gdb_byte *op_ptr,
diff --git a/gdb/dwarf2/expr.h b/gdb/dwarf2/expr.h
index 1f3507ba5db..adf1f11c8ec 100644
--- a/gdb/dwarf2/expr.h
+++ b/gdb/dwarf2/expr.h
@@ -47,10 +47,17 @@ struct dwarf2_per_objfile;
its current state and its callbacks. */
struct dwarf_expr_context
{
- dwarf_expr_context (dwarf2_per_objfile *per_objfile,
- int addr_size);
+ /* Create a new context for the expression evaluator.
+
+ We should ever only pass in the PER_OBJFILE and the ADDR_SIZE
+ information should be retrievable from there. The PER_OBJFILE
+ contains a pointer to the PER_BFD information anyway and the
+ address size information must be the same for the whole BFD. */
+ dwarf_expr_context (dwarf2_per_objfile *per_objfile, int addr_size);
+
virtual ~dwarf_expr_context () = default;
+ /* Push ADDR onto the stack. */
void push_address (CORE_ADDR addr, bool in_stack_memory);
/* Evaluate the expression at ADDR (LEN bytes long) in a given PER_CU
@@ -95,13 +102,38 @@ struct dwarf_expr_context
/* Property address info used for the evaluation. */
const struct property_addr_info *m_addr_info = nullptr;
+ /* Evaluate the expression at ADDR (LEN bytes long). */
void eval (const gdb_byte *addr, size_t len);
+
+ /* Return the type used for DWARF operations where the type is
+ unspecified in the DWARF spec. Only certain sizes are
+ supported. */
struct type *address_type () const;
- void push (dwarf_entry_up value);
+
+ /* Push ENTRY onto the stack. */
+ void push (dwarf_entry_up entry);
+
+ /* Return true if the expression stack is empty. */
bool stack_empty_p () const;
+
+ /* Pop a top element of the stack and add as a composite piece
+ with an BIT_OFFSET offset and of a BIT_SIZE size.
+
+ If the following top element of the stack is a composite
+ location description, the piece will be added to it. Otherwise
+ a new composite location description will be created, pushed on
+ the stack and the piece will be added to that composite. */
void add_piece (ULONGEST bit_size, ULONGEST bit_offset);
+
+ /* The engine for the expression evaluator. Using the context in
+ this object, evaluate the expression between OP_PTR and
+ OP_END. */
void execute_stack_op (const gdb_byte *op_ptr, const gdb_byte *op_end);
+
+ /* Pop the top item off of the stack. */
dwarf_entry_up pop ();
+
+ /* Retrieve the N'th item on the stack. */
dwarf_entry &fetch (int n);
/* Fetch the result of the expression evaluation in a form of
@@ -141,18 +173,32 @@ struct dwarf_expr_context
read as an address in a given FRAME. */
CORE_ADDR read_addr_from_reg (frame_info *frame, int reg);
+/* Check that the current operator is either at the end of an
+ expression, or that it is followed by a composition operator or by
+ DW_OP_GNU_uninit (which should terminate the expression). */
void dwarf_expr_require_composition (const gdb_byte *, const gdb_byte *,
const char *);
+/* If <BUF..BUF_END] contains DW_FORM_block* with single DW_OP_reg* return the
+ DWARF register number. Otherwise return -1. */
int dwarf_block_to_dwarf_reg (const gdb_byte *buf, const gdb_byte *buf_end);
+/* If <BUF..BUF_END] contains DW_FORM_block* with just DW_OP_breg*(0) and
+ DW_OP_deref* return the DWARF register number. Otherwise return -1.
+ DEREF_SIZE_RETURN contains -1 for DW_OP_deref; otherwise it contains the
+ size from DW_OP_deref_size. */
int dwarf_block_to_dwarf_reg_deref (const gdb_byte *buf,
const gdb_byte *buf_end,
CORE_ADDR *deref_size_return);
+/* If <BUF..BUF_END] contains DW_FORM_block* with single DW_OP_fbreg(X) fill
+ in FB_OFFSET_RETURN with the X offset and return 1. Otherwise return 0. */
int dwarf_block_to_fb_offset (const gdb_byte *buf, const gdb_byte *buf_end,
CORE_ADDR *fb_offset_return);
+/* If <BUF..BUF_END] contains DW_FORM_block* with single DW_OP_bregSP(X) fill
+ in SP_OFFSET_RETURN with the X offset and return 1. Otherwise return 0.
+ The matched SP register number depends on GDBARCH. */
int dwarf_block_to_sp_offset (struct gdbarch *gdbarch, const gdb_byte *buf,
const gdb_byte *buf_end,
CORE_ADDR *sp_offset_return);
@@ -192,14 +238,17 @@ gdb_skip_leb128 (const gdb_byte *buf, const gdb_byte *buf_end)
return buf + bytes_read;
}
+/* Helper to read a uleb128 value or throw an error. */
extern const gdb_byte *safe_read_uleb128 (const gdb_byte *buf,
const gdb_byte *buf_end,
uint64_t *r);
+/* Helper to read a uleb128 value or throw an error. */
extern const gdb_byte *safe_read_sleb128 (const gdb_byte *buf,
const gdb_byte *buf_end,
int64_t *r);
+/* Helper to skip a leb128 value or throw an error. */
extern const gdb_byte *safe_skip_leb128 (const gdb_byte *buf,
const gdb_byte *buf_end);
--
2.17.1
next prev parent reply other threads:[~2021-10-14 9:33 UTC|newest]
Thread overview: 62+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-14 9:32 [PATCH v3 00/28] Allow location description on the DWARF stack Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 01/28] Add new register access interface to expr.c Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 02/28] Add new memory " Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 03/28] Add new classes that model DWARF stack element Zoran Zaric
2021-10-21 23:43 ` Lancelot SIX
2021-10-22 16:38 ` Zoran Zaric
2021-10-22 21:34 ` Lancelot SIX
2021-10-14 9:32 ` [PATCH v3 04/28] Add to_location method to DWARF entry classes Zoran Zaric
2021-10-22 21:21 ` Lancelot SIX
2021-10-25 21:23 ` Simon Marchi
2021-11-01 16:01 ` Zoran Zaric
2021-11-01 20:36 ` Simon Marchi
2021-11-01 16:00 ` Zoran Zaric
2021-11-01 17:48 ` Lancelot SIX
2021-10-14 9:32 ` [PATCH v3 05/28] Add to_value " Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 06/28] Add read method to location description classes Zoran Zaric
2021-10-25 18:33 ` Lancelot SIX
2021-10-25 21:37 ` Simon Marchi
2021-11-02 14:26 ` Zoran Zaric
2021-11-03 19:03 ` Simon Marchi
2021-11-05 11:58 ` Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 07/28] Add write " Zoran Zaric
2021-10-25 20:21 ` Lancelot SIX
2021-11-03 10:27 ` Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 08/28] Add deref " Zoran Zaric
2021-10-25 22:31 ` Lancelot SIX
2021-11-03 10:51 ` Zoran Zaric
2021-11-03 17:37 ` Simon Marchi
2021-11-05 11:55 ` Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 09/28] Add read_from_gdb_value method to dwarf_location Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 10/28] Add write_to_gdb_value " Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 11/28] Add is_implicit_ptr_at " Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 12/28] Add indirect_implicit_ptr to dwarf_location class Zoran Zaric
2021-10-26 20:52 ` Lancelot SIX
2021-11-03 15:11 ` Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 13/28] Add is_optimized_out " Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 14/28] Add new computed struct value callback interface Zoran Zaric
2021-10-26 22:50 ` Lancelot SIX
2021-11-04 11:32 ` Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 15/28] Add to_gdb_value method to DWARF entry class Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 16/28] Change DWARF stack to use new dwarf_entry classes Zoran Zaric
2021-10-31 17:58 ` Lancelot SIX
2021-11-04 12:43 ` Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 17/28] Remove old computed struct value callbacks Zoran Zaric
2021-10-14 9:32 ` Zoran Zaric [this message]
2021-10-14 9:32 ` [PATCH v3 19/28] Remove dwarf_expr_context from expr.h interface Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 20/28] Move read_addr_from_reg function to frame.c Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 21/28] Add frame info check to DW_OP_reg operations Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 22/28] Remove DWARF expression composition check Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 23/28] Add support for any location description in CFI Zoran Zaric
2021-10-31 22:58 ` Lancelot SIX
2021-11-04 15:09 ` Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 24/28] Add DWARF operations for byte and bit offset Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 25/28] Add support for DW_OP_LLVM_undefined operation Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 26/28] Add support for nested composite locations Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 27/28] Add DW_OP_LLVM_extend DWARF operation Zoran Zaric
2021-11-01 21:48 ` Lancelot SIX
2021-11-04 16:26 ` Zoran Zaric
2021-10-14 9:32 ` [PATCH v3 28/28] Add DW_OP_LLVM_select_bit_piece " Zoran Zaric
2021-11-01 22:25 ` Lancelot SIX
2021-11-04 16:39 ` Zoran Zaric
2021-11-05 11:54 ` [PATCH v3 00/28] Allow location description on the DWARF stack Zaric, Zoran (Zare)
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211014093235.69756-19-zoran.zaric@amd.com \
--to=zoran.zaric@amd.com \
--cc=gdb-patches@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).