* [PATCH v10 1/5] Provide counted_by attribute to flexible array member field (PR108896)
2024-05-30 12:26 [PATCH v10 0/5] New attribute "counted_by" to annotate bounds for C99 FAM(PR108896) Qing Zhao
@ 2024-05-30 12:26 ` Qing Zhao
2024-05-30 12:26 ` [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE Qing Zhao
` (3 subsequent siblings)
4 siblings, 0 replies; 14+ messages in thread
From: Qing Zhao @ 2024-05-30 12:26 UTC (permalink / raw)
To: rguenther, josmyers
Cc: siddhesh, uecker, keescook, isanbard, gcc-patches, Qing Zhao
'counted_by (COUNT)'
The 'counted_by' attribute may be attached to the C99 flexible
array member of a structure. It indicates that the number of the
elements of the array is given by the field "COUNT" in the
same structure as the flexible array member.
GCC may use this information to improve detection of object size information
for such structures and provide better results in compile-time diagnostics
and runtime features like the array bound sanitizer and
the '__builtin_dynamic_object_size'.
For instance, the following code:
struct P {
size_t count;
char other;
char array[] __attribute__ ((counted_by (count)));
} *p;
specifies that the 'array' is a flexible array member whose number
of elements is given by the field 'count' in the same structure.
The field that represents the number of the elements should have an
integer type. Otherwise, the compiler reports an error and
ignores the attribute.
When the field that represents the number of the elements is assigned a
negative integer value, the compiler treats the value as zero.
An explicit 'counted_by' annotation defines a relationship between
two objects, 'p->array' and 'p->count', and there are the following
requirementthat on the relationship between this pair:
* 'p->count' must be initialized before the first reference to
'p->array';
* 'p->array' has _at least_ 'p->count' number of elements
available all the time. This relationship must hold even
after any of these related objects are updated during the
program.
It's the user's responsibility to make sure the above requirements
to be kept all the time. Otherwise the compiler reports
warnings, at the same time, the results of the array bound
sanitizer and the '__builtin_dynamic_object_size' is undefined.
One important feature of the attribute is, a reference to the
flexible array member field uses the latest value assigned to
the field that represents the number of the elements before that
reference. For example,
p->count = val1;
p->array[20] = 0; // ref1 to p->array
p->count = val2;
p->array[30] = 0; // ref2 to p->array
in the above, 'ref1' uses 'val1' as the number of the elements
in 'p->array', and 'ref2' uses 'val2' as the number of elements
in 'p->array'.
gcc/c-family/ChangeLog:
PR C/108896
* c-attribs.cc (handle_counted_by_attribute): New function.
(attribute_takes_identifier_p): Add counted_by attribute to the list.
* c-common.cc (c_flexible_array_member_type_p): ...To this.
* c-common.h (c_flexible_array_member_type_p): New prototype.
gcc/c/ChangeLog:
PR C/108896
* c-decl.cc (flexible_array_member_type_p): Renamed and moved to...
(add_flexible_array_elts_to_size): Use renamed function.
(is_flexible_array_member_p): Use renamed function.
(verify_counted_by_attribute): New function.
(finish_struct): Use renamed function and verify counted_by
attribute.
* c-tree.h (lookup_field): New prototype.
* c-typeck.cc (lookup_field): Expose as extern function.
(tagged_types_tu_compatible_p): Check counted_by attribute for
structure type.
gcc/ChangeLog:
PR C/108896
* doc/extend.texi: Document attribute counted_by.
gcc/testsuite/ChangeLog:
PR C/108896
* gcc.dg/flex-array-counted-by.c: New test.
* gcc.dg/flex-array-counted-by-7.c: New test.
* gcc.dg/flex-array-counted-by-8.c: New test.
---
gcc/c-family/c-attribs.cc | 68 +++++++++-
gcc/c-family/c-common.cc | 13 ++
gcc/c-family/c-common.h | 1 +
gcc/c/c-decl.cc | 80 ++++++++---
gcc/c/c-tree.h | 1 +
gcc/c/c-typeck.cc | 37 ++++-
gcc/doc/extend.texi | 68 ++++++++++
.../gcc.dg/flex-array-counted-by-7.c | 8 ++
.../gcc.dg/flex-array-counted-by-8.c | 127 ++++++++++++++++++
gcc/testsuite/gcc.dg/flex-array-counted-by.c | 62 +++++++++
10 files changed, 444 insertions(+), 21 deletions(-)
create mode 100644 gcc/testsuite/gcc.dg/flex-array-counted-by-7.c
create mode 100644 gcc/testsuite/gcc.dg/flex-array-counted-by-8.c
create mode 100644 gcc/testsuite/gcc.dg/flex-array-counted-by.c
diff --git a/gcc/c-family/c-attribs.cc b/gcc/c-family/c-attribs.cc
index 04e39b41bdf3..9d562ea8548e 100644
--- a/gcc/c-family/c-attribs.cc
+++ b/gcc/c-family/c-attribs.cc
@@ -105,6 +105,8 @@ static tree handle_warn_if_not_aligned_attribute (tree *, tree, tree,
int, bool *);
static tree handle_strict_flex_array_attribute (tree *, tree, tree,
int, bool *);
+static tree handle_counted_by_attribute (tree *, tree, tree,
+ int, bool *);
static tree handle_weak_attribute (tree *, tree, tree, int, bool *) ;
static tree handle_noplt_attribute (tree *, tree, tree, int, bool *) ;
static tree handle_alias_ifunc_attribute (bool, tree *, tree, tree, bool *);
@@ -412,6 +414,8 @@ const struct attribute_spec c_common_gnu_attributes[] =
handle_warn_if_not_aligned_attribute, NULL },
{ "strict_flex_array", 1, 1, true, false, false, false,
handle_strict_flex_array_attribute, NULL },
+ { "counted_by", 1, 1, true, false, false, false,
+ handle_counted_by_attribute, NULL },
{ "weak", 0, 0, true, false, false, false,
handle_weak_attribute, NULL },
{ "noplt", 0, 0, true, false, false, false,
@@ -659,7 +663,8 @@ attribute_takes_identifier_p (const_tree attr_id)
else if (!strcmp ("mode", spec->name)
|| !strcmp ("format", spec->name)
|| !strcmp ("cleanup", spec->name)
- || !strcmp ("access", spec->name))
+ || !strcmp ("access", spec->name)
+ || !strcmp ("counted_by", spec->name))
return true;
else
return targetm.attribute_takes_identifier_p (attr_id);
@@ -2806,6 +2811,67 @@ handle_strict_flex_array_attribute (tree *node, tree name,
return NULL_TREE;
}
+/* Handle a "counted_by" attribute; arguments as in
+ struct attribute_spec.handler. */
+
+static tree
+handle_counted_by_attribute (tree *node, tree name,
+ tree args, int ARG_UNUSED (flags),
+ bool *no_add_attrs)
+{
+ tree decl = *node;
+ tree argval = TREE_VALUE (args);
+ tree old_counted_by = lookup_attribute ("counted_by", DECL_ATTRIBUTES (decl));
+
+ /* This attribute only applies to field decls of a structure. */
+ if (TREE_CODE (decl) != FIELD_DECL)
+ {
+ error_at (DECL_SOURCE_LOCATION (decl),
+ "%qE attribute is not allowed for a non-field"
+ " declaration %q+D", name, decl);
+ *no_add_attrs = true;
+ }
+ /* This attribute only applies to field with array type. */
+ else if (TREE_CODE (TREE_TYPE (decl)) != ARRAY_TYPE)
+ {
+ error_at (DECL_SOURCE_LOCATION (decl),
+ "%qE attribute is not allowed for a non-array field",
+ name);
+ *no_add_attrs = true;
+ }
+ /* This attribute only applies to a C99 flexible array member type. */
+ else if (! c_flexible_array_member_type_p (TREE_TYPE (decl)))
+ {
+ error_at (DECL_SOURCE_LOCATION (decl),
+ "%qE attribute is not allowed for a non-flexible"
+ " array member field", name);
+ *no_add_attrs = true;
+ }
+ /* The argument should be an identifier. */
+ else if (TREE_CODE (argval) != IDENTIFIER_NODE)
+ {
+ error_at (DECL_SOURCE_LOCATION (decl),
+ "%<counted_by%> argument is not an identifier");
+ *no_add_attrs = true;
+ }
+ /* Issue error when there is a counted_by attribute with a different
+ field as the argument for the same flexible array member field. */
+ else if (old_counted_by != NULL_TREE)
+ {
+ tree old_fieldname = TREE_VALUE (TREE_VALUE (old_counted_by));
+ if (strcmp (IDENTIFIER_POINTER (old_fieldname),
+ IDENTIFIER_POINTER (argval)) != 0)
+ {
+ error_at (DECL_SOURCE_LOCATION (decl),
+ "%<counted_by%> argument %qE conflicts with"
+ " previous declaration %qE", argval, old_fieldname);
+ *no_add_attrs = true;
+ }
+ }
+
+ return NULL_TREE;
+}
+
/* Handle a "weak" attribute; arguments as in
struct attribute_spec.handler. */
diff --git a/gcc/c-family/c-common.cc b/gcc/c-family/c-common.cc
index aae998d0f738..0341c44a2cd9 100644
--- a/gcc/c-family/c-common.cc
+++ b/gcc/c-family/c-common.cc
@@ -9942,6 +9942,19 @@ c_common_finalize_early_debug (void)
(*debug_hooks->early_global_decl) (cnode->decl);
}
+/* Determine whether TYPE is an ISO C99 flexible array member type "[]". */
+bool
+c_flexible_array_member_type_p (const_tree type)
+{
+ if (TREE_CODE (type) == ARRAY_TYPE
+ && TYPE_SIZE (type) == NULL_TREE
+ && TYPE_DOMAIN (type) != NULL_TREE
+ && TYPE_MAX_VALUE (TYPE_DOMAIN (type)) == NULL_TREE)
+ return true;
+
+ return false;
+}
+
/* Get the LEVEL of the strict_flex_array for the ARRAY_FIELD based on the
values of attribute strict_flex_array and the flag_strict_flex_arrays. */
unsigned int
diff --git a/gcc/c-family/c-common.h b/gcc/c-family/c-common.h
index 2d5f53998855..3e0eed0548b0 100644
--- a/gcc/c-family/c-common.h
+++ b/gcc/c-family/c-common.h
@@ -904,6 +904,7 @@ extern tree fold_for_warn (tree);
extern tree c_common_get_narrower (tree, int *);
extern bool get_attribute_operand (tree, unsigned HOST_WIDE_INT *);
extern void c_common_finalize_early_debug (void);
+extern bool c_flexible_array_member_type_p (const_tree);
extern unsigned int c_strict_flex_array_level_of (tree);
extern bool c_option_is_from_cpp_diagnostics (int);
extern tree c_hardbool_type_attr_1 (tree, tree *, tree *);
diff --git a/gcc/c/c-decl.cc b/gcc/c/c-decl.cc
index b691b91b3db4..9c2213dadeaa 100644
--- a/gcc/c/c-decl.cc
+++ b/gcc/c/c-decl.cc
@@ -5303,19 +5303,6 @@ set_array_declarator_inner (struct c_declarator *decl,
return decl;
}
-/* Determine whether TYPE is a ISO C99 flexible array memeber type "[]". */
-static bool
-flexible_array_member_type_p (const_tree type)
-{
- if (TREE_CODE (type) == ARRAY_TYPE
- && TYPE_SIZE (type) == NULL_TREE
- && TYPE_DOMAIN (type) != NULL_TREE
- && TYPE_MAX_VALUE (TYPE_DOMAIN (type)) == NULL_TREE)
- return true;
-
- return false;
-}
-
/* Determine whether TYPE is a one-element array type "[1]". */
static bool
one_element_array_type_p (const_tree type)
@@ -5353,7 +5340,7 @@ add_flexible_array_elts_to_size (tree decl, tree init)
elt = CONSTRUCTOR_ELTS (init)->last ().value;
type = TREE_TYPE (elt);
- if (flexible_array_member_type_p (type))
+ if (c_flexible_array_member_type_p (type))
{
complete_array_type (&type, elt, false);
/* For a structure, add the size of the initializer to the DECL's
@@ -9340,7 +9327,7 @@ is_flexible_array_member_p (bool is_last_field,
bool is_zero_length_array = zero_length_array_type_p (TREE_TYPE (x));
bool is_one_element_array = one_element_array_type_p (TREE_TYPE (x));
- bool is_flexible_array = flexible_array_member_type_p (TREE_TYPE (x));
+ bool is_flexible_array = c_flexible_array_member_type_p (TREE_TYPE (x));
unsigned int strict_flex_array_level = c_strict_flex_array_level_of (x);
@@ -9410,6 +9397,55 @@ c_update_type_canonical (tree t)
}
}
+/* Verify the argument of the counted_by attribute of the flexible array
+ member FIELD_DECL is a valid field of the containing structure,
+ STRUCT_TYPE, Report error and remove this attribute when it's not. */
+
+static void
+verify_counted_by_attribute (tree struct_type, tree field_decl)
+{
+ tree attr_counted_by = lookup_attribute ("counted_by",
+ DECL_ATTRIBUTES (field_decl));
+
+ if (!attr_counted_by)
+ return;
+
+ /* If there is an counted_by attribute attached to the field,
+ verify it. */
+
+ tree fieldname = TREE_VALUE (TREE_VALUE (attr_counted_by));
+
+ /* Verify the argument of the attrbute is a valid field of the
+ containing structure. */
+
+ tree counted_by_field = lookup_field (struct_type, fieldname);
+
+ /* Error when the field is not found in the containing structure. */
+ if (!counted_by_field)
+ error_at (DECL_SOURCE_LOCATION (field_decl),
+ "argument %qE to the %qE attribute is not a field declaration"
+ " in the same structure as %qD", fieldname,
+ (get_attribute_name (attr_counted_by)),
+ field_decl);
+
+ else
+ /* Error when the field is not with an integer type. */
+ {
+ while (TREE_CHAIN (counted_by_field))
+ counted_by_field = TREE_CHAIN (counted_by_field);
+ tree real_field = TREE_VALUE (counted_by_field);
+
+ if (!INTEGRAL_TYPE_P (TREE_TYPE (real_field)))
+ error_at (DECL_SOURCE_LOCATION (field_decl),
+ "argument %qE to the %qE attribute is not a field declaration"
+ " with an integer type", fieldname,
+ (get_attribute_name (attr_counted_by)));
+
+ }
+
+ return;
+}
+
/* Fill in the fields of a RECORD_TYPE or UNION_TYPE node, T.
LOC is the location of the RECORD_TYPE or UNION_TYPE's definition.
FIELDLIST is a chain of FIELD_DECL nodes for the fields.
@@ -9470,6 +9506,7 @@ finish_struct (location_t loc, tree t, tree fieldlist, tree attributes,
until now.) */
bool saw_named_field = false;
+ tree counted_by_fam_field = NULL_TREE;
for (x = fieldlist; x; x = DECL_CHAIN (x))
{
/* Whether this field is the last field of the structure or union.
@@ -9530,7 +9567,7 @@ finish_struct (location_t loc, tree t, tree fieldlist, tree attributes,
DECL_PACKED (x) = 1;
/* Detect flexible array member in an invalid context. */
- if (flexible_array_member_type_p (TREE_TYPE (x)))
+ if (c_flexible_array_member_type_p (TREE_TYPE (x)))
{
if (TREE_CODE (t) == UNION_TYPE)
pedwarn (DECL_SOURCE_LOCATION (x), OPT_Wpedantic,
@@ -9545,6 +9582,12 @@ finish_struct (location_t loc, tree t, tree fieldlist, tree attributes,
pedwarn (DECL_SOURCE_LOCATION (x), OPT_Wpedantic,
"flexible array member in a struct with no named "
"members is a GCC extension");
+
+ /* If there is a counted_by attribute attached to this field,
+ record it here and do more verification later after the
+ whole structure is complete. */
+ if (lookup_attribute ("counted_by", DECL_ATTRIBUTES (x)))
+ counted_by_fam_field = x;
}
if (pedantic && TREE_CODE (t) == RECORD_TYPE
@@ -9559,7 +9602,7 @@ finish_struct (location_t loc, tree t, tree fieldlist, tree attributes,
when x is an array and is the last field. */
if (TREE_CODE (TREE_TYPE (x)) == ARRAY_TYPE)
TYPE_INCLUDES_FLEXARRAY (t)
- = is_last_field && flexible_array_member_type_p (TREE_TYPE (x));
+ = is_last_field && c_flexible_array_member_type_p (TREE_TYPE (x));
/* Recursively set TYPE_INCLUDES_FLEXARRAY for the context of x, t
when x is an union or record and is the last field. */
else if (RECORD_OR_UNION_TYPE_P (TREE_TYPE (x)))
@@ -9816,6 +9859,9 @@ finish_struct (location_t loc, tree t, tree fieldlist, tree attributes,
struct_parse_info->struct_types.safe_push (t);
}
+ if (counted_by_fam_field)
+ verify_counted_by_attribute (t, counted_by_fam_field);
+
return t;
}
diff --git a/gcc/c/c-tree.h b/gcc/c/c-tree.h
index 22b0009874b5..531a7e8742e3 100644
--- a/gcc/c/c-tree.h
+++ b/gcc/c/c-tree.h
@@ -777,6 +777,7 @@ extern struct c_expr convert_lvalue_to_rvalue (location_t, struct c_expr,
extern tree decl_constant_value_1 (tree, bool);
extern void mark_exp_read (tree);
extern tree composite_type (tree, tree);
+extern tree lookup_field (const_tree, tree);
extern tree build_component_ref (location_t, tree, tree, location_t,
location_t);
extern tree build_array_ref (location_t, tree, tree);
diff --git a/gcc/c/c-typeck.cc b/gcc/c/c-typeck.cc
index 2d092357e0f9..2375953fdb62 100644
--- a/gcc/c/c-typeck.cc
+++ b/gcc/c/c-typeck.cc
@@ -101,7 +101,6 @@ static bool function_types_compatible_p (const_tree, const_tree,
struct comptypes_data *);
static bool type_lists_compatible_p (const_tree, const_tree,
struct comptypes_data *);
-static tree lookup_field (tree, tree);
static int convert_arguments (location_t, vec<location_t>, tree,
vec<tree, va_gc> *, vec<tree, va_gc> *, tree,
tree);
@@ -1623,6 +1622,38 @@ tagged_types_tu_compatible_p (const_tree t1, const_tree t2,
&& st2 && TREE_CODE (st2) == INTEGER_CST
&& !tree_int_cst_equal (st1, st2))
return false;
+
+ tree counted_by1 = lookup_attribute ("counted_by",
+ DECL_ATTRIBUTES (s1));
+ tree counted_by2 = lookup_attribute ("counted_by",
+ DECL_ATTRIBUTES (s2));
+ /* If there is no counted_by attribute for both fields. */
+ if (!counted_by1 && !counted_by2)
+ continue;
+
+ /* If only one field has counted_by attribute. */
+ if ((counted_by1 && !counted_by2)
+ || (!counted_by1 && counted_by2))
+ return false;
+
+ /* Now both s1 and s2 have counted_by attributes, check
+ whether they are the same. */
+
+ tree counted_by_field1
+ = lookup_field (t1, TREE_VALUE (TREE_VALUE (counted_by1)));
+ tree counted_by_field2
+ = lookup_field (t2, TREE_VALUE (TREE_VALUE (counted_by2)));
+
+ gcc_assert (counted_by_field1 && counted_by_field2);
+
+ while (TREE_CHAIN (counted_by_field1))
+ counted_by_field1 = TREE_CHAIN (counted_by_field1);
+ while (TREE_CHAIN (counted_by_field2))
+ counted_by_field2 = TREE_CHAIN (counted_by_field2);
+
+ if (DECL_NAME (TREE_VALUE (counted_by_field1))
+ != DECL_NAME (TREE_VALUE (counted_by_field2)))
+ return false;
}
return true;
@@ -2381,8 +2412,8 @@ default_conversion (tree exp)
the component is embedded within (nested) anonymous structures or
unions, the list steps down the chain to the component. */
-static tree
-lookup_field (tree type, tree component)
+tree
+lookup_field (const_tree type, tree component)
{
tree field;
diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index 00449bd96304..799a36586dc9 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -7788,6 +7788,74 @@ align them on any target.
The @code{aligned} attribute can also be used for functions
(@pxref{Common Function Attributes}.)
+@cindex @code{counted_by} variable attribute
+@item counted_by (@var{count})
+The @code{counted_by} attribute may be attached to the C99 flexible array
+member of a structure. It indicates that the number of the elements of the
+array is given by the field "@var{count}" in the same structure as the
+flexible array member.
+GCC may use this information to improve detection of object size information
+for such structures and provide better results in compile-time diagnostics
+and runtime features like the array bound sanitizer and
+the @code{__builtin_dynamic_object_size}.
+
+For instance, the following code:
+
+@smallexample
+struct P @{
+ size_t count;
+ char other;
+ char array[] __attribute__ ((counted_by (count)));
+@} *p;
+@end smallexample
+
+@noindent
+specifies that the @code{array} is a flexible array member whose number of
+elements is given by the field @code{count} in the same structure.
+
+The field that represents the number of the elements should have an
+integer type. Otherwise, the compiler reports an error and ignores
+the attribute.
+
+When the field that represents the number of the elements is assigned a
+negative integer value, the compiler treats the value as zero.
+
+An explicit @code{counted_by} annotation defines a relationship between
+two objects, @code{p->array} and @code{p->count}, and there are the
+following requirementthat on the relationship between this pair:
+
+@itemize @bullet
+@item
+@code{p->count} must be initialized before the first reference to
+@code{p->array};
+
+@item
+@code{p->array} has @emph{at least} @code{p->count} number of elements
+available all the time. This relationship must hold even after any of
+these related objects are updated during the program.
+@end itemize
+
+It's the user's responsibility to make sure the above requirements to
+be kept all the time. Otherwise the compiler reports warnings,
+at the same time, the results of the array bound sanitizer and the
+@code{__builtin_dynamic_object_size} is undefined.
+
+One important feature of the attribute is, a reference to the flexible
+array member field uses the latest value assigned to the field that
+represents the number of the elements before that reference. For example,
+
+@smallexample
+ p->count = val1;
+ p->array[20] = 0; // ref1 to p->array
+ p->count = val2;
+ p->array[30] = 0; // ref2 to p->array
+@end smallexample
+
+@noindent
+in the above, @code{ref1} uses @code{val1} as the number of the elements in
+@code{p->array}, and @code{ref2} uses @code{val2} as the number of elements
+in @code{p->array}.
+
@cindex @code{alloc_size} variable attribute
@item alloc_size (@var{position})
@itemx alloc_size (@var{position-1}, @var{position-2})
diff --git a/gcc/testsuite/gcc.dg/flex-array-counted-by-7.c b/gcc/testsuite/gcc.dg/flex-array-counted-by-7.c
new file mode 100644
index 000000000000..fcb6f1b79690
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/flex-array-counted-by-7.c
@@ -0,0 +1,8 @@
+/* Testing the correct usage of attribute counted_by: _BitInt */
+/* { dg-do compile { target bitint } } */
+/* { dg-options "-O2 -std=c23" } */
+
+struct trailing_array {
+ _BitInt(24) count;
+ int array[] __attribute ((counted_by (count)));
+};
diff --git a/gcc/testsuite/gcc.dg/flex-array-counted-by-8.c b/gcc/testsuite/gcc.dg/flex-array-counted-by-8.c
new file mode 100644
index 000000000000..058d58fb2931
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/flex-array-counted-by-8.c
@@ -0,0 +1,127 @@
+ /* Testing the correct usage of attribute counted_by in c23, multiple
+ * definitions of the same tag in same or different scopes.
+ * { dg-do compile }
+ * { dg-options "-std=c23" }
+ */
+
+/* Allowed redefinitions of the same struct in the same scope, with the
+ same counted_by attribute. */
+struct f {
+ int b;
+ int c;
+ int a[] __attribute__ ((counted_by (b))); };
+struct f {
+ int b;
+ int c;
+ int a[] __attribute__ ((counted_by (b))); };
+struct f {
+ int b;
+ int c;
+ int a[]; }; /* { dg-error "redefinition of struct or union" } */
+
+/* Error when the counted_by attribute is defined differently. */
+struct f {
+ int b;
+ int c;
+ int a[] __attribute__ ((counted_by (c))); }; /* { dg-error "redefinition of struct or union" } */
+
+struct h {
+ int b;
+ int c;
+ int a[] __attribute__ ((counted_by (b))); } p;
+
+void test (void)
+{
+ struct h {
+ int b;
+ int c;
+ int a[] __attribute__ ((counted_by (b))); } x;
+
+ p = x;
+}
+
+void test1 (void)
+{
+ struct h {
+ int b;
+ int c;
+ int a[] __attribute__ ((counted_by (c))); } y;
+
+ p = y; /* { dg-error "incompatible types when assigning to type" } */
+}
+
+struct nested_f {
+ struct {
+ union {
+ int b;
+ float f;
+ };
+ int n;
+ };
+ char c[] __attribute__ ((counted_by (b)));
+};
+
+struct nested_f {
+ struct {
+ union {
+ int b;
+ float f;
+ };
+ int n;
+ };
+ char c[] __attribute__ ((counted_by (b)));
+};
+
+struct nested_f {
+ struct {
+ union {
+ int b;
+ float f;
+ };
+ int n;
+ };
+ char c[] __attribute__ ((counted_by (n)));
+}; /* { dg-error "redefinition of struct or union" } */
+
+struct nested_h {
+ struct {
+ union {
+ int b;
+ float f;
+ };
+ int n;
+ };
+ char c[] __attribute__ ((counted_by (b)));
+} nested_p;
+
+void test_2 (void)
+{
+struct nested_h {
+ struct {
+ union {
+ int b;
+ float f;
+ };
+ int n;
+ };
+ char c[] __attribute__ ((counted_by (b)));
+} nested_x;
+
+ nested_p = nested_x;
+}
+
+void test_3 (void)
+{
+struct nested_h {
+ struct {
+ union {
+ int b;
+ float f;
+ };
+ int n;
+ };
+ char c[] __attribute__ ((counted_by (n)));
+} nested_y;
+
+ nested_p = nested_y; /* { dg-error "incompatible types when assigning to type" } */
+}
diff --git a/gcc/testsuite/gcc.dg/flex-array-counted-by.c b/gcc/testsuite/gcc.dg/flex-array-counted-by.c
new file mode 100644
index 000000000000..e8b54c2de1c0
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/flex-array-counted-by.c
@@ -0,0 +1,62 @@
+/* Testing the correct usage of attribute counted_by. */
+/* { dg-do compile } */
+/* { dg-options "-O2" } */
+
+#include <wchar.h>
+
+int size;
+int x __attribute ((counted_by (size))); /* { dg-error "attribute is not allowed for a non-field declaration" } */
+
+struct trailing {
+ int count;
+ int field __attribute ((counted_by (count))); /* { dg-error "attribute is not allowed for a non-array field" } */
+};
+
+struct trailing_1 {
+ int count;
+ int array_1[0] __attribute ((counted_by (count))); /* { dg-error "attribute is not allowed for a non-flexible array member field" } */
+};
+
+int count;
+struct trailing_array_2 {
+ int count;
+ int array_2[] __attribute ((counted_by ("count"))); /* { dg-error "argument is not an identifier" } */
+};
+
+struct trailing_array_3 {
+ int other;
+ int array_3[] __attribute ((counted_by (L"count"))); /* { dg-error "argument is not an identifier" } */
+};
+
+struct trailing_array_4 {
+ int other;
+ int array_4[] __attribute ((counted_by (count))); /* { dg-error "attribute is not a field declaration in the same structure as" } */
+};
+
+int count;
+struct trailing_array_5 {
+ float count;
+ int array_5[] __attribute ((counted_by (count))); /* { dg-error "attribute is not a field declaration with an integer type" } */
+};
+
+struct trailing_array_6 {
+ int count;
+ int array_6[] __attribute ((counted_by (count))) __attribute ((counted_by (count)));
+};
+
+struct trailing_array_7 {
+ int count1;
+ int count2;
+ int array_7[] __attribute ((counted_by (count1))) __attribute ((counted_by (count2))); /* { dg-error "conflicts with previous declaration" } */
+};
+
+struct trailing_array_8 {
+ _Bool count;
+ int array_8[] __attribute ((counted_by (count)));
+};
+
+enum week {Mon, Tue, Wed};
+struct trailing_array_9 {
+ enum week days;
+ int array_9[] __attribute ((counted_by (days)));
+};
--
2.31.1
^ permalink raw reply [flat|nested] 14+ messages in thread* [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE.
2024-05-30 12:26 [PATCH v10 0/5] New attribute "counted_by" to annotate bounds for C99 FAM(PR108896) Qing Zhao
2024-05-30 12:26 ` [PATCH v10 1/5] Provide counted_by attribute to flexible array member field (PR108896) Qing Zhao
@ 2024-05-30 12:26 ` Qing Zhao
2024-05-30 19:43 ` Joseph Myers
2024-05-31 12:58 ` Richard Biener
2024-05-30 12:26 ` [PATCH v10 3/5] Use the .ACCESS_WITH_SIZE in builtin object size Qing Zhao
` (2 subsequent siblings)
4 siblings, 2 replies; 14+ messages in thread
From: Qing Zhao @ 2024-05-30 12:26 UTC (permalink / raw)
To: rguenther, josmyers
Cc: siddhesh, uecker, keescook, isanbard, gcc-patches, Qing Zhao
Including the following changes:
* The definition of the new internal function .ACCESS_WITH_SIZE
in internal-fn.def.
* C FE converts every reference to a FAM with a "counted_by" attribute
to a call to the internal function .ACCESS_WITH_SIZE.
(build_component_ref in c_typeck.cc)
This includes the case when the object is statically allocated and
initialized.
In order to make this working, the routine digest_init in c-typeck.cc
is updated to fold calls to .ACCESS_WITH_SIZE to its first argument
when require_constant is TRUE.
However, for the reference inside "offsetof", the "counted_by" attribute is
ignored since it's not useful at all.
(c_parser_postfix_expression in c/c-parser.cc)
In addtion to "offsetof", for the reference inside operator "typeof" and
"alignof", we ignore counted_by attribute too.
When building ADDR_EXPR for the .ACCESS_WITH_SIZE in C FE,
replace the call with its first argument.
* Convert every call to .ACCESS_WITH_SIZE to its first argument.
(expand_ACCESS_WITH_SIZE in internal-fn.cc)
* Provide the utility routines to check the call is .ACCESS_WITH_SIZE and
get the reference from the call to .ACCESS_WITH_SIZE.
(is_access_with_size_p and get_ref_from_access_with_size in tree.cc)
gcc/c/ChangeLog:
* c-parser.cc (c_parser_postfix_expression): Ignore the counted-by
attribute when build_component_ref inside offsetof operator.
* c-tree.h (build_component_ref): Add one more parameter.
* c-typeck.cc (build_counted_by_ref): New function.
(build_access_with_size_for_counted_by): New function.
(build_component_ref): Check the counted-by attribute and build
call to .ACCESS_WITH_SIZE.
(build_unary_op): When building ADDR_EXPR for
.ACCESS_WITH_SIZE, use its first argument.
(lvalue_p): Accept call to .ACCESS_WITH_SIZE.
(digest_init): Fold call to .ACCESS_WITH_SIZE to its first
argument when require_constant is TRUE.
gcc/ChangeLog:
* internal-fn.cc (expand_ACCESS_WITH_SIZE): New function.
* internal-fn.def (ACCESS_WITH_SIZE): New internal function.
* tree.cc (is_access_with_size_p): New function.
(get_ref_from_access_with_size): New function.
* tree.h (is_access_with_size_p): New prototype.
(get_ref_from_access_with_size): New prototype.
gcc/testsuite/ChangeLog:
* gcc.dg/flex-array-counted-by-2.c: New test.
---
gcc/c/c-parser.cc | 10 +-
gcc/c/c-tree.h | 2 +-
gcc/c/c-typeck.cc | 142 +++++++++++++++++-
gcc/internal-fn.cc | 34 +++++
gcc/internal-fn.def | 5 +
.../gcc.dg/flex-array-counted-by-2.c | 112 ++++++++++++++
gcc/tree.cc | 22 +++
gcc/tree.h | 8 +
8 files changed, 328 insertions(+), 7 deletions(-)
create mode 100644 gcc/testsuite/gcc.dg/flex-array-counted-by-2.c
diff --git a/gcc/c/c-parser.cc b/gcc/c/c-parser.cc
index 00f8bf4376e5..2d9e9c0969f0 100644
--- a/gcc/c/c-parser.cc
+++ b/gcc/c/c-parser.cc
@@ -10848,9 +10848,12 @@ c_parser_postfix_expression (c_parser *parser)
if (c_parser_next_token_is (parser, CPP_NAME))
{
c_token *comp_tok = c_parser_peek_token (parser);
+ /* Ignore the counted_by attribute for reference inside
+ offsetof since the information is not useful at all. */
offsetof_ref
= build_component_ref (loc, offsetof_ref, comp_tok->value,
- comp_tok->location, UNKNOWN_LOCATION);
+ comp_tok->location, UNKNOWN_LOCATION,
+ false);
c_parser_consume_token (parser);
while (c_parser_next_token_is (parser, CPP_DOT)
|| c_parser_next_token_is (parser,
@@ -10877,11 +10880,14 @@ c_parser_postfix_expression (c_parser *parser)
break;
}
c_token *comp_tok = c_parser_peek_token (parser);
+ /* Ignore the counted_by attribute for reference inside
+ offsetof since the information is not useful. */
offsetof_ref
= build_component_ref (loc, offsetof_ref,
comp_tok->value,
comp_tok->location,
- UNKNOWN_LOCATION);
+ UNKNOWN_LOCATION,
+ false);
c_parser_consume_token (parser);
}
else
diff --git a/gcc/c/c-tree.h b/gcc/c/c-tree.h
index 531a7e8742e3..56a33b8156c6 100644
--- a/gcc/c/c-tree.h
+++ b/gcc/c/c-tree.h
@@ -779,7 +779,7 @@ extern void mark_exp_read (tree);
extern tree composite_type (tree, tree);
extern tree lookup_field (const_tree, tree);
extern tree build_component_ref (location_t, tree, tree, location_t,
- location_t);
+ location_t, bool = true);
extern tree build_array_ref (location_t, tree, tree);
extern tree build_omp_array_section (location_t, tree, tree, tree);
extern tree build_external_ref (location_t, tree, bool, tree *);
diff --git a/gcc/c/c-typeck.cc b/gcc/c/c-typeck.cc
index 2375953fdb62..0d9c7a34a0df 100644
--- a/gcc/c/c-typeck.cc
+++ b/gcc/c/c-typeck.cc
@@ -2584,15 +2584,116 @@ should_suggest_deref_p (tree datum_type)
return false;
}
+/* For a SUBDATUM field of a structure or union DATUM, generate a REF to
+ the object that represents its counted_by per the attribute counted_by
+ attached to this field if it's a flexible array member field, otherwise
+ return NULL_TREE.
+ Set COUNTED_BY_TYPE to the TYPE of the counted_by field.
+ For example, if:
+
+ struct P {
+ int k;
+ int x[] __attribute__ ((counted_by (k)));
+ } *p;
+
+ for:
+ p->x
+
+ the ref to the object that represents its element count will be:
+
+ &(p->k)
+
+*/
+static tree
+build_counted_by_ref (tree datum, tree subdatum, tree *counted_by_type)
+{
+ tree type = TREE_TYPE (datum);
+ if (!c_flexible_array_member_type_p (TREE_TYPE (subdatum)))
+ return NULL_TREE;
+
+ tree attr_counted_by = lookup_attribute ("counted_by",
+ DECL_ATTRIBUTES (subdatum));
+ tree counted_by_ref = NULL_TREE;
+ *counted_by_type = NULL_TREE;
+ if (attr_counted_by)
+ {
+ tree field_id = TREE_VALUE (TREE_VALUE (attr_counted_by));
+ counted_by_ref
+ = build_component_ref (UNKNOWN_LOCATION,
+ datum, field_id,
+ UNKNOWN_LOCATION, UNKNOWN_LOCATION);
+ counted_by_ref = build_fold_addr_expr (counted_by_ref);
+
+ /* Get the TYPE of the counted_by field. */
+ tree counted_by_field = lookup_field (type, field_id);
+ gcc_assert (counted_by_field);
+
+ do
+ {
+ *counted_by_type = TREE_TYPE (TREE_VALUE (counted_by_field));
+ counted_by_field = TREE_CHAIN (counted_by_field);
+ }
+ while (counted_by_field);
+ }
+ return counted_by_ref;
+}
+
+/* Given a COMPONENT_REF REF with the location LOC, the corresponding
+ COUNTED_BY_REF, and the COUNTED_BY_TYPE, generate an INDIRECT_REF
+ to a call to the internal function .ACCESS_WITH_SIZE.
+
+ REF
+
+ to:
+
+ (*.ACCESS_WITH_SIZE (REF, COUNTED_BY_REF, 1, (TYPE_OF_SIZE)0, -1))
+
+ NOTE: The return type of this function is the POINTER type pointing
+ to the original flexible array type.
+ Then the type of the INDIRECT_REF is the original flexible array type.
+
+ The type of the first argument of this function is a POINTER type
+ to the original flexible array type.
+
+ The 4th argument of the call is a constant 0 with the TYPE of the
+ object pointed by COUNTED_BY_REF.
+
+ */
+static tree
+build_access_with_size_for_counted_by (location_t loc, tree ref,
+ tree counted_by_ref,
+ tree counted_by_type)
+{
+ gcc_assert (c_flexible_array_member_type_p (TREE_TYPE (ref)));
+ /* The result type of the call is a pointer to the flexible array type. */
+ tree result_type = build_pointer_type (TREE_TYPE (ref));
+
+ tree call
+ = build_call_expr_internal_loc (loc, IFN_ACCESS_WITH_SIZE,
+ result_type, 5,
+ array_to_pointer_conversion (loc, ref),
+ counted_by_ref,
+ build_int_cst (integer_type_node, 1),
+ build_int_cst (counted_by_type, 0),
+ build_int_cst (integer_type_node, -1));
+ /* Wrap the call with an INDIRECT_REF with the flexible array type. */
+ call = build1 (INDIRECT_REF, TREE_TYPE (ref), call);
+ SET_EXPR_LOCATION (call, loc);
+ return call;
+}
+
/* Make an expression to refer to the COMPONENT field of structure or
union value DATUM. COMPONENT is an IDENTIFIER_NODE. LOC is the
location of the COMPONENT_REF. COMPONENT_LOC is the location
of COMPONENT. ARROW_LOC is the location of the first -> operand if
- it is from -> operator. */
+ it is from -> operator.
+ If HANDLE_COUNTED_BY is true, check the counted_by attribute and generate
+ a call to .ACCESS_WITH_SIZE. Otherwise, ignore the attribute. */
tree
build_component_ref (location_t loc, tree datum, tree component,
- location_t component_loc, location_t arrow_loc)
+ location_t component_loc, location_t arrow_loc,
+ bool handle_counted_by)
{
tree type = TREE_TYPE (datum);
enum tree_code code = TREE_CODE (type);
@@ -2664,7 +2765,13 @@ build_component_ref (location_t loc, tree datum, tree component,
int quals;
tree subtype;
bool use_datum_quals;
-
+ tree counted_by_type = NULL_TREE;
+ /* Do not handle counted_by when in typeof and alignof operator. */
+ handle_counted_by = handle_counted_by && !in_typeof && !in_alignof;
+ tree counted_by_ref = handle_counted_by
+ ? build_counted_by_ref (datum, subdatum,
+ &counted_by_type)
+ : NULL_TREE;
if (TREE_TYPE (subdatum) == error_mark_node)
return error_mark_node;
@@ -2683,6 +2790,12 @@ build_component_ref (location_t loc, tree datum, tree component,
ref = build3 (COMPONENT_REF, subtype, datum, subdatum,
NULL_TREE);
SET_EXPR_LOCATION (ref, loc);
+
+ if (counted_by_ref)
+ ref = build_access_with_size_for_counted_by (loc, ref,
+ counted_by_ref,
+ counted_by_type);
+
if (TREE_READONLY (subdatum)
|| (use_datum_quals && TREE_READONLY (datum)))
TREE_READONLY (ref) = 1;
@@ -5087,7 +5200,11 @@ build_unary_op (location_t location, enum tree_code code, tree xarg,
goto return_build_unary_op;
}
- /* Ordinary case; arg is a COMPONENT_REF or a decl. */
+ /* Ordinary case; arg is a COMPONENT_REF or a decl, or a call to
+ .ACCESS_WITH_SIZE. */
+ if (is_access_with_size_p (arg))
+ arg = TREE_OPERAND (TREE_OPERAND (CALL_EXPR_ARG (arg, 0), 0), 0);
+
argtype = TREE_TYPE (arg);
/* If the lvalue is const or volatile, merge that into the type
@@ -5238,6 +5355,9 @@ lvalue_p (const_tree ref)
case BIND_EXPR:
return TREE_CODE (TREE_TYPE (ref)) == ARRAY_TYPE;
+ case CALL_EXPR:
+ return is_access_with_size_p (ref);
+
default:
return false;
}
@@ -8525,6 +8645,20 @@ digest_init (location_t init_loc, tree type, tree init, tree origtype,
STRIP_TYPE_NOPS (inside_init);
+ /* If require_constant is TRUE, when the initializer is a call to
+ .ACCESS_WITH_SIZE, use the first argument as the initializer.
+ For example:
+ y = (char *) .ACCESS_WITH_SIZE ((char *) &static_annotated.c,...)
+ will be converted to
+ y = &static_annotated.c. */
+
+ if (require_constant
+ && TREE_CODE (inside_init) == NOP_EXPR
+ && TREE_CODE (TREE_OPERAND (inside_init, 0)) == CALL_EXPR
+ && is_access_with_size_p (TREE_OPERAND (inside_init, 0)))
+ inside_init
+ = get_ref_from_access_with_size (TREE_OPERAND (inside_init, 0));
+
if (!c_in_omp_for)
{
if (TREE_CODE (inside_init) == EXCESS_PRECISION_EXPR)
diff --git a/gcc/internal-fn.cc b/gcc/internal-fn.cc
index 9c09026793fa..eb2c4cd59048 100644
--- a/gcc/internal-fn.cc
+++ b/gcc/internal-fn.cc
@@ -3438,6 +3438,40 @@ expand_DEFERRED_INIT (internal_fn, gcall *stmt)
}
}
+/* Expand the IFN_ACCESS_WITH_SIZE function:
+ ACCESS_WITH_SIZE (REF_TO_OBJ, REF_TO_SIZE, CLASS_OF_SIZE,
+ TYPE_OF_SIZE, ACCESS_MODE)
+ which returns the REF_TO_OBJ same as the 1st argument;
+
+ 1st argument REF_TO_OBJ: The reference to the object;
+ 2nd argument REF_TO_SIZE: The reference to the size of the object,
+ 3rd argument CLASS_OF_SIZE: The size referenced by the REF_TO_SIZE represents
+ 0: the number of bytes.
+ 1: the number of the elements of the object type;
+ 4th argument TYPE_OF_SIZE: A constant 0 with its TYPE being the same as the TYPE
+ of the object referenced by REF_TO_SIZE
+ 5th argument ACCESS_MODE:
+ -1: Unknown access semantics
+ 0: none
+ 1: read_only
+ 2: write_only
+ 3: read_write
+
+ Both the return type and the type of the first argument of this
+ function have been converted from the incomplete array type to
+ the corresponding pointer type.
+
+ For each call to a .ACCESS_WITH_SIZE, replace it with its 1st argument. */
+
+static void
+expand_ACCESS_WITH_SIZE (internal_fn, gcall *stmt)
+{
+ tree lhs = gimple_call_lhs (stmt);
+ tree ref_to_obj = gimple_call_arg (stmt, 0);
+ if (lhs)
+ expand_assignment (lhs, ref_to_obj, false);
+}
+
/* The size of an OpenACC compute dimension. */
static void
diff --git a/gcc/internal-fn.def b/gcc/internal-fn.def
index 25badbb86e56..8de1fa882e95 100644
--- a/gcc/internal-fn.def
+++ b/gcc/internal-fn.def
@@ -512,6 +512,11 @@ DEF_INTERNAL_FN (PHI, 0, NULL)
automatic variable. */
DEF_INTERNAL_FN (DEFERRED_INIT, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
+/* A function to associate the access size and access mode information
+ with the corresponding reference to an object. It only reads from the
+ 2nd argument. */
+DEF_INTERNAL_FN (ACCESS_WITH_SIZE, ECF_PURE | ECF_LEAF | ECF_NOTHROW, NULL)
+
/* DIM_SIZE and DIM_POS return the size of a particular compute
dimension and the executing thread's position within that
dimension. DIM_POS is pure (and not const) so that it isn't
diff --git a/gcc/testsuite/gcc.dg/flex-array-counted-by-2.c b/gcc/testsuite/gcc.dg/flex-array-counted-by-2.c
new file mode 100644
index 000000000000..d4899a63af3c
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/flex-array-counted-by-2.c
@@ -0,0 +1,112 @@
+/* Test the code generation for the new attribute counted_by.
+ And also the offsetof operator on such array. */
+/* { dg-do run } */
+/* { dg-options "-O2 -fdump-tree-original" } */
+
+#include <stdlib.h>
+
+struct annotated {
+ int b;
+ char c[] __attribute__ ((counted_by (b)));
+} *array_annotated;
+
+static struct annotated static_annotated = { sizeof "hello", "hello" };
+static char *y = static_annotated.c;
+
+struct flex {
+ int b;
+ char c[];
+};
+
+struct nested_annotated {
+ struct {
+ union {
+ int b;
+ float f;
+ };
+ int n;
+ };
+ char c[] __attribute__ ((counted_by (b)));
+} *array_nested_annotated;
+
+static struct nested_annotated nested_static_annotated
+ = { sizeof "hello1", 0, "hello1" };
+static char *nested_y = nested_static_annotated.c;
+
+struct nested_flex {
+ struct {
+ union {
+ int b;
+ float f;
+ };
+ int n;
+ };
+ char c[];
+};
+
+void __attribute__((__noinline__)) setup (int normal_count, int attr_count)
+{
+ array_annotated
+ = (struct annotated *)malloc (sizeof (struct annotated)
+ + attr_count * sizeof (char));
+ array_annotated->b = attr_count;
+
+ array_nested_annotated
+ = (struct nested_annotated *)malloc (sizeof (struct nested_annotated)
+ + attr_count * sizeof (char));
+ array_nested_annotated->b = attr_count;
+
+ return;
+}
+
+void __attribute__((__noinline__)) test (char a, char b)
+{
+ if (__builtin_offsetof (struct annotated, c[0])
+ != __builtin_offsetof (struct flex, c[0]))
+ abort ();
+ if (__builtin_offsetof (struct annotated, c[1])
+ != __builtin_offsetof (struct flex, c[1]))
+ abort ();
+ if (__builtin_offsetof (struct nested_annotated, c[0])
+ != __builtin_offsetof (struct nested_flex, c[0]))
+ abort ();
+ if (__builtin_offsetof (struct nested_annotated, c[1])
+ != __builtin_offsetof (struct nested_flex, c[1]))
+ abort ();
+
+ if (__builtin_types_compatible_p (typeof (array_annotated->c),
+ typeof (&(array_annotated->c)[0])))
+ abort ();
+ if (__builtin_types_compatible_p (typeof (array_nested_annotated->c),
+ typeof (&(array_nested_annotated->c)[0])))
+ abort ();
+
+ if (__alignof (array_annotated->c) != __alignof (char))
+ abort ();
+ if (__alignof (array_nested_annotated->c) != __alignof (char))
+ abort ();
+
+ if ((unsigned long) array_annotated->c != (unsigned long) &array_annotated->c)
+ abort ();
+ if ((unsigned long) array_nested_annotated->c
+ != (unsigned long) &array_nested_annotated->c)
+ abort ();
+
+ array_annotated->c[2] = a;
+ array_nested_annotated->c[3] = b;
+
+ if (y[2] != 'l') abort ();
+ if (nested_y[4] !='o') abort ();
+
+}
+
+int main(int argc, char *argv[])
+{
+ setup (10,10);
+ test ('A', 'B');
+ if (array_annotated->c[2] != 'A') abort ();
+ if (array_nested_annotated->c[3] != 'B') abort ();
+ return 0;
+}
+
+/* { dg-final { scan-tree-dump-times "ACCESS_WITH_SIZE" 8 "original" } } */
diff --git a/gcc/tree.cc b/gcc/tree.cc
index 6564b002dc1a..01572fe70f72 100644
--- a/gcc/tree.cc
+++ b/gcc/tree.cc
@@ -13405,6 +13405,28 @@ component_ref_size (tree ref, special_array_member *sam /* = NULL */)
? NULL_TREE : size_zero_node);
}
+/* Return true if the given node CALL is a call to a .ACCESS_WITH_SIZE
+ function. */
+bool
+is_access_with_size_p (const_tree call)
+{
+ if (TREE_CODE (call) != CALL_EXPR)
+ return false;
+ if (CALL_EXPR_IFN (call) == IFN_ACCESS_WITH_SIZE)
+ return true;
+ return false;
+}
+
+/* Get the corresponding reference from the call to a .ACCESS_WITH_SIZE.
+ * i.e the first argument of this call. Return NULL_TREE otherwise. */
+tree
+get_ref_from_access_with_size (tree call)
+{
+ if (is_access_with_size_p (call))
+ return CALL_EXPR_ARG (call, 0);
+ return NULL_TREE;
+}
+
/* Return the machine mode of T. For vectors, returns the mode of the
inner type. The main use case is to feed the result to HONOR_NANS,
avoiding the BLKmode that a direct TYPE_MODE (T) might return. */
diff --git a/gcc/tree.h b/gcc/tree.h
index ee2aae332a41..604885641184 100644
--- a/gcc/tree.h
+++ b/gcc/tree.h
@@ -5772,6 +5772,14 @@ extern special_array_member component_ref_sam_type (tree);
cannot be determined. */
extern tree component_ref_size (tree, special_array_member * = NULL);
+/* Return true if the given node is a call to a .ACCESS_WITH_SIZE
+ function. */
+extern bool is_access_with_size_p (const_tree);
+
+/* Get the corresponding reference from the call to a .ACCESS_WITH_SIZE,
+ * i.e. the first argument of this call. Return NULL_TREE otherwise. */
+extern tree get_ref_from_access_with_size (tree);
+
extern int tree_map_base_eq (const void *, const void *);
extern unsigned int tree_map_base_hash (const void *);
extern bool tree_map_base_marked_p (const void *);
--
2.31.1
^ permalink raw reply [flat|nested] 14+ messages in thread* Re: [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE.
2024-05-30 12:26 ` [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE Qing Zhao
@ 2024-05-30 19:43 ` Joseph Myers
2024-05-30 20:03 ` Qing Zhao
2024-05-31 12:58 ` Richard Biener
1 sibling, 1 reply; 14+ messages in thread
From: Joseph Myers @ 2024-05-30 19:43 UTC (permalink / raw)
To: Qing Zhao; +Cc: rguenther, siddhesh, uecker, keescook, isanbard, gcc-patches
On Thu, 30 May 2024, Qing Zhao wrote:
> In order to make this working, the routine digest_init in c-typeck.cc
> is updated to fold calls to .ACCESS_WITH_SIZE to its first argument
> when require_constant is TRUE.
The new changes here are OK.
--
Joseph S. Myers
josmyers@redhat.com
^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE.
2024-05-30 19:43 ` Joseph Myers
@ 2024-05-30 20:03 ` Qing Zhao
0 siblings, 0 replies; 14+ messages in thread
From: Qing Zhao @ 2024-05-30 20:03 UTC (permalink / raw)
To: Joseph Myers
Cc: Richard Guenther, Siddhesh Poyarekar, uecker, kees Cook,
isanbard, GCC Patches
> On May 30, 2024, at 15:43, Joseph Myers <josmyers@redhat.com> wrote:
>
> On Thu, 30 May 2024, Qing Zhao wrote:
>
>> In order to make this working, the routine digest_init in c-typeck.cc
>> is updated to fold calls to .ACCESS_WITH_SIZE to its first argument
>> when require_constant is TRUE.
>
> The new changes here are OK.
Thanks.
Qing
>
> --
> Joseph S. Myers
> josmyers@redhat.com
>
^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE.
2024-05-30 12:26 ` [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE Qing Zhao
2024-05-30 19:43 ` Joseph Myers
@ 2024-05-31 12:58 ` Richard Biener
2024-05-31 13:11 ` Qing Zhao
1 sibling, 1 reply; 14+ messages in thread
From: Richard Biener @ 2024-05-31 12:58 UTC (permalink / raw)
To: Qing Zhao; +Cc: josmyers, siddhesh, uecker, keescook, isanbard, gcc-patches
On Thu, 30 May 2024, Qing Zhao wrote:
> Including the following changes:
> * The definition of the new internal function .ACCESS_WITH_SIZE
> in internal-fn.def.
> * C FE converts every reference to a FAM with a "counted_by" attribute
> to a call to the internal function .ACCESS_WITH_SIZE.
> (build_component_ref in c_typeck.cc)
>
> This includes the case when the object is statically allocated and
> initialized.
> In order to make this working, the routine digest_init in c-typeck.cc
> is updated to fold calls to .ACCESS_WITH_SIZE to its first argument
> when require_constant is TRUE.
>
> However, for the reference inside "offsetof", the "counted_by" attribute is
> ignored since it's not useful at all.
> (c_parser_postfix_expression in c/c-parser.cc)
>
> In addtion to "offsetof", for the reference inside operator "typeof" and
> "alignof", we ignore counted_by attribute too.
>
> When building ADDR_EXPR for the .ACCESS_WITH_SIZE in C FE,
> replace the call with its first argument.
>
> * Convert every call to .ACCESS_WITH_SIZE to its first argument.
> (expand_ACCESS_WITH_SIZE in internal-fn.cc)
> * Provide the utility routines to check the call is .ACCESS_WITH_SIZE and
> get the reference from the call to .ACCESS_WITH_SIZE.
> (is_access_with_size_p and get_ref_from_access_with_size in tree.cc)
The middle-end parts of this revised patch are OK.
Thanks,
Richard.
> gcc/c/ChangeLog:
>
> * c-parser.cc (c_parser_postfix_expression): Ignore the counted-by
> attribute when build_component_ref inside offsetof operator.
> * c-tree.h (build_component_ref): Add one more parameter.
> * c-typeck.cc (build_counted_by_ref): New function.
> (build_access_with_size_for_counted_by): New function.
> (build_component_ref): Check the counted-by attribute and build
> call to .ACCESS_WITH_SIZE.
> (build_unary_op): When building ADDR_EXPR for
> .ACCESS_WITH_SIZE, use its first argument.
> (lvalue_p): Accept call to .ACCESS_WITH_SIZE.
> (digest_init): Fold call to .ACCESS_WITH_SIZE to its first
> argument when require_constant is TRUE.
>
> gcc/ChangeLog:
>
> * internal-fn.cc (expand_ACCESS_WITH_SIZE): New function.
> * internal-fn.def (ACCESS_WITH_SIZE): New internal function.
> * tree.cc (is_access_with_size_p): New function.
> (get_ref_from_access_with_size): New function.
> * tree.h (is_access_with_size_p): New prototype.
> (get_ref_from_access_with_size): New prototype.
>
> gcc/testsuite/ChangeLog:
>
> * gcc.dg/flex-array-counted-by-2.c: New test.
> ---
> gcc/c/c-parser.cc | 10 +-
> gcc/c/c-tree.h | 2 +-
> gcc/c/c-typeck.cc | 142 +++++++++++++++++-
> gcc/internal-fn.cc | 34 +++++
> gcc/internal-fn.def | 5 +
> .../gcc.dg/flex-array-counted-by-2.c | 112 ++++++++++++++
> gcc/tree.cc | 22 +++
> gcc/tree.h | 8 +
> 8 files changed, 328 insertions(+), 7 deletions(-)
> create mode 100644 gcc/testsuite/gcc.dg/flex-array-counted-by-2.c
>
> diff --git a/gcc/c/c-parser.cc b/gcc/c/c-parser.cc
> index 00f8bf4376e5..2d9e9c0969f0 100644
> --- a/gcc/c/c-parser.cc
> +++ b/gcc/c/c-parser.cc
> @@ -10848,9 +10848,12 @@ c_parser_postfix_expression (c_parser *parser)
> if (c_parser_next_token_is (parser, CPP_NAME))
> {
> c_token *comp_tok = c_parser_peek_token (parser);
> + /* Ignore the counted_by attribute for reference inside
> + offsetof since the information is not useful at all. */
> offsetof_ref
> = build_component_ref (loc, offsetof_ref, comp_tok->value,
> - comp_tok->location, UNKNOWN_LOCATION);
> + comp_tok->location, UNKNOWN_LOCATION,
> + false);
> c_parser_consume_token (parser);
> while (c_parser_next_token_is (parser, CPP_DOT)
> || c_parser_next_token_is (parser,
> @@ -10877,11 +10880,14 @@ c_parser_postfix_expression (c_parser *parser)
> break;
> }
> c_token *comp_tok = c_parser_peek_token (parser);
> + /* Ignore the counted_by attribute for reference inside
> + offsetof since the information is not useful. */
> offsetof_ref
> = build_component_ref (loc, offsetof_ref,
> comp_tok->value,
> comp_tok->location,
> - UNKNOWN_LOCATION);
> + UNKNOWN_LOCATION,
> + false);
> c_parser_consume_token (parser);
> }
> else
> diff --git a/gcc/c/c-tree.h b/gcc/c/c-tree.h
> index 531a7e8742e3..56a33b8156c6 100644
> --- a/gcc/c/c-tree.h
> +++ b/gcc/c/c-tree.h
> @@ -779,7 +779,7 @@ extern void mark_exp_read (tree);
> extern tree composite_type (tree, tree);
> extern tree lookup_field (const_tree, tree);
> extern tree build_component_ref (location_t, tree, tree, location_t,
> - location_t);
> + location_t, bool = true);
> extern tree build_array_ref (location_t, tree, tree);
> extern tree build_omp_array_section (location_t, tree, tree, tree);
> extern tree build_external_ref (location_t, tree, bool, tree *);
> diff --git a/gcc/c/c-typeck.cc b/gcc/c/c-typeck.cc
> index 2375953fdb62..0d9c7a34a0df 100644
> --- a/gcc/c/c-typeck.cc
> +++ b/gcc/c/c-typeck.cc
> @@ -2584,15 +2584,116 @@ should_suggest_deref_p (tree datum_type)
> return false;
> }
>
> +/* For a SUBDATUM field of a structure or union DATUM, generate a REF to
> + the object that represents its counted_by per the attribute counted_by
> + attached to this field if it's a flexible array member field, otherwise
> + return NULL_TREE.
> + Set COUNTED_BY_TYPE to the TYPE of the counted_by field.
> + For example, if:
> +
> + struct P {
> + int k;
> + int x[] __attribute__ ((counted_by (k)));
> + } *p;
> +
> + for:
> + p->x
> +
> + the ref to the object that represents its element count will be:
> +
> + &(p->k)
> +
> +*/
> +static tree
> +build_counted_by_ref (tree datum, tree subdatum, tree *counted_by_type)
> +{
> + tree type = TREE_TYPE (datum);
> + if (!c_flexible_array_member_type_p (TREE_TYPE (subdatum)))
> + return NULL_TREE;
> +
> + tree attr_counted_by = lookup_attribute ("counted_by",
> + DECL_ATTRIBUTES (subdatum));
> + tree counted_by_ref = NULL_TREE;
> + *counted_by_type = NULL_TREE;
> + if (attr_counted_by)
> + {
> + tree field_id = TREE_VALUE (TREE_VALUE (attr_counted_by));
> + counted_by_ref
> + = build_component_ref (UNKNOWN_LOCATION,
> + datum, field_id,
> + UNKNOWN_LOCATION, UNKNOWN_LOCATION);
> + counted_by_ref = build_fold_addr_expr (counted_by_ref);
> +
> + /* Get the TYPE of the counted_by field. */
> + tree counted_by_field = lookup_field (type, field_id);
> + gcc_assert (counted_by_field);
> +
> + do
> + {
> + *counted_by_type = TREE_TYPE (TREE_VALUE (counted_by_field));
> + counted_by_field = TREE_CHAIN (counted_by_field);
> + }
> + while (counted_by_field);
> + }
> + return counted_by_ref;
> +}
> +
> +/* Given a COMPONENT_REF REF with the location LOC, the corresponding
> + COUNTED_BY_REF, and the COUNTED_BY_TYPE, generate an INDIRECT_REF
> + to a call to the internal function .ACCESS_WITH_SIZE.
> +
> + REF
> +
> + to:
> +
> + (*.ACCESS_WITH_SIZE (REF, COUNTED_BY_REF, 1, (TYPE_OF_SIZE)0, -1))
> +
> + NOTE: The return type of this function is the POINTER type pointing
> + to the original flexible array type.
> + Then the type of the INDIRECT_REF is the original flexible array type.
> +
> + The type of the first argument of this function is a POINTER type
> + to the original flexible array type.
> +
> + The 4th argument of the call is a constant 0 with the TYPE of the
> + object pointed by COUNTED_BY_REF.
> +
> + */
> +static tree
> +build_access_with_size_for_counted_by (location_t loc, tree ref,
> + tree counted_by_ref,
> + tree counted_by_type)
> +{
> + gcc_assert (c_flexible_array_member_type_p (TREE_TYPE (ref)));
> + /* The result type of the call is a pointer to the flexible array type. */
> + tree result_type = build_pointer_type (TREE_TYPE (ref));
> +
> + tree call
> + = build_call_expr_internal_loc (loc, IFN_ACCESS_WITH_SIZE,
> + result_type, 5,
> + array_to_pointer_conversion (loc, ref),
> + counted_by_ref,
> + build_int_cst (integer_type_node, 1),
> + build_int_cst (counted_by_type, 0),
> + build_int_cst (integer_type_node, -1));
> + /* Wrap the call with an INDIRECT_REF with the flexible array type. */
> + call = build1 (INDIRECT_REF, TREE_TYPE (ref), call);
> + SET_EXPR_LOCATION (call, loc);
> + return call;
> +}
> +
> /* Make an expression to refer to the COMPONENT field of structure or
> union value DATUM. COMPONENT is an IDENTIFIER_NODE. LOC is the
> location of the COMPONENT_REF. COMPONENT_LOC is the location
> of COMPONENT. ARROW_LOC is the location of the first -> operand if
> - it is from -> operator. */
> + it is from -> operator.
> + If HANDLE_COUNTED_BY is true, check the counted_by attribute and generate
> + a call to .ACCESS_WITH_SIZE. Otherwise, ignore the attribute. */
>
> tree
> build_component_ref (location_t loc, tree datum, tree component,
> - location_t component_loc, location_t arrow_loc)
> + location_t component_loc, location_t arrow_loc,
> + bool handle_counted_by)
> {
> tree type = TREE_TYPE (datum);
> enum tree_code code = TREE_CODE (type);
> @@ -2664,7 +2765,13 @@ build_component_ref (location_t loc, tree datum, tree component,
> int quals;
> tree subtype;
> bool use_datum_quals;
> -
> + tree counted_by_type = NULL_TREE;
> + /* Do not handle counted_by when in typeof and alignof operator. */
> + handle_counted_by = handle_counted_by && !in_typeof && !in_alignof;
> + tree counted_by_ref = handle_counted_by
> + ? build_counted_by_ref (datum, subdatum,
> + &counted_by_type)
> + : NULL_TREE;
> if (TREE_TYPE (subdatum) == error_mark_node)
> return error_mark_node;
>
> @@ -2683,6 +2790,12 @@ build_component_ref (location_t loc, tree datum, tree component,
> ref = build3 (COMPONENT_REF, subtype, datum, subdatum,
> NULL_TREE);
> SET_EXPR_LOCATION (ref, loc);
> +
> + if (counted_by_ref)
> + ref = build_access_with_size_for_counted_by (loc, ref,
> + counted_by_ref,
> + counted_by_type);
> +
> if (TREE_READONLY (subdatum)
> || (use_datum_quals && TREE_READONLY (datum)))
> TREE_READONLY (ref) = 1;
> @@ -5087,7 +5200,11 @@ build_unary_op (location_t location, enum tree_code code, tree xarg,
> goto return_build_unary_op;
> }
>
> - /* Ordinary case; arg is a COMPONENT_REF or a decl. */
> + /* Ordinary case; arg is a COMPONENT_REF or a decl, or a call to
> + .ACCESS_WITH_SIZE. */
> + if (is_access_with_size_p (arg))
> + arg = TREE_OPERAND (TREE_OPERAND (CALL_EXPR_ARG (arg, 0), 0), 0);
> +
> argtype = TREE_TYPE (arg);
>
> /* If the lvalue is const or volatile, merge that into the type
> @@ -5238,6 +5355,9 @@ lvalue_p (const_tree ref)
> case BIND_EXPR:
> return TREE_CODE (TREE_TYPE (ref)) == ARRAY_TYPE;
>
> + case CALL_EXPR:
> + return is_access_with_size_p (ref);
> +
> default:
> return false;
> }
> @@ -8525,6 +8645,20 @@ digest_init (location_t init_loc, tree type, tree init, tree origtype,
>
> STRIP_TYPE_NOPS (inside_init);
>
> + /* If require_constant is TRUE, when the initializer is a call to
> + .ACCESS_WITH_SIZE, use the first argument as the initializer.
> + For example:
> + y = (char *) .ACCESS_WITH_SIZE ((char *) &static_annotated.c,...)
> + will be converted to
> + y = &static_annotated.c. */
> +
> + if (require_constant
> + && TREE_CODE (inside_init) == NOP_EXPR
> + && TREE_CODE (TREE_OPERAND (inside_init, 0)) == CALL_EXPR
> + && is_access_with_size_p (TREE_OPERAND (inside_init, 0)))
> + inside_init
> + = get_ref_from_access_with_size (TREE_OPERAND (inside_init, 0));
> +
> if (!c_in_omp_for)
> {
> if (TREE_CODE (inside_init) == EXCESS_PRECISION_EXPR)
> diff --git a/gcc/internal-fn.cc b/gcc/internal-fn.cc
> index 9c09026793fa..eb2c4cd59048 100644
> --- a/gcc/internal-fn.cc
> +++ b/gcc/internal-fn.cc
> @@ -3438,6 +3438,40 @@ expand_DEFERRED_INIT (internal_fn, gcall *stmt)
> }
> }
>
> +/* Expand the IFN_ACCESS_WITH_SIZE function:
> + ACCESS_WITH_SIZE (REF_TO_OBJ, REF_TO_SIZE, CLASS_OF_SIZE,
> + TYPE_OF_SIZE, ACCESS_MODE)
> + which returns the REF_TO_OBJ same as the 1st argument;
> +
> + 1st argument REF_TO_OBJ: The reference to the object;
> + 2nd argument REF_TO_SIZE: The reference to the size of the object,
> + 3rd argument CLASS_OF_SIZE: The size referenced by the REF_TO_SIZE represents
> + 0: the number of bytes.
> + 1: the number of the elements of the object type;
> + 4th argument TYPE_OF_SIZE: A constant 0 with its TYPE being the same as the TYPE
> + of the object referenced by REF_TO_SIZE
> + 5th argument ACCESS_MODE:
> + -1: Unknown access semantics
> + 0: none
> + 1: read_only
> + 2: write_only
> + 3: read_write
> +
> + Both the return type and the type of the first argument of this
> + function have been converted from the incomplete array type to
> + the corresponding pointer type.
> +
> + For each call to a .ACCESS_WITH_SIZE, replace it with its 1st argument. */
> +
> +static void
> +expand_ACCESS_WITH_SIZE (internal_fn, gcall *stmt)
> +{
> + tree lhs = gimple_call_lhs (stmt);
> + tree ref_to_obj = gimple_call_arg (stmt, 0);
> + if (lhs)
> + expand_assignment (lhs, ref_to_obj, false);
> +}
> +
> /* The size of an OpenACC compute dimension. */
>
> static void
> diff --git a/gcc/internal-fn.def b/gcc/internal-fn.def
> index 25badbb86e56..8de1fa882e95 100644
> --- a/gcc/internal-fn.def
> +++ b/gcc/internal-fn.def
> @@ -512,6 +512,11 @@ DEF_INTERNAL_FN (PHI, 0, NULL)
> automatic variable. */
> DEF_INTERNAL_FN (DEFERRED_INIT, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
>
> +/* A function to associate the access size and access mode information
> + with the corresponding reference to an object. It only reads from the
> + 2nd argument. */
> +DEF_INTERNAL_FN (ACCESS_WITH_SIZE, ECF_PURE | ECF_LEAF | ECF_NOTHROW, NULL)
> +
> /* DIM_SIZE and DIM_POS return the size of a particular compute
> dimension and the executing thread's position within that
> dimension. DIM_POS is pure (and not const) so that it isn't
> diff --git a/gcc/testsuite/gcc.dg/flex-array-counted-by-2.c b/gcc/testsuite/gcc.dg/flex-array-counted-by-2.c
> new file mode 100644
> index 000000000000..d4899a63af3c
> --- /dev/null
> +++ b/gcc/testsuite/gcc.dg/flex-array-counted-by-2.c
> @@ -0,0 +1,112 @@
> +/* Test the code generation for the new attribute counted_by.
> + And also the offsetof operator on such array. */
> +/* { dg-do run } */
> +/* { dg-options "-O2 -fdump-tree-original" } */
> +
> +#include <stdlib.h>
> +
> +struct annotated {
> + int b;
> + char c[] __attribute__ ((counted_by (b)));
> +} *array_annotated;
> +
> +static struct annotated static_annotated = { sizeof "hello", "hello" };
> +static char *y = static_annotated.c;
> +
> +struct flex {
> + int b;
> + char c[];
> +};
> +
> +struct nested_annotated {
> + struct {
> + union {
> + int b;
> + float f;
> + };
> + int n;
> + };
> + char c[] __attribute__ ((counted_by (b)));
> +} *array_nested_annotated;
> +
> +static struct nested_annotated nested_static_annotated
> + = { sizeof "hello1", 0, "hello1" };
> +static char *nested_y = nested_static_annotated.c;
> +
> +struct nested_flex {
> + struct {
> + union {
> + int b;
> + float f;
> + };
> + int n;
> + };
> + char c[];
> +};
> +
> +void __attribute__((__noinline__)) setup (int normal_count, int attr_count)
> +{
> + array_annotated
> + = (struct annotated *)malloc (sizeof (struct annotated)
> + + attr_count * sizeof (char));
> + array_annotated->b = attr_count;
> +
> + array_nested_annotated
> + = (struct nested_annotated *)malloc (sizeof (struct nested_annotated)
> + + attr_count * sizeof (char));
> + array_nested_annotated->b = attr_count;
> +
> + return;
> +}
> +
> +void __attribute__((__noinline__)) test (char a, char b)
> +{
> + if (__builtin_offsetof (struct annotated, c[0])
> + != __builtin_offsetof (struct flex, c[0]))
> + abort ();
> + if (__builtin_offsetof (struct annotated, c[1])
> + != __builtin_offsetof (struct flex, c[1]))
> + abort ();
> + if (__builtin_offsetof (struct nested_annotated, c[0])
> + != __builtin_offsetof (struct nested_flex, c[0]))
> + abort ();
> + if (__builtin_offsetof (struct nested_annotated, c[1])
> + != __builtin_offsetof (struct nested_flex, c[1]))
> + abort ();
> +
> + if (__builtin_types_compatible_p (typeof (array_annotated->c),
> + typeof (&(array_annotated->c)[0])))
> + abort ();
> + if (__builtin_types_compatible_p (typeof (array_nested_annotated->c),
> + typeof (&(array_nested_annotated->c)[0])))
> + abort ();
> +
> + if (__alignof (array_annotated->c) != __alignof (char))
> + abort ();
> + if (__alignof (array_nested_annotated->c) != __alignof (char))
> + abort ();
> +
> + if ((unsigned long) array_annotated->c != (unsigned long) &array_annotated->c)
> + abort ();
> + if ((unsigned long) array_nested_annotated->c
> + != (unsigned long) &array_nested_annotated->c)
> + abort ();
> +
> + array_annotated->c[2] = a;
> + array_nested_annotated->c[3] = b;
> +
> + if (y[2] != 'l') abort ();
> + if (nested_y[4] !='o') abort ();
> +
> +}
> +
> +int main(int argc, char *argv[])
> +{
> + setup (10,10);
> + test ('A', 'B');
> + if (array_annotated->c[2] != 'A') abort ();
> + if (array_nested_annotated->c[3] != 'B') abort ();
> + return 0;
> +}
> +
> +/* { dg-final { scan-tree-dump-times "ACCESS_WITH_SIZE" 8 "original" } } */
> diff --git a/gcc/tree.cc b/gcc/tree.cc
> index 6564b002dc1a..01572fe70f72 100644
> --- a/gcc/tree.cc
> +++ b/gcc/tree.cc
> @@ -13405,6 +13405,28 @@ component_ref_size (tree ref, special_array_member *sam /* = NULL */)
> ? NULL_TREE : size_zero_node);
> }
>
> +/* Return true if the given node CALL is a call to a .ACCESS_WITH_SIZE
> + function. */
> +bool
> +is_access_with_size_p (const_tree call)
> +{
> + if (TREE_CODE (call) != CALL_EXPR)
> + return false;
> + if (CALL_EXPR_IFN (call) == IFN_ACCESS_WITH_SIZE)
> + return true;
> + return false;
> +}
> +
> +/* Get the corresponding reference from the call to a .ACCESS_WITH_SIZE.
> + * i.e the first argument of this call. Return NULL_TREE otherwise. */
> +tree
> +get_ref_from_access_with_size (tree call)
> +{
> + if (is_access_with_size_p (call))
> + return CALL_EXPR_ARG (call, 0);
> + return NULL_TREE;
> +}
> +
> /* Return the machine mode of T. For vectors, returns the mode of the
> inner type. The main use case is to feed the result to HONOR_NANS,
> avoiding the BLKmode that a direct TYPE_MODE (T) might return. */
> diff --git a/gcc/tree.h b/gcc/tree.h
> index ee2aae332a41..604885641184 100644
> --- a/gcc/tree.h
> +++ b/gcc/tree.h
> @@ -5772,6 +5772,14 @@ extern special_array_member component_ref_sam_type (tree);
> cannot be determined. */
> extern tree component_ref_size (tree, special_array_member * = NULL);
>
> +/* Return true if the given node is a call to a .ACCESS_WITH_SIZE
> + function. */
> +extern bool is_access_with_size_p (const_tree);
> +
> +/* Get the corresponding reference from the call to a .ACCESS_WITH_SIZE,
> + * i.e. the first argument of this call. Return NULL_TREE otherwise. */
> +extern tree get_ref_from_access_with_size (tree);
> +
> extern int tree_map_base_eq (const void *, const void *);
> extern unsigned int tree_map_base_hash (const void *);
> extern bool tree_map_base_marked_p (const void *);
>
--
Richard Biener <rguenther@suse.de>
SUSE Software Solutions Germany GmbH,
Frankenstrasse 146, 90461 Nuernberg, Germany;
GF: Ivo Totev, Andrew McDonald, Werner Knoblich; (HRB 36809, AG Nuernberg)
^ permalink raw reply [flat|nested] 14+ messages in thread* Re: [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE.
2024-05-31 12:58 ` Richard Biener
@ 2024-05-31 13:11 ` Qing Zhao
2024-06-04 21:55 ` "counted_by" and -fanalyzer (was Re: [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE.) David Malcolm
0 siblings, 1 reply; 14+ messages in thread
From: Qing Zhao @ 2024-05-31 13:11 UTC (permalink / raw)
To: Richard Biener
Cc: Joseph Myers, Siddhesh Poyarekar, uecker, kees Cook, isanbard,
GCC Patches
> On May 31, 2024, at 08:58, Richard Biener <rguenther@suse.de> wrote:
>
> On Thu, 30 May 2024, Qing Zhao wrote:
>
>> Including the following changes:
>> * The definition of the new internal function .ACCESS_WITH_SIZE
>> in internal-fn.def.
>> * C FE converts every reference to a FAM with a "counted_by" attribute
>> to a call to the internal function .ACCESS_WITH_SIZE.
>> (build_component_ref in c_typeck.cc)
>>
>> This includes the case when the object is statically allocated and
>> initialized.
>> In order to make this working, the routine digest_init in c-typeck.cc
>> is updated to fold calls to .ACCESS_WITH_SIZE to its first argument
>> when require_constant is TRUE.
>>
>> However, for the reference inside "offsetof", the "counted_by" attribute is
>> ignored since it's not useful at all.
>> (c_parser_postfix_expression in c/c-parser.cc)
>>
>> In addtion to "offsetof", for the reference inside operator "typeof" and
>> "alignof", we ignore counted_by attribute too.
>>
>> When building ADDR_EXPR for the .ACCESS_WITH_SIZE in C FE,
>> replace the call with its first argument.
>>
>> * Convert every call to .ACCESS_WITH_SIZE to its first argument.
>> (expand_ACCESS_WITH_SIZE in internal-fn.cc)
>> * Provide the utility routines to check the call is .ACCESS_WITH_SIZE and
>> get the reference from the call to .ACCESS_WITH_SIZE.
>> (is_access_with_size_p and get_ref_from_access_with_size in tree.cc)
>
> The middle-end parts of this revised patch are OK.
Thanks a lot for the review.
Will commit the patch set soon.
Qing
>
> Thanks,
> Richard.
>
>> gcc/c/ChangeLog:
>>
>> * c-parser.cc (c_parser_postfix_expression): Ignore the counted-by
>> attribute when build_component_ref inside offsetof operator.
>> * c-tree.h (build_component_ref): Add one more parameter.
>> * c-typeck.cc (build_counted_by_ref): New function.
>> (build_access_with_size_for_counted_by): New function.
>> (build_component_ref): Check the counted-by attribute and build
>> call to .ACCESS_WITH_SIZE.
>> (build_unary_op): When building ADDR_EXPR for
>> .ACCESS_WITH_SIZE, use its first argument.
>> (lvalue_p): Accept call to .ACCESS_WITH_SIZE.
>> (digest_init): Fold call to .ACCESS_WITH_SIZE to its first
>> argument when require_constant is TRUE.
>>
>> gcc/ChangeLog:
>>
>> * internal-fn.cc (expand_ACCESS_WITH_SIZE): New function.
>> * internal-fn.def (ACCESS_WITH_SIZE): New internal function.
>> * tree.cc (is_access_with_size_p): New function.
>> (get_ref_from_access_with_size): New function.
>> * tree.h (is_access_with_size_p): New prototype.
>> (get_ref_from_access_with_size): New prototype.
>>
>> gcc/testsuite/ChangeLog:
>>
>> * gcc.dg/flex-array-counted-by-2.c: New test.
>> ---
>> gcc/c/c-parser.cc | 10 +-
>> gcc/c/c-tree.h | 2 +-
>> gcc/c/c-typeck.cc | 142 +++++++++++++++++-
>> gcc/internal-fn.cc | 34 +++++
>> gcc/internal-fn.def | 5 +
>> .../gcc.dg/flex-array-counted-by-2.c | 112 ++++++++++++++
>> gcc/tree.cc | 22 +++
>> gcc/tree.h | 8 +
>> 8 files changed, 328 insertions(+), 7 deletions(-)
>> create mode 100644 gcc/testsuite/gcc.dg/flex-array-counted-by-2.c
>>
>> diff --git a/gcc/c/c-parser.cc b/gcc/c/c-parser.cc
>> index 00f8bf4376e5..2d9e9c0969f0 100644
>> --- a/gcc/c/c-parser.cc
>> +++ b/gcc/c/c-parser.cc
>> @@ -10848,9 +10848,12 @@ c_parser_postfix_expression (c_parser *parser)
>> if (c_parser_next_token_is (parser, CPP_NAME))
>> {
>> c_token *comp_tok = c_parser_peek_token (parser);
>> + /* Ignore the counted_by attribute for reference inside
>> + offsetof since the information is not useful at all. */
>> offsetof_ref
>> = build_component_ref (loc, offsetof_ref, comp_tok->value,
>> - comp_tok->location, UNKNOWN_LOCATION);
>> + comp_tok->location, UNKNOWN_LOCATION,
>> + false);
>> c_parser_consume_token (parser);
>> while (c_parser_next_token_is (parser, CPP_DOT)
>> || c_parser_next_token_is (parser,
>> @@ -10877,11 +10880,14 @@ c_parser_postfix_expression (c_parser *parser)
>> break;
>> }
>> c_token *comp_tok = c_parser_peek_token (parser);
>> + /* Ignore the counted_by attribute for reference inside
>> + offsetof since the information is not useful. */
>> offsetof_ref
>> = build_component_ref (loc, offsetof_ref,
>> comp_tok->value,
>> comp_tok->location,
>> - UNKNOWN_LOCATION);
>> + UNKNOWN_LOCATION,
>> + false);
>> c_parser_consume_token (parser);
>> }
>> else
>> diff --git a/gcc/c/c-tree.h b/gcc/c/c-tree.h
>> index 531a7e8742e3..56a33b8156c6 100644
>> --- a/gcc/c/c-tree.h
>> +++ b/gcc/c/c-tree.h
>> @@ -779,7 +779,7 @@ extern void mark_exp_read (tree);
>> extern tree composite_type (tree, tree);
>> extern tree lookup_field (const_tree, tree);
>> extern tree build_component_ref (location_t, tree, tree, location_t,
>> - location_t);
>> + location_t, bool = true);
>> extern tree build_array_ref (location_t, tree, tree);
>> extern tree build_omp_array_section (location_t, tree, tree, tree);
>> extern tree build_external_ref (location_t, tree, bool, tree *);
>> diff --git a/gcc/c/c-typeck.cc b/gcc/c/c-typeck.cc
>> index 2375953fdb62..0d9c7a34a0df 100644
>> --- a/gcc/c/c-typeck.cc
>> +++ b/gcc/c/c-typeck.cc
>> @@ -2584,15 +2584,116 @@ should_suggest_deref_p (tree datum_type)
>> return false;
>> }
>>
>> +/* For a SUBDATUM field of a structure or union DATUM, generate a REF to
>> + the object that represents its counted_by per the attribute counted_by
>> + attached to this field if it's a flexible array member field, otherwise
>> + return NULL_TREE.
>> + Set COUNTED_BY_TYPE to the TYPE of the counted_by field.
>> + For example, if:
>> +
>> + struct P {
>> + int k;
>> + int x[] __attribute__ ((counted_by (k)));
>> + } *p;
>> +
>> + for:
>> + p->x
>> +
>> + the ref to the object that represents its element count will be:
>> +
>> + &(p->k)
>> +
>> +*/
>> +static tree
>> +build_counted_by_ref (tree datum, tree subdatum, tree *counted_by_type)
>> +{
>> + tree type = TREE_TYPE (datum);
>> + if (!c_flexible_array_member_type_p (TREE_TYPE (subdatum)))
>> + return NULL_TREE;
>> +
>> + tree attr_counted_by = lookup_attribute ("counted_by",
>> + DECL_ATTRIBUTES (subdatum));
>> + tree counted_by_ref = NULL_TREE;
>> + *counted_by_type = NULL_TREE;
>> + if (attr_counted_by)
>> + {
>> + tree field_id = TREE_VALUE (TREE_VALUE (attr_counted_by));
>> + counted_by_ref
>> + = build_component_ref (UNKNOWN_LOCATION,
>> + datum, field_id,
>> + UNKNOWN_LOCATION, UNKNOWN_LOCATION);
>> + counted_by_ref = build_fold_addr_expr (counted_by_ref);
>> +
>> + /* Get the TYPE of the counted_by field. */
>> + tree counted_by_field = lookup_field (type, field_id);
>> + gcc_assert (counted_by_field);
>> +
>> + do
>> + {
>> + *counted_by_type = TREE_TYPE (TREE_VALUE (counted_by_field));
>> + counted_by_field = TREE_CHAIN (counted_by_field);
>> + }
>> + while (counted_by_field);
>> + }
>> + return counted_by_ref;
>> +}
>> +
>> +/* Given a COMPONENT_REF REF with the location LOC, the corresponding
>> + COUNTED_BY_REF, and the COUNTED_BY_TYPE, generate an INDIRECT_REF
>> + to a call to the internal function .ACCESS_WITH_SIZE.
>> +
>> + REF
>> +
>> + to:
>> +
>> + (*.ACCESS_WITH_SIZE (REF, COUNTED_BY_REF, 1, (TYPE_OF_SIZE)0, -1))
>> +
>> + NOTE: The return type of this function is the POINTER type pointing
>> + to the original flexible array type.
>> + Then the type of the INDIRECT_REF is the original flexible array type.
>> +
>> + The type of the first argument of this function is a POINTER type
>> + to the original flexible array type.
>> +
>> + The 4th argument of the call is a constant 0 with the TYPE of the
>> + object pointed by COUNTED_BY_REF.
>> +
>> + */
>> +static tree
>> +build_access_with_size_for_counted_by (location_t loc, tree ref,
>> + tree counted_by_ref,
>> + tree counted_by_type)
>> +{
>> + gcc_assert (c_flexible_array_member_type_p (TREE_TYPE (ref)));
>> + /* The result type of the call is a pointer to the flexible array type. */
>> + tree result_type = build_pointer_type (TREE_TYPE (ref));
>> +
>> + tree call
>> + = build_call_expr_internal_loc (loc, IFN_ACCESS_WITH_SIZE,
>> + result_type, 5,
>> + array_to_pointer_conversion (loc, ref),
>> + counted_by_ref,
>> + build_int_cst (integer_type_node, 1),
>> + build_int_cst (counted_by_type, 0),
>> + build_int_cst (integer_type_node, -1));
>> + /* Wrap the call with an INDIRECT_REF with the flexible array type. */
>> + call = build1 (INDIRECT_REF, TREE_TYPE (ref), call);
>> + SET_EXPR_LOCATION (call, loc);
>> + return call;
>> +}
>> +
>> /* Make an expression to refer to the COMPONENT field of structure or
>> union value DATUM. COMPONENT is an IDENTIFIER_NODE. LOC is the
>> location of the COMPONENT_REF. COMPONENT_LOC is the location
>> of COMPONENT. ARROW_LOC is the location of the first -> operand if
>> - it is from -> operator. */
>> + it is from -> operator.
>> + If HANDLE_COUNTED_BY is true, check the counted_by attribute and generate
>> + a call to .ACCESS_WITH_SIZE. Otherwise, ignore the attribute. */
>>
>> tree
>> build_component_ref (location_t loc, tree datum, tree component,
>> - location_t component_loc, location_t arrow_loc)
>> + location_t component_loc, location_t arrow_loc,
>> + bool handle_counted_by)
>> {
>> tree type = TREE_TYPE (datum);
>> enum tree_code code = TREE_CODE (type);
>> @@ -2664,7 +2765,13 @@ build_component_ref (location_t loc, tree datum, tree component,
>> int quals;
>> tree subtype;
>> bool use_datum_quals;
>> -
>> + tree counted_by_type = NULL_TREE;
>> + /* Do not handle counted_by when in typeof and alignof operator. */
>> + handle_counted_by = handle_counted_by && !in_typeof && !in_alignof;
>> + tree counted_by_ref = handle_counted_by
>> + ? build_counted_by_ref (datum, subdatum,
>> + &counted_by_type)
>> + : NULL_TREE;
>> if (TREE_TYPE (subdatum) == error_mark_node)
>> return error_mark_node;
>>
>> @@ -2683,6 +2790,12 @@ build_component_ref (location_t loc, tree datum, tree component,
>> ref = build3 (COMPONENT_REF, subtype, datum, subdatum,
>> NULL_TREE);
>> SET_EXPR_LOCATION (ref, loc);
>> +
>> + if (counted_by_ref)
>> + ref = build_access_with_size_for_counted_by (loc, ref,
>> + counted_by_ref,
>> + counted_by_type);
>> +
>> if (TREE_READONLY (subdatum)
>> || (use_datum_quals && TREE_READONLY (datum)))
>> TREE_READONLY (ref) = 1;
>> @@ -5087,7 +5200,11 @@ build_unary_op (location_t location, enum tree_code code, tree xarg,
>> goto return_build_unary_op;
>> }
>>
>> - /* Ordinary case; arg is a COMPONENT_REF or a decl. */
>> + /* Ordinary case; arg is a COMPONENT_REF or a decl, or a call to
>> + .ACCESS_WITH_SIZE. */
>> + if (is_access_with_size_p (arg))
>> + arg = TREE_OPERAND (TREE_OPERAND (CALL_EXPR_ARG (arg, 0), 0), 0);
>> +
>> argtype = TREE_TYPE (arg);
>>
>> /* If the lvalue is const or volatile, merge that into the type
>> @@ -5238,6 +5355,9 @@ lvalue_p (const_tree ref)
>> case BIND_EXPR:
>> return TREE_CODE (TREE_TYPE (ref)) == ARRAY_TYPE;
>>
>> + case CALL_EXPR:
>> + return is_access_with_size_p (ref);
>> +
>> default:
>> return false;
>> }
>> @@ -8525,6 +8645,20 @@ digest_init (location_t init_loc, tree type, tree init, tree origtype,
>>
>> STRIP_TYPE_NOPS (inside_init);
>>
>> + /* If require_constant is TRUE, when the initializer is a call to
>> + .ACCESS_WITH_SIZE, use the first argument as the initializer.
>> + For example:
>> + y = (char *) .ACCESS_WITH_SIZE ((char *) &static_annotated.c,...)
>> + will be converted to
>> + y = &static_annotated.c. */
>> +
>> + if (require_constant
>> + && TREE_CODE (inside_init) == NOP_EXPR
>> + && TREE_CODE (TREE_OPERAND (inside_init, 0)) == CALL_EXPR
>> + && is_access_with_size_p (TREE_OPERAND (inside_init, 0)))
>> + inside_init
>> + = get_ref_from_access_with_size (TREE_OPERAND (inside_init, 0));
>> +
>> if (!c_in_omp_for)
>> {
>> if (TREE_CODE (inside_init) == EXCESS_PRECISION_EXPR)
>> diff --git a/gcc/internal-fn.cc b/gcc/internal-fn.cc
>> index 9c09026793fa..eb2c4cd59048 100644
>> --- a/gcc/internal-fn.cc
>> +++ b/gcc/internal-fn.cc
>> @@ -3438,6 +3438,40 @@ expand_DEFERRED_INIT (internal_fn, gcall *stmt)
>> }
>> }
>>
>> +/* Expand the IFN_ACCESS_WITH_SIZE function:
>> + ACCESS_WITH_SIZE (REF_TO_OBJ, REF_TO_SIZE, CLASS_OF_SIZE,
>> + TYPE_OF_SIZE, ACCESS_MODE)
>> + which returns the REF_TO_OBJ same as the 1st argument;
>> +
>> + 1st argument REF_TO_OBJ: The reference to the object;
>> + 2nd argument REF_TO_SIZE: The reference to the size of the object,
>> + 3rd argument CLASS_OF_SIZE: The size referenced by the REF_TO_SIZE represents
>> + 0: the number of bytes.
>> + 1: the number of the elements of the object type;
>> + 4th argument TYPE_OF_SIZE: A constant 0 with its TYPE being the same as the TYPE
>> + of the object referenced by REF_TO_SIZE
>> + 5th argument ACCESS_MODE:
>> + -1: Unknown access semantics
>> + 0: none
>> + 1: read_only
>> + 2: write_only
>> + 3: read_write
>> +
>> + Both the return type and the type of the first argument of this
>> + function have been converted from the incomplete array type to
>> + the corresponding pointer type.
>> +
>> + For each call to a .ACCESS_WITH_SIZE, replace it with its 1st argument. */
>> +
>> +static void
>> +expand_ACCESS_WITH_SIZE (internal_fn, gcall *stmt)
>> +{
>> + tree lhs = gimple_call_lhs (stmt);
>> + tree ref_to_obj = gimple_call_arg (stmt, 0);
>> + if (lhs)
>> + expand_assignment (lhs, ref_to_obj, false);
>> +}
>> +
>> /* The size of an OpenACC compute dimension. */
>>
>> static void
>> diff --git a/gcc/internal-fn.def b/gcc/internal-fn.def
>> index 25badbb86e56..8de1fa882e95 100644
>> --- a/gcc/internal-fn.def
>> +++ b/gcc/internal-fn.def
>> @@ -512,6 +512,11 @@ DEF_INTERNAL_FN (PHI, 0, NULL)
>> automatic variable. */
>> DEF_INTERNAL_FN (DEFERRED_INIT, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
>>
>> +/* A function to associate the access size and access mode information
>> + with the corresponding reference to an object. It only reads from the
>> + 2nd argument. */
>> +DEF_INTERNAL_FN (ACCESS_WITH_SIZE, ECF_PURE | ECF_LEAF | ECF_NOTHROW, NULL)
>> +
>> /* DIM_SIZE and DIM_POS return the size of a particular compute
>> dimension and the executing thread's position within that
>> dimension. DIM_POS is pure (and not const) so that it isn't
>> diff --git a/gcc/testsuite/gcc.dg/flex-array-counted-by-2.c b/gcc/testsuite/gcc.dg/flex-array-counted-by-2.c
>> new file mode 100644
>> index 000000000000..d4899a63af3c
>> --- /dev/null
>> +++ b/gcc/testsuite/gcc.dg/flex-array-counted-by-2.c
>> @@ -0,0 +1,112 @@
>> +/* Test the code generation for the new attribute counted_by.
>> + And also the offsetof operator on such array. */
>> +/* { dg-do run } */
>> +/* { dg-options "-O2 -fdump-tree-original" } */
>> +
>> +#include <stdlib.h>
>> +
>> +struct annotated {
>> + int b;
>> + char c[] __attribute__ ((counted_by (b)));
>> +} *array_annotated;
>> +
>> +static struct annotated static_annotated = { sizeof "hello", "hello" };
>> +static char *y = static_annotated.c;
>> +
>> +struct flex {
>> + int b;
>> + char c[];
>> +};
>> +
>> +struct nested_annotated {
>> + struct {
>> + union {
>> + int b;
>> + float f;
>> + };
>> + int n;
>> + };
>> + char c[] __attribute__ ((counted_by (b)));
>> +} *array_nested_annotated;
>> +
>> +static struct nested_annotated nested_static_annotated
>> + = { sizeof "hello1", 0, "hello1" };
>> +static char *nested_y = nested_static_annotated.c;
>> +
>> +struct nested_flex {
>> + struct {
>> + union {
>> + int b;
>> + float f;
>> + };
>> + int n;
>> + };
>> + char c[];
>> +};
>> +
>> +void __attribute__((__noinline__)) setup (int normal_count, int attr_count)
>> +{
>> + array_annotated
>> + = (struct annotated *)malloc (sizeof (struct annotated)
>> + + attr_count * sizeof (char));
>> + array_annotated->b = attr_count;
>> +
>> + array_nested_annotated
>> + = (struct nested_annotated *)malloc (sizeof (struct nested_annotated)
>> + + attr_count * sizeof (char));
>> + array_nested_annotated->b = attr_count;
>> +
>> + return;
>> +}
>> +
>> +void __attribute__((__noinline__)) test (char a, char b)
>> +{
>> + if (__builtin_offsetof (struct annotated, c[0])
>> + != __builtin_offsetof (struct flex, c[0]))
>> + abort ();
>> + if (__builtin_offsetof (struct annotated, c[1])
>> + != __builtin_offsetof (struct flex, c[1]))
>> + abort ();
>> + if (__builtin_offsetof (struct nested_annotated, c[0])
>> + != __builtin_offsetof (struct nested_flex, c[0]))
>> + abort ();
>> + if (__builtin_offsetof (struct nested_annotated, c[1])
>> + != __builtin_offsetof (struct nested_flex, c[1]))
>> + abort ();
>> +
>> + if (__builtin_types_compatible_p (typeof (array_annotated->c),
>> + typeof (&(array_annotated->c)[0])))
>> + abort ();
>> + if (__builtin_types_compatible_p (typeof (array_nested_annotated->c),
>> + typeof (&(array_nested_annotated->c)[0])))
>> + abort ();
>> +
>> + if (__alignof (array_annotated->c) != __alignof (char))
>> + abort ();
>> + if (__alignof (array_nested_annotated->c) != __alignof (char))
>> + abort ();
>> +
>> + if ((unsigned long) array_annotated->c != (unsigned long) &array_annotated->c)
>> + abort ();
>> + if ((unsigned long) array_nested_annotated->c
>> + != (unsigned long) &array_nested_annotated->c)
>> + abort ();
>> +
>> + array_annotated->c[2] = a;
>> + array_nested_annotated->c[3] = b;
>> +
>> + if (y[2] != 'l') abort ();
>> + if (nested_y[4] !='o') abort ();
>> +
>> +}
>> +
>> +int main(int argc, char *argv[])
>> +{
>> + setup (10,10);
>> + test ('A', 'B');
>> + if (array_annotated->c[2] != 'A') abort ();
>> + if (array_nested_annotated->c[3] != 'B') abort ();
>> + return 0;
>> +}
>> +
>> +/* { dg-final { scan-tree-dump-times "ACCESS_WITH_SIZE" 8 "original" } } */
>> diff --git a/gcc/tree.cc b/gcc/tree.cc
>> index 6564b002dc1a..01572fe70f72 100644
>> --- a/gcc/tree.cc
>> +++ b/gcc/tree.cc
>> @@ -13405,6 +13405,28 @@ component_ref_size (tree ref, special_array_member *sam /* = NULL */)
>> ? NULL_TREE : size_zero_node);
>> }
>>
>> +/* Return true if the given node CALL is a call to a .ACCESS_WITH_SIZE
>> + function. */
>> +bool
>> +is_access_with_size_p (const_tree call)
>> +{
>> + if (TREE_CODE (call) != CALL_EXPR)
>> + return false;
>> + if (CALL_EXPR_IFN (call) == IFN_ACCESS_WITH_SIZE)
>> + return true;
>> + return false;
>> +}
>> +
>> +/* Get the corresponding reference from the call to a .ACCESS_WITH_SIZE.
>> + * i.e the first argument of this call. Return NULL_TREE otherwise. */
>> +tree
>> +get_ref_from_access_with_size (tree call)
>> +{
>> + if (is_access_with_size_p (call))
>> + return CALL_EXPR_ARG (call, 0);
>> + return NULL_TREE;
>> +}
>> +
>> /* Return the machine mode of T. For vectors, returns the mode of the
>> inner type. The main use case is to feed the result to HONOR_NANS,
>> avoiding the BLKmode that a direct TYPE_MODE (T) might return. */
>> diff --git a/gcc/tree.h b/gcc/tree.h
>> index ee2aae332a41..604885641184 100644
>> --- a/gcc/tree.h
>> +++ b/gcc/tree.h
>> @@ -5772,6 +5772,14 @@ extern special_array_member component_ref_sam_type (tree);
>> cannot be determined. */
>> extern tree component_ref_size (tree, special_array_member * = NULL);
>>
>> +/* Return true if the given node is a call to a .ACCESS_WITH_SIZE
>> + function. */
>> +extern bool is_access_with_size_p (const_tree);
>> +
>> +/* Get the corresponding reference from the call to a .ACCESS_WITH_SIZE,
>> + * i.e. the first argument of this call. Return NULL_TREE otherwise. */
>> +extern tree get_ref_from_access_with_size (tree);
>> +
>> extern int tree_map_base_eq (const void *, const void *);
>> extern unsigned int tree_map_base_hash (const void *);
>> extern bool tree_map_base_marked_p (const void *);
>>
>
> --
> Richard Biener <rguenther@suse.de>
> SUSE Software Solutions Germany GmbH,
> Frankenstrasse 146, 90461 Nuernberg, Germany;
> GF: Ivo Totev, Andrew McDonald, Werner Knoblich; (HRB 36809, AG Nuernberg)
^ permalink raw reply [flat|nested] 14+ messages in thread* "counted_by" and -fanalyzer (was Re: [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE.)
2024-05-31 13:11 ` Qing Zhao
@ 2024-06-04 21:55 ` David Malcolm
2024-06-04 22:09 ` Qing Zhao
0 siblings, 1 reply; 14+ messages in thread
From: David Malcolm @ 2024-06-04 21:55 UTC (permalink / raw)
To: Qing Zhao, Richard Biener
Cc: Joseph Myers, Siddhesh Poyarekar, uecker, kees Cook, isanbard,
GCC Patches
On Fri, 2024-05-31 at 13:11 +0000, Qing Zhao wrote:
>
>
> > On May 31, 2024, at 08:58, Richard Biener <rguenther@suse.de>
> > wrote:
> >
> > On Thu, 30 May 2024, Qing Zhao wrote:
> >
> > > Including the following changes:
> > > * The definition of the new internal function .ACCESS_WITH_SIZE
> > > in internal-fn.def.
> > > * C FE converts every reference to a FAM with a "counted_by"
> > > attribute
> > > to a call to the internal function .ACCESS_WITH_SIZE.
> > > (build_component_ref in c_typeck.cc)
> > >
> > > This includes the case when the object is statically allocated
> > > and
> > > initialized.
> > > In order to make this working, the routine digest_init in c-
> > > typeck.cc
> > > is updated to fold calls to .ACCESS_WITH_SIZE to its first
> > > argument
> > > when require_constant is TRUE.
> > >
> > > However, for the reference inside "offsetof", the "counted_by"
> > > attribute is
> > > ignored since it's not useful at all.
> > > (c_parser_postfix_expression in c/c-parser.cc)
> > >
> > > In addtion to "offsetof", for the reference inside operator
> > > "typeof" and
> > > "alignof", we ignore counted_by attribute too.
> > >
> > > When building ADDR_EXPR for the .ACCESS_WITH_SIZE in C FE,
> > > replace the call with its first argument.
> > >
> > > * Convert every call to .ACCESS_WITH_SIZE to its first argument.
> > > (expand_ACCESS_WITH_SIZE in internal-fn.cc)
> > > * Provide the utility routines to check the call is
> > > .ACCESS_WITH_SIZE and
> > > get the reference from the call to .ACCESS_WITH_SIZE.
> > > (is_access_with_size_p and get_ref_from_access_with_size in
> > > tree.cc)
> >
> > The middle-end parts of this revised patch are OK.
>
> Thanks a lot for the review.
> Will commit the patch set soon.
[...snip...]
Congratulations on getting this merged.
FWIW I've started investigating adding support for the new attribute to
-fanalyzer (and am tracked this as PR analyzer/111567
https://gcc.gnu.org/bugzilla/show_bug.cgi?id=111567 ).
The docs for the attribute speak of the implied relationship between
the count field and size of the flex array, and say that: "It's the
user's responsibility to make sure the above requirements to be kept
all the time. Otherwise the compiler *reports warnings*, at the same
time, the results of the array bound sanitizer and the
'__builtin_dynamic_object_size' is undefined." (my emphasis).
What are these warnings that are reported? I looked through
r15-944-gf824acd0e80754 through r15-948-g4c5bea7def1361 and I didn't
see any new warnings or test coverage for warnings (beyond misuing the
attribute). Sorry if I'm missing something obvious here.
Does anyone have examples of cases that -fanalyzer ought to warn for?
Presumably it would be helpful for the analyzer to report about code
paths in which the requirements are violated (but it may be that the
analyzer runs too late to do this...)
Thanks
Dave
^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: "counted_by" and -fanalyzer (was Re: [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE.)
2024-06-04 21:55 ` "counted_by" and -fanalyzer (was Re: [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE.) David Malcolm
@ 2024-06-04 22:09 ` Qing Zhao
2024-06-05 13:49 ` "counted_by" and -fanalyzer David Malcolm
0 siblings, 1 reply; 14+ messages in thread
From: Qing Zhao @ 2024-06-04 22:09 UTC (permalink / raw)
To: David Malcolm
Cc: Richard Biener, Joseph Myers, Siddhesh Poyarekar, uecker,
kees Cook, isanbard, GCC Patches
> On Jun 4, 2024, at 17:55, David Malcolm <dmalcolm@redhat.com> wrote:
>
> On Fri, 2024-05-31 at 13:11 +0000, Qing Zhao wrote:
>>
>>
>>> On May 31, 2024, at 08:58, Richard Biener <rguenther@suse.de>
>>> wrote:
>>>
>>> On Thu, 30 May 2024, Qing Zhao wrote:
>>>
>>>> Including the following changes:
>>>> * The definition of the new internal function .ACCESS_WITH_SIZE
>>>> in internal-fn.def.
>>>> * C FE converts every reference to a FAM with a "counted_by"
>>>> attribute
>>>> to a call to the internal function .ACCESS_WITH_SIZE.
>>>> (build_component_ref in c_typeck.cc)
>>>>
>>>> This includes the case when the object is statically allocated
>>>> and
>>>> initialized.
>>>> In order to make this working, the routine digest_init in c-
>>>> typeck.cc
>>>> is updated to fold calls to .ACCESS_WITH_SIZE to its first
>>>> argument
>>>> when require_constant is TRUE.
>>>>
>>>> However, for the reference inside "offsetof", the "counted_by"
>>>> attribute is
>>>> ignored since it's not useful at all.
>>>> (c_parser_postfix_expression in c/c-parser.cc)
>>>>
>>>> In addtion to "offsetof", for the reference inside operator
>>>> "typeof" and
>>>> "alignof", we ignore counted_by attribute too.
>>>>
>>>> When building ADDR_EXPR for the .ACCESS_WITH_SIZE in C FE,
>>>> replace the call with its first argument.
>>>>
>>>> * Convert every call to .ACCESS_WITH_SIZE to its first argument.
>>>> (expand_ACCESS_WITH_SIZE in internal-fn.cc)
>>>> * Provide the utility routines to check the call is
>>>> .ACCESS_WITH_SIZE and
>>>> get the reference from the call to .ACCESS_WITH_SIZE.
>>>> (is_access_with_size_p and get_ref_from_access_with_size in
>>>> tree.cc)
>>>
>>> The middle-end parts of this revised patch are OK.
>>
>> Thanks a lot for the review.
>> Will commit the patch set soon.
>
> [...snip...]
>
> Congratulations on getting this merged.
>
> FWIW I've started investigating adding support for the new attribute to
> -fanalyzer (and am tracked this as PR analyzer/111567
> https://gcc.gnu.org/bugzilla/show_bug.cgi?id=111567 ).
Thank you for starting looking at this.
>
> The docs for the attribute speak of the implied relationship between
> the count field and size of the flex array, and say that: "It's the
> user's responsibility to make sure the above requirements to be kept
> all the time. Otherwise the compiler *reports warnings*, at the same
> time, the results of the array bound sanitizer and the
> '__builtin_dynamic_object_size' is undefined." (my emphasis).
>
> What are these warnings that are reported? I looked through
> r15-944-gf824acd0e80754 through r15-948-g4c5bea7def1361 and I didn't
> see any new warnings or test coverage for warnings (beyond misuing the
> attribute). Sorry if I'm missing something obvious here.
These warnings will be in the remaining work (I listed the remaining work in all versions except the last one):
>>>> ******Remaining works:
>>>>
>>>> 6 Improve __bdos to use the counted_by info in whole-object size for the structure with FAM.
>>>> 7 Emit warnings when the user breaks the requirments for the new counted_by attribute
>>>> compilation time: -Wcounted-by
>>>> run time: -fsanitizer=counted-by
>>>> * The initialization to the size field should be done before the first reference to the FAM field.
>>>> * the array has at least # of elements specified by the size field all the time during the program.
With the current patches that have been committed, the warnings are not emitted.
I believe that more analysis and more information are needed for these warnings to be effective, it might not
be a trivial patch. More discussion is needed for emitting such warnings.
>
> Does anyone have examples of cases that -fanalyzer ought to warn for?
At this moment, I don’t have concrete testing cases for this yet, but I can come up with several small examples and share with you in a later email.
Qing
> Presumably it would be helpful for the analyzer to report about code
> paths in which the requirements are violated (but it may be that the
> analyzer runs too late to do this...)
>
> Thanks
> Dave
>
^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: "counted_by" and -fanalyzer
2024-06-04 22:09 ` Qing Zhao
@ 2024-06-05 13:49 ` David Malcolm
2024-06-05 19:54 ` Qing Zhao
0 siblings, 1 reply; 14+ messages in thread
From: David Malcolm @ 2024-06-05 13:49 UTC (permalink / raw)
To: Qing Zhao
Cc: Richard Biener, Joseph Myers, Siddhesh Poyarekar, uecker,
kees Cook, isanbard, GCC Patches
On Tue, 2024-06-04 at 22:09 +0000, Qing Zhao wrote:
>
>
> > On Jun 4, 2024, at 17:55, David Malcolm <dmalcolm@redhat.com>
> > wrote:
> >
> > On Fri, 2024-05-31 at 13:11 +0000, Qing Zhao wrote:
> > >
> > >
[...]
> > >
> > >
> > > Thanks a lot for the review.
> > > Will commit the patch set soon.
> >
> > [...snip...]
> >
> > Congratulations on getting this merged.
> >
> > FWIW I've started investigating adding support for the new
> > attribute to
> > -fanalyzer (and am tracked this as PR analyzer/111567
> > https://gcc.gnu.org/bugzilla/show_bug.cgi?id=111567 ).
>
> Thank you for starting looking at this.
> >
> > The docs for the attribute speak of the implied relationship
> > between
> > the count field and size of the flex array, and say that: "It's the
> > user's responsibility to make sure the above requirements to be
> > kept
> > all the time. Otherwise the compiler *reports warnings*, at the
> > same
> > time, the results of the array bound sanitizer and the
> > '__builtin_dynamic_object_size' is undefined." (my emphasis).
> >
> > What are these warnings that are reported? I looked through
> > r15-944-gf824acd0e80754 through r15-948-g4c5bea7def1361 and I
> > didn't
> > see any new warnings or test coverage for warnings (beyond misuing
> > the
> > attribute). Sorry if I'm missing something obvious here.
>
> These warnings will be in the remaining work (I listed the remaining
> work in all versions except the last one):
>
> > > > > ******Remaining works:
> > > > >
> > > > > 6 Improve __bdos to use the counted_by info in whole-object
> > > > > size for the structure with FAM.
> > > > > 7 Emit warnings when the user breaks the requirments for the
> > > > > new counted_by attribute
> > > > > compilation time: -Wcounted-by
> > > > > run time: -fsanitizer=counted-by
> > > > > * The initialization to the size field should be done
> > > > > before the first reference to the FAM field.
> > > > > * the array has at least # of elements specified by the
> > > > > size field all the time during the program.
Aha - thanks. Sorry for missing this, I confess I haven't been paying
close attention to this thread.
>
> With the current patches that have been committed, the warnings are
> not emitted.
> I believe that more analysis and more information are needed for
> these warnings to be effective, it might not
> be a trivial patch. More discussion is needed for emitting such
> warnings.
>
> >
> > Does anyone have examples of cases that -fanalyzer ought to warn
> > for?
>
> At this moment, I don’t have concrete testing cases for this yet, but
> I can come up with several small examples and share with you in a
> later email.
FWIW I did some brainstorming and put together the following .c file,
am posting it inline here for the sake of discussion; does this look
like the kind of thing to test for (in terms of how users are expected
to use the attribute, and the kinds of mistake they'd want warnings
about) ?
/* TODO:
Some ideas for dimensions of test matrix:
(a) concrete value vs symbolic value for "count"
(b) concrete value vs symbolic value for size of array
(c) dynamic vs static allocation of buffer (and malloc vs alloca)
(d) relative size of array and of count
- same size (not an issue)
- array is too small compared to "count"
- off by one
- off by more than one
- size is zero (but not negative)
- negative size (which the docs say is OK)
- array is too large compared to "count" (not an issue)
(e) type of flex array:
- char
- non-char
- type requiring padding
(f) type/size/signedness of count field; what about overflow
in (count * sizeof (type of array element)) ?
... etc: ideas?
Other ideas for test coverage:
- realloc
- growing object
- shrinking object
- symbolic sizes where could be growth or shrinkage
- failing realloc
- ...etc: ideas? */
#include <stddef.h>
#include <stdlib.h>
#include <stdint.h>
/* Example from the docs. */
struct P {
size_t count;
char other;
char array[] __attribute__ ((counted_by (count)));
} *p;
struct P *
test_malloc_with_correct_symbolic (size_t n)
{
struct P *p = malloc (sizeof (struct P) + n);
if (!p)
return NULL;
p->count = n; // don't warn here
return p;
}
struct P *
test_malloc_with_correct_count_concrete (void)
{
struct P *p = malloc (sizeof (struct P) + 42);
if (!p)
return NULL;
p->count = 42; // don't warn here
return p;
}
struct P *
test_malloc_with_array_smaller_than_count_concrete (void)
{
struct P *p = malloc (sizeof (struct P) + 42);
if (!p)
return NULL;
p->count = 80; // TODO: warn here
return p;
}
struct P *
test_malloc_with_array_larger_than_count_concrete (void)
{
struct P *p = malloc (sizeof (struct P) + 80);
if (!p)
return NULL;
p->count = 42; // don't warn here
return p;
}
struct P *
test_malloc_with_array_access_before_count_init_concrete_1 (void)
{
struct P *p = malloc (sizeof (struct P) + 42);
if (!p)
return NULL;
/* Forgetting to set count altogether. */
__builtin_memset (p->array, 0, 42); // TODO: should warn here
return p;
}
struct P *
test_malloc_with_array_access_before_count_init_concrete_2 (void)
{
struct P *p = malloc (sizeof (struct P) + 42);
if (!p)
return NULL;
/* Erroneously touching array before setting count. */
__builtin_memset (p->array, 0, 42); // TODO: should warn here
p->count = 42;
return p;
}
struct P *
test_malloc_with_array_access_before_count_init_symbolic_1 (size_t n)
{
struct P *p = malloc (sizeof (struct P) + n);
if (!p)
return NULL;
/* Forgetting to set count altogether. */
__builtin_memset (p->array, 0, n); // TODO: should warn here
return p;
}
struct P *
test_malloc_with_array_access_before_count_init_symbolic_2 (size_t n)
{
struct P *p = malloc (sizeof (struct P) + n);
if (!p)
return NULL;
/* Erroneously touching array before setting count. */
__builtin_memset (p->array, 0, n); // TODO: should warn here
p->count = n;
return p;
}
/* Example where sizeof array element != 1. */
struct Q
{
size_t count;
int32_t array[] __attribute__ ((counted_by (count)));
};
struct Q *
test_malloc_of_non_char_array_valid_symbolic (size_t n)
{
size_t alloc_sz = sizeof (struct Q) + (sizeof (int32_t) * n);
struct Q *q = malloc (alloc_sz);
if (!q)
return NULL;
// Don't warn for this:
q->count = n;
__builtin_memset (q->array, 0, sizeof (int32_t) * n);
return q;
}
struct Q *
test_malloc_of_non_char_array_bad_size_symbolic (size_t n)
{
/* Allocation size is too small: forgetting to multiply
count by sizeof (array element). */
size_t alloc_sz = sizeof (struct Q) + n;
struct Q *q = malloc (alloc_sz);
if (!q)
return NULL;
/* TODO: should we warn here?
Allocated size of flex array is too small relative
to implicit size of accesses. */
q->count = n;
/* TODO: should we warn here?
This initializes the buffer we allocated,
but only the first quarter of the flex array. */
__builtin_memset (q->array, 0, n);
/* TODO: should we warn here?
This initializes the full flex array as specified by
"count", but is out-of-bounds relative to our heap
allocation. */
__builtin_memset (q->array, 0, sizeof (int32_t) * n);
return q;
}
^ permalink raw reply [flat|nested] 14+ messages in thread* Re: "counted_by" and -fanalyzer
2024-06-05 13:49 ` "counted_by" and -fanalyzer David Malcolm
@ 2024-06-05 19:54 ` Qing Zhao
0 siblings, 0 replies; 14+ messages in thread
From: Qing Zhao @ 2024-06-05 19:54 UTC (permalink / raw)
To: David Malcolm
Cc: Richard Biener, Joseph Myers, Siddhesh Poyarekar, uecker,
kees Cook, isanbard, GCC Patches
> On Jun 5, 2024, at 09:49, David Malcolm <dmalcolm@redhat.com> wrote:
>
> On Tue, 2024-06-04 at 22:09 +0000, Qing Zhao wrote:
>>
>>
>>> On Jun 4, 2024, at 17:55, David Malcolm <dmalcolm@redhat.com>
>>> wrote:
>>>
>>> On Fri, 2024-05-31 at 13:11 +0000, Qing Zhao wrote:
>>>>
>>>>
>
> [...]
>
>>>>
>>>>
>>>> Thanks a lot for the review.
>>>> Will commit the patch set soon.
>>>
>>> [...snip...]
>>>
>>> Congratulations on getting this merged.
>>>
>>> FWIW I've started investigating adding support for the new
>>> attribute to
>>> -fanalyzer (and am tracked this as PR analyzer/111567
>>> https://gcc.gnu.org/bugzilla/show_bug.cgi?id=111567 ).
>>
>> Thank you for starting looking at this.
>>>
>>> The docs for the attribute speak of the implied relationship
>>> between
>>> the count field and size of the flex array, and say that: "It's the
>>> user's responsibility to make sure the above requirements to be
>>> kept
>>> all the time. Otherwise the compiler *reports warnings*, at the
>>> same
>>> time, the results of the array bound sanitizer and the
>>> '__builtin_dynamic_object_size' is undefined." (my emphasis).
>>>
>>> What are these warnings that are reported? I looked through
>>> r15-944-gf824acd0e80754 through r15-948-g4c5bea7def1361 and I
>>> didn't
>>> see any new warnings or test coverage for warnings (beyond misuing
>>> the
>>> attribute). Sorry if I'm missing something obvious here.
>>
>> These warnings will be in the remaining work (I listed the remaining
>> work in all versions except the last one):
>>
>>>>>> ******Remaining works:
>>>>>>
>>>>>> 6 Improve __bdos to use the counted_by info in whole-object
>>>>>> size for the structure with FAM.
>>>>>> 7 Emit warnings when the user breaks the requirments for the
>>>>>> new counted_by attribute
>>>>>> compilation time: -Wcounted-by
>>>>>> run time: -fsanitizer=counted-by
>>>>>> * The initialization to the size field should be done
>>>>>> before the first reference to the FAM field.
>>>>>> * the array has at least # of elements specified by the
>>>>>> size field all the time during the program.
>
> Aha - thanks. Sorry for missing this, I confess I haven't been paying
> close attention to this thread.
>
>>
>> With the current patches that have been committed, the warnings are
>> not emitted.
>> I believe that more analysis and more information are needed for
>> these warnings to be effective, it might not
>> be a trivial patch. More discussion is needed for emitting such
>> warnings.
>>
>>>
>>> Does anyone have examples of cases that -fanalyzer ought to warn
>>> for?
>>
>> At this moment, I don’t have concrete testing cases for this yet, but
>> I can come up with several small examples and share with you in a
>> later email.
>
> FWIW I did some brainstorming and put together the following .c file,
> am posting it inline here for the sake of discussion; does this look
> like the kind of thing to test for (in terms of how users are expected
> to use the attribute, and the kinds of mistake they'd want warnings
> about) ?
From my understanding, there are two parts of work to support “counted-by” in -fanalyzer:
1. Use this new attribute to improve out-of-bound, buffer overflow detection in -fanalyzer (maybe -Wanalyzer-out-of-bounds can be improved with this new attribute?)
2. Report user errors that breaks the following 2 requirements for the new counted-by attribute:
-fsanitizer=counted-by
* The initialization to the size field should be done before the first reference to the FAM field.
* the array has at least # of elements specified by the size field all the time during the program.
So, the testing cases might include the above 1 and 2.
From my understanding of the below testings, mostly belong to 2.
Some more comments inlined below:
>
> /* TODO:
> Some ideas for dimensions of test matrix:
> (a) concrete value vs symbolic value for "count"
> (b) concrete value vs symbolic value for size of array
> (c) dynamic vs static allocation of buffer (and malloc vs alloca)
> (d) relative size of array and of count
> - same size (not an issue)
> - array is too small compared to "count"
> - off by one
> - off by more than one
> - size is zero (but not negative)
> - negative size (which the docs say is OK)
> - array is too large compared to "count" (not an issue)
> (e) type of flex array:
> - char
> - non-char
> - type requiring padding
> (f) type/size/signedness of count field; what about overflow
> in (count * sizeof (type of array element)) ?
> ... etc: ideas?
>
> Other ideas for test coverage:
> - realloc
> - growing object
> - shrinking object
> - symbolic sizes where could be growth or shrinkage
> - failing realloc
> - ...etc: ideas? */
>
> #include <stddef.h>
> #include <stdlib.h>
> #include <stdint.h>
>
> /* Example from the docs. */
>
> struct P {
> size_t count;
> char other;
> char array[] __attribute__ ((counted_by (count)));
> } *p;
>
> struct P *
> test_malloc_with_correct_symbolic (size_t n)
> {
> struct P *p = malloc (sizeof (struct P) + n);
The size of the malloc might not be computed very accurately here, you might want:
malloc (MAX (sizeof (struct P), (offsetof (struct P, array[0]) + n))
> if (!p)
> return NULL;
> p->count = n; // don't warn here
> return p;
> }
>
> struct P *
> test_malloc_with_correct_count_concrete (void)
> {
> struct P *p = malloc (sizeof (struct P) + 42);
> if (!p)
> return NULL;
> p->count = 42; // don't warn here
> return p;
> }
>
> struct P *
> test_malloc_with_array_smaller_than_count_concrete (void)
> {
> struct P *p = malloc (sizeof (struct P) + 42);
> if (!p)
> return NULL;
> p->count = 80; // TODO: warn here
> return p;
> }
>
> struct P *
> test_malloc_with_array_larger_than_count_concrete (void)
> {
> struct P *p = malloc (sizeof (struct P) + 80);
> if (!p)
> return NULL;
> p->count = 42; // don't warn here
> return p;
> }
Okay (except the malloc size). You can take a look at:
gcc/testsuite/gcc.dg/flex-array-counted-by-4.c
alloc_buf_more and alloc_buf_less
> struct P *
> test_malloc_with_array_access_before_count_init_concrete_1 (void)
> {
> struct P *p = malloc (sizeof (struct P) + 42);
> if (!p)
> return NULL;
> /* Forgetting to set count altogether. */
> __builtin_memset (p->array, 0, 42); // TODO: should warn here
> return p;
> }
>
> struct P *
> test_malloc_with_array_access_before_count_init_concrete_2 (void)
> {
> struct P *p = malloc (sizeof (struct P) + 42);
> if (!p)
> return NULL;
> /* Erroneously touching array before setting count. */
> __builtin_memset (p->array, 0, 42); // TODO: should warn here
> p->count = 42;
> return p;
> }
>
> struct P *
> test_malloc_with_array_access_before_count_init_symbolic_1 (size_t n)
> {
> struct P *p = malloc (sizeof (struct P) + n);
> if (!p)
> return NULL;
> /* Forgetting to set count altogether. */
> __builtin_memset (p->array, 0, n); // TODO: should warn here
> return p;
> }
>
> struct P *
> test_malloc_with_array_access_before_count_init_symbolic_2 (size_t n)
> {
> struct P *p = malloc (sizeof (struct P) + n);
> if (!p)
> return NULL;
> /* Erroneously touching array before setting count. */
> __builtin_memset (p->array, 0, n); // TODO: should warn here
> p->count = n;
> return p;
> }
Yes, the above are good for: The initialization to the size field should be done before the first reference to the FAM field.
/* Example where sizeof array element != 1. */
>
>
> struct Q
> {
> size_t count;
> int32_t array[] __attribute__ ((counted_by (count)));
> };
>
> struct Q *
> test_malloc_of_non_char_array_valid_symbolic (size_t n)
> {
> size_t alloc_sz = sizeof (struct Q) + (sizeof (int32_t) * n);
> struct Q *q = malloc (alloc_sz);
> if (!q)
> return NULL;
> // Don't warn for this:
> q->count = n;
> __builtin_memset (q->array, 0, sizeof (int32_t) * n);
> return q;
> }
>
> struct Q *
> test_malloc_of_non_char_array_bad_size_symbolic (size_t n)
> {
> /* Allocation size is too small: forgetting to multiply
> count by sizeof (array element). */
> size_t alloc_sz = sizeof (struct Q) + n;
> struct Q *q = malloc (alloc_sz);
> if (!q)
> return NULL;
>
> /* TODO: should we warn here?
> Allocated size of flex array is too small relative
> to implicit size of accesses. */
> q->count = n;
If the real # of elements of the array "q->array” is smaller than that is specified by “q->count”, we should issue warning here.
>
> /* TODO: should we warn here?
> This initializes the buffer we allocated,
> but only the first quarter of the flex array. */
> __builtin_memset (q->array, 0, n);
I think that no warning is needed for -fanalyzer=counted-by here, since “q->count” has been initialized before the reference to “q->array”. This is correct.
(The error of the initialization is bigger than the real array has been issued in the above warning already).
>
> /* TODO: should we warn here?
> This initializes the full flex array as specified by
> "count", but is out-of-bounds relative to our heap
> allocation. */
> __builtin_memset (q->array, 0, sizeof (int32_t) * n);
I think that no warning is needed for -fanalyzer=counted-by here.
But whether there are warnings for -Wanalyzer-out-of-bounds is another question, I think when the user use the “counted-by” attribute incorrectly in their source code, the behavior of out-of-bounds detection is undefined as we mentioned in the documentation:
"It's the user's responsibility to make sure the above requirements to
be kept all the time. Otherwise the compiler reports warnings,
at the same time, the results of the array bound sanitizer and the
@code{__builtin_dynamic_object_size} is undefined”
Qing
> return q;
> }
>
>
>
>
>
>
>
>
^ permalink raw reply [flat|nested] 14+ messages in thread
* [PATCH v10 3/5] Use the .ACCESS_WITH_SIZE in builtin object size.
2024-05-30 12:26 [PATCH v10 0/5] New attribute "counted_by" to annotate bounds for C99 FAM(PR108896) Qing Zhao
2024-05-30 12:26 ` [PATCH v10 1/5] Provide counted_by attribute to flexible array member field (PR108896) Qing Zhao
2024-05-30 12:26 ` [PATCH v10 2/5] Convert references with "counted_by" attributes to/from .ACCESS_WITH_SIZE Qing Zhao
@ 2024-05-30 12:26 ` Qing Zhao
2024-05-30 12:26 ` [PATCH v10 4/5] Use the .ACCESS_WITH_SIZE in bound sanitizer Qing Zhao
2024-05-30 12:27 ` [PATCH v10 5/5] Add the 6th argument to .ACCESS_WITH_SIZE Qing Zhao
4 siblings, 0 replies; 14+ messages in thread
From: Qing Zhao @ 2024-05-30 12:26 UTC (permalink / raw)
To: rguenther, josmyers
Cc: siddhesh, uecker, keescook, isanbard, gcc-patches, Qing Zhao
gcc/ChangeLog:
* tree-object-size.cc (access_with_size_object_size): New function.
(call_object_size): Call the new function.
gcc/testsuite/ChangeLog:
* gcc.dg/builtin-object-size-common.h: Add a new macro EXPECT.
* gcc.dg/flex-array-counted-by-3.c: New test.
* gcc.dg/flex-array-counted-by-4.c: New test.
* gcc.dg/flex-array-counted-by-5.c: New test.
---
.../gcc.dg/builtin-object-size-common.h | 11 ++
.../gcc.dg/flex-array-counted-by-3.c | 63 +++++++
.../gcc.dg/flex-array-counted-by-4.c | 178 ++++++++++++++++++
.../gcc.dg/flex-array-counted-by-5.c | 48 +++++
gcc/tree-object-size.cc | 60 ++++++
5 files changed, 360 insertions(+)
create mode 100644 gcc/testsuite/gcc.dg/flex-array-counted-by-3.c
create mode 100644 gcc/testsuite/gcc.dg/flex-array-counted-by-4.c
create mode 100644 gcc/testsuite/gcc.dg/flex-array-counted-by-5.c
diff --git a/gcc/testsuite/gcc.dg/builtin-object-size-common.h b/gcc/testsuite/gcc.dg/builtin-object-size-common.h
index 66ff7cdd953a..b677067c6e6b 100644
--- a/gcc/testsuite/gcc.dg/builtin-object-size-common.h
+++ b/gcc/testsuite/gcc.dg/builtin-object-size-common.h
@@ -30,3 +30,14 @@ unsigned nfails = 0;
__builtin_abort (); \
return 0; \
} while (0)
+
+#define EXPECT(p, _v) do { \
+ size_t v = _v; \
+ if (p == v) \
+ __builtin_printf ("ok: %s == %zd\n", #p, p); \
+ else \
+ { \
+ __builtin_printf ("WAT: %s == %zd (expected %zd)\n", #p, p, v); \
+ FAIL (); \
+ } \
+} while (0);
diff --git a/gcc/testsuite/gcc.dg/flex-array-counted-by-3.c b/gcc/testsuite/gcc.dg/flex-array-counted-by-3.c
new file mode 100644
index 000000000000..78f50230e891
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/flex-array-counted-by-3.c
@@ -0,0 +1,63 @@
+/* Test the attribute counted_by and its usage in
+ * __builtin_dynamic_object_size. */
+/* { dg-do run } */
+/* { dg-options "-O2" } */
+
+#include "builtin-object-size-common.h"
+
+struct flex {
+ int b;
+ int c[];
+} *array_flex;
+
+struct annotated {
+ int b;
+ int c[] __attribute__ ((counted_by (b)));
+} *array_annotated;
+
+struct nested_annotated {
+ struct {
+ union {
+ int b;
+ float f;
+ };
+ int n;
+ };
+ int c[] __attribute__ ((counted_by (b)));
+} *array_nested_annotated;
+
+void __attribute__((__noinline__)) setup (int normal_count, int attr_count)
+{
+ array_flex
+ = (struct flex *)malloc (sizeof (struct flex)
+ + normal_count * sizeof (int));
+ array_flex->b = normal_count;
+
+ array_annotated
+ = (struct annotated *)malloc (sizeof (struct annotated)
+ + attr_count * sizeof (int));
+ array_annotated->b = attr_count;
+
+ array_nested_annotated
+ = (struct nested_annotated *)malloc (sizeof (struct nested_annotated)
+ + attr_count * sizeof (int));
+ array_nested_annotated->b = attr_count;
+
+ return;
+}
+
+void __attribute__((__noinline__)) test ()
+{
+ EXPECT(__builtin_dynamic_object_size(array_flex->c, 1), -1);
+ EXPECT(__builtin_dynamic_object_size(array_annotated->c, 1),
+ array_annotated->b * sizeof (int));
+ EXPECT(__builtin_dynamic_object_size(array_nested_annotated->c, 1),
+ array_nested_annotated->b * sizeof (int));
+}
+
+int main(int argc, char *argv[])
+{
+ setup (10,10);
+ test ();
+ DONE ();
+}
diff --git a/gcc/testsuite/gcc.dg/flex-array-counted-by-4.c b/gcc/testsuite/gcc.dg/flex-array-counted-by-4.c
new file mode 100644
index 000000000000..20103d58ef51
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/flex-array-counted-by-4.c
@@ -0,0 +1,178 @@
+/* Test the attribute counted_by and its usage in
+__builtin_dynamic_object_size: what's the correct behavior when the
+allocation size mismatched with the value of counted_by attribute?
+We should always use the latest value that is hold by the counted_by
+field. */
+/* { dg-do run } */
+/* { dg-options "-O -fstrict-flex-arrays=3" } */
+
+#include "builtin-object-size-common.h"
+
+struct annotated {
+ size_t foo;
+ char others;
+ char array[] __attribute__((counted_by (foo)));
+};
+
+#define noinline __attribute__((__noinline__))
+#define SIZE_BUMP 10
+#define MAX(a, b) ((a) > (b) ? (a) : (b))
+
+/* In general, Due to type casting, the type for the pointee of a pointer
+ does not say anything about the object it points to,
+ So, __builtin_object_size can not directly use the type of the pointee
+ to decide the size of the object the pointer points to.
+
+ There are only two reliable ways:
+ A. observed allocations (call to the allocation functions in the routine)
+ B. observed accesses (read or write access to the location of the
+ pointer points to)
+
+ That provide information about the type/existence of an object at
+ the corresponding address.
+
+ For A, we use the "alloc_size" attribute for the corresponding allocation
+ functions to determine the object size;
+ (We treat counted_by attribute the same as the "alloc_size" attribute)
+
+ For B, we use the SIZE info of the TYPE attached to the corresponding access.
+
+ The only other way in C which ensures that a pointer actually points
+ to an object of the correct type is 'static':
+
+ void foo(struct P *p[static 1]);
+
+ See https://gcc.gnu.org/pipermail/gcc-patches/2023-July/624814.html
+ for more details. */
+
+/* In the following function, malloc allocated more space than the value
+ of counted_by attribute. Then what's the correct behavior we expect
+ the __builtin_dynamic_object_size should have for each of the cases? */
+
+static struct annotated * noinline alloc_buf_more (size_t index)
+{
+ struct annotated *p;
+ size_t allocated_size
+ = MAX (sizeof (struct annotated),
+ (__builtin_offsetof (struct annotated, array[0])
+ + (index + SIZE_BUMP) * sizeof (char)));
+ p = (struct annotated *) malloc (allocated_size);
+
+ p->foo = index;
+
+ /* When checking the observed access p->array, we have info on both
+ observered allocation and observed access,
+ A.1 from observed allocation:
+ allocated_size - offsetof (struct annotated, array[0])
+
+ A.2 from the counted-by attribute:
+ p->foo * sizeof (char)
+
+ We always use the latest value that is hold by the counted-by field.
+ */
+
+ EXPECT(__builtin_dynamic_object_size(p->array, 0),
+ (p->foo) * sizeof(char));
+
+ EXPECT(__builtin_dynamic_object_size(p->array, 1),
+ (p->foo) * sizeof(char));
+
+ EXPECT(__builtin_dynamic_object_size(p->array, 2),
+ (p->foo) * sizeof(char));
+
+ EXPECT(__builtin_dynamic_object_size(p->array, 3),
+ (p->foo) * sizeof(char));
+
+ /* When checking the pointer p, we only have info on the observed allocation.
+ So, the object size info can only been obtained from the call to malloc.
+ For both MAXIMUM and MINIMUM: A = (index + SIZE_BUMP) * sizeof (char) */
+ EXPECT(__builtin_dynamic_object_size(p, 0), allocated_size);
+ EXPECT(__builtin_dynamic_object_size(p, 1), allocated_size);
+ EXPECT(__builtin_dynamic_object_size(p, 2), allocated_size);
+ EXPECT(__builtin_dynamic_object_size(p, 3), allocated_size);
+ return p;
+}
+
+/* In the following function, malloc allocated less space than the value
+ of counted_by attribute. Then what's the correct behavior we expect
+ the __builtin_dynamic_object_size should have for each of the cases?
+ NOTE: this is an user error, GCC should issue warnings for such case.
+ This is a seperate issue we should address later. */
+
+static struct annotated * noinline alloc_buf_less (size_t index)
+{
+ struct annotated *p;
+ size_t allocated_size
+ = MAX (sizeof (struct annotated),
+ (__builtin_offsetof (struct annotated, array[0])
+ + (index) * sizeof (char)));
+ p = (struct annotated *) malloc (allocated_size);
+
+ p->foo = index + SIZE_BUMP;
+
+ /* When checking the observed access p->array, we have info on both
+ observered allocation and observed access,
+ A.1 from observed allocation:
+ allocated_size - offsetof (struct annotated, array[0])
+ A.2 from the counted-by attribute:
+ p->foo * sizeof (char)
+
+ We always use the latest value that is hold by the counted-by field.
+ */
+
+ EXPECT(__builtin_dynamic_object_size(p->array, 0),
+ (p->foo) * sizeof(char));
+
+ EXPECT(__builtin_dynamic_object_size(p->array, 1),
+ (p->foo) * sizeof(char));
+
+ EXPECT(__builtin_dynamic_object_size(p->array, 2),
+ (p->foo) * sizeof(char));
+
+ EXPECT(__builtin_dynamic_object_size(p->array, 3),
+ (p->foo) * sizeof(char));
+
+ /* When checking the pointer p, we only have info on the observed
+ allocation. So, the object size info can only been obtained from
+ the call to malloc. */
+ EXPECT(__builtin_dynamic_object_size(p, 0), allocated_size);
+ EXPECT(__builtin_dynamic_object_size(p, 1), allocated_size);
+ EXPECT(__builtin_dynamic_object_size(p, 2), allocated_size);
+ EXPECT(__builtin_dynamic_object_size(p, 3), allocated_size);
+ return p;
+}
+
+int main ()
+{
+ struct annotated *p, *q;
+ p = alloc_buf_more (10);
+ q = alloc_buf_less (10);
+
+ /* When checking the access p->array, we only have info on the counted-by
+ value. */
+ EXPECT(__builtin_dynamic_object_size(p->array, 0), p->foo * sizeof(char));
+ EXPECT(__builtin_dynamic_object_size(p->array, 1), p->foo * sizeof(char));
+ EXPECT(__builtin_dynamic_object_size(p->array, 2), p->foo * sizeof(char));
+ EXPECT(__builtin_dynamic_object_size(p->array, 3), p->foo * sizeof(char));
+ /* When checking the pointer p, we have no observed allocation nor observed
+ access, therefore, we cannot determine the size info here. */
+ EXPECT(__builtin_dynamic_object_size(p, 0), -1);
+ EXPECT(__builtin_dynamic_object_size(p, 1), -1);
+ EXPECT(__builtin_dynamic_object_size(p, 2), 0);
+ EXPECT(__builtin_dynamic_object_size(p, 3), 0);
+
+ /* When checking the access p->array, we only have info on the counted-by
+ value. */
+ EXPECT(__builtin_dynamic_object_size(q->array, 0), q->foo * sizeof(char));
+ EXPECT(__builtin_dynamic_object_size(q->array, 1), q->foo * sizeof(char));
+ EXPECT(__builtin_dynamic_object_size(q->array, 2), q->foo * sizeof(char));
+ EXPECT(__builtin_dynamic_object_size(q->array, 3), q->foo * sizeof(char));
+ /* When checking the pointer p, we have no observed allocation nor observed
+ access, therefore, we cannot determine the size info here. */
+ EXPECT(__builtin_dynamic_object_size(q, 0), -1);
+ EXPECT(__builtin_dynamic_object_size(q, 1), -1);
+ EXPECT(__builtin_dynamic_object_size(q, 2), 0);
+ EXPECT(__builtin_dynamic_object_size(q, 3), 0);
+
+ DONE ();
+}
diff --git a/gcc/testsuite/gcc.dg/flex-array-counted-by-5.c b/gcc/testsuite/gcc.dg/flex-array-counted-by-5.c
new file mode 100644
index 000000000000..68f9b0f7c8d2
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/flex-array-counted-by-5.c
@@ -0,0 +1,48 @@
+/* Test the attribute counted_by and its usage in
+ * __builtin_dynamic_object_size: when the counted_by field is negative. */
+/* { dg-do run } */
+/* { dg-options "-O2" } */
+
+#include "builtin-object-size-common.h"
+
+struct annotated {
+ int b;
+ int c[] __attribute__ ((counted_by (b)));
+} *array_annotated;
+
+struct nested_annotated {
+ struct {
+ union {
+ int b;
+ float f;
+ };
+ int n;
+ };
+ int c[] __attribute__ ((counted_by (b)));
+} *array_nested_annotated;
+
+void __attribute__((__noinline__)) setup (int attr_count)
+{
+ array_annotated
+ = (struct annotated *)malloc (sizeof (struct annotated));
+ array_annotated->b = attr_count;
+
+ array_nested_annotated
+ = (struct nested_annotated *)malloc (sizeof (struct nested_annotated));
+ array_nested_annotated->b = attr_count -1;
+
+ return;
+}
+
+void __attribute__((__noinline__)) test ()
+{
+ EXPECT(__builtin_dynamic_object_size(array_annotated->c, 1), 0);
+ EXPECT(__builtin_dynamic_object_size(array_nested_annotated->c, 1), 0);
+}
+
+int main(int argc, char *argv[])
+{
+ setup (-10);
+ test ();
+ DONE ();
+}
diff --git a/gcc/tree-object-size.cc b/gcc/tree-object-size.cc
index 018fbc30cbb6..8de264d1dee2 100644
--- a/gcc/tree-object-size.cc
+++ b/gcc/tree-object-size.cc
@@ -37,6 +37,7 @@ along with GCC; see the file COPYING3. If not see
#include "attribs.h"
#include "builtins.h"
#include "gimplify-me.h"
+#include "gimplify.h"
struct object_size_info
{
@@ -60,6 +61,7 @@ static tree compute_object_offset (tree, const_tree);
static bool addr_object_size (struct object_size_info *,
const_tree, int, tree *, tree *t = NULL);
static tree alloc_object_size (const gcall *, int);
+static tree access_with_size_object_size (const gcall *, int);
static tree pass_through_call (const gcall *);
static void collect_object_sizes_for (struct object_size_info *, tree);
static void expr_object_size (struct object_size_info *, tree, tree);
@@ -749,6 +751,60 @@ addr_object_size (struct object_size_info *osi, const_tree ptr,
return false;
}
+/* Compute __builtin_object_size for a CALL to .ACCESS_WITH_SIZE,
+ OBJECT_SIZE_TYPE is the second argument from __builtin_object_size.
+ The 2nd, 3rd, and the 4th parameters of the call determine the size of
+ the CALL:
+
+ 2nd argument REF_TO_SIZE: The reference to the size of the object,
+ 3rd argument CLASS_OF_SIZE: The size referenced by the REF_TO_SIZE represents
+ 0: the number of bytes;
+ 1: the number of the elements of the object type;
+ 4th argument TYPE_OF_SIZE: A constant 0 with its TYPE being the same as the TYPE
+ of the object referenced by REF_TO_SIZE
+
+ The size of the element can be retrived from the result type of the call,
+ which is the pointer to the array type. */
+static tree
+access_with_size_object_size (const gcall *call, int object_size_type)
+{
+ /* If not for dynamic object size, return. */
+ if ((object_size_type & OST_DYNAMIC) == 0)
+ return size_unknown (object_size_type);
+
+ gcc_assert (gimple_call_internal_p (call, IFN_ACCESS_WITH_SIZE));
+ /* Result type is a pointer type to the original flexible array type. */
+ tree result_type = gimple_call_return_type (call);
+ gcc_assert (POINTER_TYPE_P (result_type));
+ tree element_size = TYPE_SIZE_UNIT (TREE_TYPE (TREE_TYPE (result_type)));
+ tree ref_to_size = gimple_call_arg (call, 1);
+ unsigned int class_of_size = TREE_INT_CST_LOW (gimple_call_arg (call, 2));
+ tree type = TREE_TYPE (gimple_call_arg (call, 3));
+
+ tree size = fold_build2 (MEM_REF, type, ref_to_size,
+ build_int_cst (ptr_type_node, 0));
+
+ /* If size is negative value, treat it as zero. */
+ if (!TYPE_UNSIGNED (type))
+ {
+ tree cond_expr = fold_build2 (LT_EXPR, boolean_type_node,
+ unshare_expr (size), build_zero_cst (type));
+ size = fold_build3 (COND_EXPR, integer_type_node, cond_expr,
+ build_zero_cst (type), size);
+ }
+
+ if (class_of_size == 1)
+ size = size_binop (MULT_EXPR,
+ fold_convert (sizetype, size),
+ fold_convert (sizetype, element_size));
+ else
+ size = fold_convert (sizetype, size);
+
+ if (!todo)
+ todo = TODO_update_ssa_only_virtuals;
+
+ return size;
+}
/* Compute __builtin_object_size for CALL, which is a GIMPLE_CALL.
Handles calls to functions declared with attribute alloc_size.
@@ -1350,8 +1406,12 @@ call_object_size (struct object_size_info *osi, tree ptr, gcall *call)
bool is_strdup = gimple_call_builtin_p (call, BUILT_IN_STRDUP);
bool is_strndup = gimple_call_builtin_p (call, BUILT_IN_STRNDUP);
+ bool is_access_with_size
+ = gimple_call_internal_p (call, IFN_ACCESS_WITH_SIZE);
if (is_strdup || is_strndup)
bytes = strdup_object_size (call, object_size_type, is_strndup);
+ else if (is_access_with_size)
+ bytes = access_with_size_object_size (call, object_size_type);
else
bytes = alloc_object_size (call, object_size_type);
--
2.31.1
^ permalink raw reply [flat|nested] 14+ messages in thread* [PATCH v10 4/5] Use the .ACCESS_WITH_SIZE in bound sanitizer.
2024-05-30 12:26 [PATCH v10 0/5] New attribute "counted_by" to annotate bounds for C99 FAM(PR108896) Qing Zhao
` (2 preceding siblings ...)
2024-05-30 12:26 ` [PATCH v10 3/5] Use the .ACCESS_WITH_SIZE in builtin object size Qing Zhao
@ 2024-05-30 12:26 ` Qing Zhao
2024-05-30 12:27 ` [PATCH v10 5/5] Add the 6th argument to .ACCESS_WITH_SIZE Qing Zhao
4 siblings, 0 replies; 14+ messages in thread
From: Qing Zhao @ 2024-05-30 12:26 UTC (permalink / raw)
To: rguenther, josmyers
Cc: siddhesh, uecker, keescook, isanbard, gcc-patches, Qing Zhao
gcc/c-family/ChangeLog:
* c-ubsan.cc (get_bound_from_access_with_size): New function.
(ubsan_instrument_bounds): Handle call to .ACCESS_WITH_SIZE.
gcc/testsuite/ChangeLog:
* gcc.dg/ubsan/flex-array-counted-by-bounds-2.c: New test.
* gcc.dg/ubsan/flex-array-counted-by-bounds-3.c: New test.
* gcc.dg/ubsan/flex-array-counted-by-bounds-4.c: New test.
* gcc.dg/ubsan/flex-array-counted-by-bounds.c: New test.
---
gcc/c-family/c-ubsan.cc | 42 +++++++++++++++++
.../ubsan/flex-array-counted-by-bounds-2.c | 45 ++++++++++++++++++
.../ubsan/flex-array-counted-by-bounds-3.c | 34 ++++++++++++++
.../ubsan/flex-array-counted-by-bounds-4.c | 34 ++++++++++++++
.../ubsan/flex-array-counted-by-bounds.c | 46 +++++++++++++++++++
5 files changed, 201 insertions(+)
create mode 100644 gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-2.c
create mode 100644 gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-3.c
create mode 100644 gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-4.c
create mode 100644 gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds.c
diff --git a/gcc/c-family/c-ubsan.cc b/gcc/c-family/c-ubsan.cc
index 940982819ddf..7cd3c6aa5b88 100644
--- a/gcc/c-family/c-ubsan.cc
+++ b/gcc/c-family/c-ubsan.cc
@@ -376,6 +376,40 @@ ubsan_instrument_return (location_t loc)
return build_call_expr_loc (loc, t, 1, build_fold_addr_expr_loc (loc, data));
}
+/* Get the tree that represented the number of counted_by, i.e, the maximum
+ number of the elements of the object that the call to .ACCESS_WITH_SIZE
+ points to, this number will be the bound of the corresponding array. */
+static tree
+get_bound_from_access_with_size (tree call)
+{
+ if (!is_access_with_size_p (call))
+ return NULL_TREE;
+
+ tree ref_to_size = CALL_EXPR_ARG (call, 1);
+ unsigned int class_of_size = TREE_INT_CST_LOW (CALL_EXPR_ARG (call, 2));
+ tree type = TREE_TYPE (CALL_EXPR_ARG (call, 3));
+ tree size = fold_build2 (MEM_REF, type, unshare_expr (ref_to_size),
+ build_int_cst (ptr_type_node, 0));
+ /* If size is negative value, treat it as zero. */
+ if (!TYPE_UNSIGNED (type))
+ {
+ tree cond = fold_build2 (LT_EXPR, boolean_type_node,
+ unshare_expr (size), build_zero_cst (type));
+ size = fold_build3 (COND_EXPR, type, cond,
+ build_zero_cst (type), size);
+ }
+
+ /* Only when class_of_size is 1, i.e, the number of the elements of
+ the object type, return the size. */
+ if (class_of_size != 1)
+ return NULL_TREE;
+ else
+ size = fold_convert (sizetype, size);
+
+ return size;
+}
+
+
/* Instrument array bounds for ARRAY_REFs. We create special builtin,
that gets expanded in the sanopt pass, and make an array dimension
of it. ARRAY is the array, *INDEX is an index to the array.
@@ -401,6 +435,14 @@ ubsan_instrument_bounds (location_t loc, tree array, tree *index,
&& COMPLETE_TYPE_P (type)
&& integer_zerop (TYPE_SIZE (type)))
bound = build_int_cst (TREE_TYPE (TYPE_MIN_VALUE (domain)), -1);
+ else if (INDIRECT_REF_P (array)
+ && is_access_with_size_p ((TREE_OPERAND (array, 0))))
+ {
+ bound = get_bound_from_access_with_size ((TREE_OPERAND (array, 0)));
+ bound = fold_build2 (MINUS_EXPR, TREE_TYPE (bound),
+ bound,
+ build_int_cst (TREE_TYPE (bound), 1));
+ }
else
return NULL_TREE;
}
diff --git a/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-2.c b/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-2.c
new file mode 100644
index 000000000000..b503320628d2
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-2.c
@@ -0,0 +1,45 @@
+/* Test the attribute counted_by and its usage in
+ bounds sanitizer combined with VLA. */
+/* { dg-do run } */
+/* { dg-options "-fsanitize=bounds" } */
+/* { dg-output "index 11 out of bounds for type 'int \\\[\\\*\\\]\\\[\\\*\\\]'\[^\n\r]*(\n|\r\n|\r)" } */
+/* { dg-output "\[^\n\r]*index 20 out of bounds for type 'int \\\[\\\*\\\]\\\[\\\*\\\]\\\[\\\*\\\]'\[^\n\r]*(\n|\r\n|\r)" } */
+/* { dg-output "\[^\n\r]*index 11 out of bounds for type 'int \\\[\\\*\\\]\\\[\\\*\\\]'\[^\n\r]*(\n|\r\n|\r)" } */
+/* { dg-output "\[^\n\r]*index 10 out of bounds for type 'int \\\[\\\*\\\]'\[^\n\r]*(\n|\r\n|\r)" } */
+
+
+#include <stdlib.h>
+
+void __attribute__((__noinline__)) setup_and_test_vla (int n, int m)
+{
+ struct foo {
+ int n;
+ int p[][n] __attribute__((counted_by(n)));
+ } *f;
+
+ f = (struct foo *) malloc (sizeof(struct foo) + m*sizeof(int[n]));
+ f->n = m;
+ f->p[m][n-1]=1;
+ return;
+}
+
+void __attribute__((__noinline__)) setup_and_test_vla_1 (int n1, int n2, int m)
+{
+ struct foo {
+ int n;
+ int p[][n2][n1] __attribute__((counted_by(n)));
+ } *f;
+
+ f = (struct foo *) malloc (sizeof(struct foo) + m*sizeof(int[n2][n1]));
+ f->n = m;
+ f->p[m][n2][n1]=1;
+ return;
+}
+
+int main(int argc, char *argv[])
+{
+ setup_and_test_vla (10, 11);
+ setup_and_test_vla_1 (10, 11, 20);
+ return 0;
+}
+
diff --git a/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-3.c b/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-3.c
new file mode 100644
index 000000000000..9da25644af3e
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-3.c
@@ -0,0 +1,34 @@
+/* Test the attribute counted_by and its usage in bounds
+ sanitizer. when counted_by field is negative value. */
+/* { dg-do run } */
+/* { dg-options "-fsanitize=bounds" } */
+
+#include <stdlib.h>
+
+struct annotated {
+ int b;
+ int c[] __attribute__ ((counted_by (b)));
+} *array_annotated;
+
+void __attribute__((__noinline__)) setup (int annotated_count)
+{
+ array_annotated
+ = (struct annotated *)malloc (sizeof (struct annotated));
+ array_annotated->b = annotated_count;
+
+ return;
+}
+
+void __attribute__((__noinline__)) test (int annotated_index)
+{
+ array_annotated->c[annotated_index] = 2;
+}
+
+int main(int argc, char *argv[])
+{
+ setup (-3);
+ test (2);
+ return 0;
+}
+
+/* { dg-output "24:21: runtime error: index 2 out of bounds for type" } */
diff --git a/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-4.c b/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-4.c
new file mode 100644
index 000000000000..bd7e144274fc
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds-4.c
@@ -0,0 +1,34 @@
+/* Test the attribute counted_by and its usage in bounds
+ sanitizer. when counted_by field is zero value. */
+/* { dg-do run } */
+/* { dg-options "-fsanitize=bounds" } */
+
+#include <stdlib.h>
+
+struct annotated {
+ int b;
+ int c[] __attribute__ ((counted_by (b)));
+} *array_annotated;
+
+void __attribute__((__noinline__)) setup (int annotated_count)
+{
+ array_annotated
+ = (struct annotated *)malloc (sizeof (struct annotated));
+ array_annotated->b = annotated_count;
+
+ return;
+}
+
+void __attribute__((__noinline__)) test (int annotated_index)
+{
+ array_annotated->c[annotated_index] = 2;
+}
+
+int main(int argc, char *argv[])
+{
+ setup (0);
+ test (1);
+ return 0;
+}
+
+/* { dg-output "24:21: runtime error: index 1 out of bounds for type" } */
diff --git a/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds.c b/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds.c
new file mode 100644
index 000000000000..e2b911dde626
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/ubsan/flex-array-counted-by-bounds.c
@@ -0,0 +1,46 @@
+/* Test the attribute counted_by and its usage in
+ bounds sanitizer. */
+/* { dg-do run } */
+/* { dg-options "-fsanitize=bounds" } */
+
+#include <stdlib.h>
+
+struct flex {
+ int b;
+ int c[];
+} *array_flex;
+
+struct annotated {
+ int b;
+ int c[] __attribute__ ((counted_by (b)));
+} *array_annotated;
+
+void __attribute__((__noinline__)) setup (int normal_count, int annotated_count)
+{
+ array_flex
+ = (struct flex *)malloc (sizeof (struct flex)
+ + normal_count * sizeof (int));
+ array_flex->b = normal_count;
+
+ array_annotated
+ = (struct annotated *)malloc (sizeof (struct annotated)
+ + annotated_count * sizeof (int));
+ array_annotated->b = annotated_count;
+
+ return;
+}
+
+void __attribute__((__noinline__)) test (int normal_index, int annotated_index)
+{
+ array_flex->c[normal_index] = 1;
+ array_annotated->c[annotated_index] = 2;
+}
+
+int main(int argc, char *argv[])
+{
+ setup (10, 10);
+ test (10, 10);
+ return 0;
+}
+
+/* { dg-output "36:21: runtime error: index 10 out of bounds for type" } */
--
2.31.1
^ permalink raw reply [flat|nested] 14+ messages in thread* [PATCH v10 5/5] Add the 6th argument to .ACCESS_WITH_SIZE
2024-05-30 12:26 [PATCH v10 0/5] New attribute "counted_by" to annotate bounds for C99 FAM(PR108896) Qing Zhao
` (3 preceding siblings ...)
2024-05-30 12:26 ` [PATCH v10 4/5] Use the .ACCESS_WITH_SIZE in bound sanitizer Qing Zhao
@ 2024-05-30 12:27 ` Qing Zhao
4 siblings, 0 replies; 14+ messages in thread
From: Qing Zhao @ 2024-05-30 12:27 UTC (permalink / raw)
To: rguenther, josmyers
Cc: siddhesh, uecker, keescook, isanbard, gcc-patches, Qing Zhao
to carry the TYPE of the flexible array.
Such information is needed during tree-object-size.cc.
We cannot use the result type or the type of the 1st argument
of the routine .ACCESS_WITH_SIZE to decide the element type
of the original array due to possible type casting in the
source code.
gcc/c/ChangeLog:
* c-typeck.cc (build_access_with_size_for_counted_by): Add the 6th
argument to .ACCESS_WITH_SIZE.
gcc/ChangeLog:
* tree-object-size.cc (access_with_size_object_size): Use the type
of the 6th argument for the type of the element.
gcc/testsuite/ChangeLog:
* gcc.dg/flex-array-counted-by-6.c: New test.
---
gcc/c/c-typeck.cc | 11 +++--
gcc/internal-fn.cc | 2 +
.../gcc.dg/flex-array-counted-by-6.c | 46 +++++++++++++++++++
gcc/tree-object-size.cc | 16 ++++---
4 files changed, 66 insertions(+), 9 deletions(-)
create mode 100644 gcc/testsuite/gcc.dg/flex-array-counted-by-6.c
diff --git a/gcc/c/c-typeck.cc b/gcc/c/c-typeck.cc
index 0d9c7a34a0df..efd111305b5a 100644
--- a/gcc/c/c-typeck.cc
+++ b/gcc/c/c-typeck.cc
@@ -2646,7 +2646,8 @@ build_counted_by_ref (tree datum, tree subdatum, tree *counted_by_type)
to:
- (*.ACCESS_WITH_SIZE (REF, COUNTED_BY_REF, 1, (TYPE_OF_SIZE)0, -1))
+ (*.ACCESS_WITH_SIZE (REF, COUNTED_BY_REF, 1, (TYPE_OF_SIZE)0, -1,
+ (TYPE_OF_ARRAY *)0))
NOTE: The return type of this function is the POINTER type pointing
to the original flexible array type.
@@ -2658,6 +2659,9 @@ build_counted_by_ref (tree datum, tree subdatum, tree *counted_by_type)
The 4th argument of the call is a constant 0 with the TYPE of the
object pointed by COUNTED_BY_REF.
+ The 6th argument of the call is a constant 0 with the pointer TYPE
+ to the original flexible array type.
+
*/
static tree
build_access_with_size_for_counted_by (location_t loc, tree ref,
@@ -2670,12 +2674,13 @@ build_access_with_size_for_counted_by (location_t loc, tree ref,
tree call
= build_call_expr_internal_loc (loc, IFN_ACCESS_WITH_SIZE,
- result_type, 5,
+ result_type, 6,
array_to_pointer_conversion (loc, ref),
counted_by_ref,
build_int_cst (integer_type_node, 1),
build_int_cst (counted_by_type, 0),
- build_int_cst (integer_type_node, -1));
+ build_int_cst (integer_type_node, -1),
+ build_int_cst (result_type, 0));
/* Wrap the call with an INDIRECT_REF with the flexible array type. */
call = build1 (INDIRECT_REF, TREE_TYPE (ref), call);
SET_EXPR_LOCATION (call, loc);
diff --git a/gcc/internal-fn.cc b/gcc/internal-fn.cc
index eb2c4cd59048..0d27f17b2834 100644
--- a/gcc/internal-fn.cc
+++ b/gcc/internal-fn.cc
@@ -3456,6 +3456,8 @@ expand_DEFERRED_INIT (internal_fn, gcall *stmt)
1: read_only
2: write_only
3: read_write
+ 6th argument: A constant 0 with the pointer TYPE to the original flexible
+ array type.
Both the return type and the type of the first argument of this
function have been converted from the incomplete array type to
diff --git a/gcc/testsuite/gcc.dg/flex-array-counted-by-6.c b/gcc/testsuite/gcc.dg/flex-array-counted-by-6.c
new file mode 100644
index 000000000000..65fa01443d95
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/flex-array-counted-by-6.c
@@ -0,0 +1,46 @@
+/* Test the attribute counted_by and its usage in
+ * __builtin_dynamic_object_size: when the type of the flexible array member
+ * is casting to another type. */
+/* { dg-do run } */
+/* { dg-options "-O2" } */
+
+#include "builtin-object-size-common.h"
+
+typedef unsigned short u16;
+
+struct info {
+ u16 data_len;
+ char data[] __attribute__((counted_by(data_len)));
+};
+
+struct foo {
+ int a;
+ int b;
+};
+
+static __attribute__((__noinline__))
+struct info *setup ()
+{
+ struct info *p;
+ size_t bytes = 3 * sizeof(struct foo);
+
+ p = (struct info *)malloc (sizeof (struct info) + bytes);
+ p->data_len = bytes;
+
+ return p;
+}
+
+static void
+__attribute__((__noinline__)) report (struct info *p)
+{
+ struct foo *bar = (struct foo *)p->data;
+ EXPECT(__builtin_dynamic_object_size((char *)(bar + 1), 1), 16);
+ EXPECT(__builtin_dynamic_object_size((char *)(bar + 2), 1), 8);
+}
+
+int main(int argc, char *argv[])
+{
+ struct info *p = setup();
+ report(p);
+ return 0;
+}
diff --git a/gcc/tree-object-size.cc b/gcc/tree-object-size.cc
index 8de264d1dee2..4c1fa9b555fa 100644
--- a/gcc/tree-object-size.cc
+++ b/gcc/tree-object-size.cc
@@ -762,9 +762,11 @@ addr_object_size (struct object_size_info *osi, const_tree ptr,
1: the number of the elements of the object type;
4th argument TYPE_OF_SIZE: A constant 0 with its TYPE being the same as the TYPE
of the object referenced by REF_TO_SIZE
+ 6th argument: A constant 0 with the pointer TYPE to the original flexible
+ array type.
- The size of the element can be retrived from the result type of the call,
- which is the pointer to the array type. */
+ The size of the element can be retrived from the TYPE of the 6th argument
+ of the call, which is the pointer to the array type. */
static tree
access_with_size_object_size (const gcall *call, int object_size_type)
{
@@ -773,10 +775,12 @@ access_with_size_object_size (const gcall *call, int object_size_type)
return size_unknown (object_size_type);
gcc_assert (gimple_call_internal_p (call, IFN_ACCESS_WITH_SIZE));
- /* Result type is a pointer type to the original flexible array type. */
- tree result_type = gimple_call_return_type (call);
- gcc_assert (POINTER_TYPE_P (result_type));
- tree element_size = TYPE_SIZE_UNIT (TREE_TYPE (TREE_TYPE (result_type)));
+ /* The type of the 6th argument type is the pointer TYPE to the original
+ flexible array type. */
+ tree pointer_to_array_type = TREE_TYPE (gimple_call_arg (call, 5));
+ gcc_assert (POINTER_TYPE_P (pointer_to_array_type));
+ tree element_type = TREE_TYPE (TREE_TYPE (pointer_to_array_type));
+ tree element_size = TYPE_SIZE_UNIT (element_type);
tree ref_to_size = gimple_call_arg (call, 1);
unsigned int class_of_size = TREE_INT_CST_LOW (gimple_call_arg (call, 2));
tree type = TREE_TYPE (gimple_call_arg (call, 3));
--
2.31.1
^ permalink raw reply [flat|nested] 14+ messages in thread