[wwwdocs] Add no_sanitize attribute

Message ID 1ad45e0c-b5a2-872d-089e-0a9e4c66b525@suse.cz
State New
Headers show
Series
  • [wwwdocs] Add no_sanitize attribute
Related show

Commit Message

Martin Liška April 18, 2018, 12:22 p.m.
I would like to mention the attribute in GCC 8 changes.

Martin

Comments

Jeff Law April 27, 2018, 11:06 p.m. | #1
On 04/18/2018 06:22 AM, Martin Liška wrote:
> I would like to mention the attribute in GCC 8 changes.

OK.
jeff
Gerald Pfeifer Oct. 7, 2018, 12:15 p.m. | #2
On Wed, 18 Apr 2018, Martin Liška wrote:
> I would like to mention the attribute in GCC 8 changes.


Index: htdocs/gcc-8/changes.html
===================================================================
>   <li>

>     New <code>no_sanitize</code> attribute has been added.  The attribute

>     on functions is used to inform the compiler that it should

>     not do sanitization of all options mentioned in sanitize option.

>     A list of values acceptable by <code>-fsanitize</code> option can be

>     provided.

>     <blockquote><pre>

>     void __attribute__ ((no_sanitize ("alignment", "object-size")))

>     f () { /* Do something. */; }

>     </pre></blockquote>

>   </li>


I've been struggling with this from a language perspective and 
while not fully happy, believe/hope the below may improve things
a bit.

Sandra, any recommendations from your end?

Martin, is my update technically acurate?

Index: gcc-8/changes.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/gcc-8/changes.html,v
retrieving revision 1.97
diff -u -r1.97 changes.html
--- gcc-8/changes.html	30 Sep 2018 14:38:54 -0000	1.97
+++ gcc-8/changes.html	7 Oct 2018 12:13:03 -0000
@@ -251,11 +251,10 @@
     tests for pointer wrapping.
   </li>
   <li>
-    New <code>no_sanitize</code> attribute has been added.  The attribute
-    on functions is used to inform the compiler that it should
-    not do sanitization of all options mentioned in sanitize option.
-    A list of values acceptable by <code>-fsanitize</code> option can be
-    provided.
+    A new attribute <code>no_sanitize</code> can be applied to functions
+    to instruct the compiler not to do sanitization of any of the options
+    specified.  Acceptable values for <code>no_sanitize</code> match those
+    acceptable by the <code>-fsanitize</code> command-line option.
     <blockquote><pre class="blackbg">
 void __attribute__ ((no_sanitize ("alignment", "object-size")))
 f () { /* Do something. */; }</pre></blockquote>

Gerald
Sandra Loosemore Oct. 7, 2018, 5:13 p.m. | #3
On 10/07/2018 06:15 AM, Gerald Pfeifer wrote:
> On Wed, 18 Apr 2018, Martin Liška wrote:

>> I would like to mention the attribute in GCC 8 changes.

> 

> Index: htdocs/gcc-8/changes.html

> ===================================================================

>>    <li>

>>      New <code>no_sanitize</code> attribute has been added.  The attribute

>>      on functions is used to inform the compiler that it should

>>      not do sanitization of all options mentioned in sanitize option.

>>      A list of values acceptable by <code>-fsanitize</code> option can be

>>      provided.

>>      <blockquote><pre>

>>      void __attribute__ ((no_sanitize ("alignment", "object-size")))

>>      f () { /* Do something. */; }

>>      </pre></blockquote>

>>    </li>

> 

> I've been struggling with this from a language perspective and

> while not fully happy, believe/hope the below may improve things

> a bit.

> 

> Sandra, any recommendations from your end?

> 

> Martin, is my update technically acurate?

> 

> Index: gcc-8/changes.html

> ===================================================================

> RCS file: /cvs/gcc/wwwdocs/htdocs/gcc-8/changes.html,v

> retrieving revision 1.97

> diff -u -r1.97 changes.html

> --- gcc-8/changes.html	30 Sep 2018 14:38:54 -0000	1.97

> +++ gcc-8/changes.html	7 Oct 2018 12:13:03 -0000

> @@ -251,11 +251,10 @@

>       tests for pointer wrapping.

>     </li>

>     <li>

> -    New <code>no_sanitize</code> attribute has been added.  The attribute

> -    on functions is used to inform the compiler that it should

> -    not do sanitization of all options mentioned in sanitize option.

> -    A list of values acceptable by <code>-fsanitize</code> option can be

> -    provided.

> +    A new attribute <code>no_sanitize</code> can be applied to functions

> +    to instruct the compiler not to do sanitization of any of the options

> +    specified.  Acceptable values for <code>no_sanitize</code> match those

> +    acceptable by the <code>-fsanitize</code> command-line option.

>       <blockquote><pre class="blackbg">

>   void __attribute__ ((no_sanitize ("alignment", "object-size")))

>   f () { /* Do something. */; }</pre></blockquote>

> 


This is definitely an improvement.  One more tweak I'd make is

s/any of the options specified/the options provided as arguments to the 
attribute/

-Sandra
Martin Liška Oct. 8, 2018, 7:55 a.m. | #4
On 10/7/18 2:15 PM, Gerald Pfeifer wrote:
> On Wed, 18 Apr 2018, Martin Liška wrote:

>> I would like to mention the attribute in GCC 8 changes.

> 

> Index: htdocs/gcc-8/changes.html

> ===================================================================

>>   <li>

>>     New <code>no_sanitize</code> attribute has been added.  The attribute

>>     on functions is used to inform the compiler that it should

>>     not do sanitization of all options mentioned in sanitize option.

>>     A list of values acceptable by <code>-fsanitize</code> option can be

>>     provided.

>>     <blockquote><pre>

>>     void __attribute__ ((no_sanitize ("alignment", "object-size")))

>>     f () { /* Do something. */; }

>>     </pre></blockquote>

>>   </li>

> 

> I've been struggling with this from a language perspective and 

> while not fully happy, believe/hope the below may improve things

> a bit.

> 

> Sandra, any recommendations from your end?

> 

> Martin, is my update technically acurate?


Hi.

Yes, it's equivalent, thanks for the improvement.

Martin

> 

> Index: gcc-8/changes.html

> ===================================================================

> RCS file: /cvs/gcc/wwwdocs/htdocs/gcc-8/changes.html,v

> retrieving revision 1.97

> diff -u -r1.97 changes.html

> --- gcc-8/changes.html	30 Sep 2018 14:38:54 -0000	1.97

> +++ gcc-8/changes.html	7 Oct 2018 12:13:03 -0000

> @@ -251,11 +251,10 @@

>      tests for pointer wrapping.

>    </li>

>    <li>

> -    New <code>no_sanitize</code> attribute has been added.  The attribute

> -    on functions is used to inform the compiler that it should

> -    not do sanitization of all options mentioned in sanitize option.

> -    A list of values acceptable by <code>-fsanitize</code> option can be

> -    provided.

> +    A new attribute <code>no_sanitize</code> can be applied to functions

> +    to instruct the compiler not to do sanitization of any of the options

> +    specified.  Acceptable values for <code>no_sanitize</code> match those

> +    acceptable by the <code>-fsanitize</code> command-line option.

>      <blockquote><pre class="blackbg">

>  void __attribute__ ((no_sanitize ("alignment", "object-size")))

>  f () { /* Do something. */; }</pre></blockquote>

> 

> Gerald

>
Gerald Pfeifer Dec. 29, 2018, 9:09 p.m. | #5
On Sun, 7 Oct 2018, Sandra Loosemore wrote:
> This is definitely an improvement.  One more tweak I'd make is

> 

> s/any of the options specified/the options provided as arguments to the

> attribute/


Thank you, Sandra.  I made that additional change.

On Mon, 8 Oct 2018, Martin Liška wrote:
> Yes, it's equivalent, thanks for the improvement.


Thanks for the reviews.  I (finally) applied this per the patch below;
sorry for the delay.

Gerald

Index: changes.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/gcc-8/changes.html,v
retrieving revision 1.97
diff -u -r1.97 changes.html
--- changes.html	30 Sep 2018 14:38:54 -0000	1.97
+++ changes.html	29 Dec 2018 21:08:04 -0000
@@ -251,11 +251,11 @@
     tests for pointer wrapping.
   </li>
   <li>
-    New <code>no_sanitize</code> attribute has been added.  The attribute
-    on functions is used to inform the compiler that it should
-    not do sanitization of all options mentioned in sanitize option.
-    A list of values acceptable by <code>-fsanitize</code> option can be
-    provided.
+    A new attribute <code>no_sanitize</code> can be applied to functions
+    to instruct the compiler not to do sanitization of the options
+    provided as arguments to the attribute. Acceptable values for
+    <code>no_sanitize</code> match those acceptable by the
+    <code>-fsanitize</code> command-line option.
     <blockquote><pre class="blackbg">
 void __attribute__ ((no_sanitize ("alignment", "object-size")))
 f () { /* Do something. */; }</pre></blockquote>

Patch

Index: htdocs/gcc-8/changes.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/gcc-8/changes.html,v
retrieving revision 1.67
diff -r1.67 changes.html
255a256,266
>   <li>
>     New <code>no_sanitize</code> attribute has been added.  The attribute
>     on functions is used to inform the compiler that it should
>     not do sanitization of all options mentioned in sanitize option.
>     A list of values acceptable by <code>-fsanitize</code> option can be
>     provided.
>     <blockquote><pre>
>     void __attribute__ ((no_sanitize ("alignment", "object-size")))
>     f () { /* Do something. */; }
>     </pre></blockquote>
>   </li>