================
@@ -1804,65 +1804,56 @@ getElementRegionOffsetsWithBase(const ElementRegion
*ER) {
/// This is a helper function for `getConstantValFromConstArrayInitializer`.
///
-/// Convert array of offsets from `SVal` to `uint64_t` in consideration of
-/// respective array extents.
-/// \param SrcOffsets [in] The array of offsets of type `SVal` in reversed
-/// order (expectedly received from `getElementRegionOffsetsWithBase`).
-/// \param ArrayExtents [in] The array of extents.
-/// \param DstOffsets [out] The array of offsets of type `uint64_t`.
+/// Flatten per-dimension SVal offsets into a linear index, bounds-check
+/// against the total allocation, and decompose back into per-dimension
+/// uint64_t indices.
+///
+/// \param SrcOffsets [in] Per-dimension offsets in reversed order
+/// (as received from `getElementRegionOffsetsWithBase`).
+/// \param ArrayExtents [in] Extents per dimension (outer to inner).
+/// \param DstOffsets [out] Normalized per-dimension indices.
/// \returns:
-/// - `std::nullopt` for successful convertion.
-/// - `UndefinedVal` or `UnknownVal` otherwise. It's expected that this SVal
-/// will be returned as a suitable value of the access operation.
-/// which should be returned as a correct
+/// - `std::nullopt` on success.
+/// - `UndefinedVal` if the flat offset is out of bounds.
+/// - `UnknownVal` if any index is symbolic.
///
/// \example:
/// const int arr[10][20][30] = {}; // ArrayExtents { 10, 20, 30 }
-/// int x1 = arr[4][5][6]; // SrcOffsets { NonLoc(6), NonLoc(5), NonLoc(4) }
----------------
NagyDonat wrote:
Please keep one example line that shows the correspondence between the analyzer
input source code and the contents of the array `SrcOffsets`.
I feel that the phrases "in reversed order", "outer" and "inner" are very hard
to interpret (in fact my first guess was incorrect) -- providing a good example
is the only good way to unambiguously describe the relationship between these
inputs.
https://github.com/llvm/llvm-project/pull/200044
_______________________________________________
cfe-commits mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
