[HLSL] Enable availability attribute

[beanz]

Summary

Some HLSL functionality is gated on the target shader model version.
Enabling the use of availability markup allows us to diagnose
availability issues easily in the frontend.

[erichkeane]

clang/lib/Sema/SemaAvailability.cpp

201

This should jsut be a 'case' label added above, we are already switching on getOS.

clang/test/SemaHLSL/AvailabilityMarkup.hlsl

11

Not sure how I feel about us testing the headers AND functionality in the same place. @aaron.ballman : Does this seem inappropriate to you?

[beanz]

Updating based on feedback from @erichkeane. Thank you for the fast feedback!

• Moved ShaderModel check into a switch case.
• Added additional self-contained test case with more variations.

[erichkeane]

Besides the request for re-organizing the the test files, LGTM.

clang/test/SemaHLSL/AvailabilityMarkup.hlsl

16

So minor thing, and one that I am going to start pushing for more, is better organization of 'expected-diagnostics'. I think they should better reflect the order and 'cause' of the diagnostic, particularly with notes. So something like:

// expected-warning@+3 {{... only available ...}}
// expected-note@#FN60_LOC {{ marked as being introduced...}}
// expected-note@+1{{enclose...}}

Then on line 5, add the comment: // FN60

I have this preference because it makes it more clear to the reader where the notes come from. I realize this is a new direction, and perhaps pushing my ability to request, but I'd still appreciate it happening here (I WILL be pushing for it on template reviews, where I think it is even MORE beneficial, thanks to 'instantiation of' diagnostics, and I have the authority to demand it :) ).

clang/test/SemaHLSL/WaveBuiltinAvailability.hlsl

11

Same here, though perhaps less-so. You can use @hlsl_intrinsics.h:14 I believe to specify the line as well (which would be nice!) but keeping the diagnostics in 'emitted order' is more important to me.

[beanz]

clang/test/SemaHLSL/AvailabilityMarkup.hlsl

16

I was completely unaware of the ability to create labels like that. That's awesome. I'll update the tests.

[beanz]

Updating test cases to use labels and sort the matches.

[erichkeane]

Still looks good to me, no nits. As far as using the bookmarks, I tend to use them for things that are 'far away' instead of 'right here', and stick to the @+/@- bits for 'local' ones.

clang/test/SemaHLSL/AvailabilityMarkup.hlsl

14

Your preference here, but the @+3 here is acceptable when they are 'local'. I have no preference either way.

clang/include/clang/Basic/Attr.td

return llvm::StringSwitch<llvm::StringRef>(Platform)
              .Case("driverkit", "DriverKit")
              .Case("ios_app_extension", "iOS (App Extension)")
              .Case("macos_app_extension", "macOS (App Extension)")
              .Case("tvos_app_extension", "tvOS (App Extension)")
              .Case("watchos_app_extension", "watchOS (App Extension)")
              .Case("maccatalyst", "macCatalyst")
              .Case("maccatalyst_app_extension", "macCatalyst (App Extension)")
              .Case("swift", "Swift")
+             .Case("shadermodel", "HLSL ShaderModel")
              .Default(llvm::StringRef());
 }
 static llvm::StringRef getPlatformNameSourceSpelling(llvm::StringRef Platform) {
     return llvm::StringSwitch<llvm::StringRef>(Platform)
              .Case("ios", "iOS")
              .Case("macos", "macOS")
              .Case("tvos", "tvOS")
              .Case("watchos", "watchOS")
              .Case("ios_app_extension", "iOSApplicationExtension")
              .Case("macos_app_extension", "macOSApplicationExtension")
              .Case("tvos_app_extension", "tvOSApplicationExtension")
              .Case("watchos_app_extension", "watchOSApplicationExtension")
              .Case("maccatalyst", "macCatalyst")
              .Case("maccatalyst_app_extension", "macCatalystApplicationExtension")
              .Case("zos", "z/OS")
+             .Case("shadermodel", "ShaderModel")
              .Default(Platform);
 }
 static llvm::StringRef canonicalizePlatformName(llvm::StringRef Platform) {
     return llvm::StringSwitch<llvm::StringRef>(Platform)
              .Case("iOS", "ios")
              .Case("macOS", "macos")
              .Case("tvOS", "tvos")
              .Case("watchOS", "watchos")
              .Case("iOSApplicationExtension", "ios_app_extension")
              .Case("macOSApplicationExtension", "macos_app_extension")
              .Case("tvOSApplicationExtension", "tvos_app_extension")
              .Case("watchOSApplicationExtension", "watchos_app_extension")
              .Case("macCatalyst", "maccatalyst")
              .Case("macCatalystApplicationExtension", "maccatalyst_app_extension")
+             .Case("ShaderModel", "shadermodel")
              .Default(Platform);
 } }];
   let HasCustomParsing = 1;
   let InheritEvenIfAlreadyPresent = 1;
   let Subjects = SubjectList<[Named]>;
   let Documentation = [AvailabilityDocs];
 }
 

clang/lib/Basic/Targets/DirectX.h

DirectXTargetInfo(const llvm::Triple &Triple, const TargetOptions &)
     TLSSupported = false;
     VLASupported = false;
     LongWidth = LongAlign = 64;
     AddrSpaceMap = &DirectXAddrSpaceMap;
     UseAddrSpaceMapMangling = true;
     HasLegalHalfType = true;
     HasFloat16 = true;
     NoAsmVariants = true;
+    PlatformMinVersion = Triple.getOSVersion();
+    PlatformName = llvm::Triple::getOSTypeName(Triple.getOS());
     resetDataLayout("e-m:e-p:32:32-i1:32-i8:8-i16:16-i32:32-i64:64-f16:16-f32:"
                     "32-f64:64-n8:16:32:64");
     TheCXXABI.set(TargetCXXABI::Microsoft);
   }
   bool useFP16ConversionIntrinsics() const override { return false; }
   void getTargetDefines(const LangOptions &Opts,
                         MacroBuilder &Builder) const override;
 

clang/lib/Headers/hlsl/hlsl_intrinsics.h

 //===----- hlsl_intrinsics.h - HLSL definitions for intrinsics ----------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef _HLSL_HLSL_INTRINSICS_H_
 #define _HLSL_HLSL_INTRINSICS_H_
 
+__attribute__((availability(shadermodel, introduced = 6.0)))
 __attribute__((clang_builtin_alias(__builtin_hlsl_wave_active_count_bits))) uint
 WaveActiveCountBits(bool bBit);
 
 __attribute__((clang_builtin_alias(__builtin_abs))) int abs(int In);
 __attribute__((clang_builtin_alias(__builtin_labs))) int64_t abs(int64_t In);
 __attribute__((clang_builtin_alias(__builtin_fabsf))) float abs(float In);
 __attribute__((clang_builtin_alias(__builtin_fabs))) double abs(double In);
 
 #ifdef __HLSL_ENABLE_16_BIT
 __attribute__((clang_builtin_alias(__builtin_fabsf16))) half abs(half In);
 #endif
 
 #endif //_HLSL_HLSL_INTRINSICS_H_

clang/lib/Sema/SemaAvailability.cpp

case llvm::Triple::TvOS:
     break;
   case llvm::Triple::WatchOS:
     ForceAvailabilityFromVersion = VersionTuple(/*Major=*/4);
     break;
   case llvm::Triple::Darwin:
   case llvm::Triple::MacOSX:
     ForceAvailabilityFromVersion = VersionTuple(/*Major=*/10, /*Minor=*/13);
     break;
+  case llvm::Triple::ShaderModel:
+    // Always enable availability diagnostics for shader models.
+    return true;
   default:
     // New targets should always warn about availability.
     return Triple.getVendor() == llvm::Triple::Apple;
   }
   return DeploymentVersion >= ForceAvailabilityFromVersion ||
          DeclVersion >= ForceAvailabilityFromVersion;
 }
 
 static NamedDecl *findEnclosingDeclToAnnotate(Decl *OrigCtx) {
   for (Decl *Ctx = OrigCtx; Ctx;
        Ctx = cast_or_null<Decl>(Ctx->getDeclContext())) {
     if (isa<TagDecl>(Ctx) || isa<FunctionDecl>(Ctx) || isa<ObjCMethodDecl>(Ctx))

clang/test/SemaHLSL/AvailabilityMarkup.hlsl

+// RUN: %clang_cc1 -triple dxil-pc-shadermodel5.0-library -verify %s
+
+__attribute__((availability(shadermodel, introduced = 6.0)))
+unsigned fn6_0(); // #fn6_0
+
+__attribute__((availability(shadermodel, introduced = 5.1)))
+unsigned fn5_1(); // #fn5_1
+
+__attribute__((availability(shadermodel, introduced = 5.0)))
+unsigned fn5_0();
+
+void fn() {
+    // expected-warning@#fn6_0_site {{'fn6_0' is only available on HLSL ShaderModel 6.0 or newer}}
+    // expected-note@#fn6_0 {{'fn6_0' has been marked as being introduced in HLSL ShaderModel 6.0 here, but the deployment target is HLSL ShaderModel 5.0}}
+    // expected-note@#fn6_0_site {{enclose 'fn6_0' in a __builtin_available check to silence this warning}}
+    unsigned A = fn6_0(); // #fn6_0_site
+
+    // expected-warning@#fn5_1_site {{'fn5_1' is only available on HLSL ShaderModel 5.1 or newer}}
+    // expected-note@#fn5_1 {{'fn5_1' has been marked as being introduced in HLSL ShaderModel 5.1 here, but the deployment target is HLSL ShaderModel 5.0}}
+    // expected-note@#fn5_1_site {{enclose 'fn5_1' in a __builtin_available check to silence this warning}}
+    unsigned B = fn5_1(); // #fn5_1_site
+
+    unsigned C = fn5_0();
+}
+

clang/test/SemaHLSL/WaveBuiltinAvailability.hlsl

+// RUN: %clang_cc1 -finclude-default-header -triple dxil-pc-shadermodel5.0-library -verify %s
+// WaveActiveCountBits is unavailable before ShaderModel 6.0.
+
+unsigned foo(bool b) {
+    // expected-warning@#site {{'WaveActiveCountBits' is only available on HLSL ShaderModel 6.0 or newer}}
+    // expected-note@hlsl/hlsl_intrinsics.h:* {{'WaveActiveCountBits' has been marked as being introduced in HLSL ShaderModel 6.0 here, but the deployment target is HLSL ShaderModel 5.0}}
+    // expected-note@#site {{enclose 'WaveActiveCountBits' in a __builtin_available check to silence this warning}}
+    return WaveActiveCountBits(b); // #site
+}