[SYCL] Deprecate sycl::abs(genfloat) (#11188)

Deprecate the `sycl::abs` function for floating point types since it's
non-standard.

---------

Signed-off-by: Michael Aziz <[email protected]>

Author: 0x12CC

sycl/source/builtins_generator.py

@@ -498,10 +498,11 @@ class DefCommon:
     implementation used when possible.
   template_scalar_args - A bool specifying if the builtin should combine the
     scalar arguments into common template types.
+  deprecation_message - A message that will appear in a declaration warning.
   """
   def __init__(self, return_type, arg_types, invoke_name, invoke_prefix,
                custom_invoke, size_alias, marray_use_loop,
-               template_scalar_args):
+               template_scalar_args, deprecation_message=""):
     self.return_type = return_type
     self.arg_types = arg_types
     self.invoke_name = invoke_name
@@ -510,6 +511,7 @@ def __init__(self, return_type, arg_types, invoke_name, invoke_prefix,
     self.size_alias = size_alias
     self.marray_use_loop = marray_use_loop
     self.template_scalar_args = template_scalar_args
+    self.deprecation_message = deprecation_message
 
   def require_size_alias(self, alternative_name, marray_type):
     """
@@ -641,10 +643,11 @@ class Def(DefCommon):
   def __init__(self, return_type, arg_types, invoke_name=None,
                invoke_prefix="", custom_invoke=None, fast_math_invoke_name=None,
                fast_math_custom_invoke=None, convert_args=[], size_alias=None,
-               marray_use_loop=False, template_scalar_args=False):
+               marray_use_loop=False, template_scalar_args=False,
+               deprecation_message=None):
     super().__init__(return_type, arg_types, invoke_name, invoke_prefix,
                      custom_invoke, size_alias, marray_use_loop,
-                     template_scalar_args)
+                     template_scalar_args, deprecation_message)
     self.fast_math_invoke_name = fast_math_invoke_name
     self.fast_math_custom_invoke = fast_math_custom_invoke
     # List of tuples with mappings for arguments to cast to argument types.
@@ -965,7 +968,9 @@ def custom_nan_invoke(return_type, arg_types, arg_names):
                                 Def("mdoublen", ["double", "double", "mdoublen"]),
                                 Def("mhalfn", ["half", "half", "mhalfn"])],
                  "sign": [Def("genfloat", ["genfloat"], template_scalar_args=True)],
-                 "abs": [Def("genfloat", ["genfloat"], invoke_prefix="f", template_scalar_args=True), # TODO: Non-standard. Deprecate.
+                 "abs": [Def("genfloat", ["genfloat"],
+                             deprecation_message="abs for floating point types is non-standard and has been deprecated. Please use fabs instead.",
+                             invoke_prefix="f", template_scalar_args=True),
                          Def("sigeninteger", ["sigeninteger"], custom_invoke=custom_signed_abs_scalar_invoke, template_scalar_args=True),
                          Def("vigeninteger", ["vigeninteger"], custom_invoke=custom_signed_abs_vec_invoke),
                          Def("migeninteger", ["migeninteger"], marray_use_loop=True),
@@ -1277,7 +1282,8 @@ def get_template_args(arg_types):
 
 def get_deprecation(builtin, return_type, arg_types):
   """Gets the deprecation statement for a given builtin."""
-  # TODO: Check builtin for deprecation message and prioritize that.
+  if builtin.deprecation_message:
+    return f'__SYCL_DEPRECATED("{builtin.deprecation_message}")\n'
   for t in [return_type] + arg_types:
     if hasattr(t, 'deprecation_message') and t.deprecation_message:
       return f'__SYCL_DEPRECATED("{t.deprecation_message}")\n'

sycl/test/warnings/sycl_2020_deprecations.cpp

@@ -134,6 +134,9 @@ int main() {
   sycl::byte B;
   (void)B;
 
+  // expected-warning@+1{{'abs<float>' is deprecated: abs for floating point types is non-standard and has been deprecated. Please use fabs instead.}}
+  sycl::abs(0.0f);
+
   // expected-warning@+1{{'image_support' is deprecated: deprecated in SYCL 2020, use device::has(aspect::ext_intel_legacy_image) to query for SYCL 1.2.1 image support}}
   using IS = sycl::info::device::image_support;
   // expected-warning@+1{{'max_constant_buffer_size' is deprecated: deprecated in SYCL 2020}}