Skip to content

Commit

Permalink
Improve function doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
jackgallagher-arm committed Mar 28, 2024
1 parent 0e9603e commit 9277917
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
6 changes: 6 additions & 0 deletions core/ir/instr.h
Original file line number Diff line number Diff line change
Expand Up @@ -678,6 +678,12 @@ bool
opc_is_not_a_real_memory_load(int opc);

#if defined(X86) || defined(AARCH64)
/* Compute the index-th address for a memory operand that uses a vector register for the
* base or index register.
* The return value has the same semantics as instr_compute_address_ex(). It returns:
* true if index is in bounds and an address was calculated and returned,
* false if index >= the number of addresses this instruction accesses.
*/
bool
instr_compute_vector_address(instr_t *instr, priv_mcontext_t *mc, size_t mc_size,
dr_mcontext_flags_t mc_flags, opnd_t curop, uint index,
Expand Down
3 changes: 2 additions & 1 deletion core/ir/instr_api.h
Original file line number Diff line number Diff line change
Expand Up @@ -1639,7 +1639,8 @@ DR_API
* write is returned in \p is_write. Either or both OUT variables can
* be NULL.
* \p mc->flags must include DR_MC_CONTROL and DR_MC_INTEGER.
* For instructions that use vector addressing (VSIB, introduced in AVX2),
* For instructions that use vector addressing (x86 VSIB, introduced in AVX2, or
* AArch64 scatter/gather instructions introduced in SVE/SVE2),
* mc->flags must additionally include DR_MC_MULTIMEDIA.
*
* Like instr_reads_memory(), this routine does not consider
Expand Down

0 comments on commit 9277917

Please sign in to comment.