[SystemZ][z/OS] Add z/OS Target and define macros

[abhina.sreeskantharajan]

Summary

This patch adds the z/OS target and defines macros which is a stepping stone towards enabling a native build on z/OS.

Dependent on https://reviews.llvm.org/D82081 being merged first.

[anirudhp]

clang/lib/Basic/Targets/OSTargets.h

745

What about the __LP64__ and the _LP64 macros?

[abhina.sreeskantharajan]

clang/lib/Basic/Targets/OSTargets.h

745

These two are already added in the common code, so it would be redundant to add them again.

[anirudhp]

clang/lib/Basic/Targets/OSTargets.h

745

Alright Thanks!

[MaskRay]

clang/lib/Basic/Targets/OSTargets.h

745

Omit braces

https://llvm.org/docs/CodingStandards.html#don-t-use-braces-on-simple-single-statement-bodies-of-if-else-loop-statements

[abhina.sreeskantharajan]

Thanks MaskRay, I removed the extra braces.

[hubert.reinterpretcast]

clang/lib/Basic/Targets/OSTargets.h

732

This is not defined by z/OS XL C/C++. It seems that this is more of a macro to be defined by a user application (perhaps as part of its configuration/port for z/OS) and less a macro that should be predefined by the compiler.

750

Shouldn't UTF literals be reported as being enabled under strict C++11?

753

Is this consistent with __has_extension with respect to -pedantic-errors?
That is, -pedantic-errors causes __has_extension to report the value that __has_feature would report. Compiler Explorer link: https://godbolt.org/z/EEn8rr

Same question for all of the other IBM-style feature test macros.

758

Should the comment instead say that __wchar_t should be defined so that the system headers do not try to declare wchar_t as a typedef?

761

Same comment as before re: macros that should be declared by the application.

764

I don't see the relation between C++11 and _Noreturn. It's an extension in C++ that's available under, e.g., -std=c++03.

767

char16_t is not a keyword in C11, so __IBM_CHAR16_T__ should not be defined for C. Same re: char32_t.

Also, char16_t and char32_t are indeed keywords in C++11.

770

The "IBMCPP" macro should not be defined in C modes.

[tatyana-krasnukha]

I'm not familiar with the z/OS target, so I cannot check the correctness of the target-specific changes. The overall patch looks good.

clang/lib/Basic/Targets/OSTargets.h

780

It is possible to use inheriting constructor here instead (i.e. using OSTargetInfo<Target>::OSTargetInfo;).

[abhina.sreeskantharajan]

clang/lib/Basic/Targets/OSTargets.h

780

Thanks Tatyana for your review! I think an inheriting constructor is also a good solution, but in order to maintain consistency with the other targets' constructors, I would prefer to keep it this way. Please let me know if there is a reason for using inherited constructors for this target, I may have missed something.

[abhina.sreeskantharajan]

clang/lib/Basic/Targets/OSTargets.h

732

This is required for building libcxx, I'll add a comment here.

750

I will get back to you on this. I will need to investigate whether we are keeping this macro.

753

This macro is unused, so we are able to remove this.

758

You're right. I'll update the comment to be more accurate.

761

Same as above: This is required for building libcxx.

764

Thanks, I will remove CPlusPlus11.

767

Right, these seem to only require C++, so I will update the check. But I will also follow up on whether we plan to keep these macros here.

770

See above: I will update this, but continue to investigate whether we need this macro.

[abhina.sreeskantharajan]

Thanks Hubert for reviewing. I updated the patch to fix the wchar_t comment and the if guards for the macros. I also updated the lit test to reflect these new changes.

[hubert.reinterpretcast]

clang/lib/Basic/Targets/OSTargets.h

730

The comment from https://reviews.llvm.org/D85324?id=283290#inline-786609 applies here as well. _LONG_LONG should not be defined under -std=c89 -pedantic-errors or -std=c89 -Werror=long-long.

753

s/so wchar_t/so that the wchar_t/;

755

The corresponding AIX code checks for -Xclang -fno-wchar. The behaviour of stddef.h differs when using -fno-wchar between AIX and Linux though. Linux suppresses the typedef based on __cplusplus. Arguably, the OS header difference should not really factor into whether the compiler defines a macro that indicates the presence of a wchar_t fundamental type.

766

The GNU extension modes do not cause u-prefixed, etc. string literals to be accepted where the base language level would treat the prefix as a separate identifier. Also noting here that the previous comment from https://reviews.llvm.org/D85324?id=283290#inline-786628 was made based on noting that __IBM_UTF_LITERAL is defined by the XL compiler in the appropriate C++ modes.

767

I would expect that the Clang implementation of the "IBM-style" feature test macros would behave similarly to the native feature testing in Clang. That is, __IBMC_NORETURN is defined when _Noreturn is available as an extension. _Noreturn is available as an "orthogonal" or "conforming" extension in modes such as -std=c89 and -std=c++03. The extension is disabled via warnings-as-errors.

770

See comment above re: GNU extension modes not enabling u-prefixed, etc. literals.

[abhina.sreeskantharajan]

clang/lib/Basic/Targets/OSTargets.h

730

I can add a FIXME here similar to what AIX did.

//FIXME: LONG_LONG should not be defined under -std=c89

Let me know if there is a better solution.

755

Thanks, I will add the same guard that AIX uses.

766

We've updated the system headers so that we no longer need to define these macros.

767

Right, we are able to remove this macro.

[abhina.sreeskantharajan]

Addressed Hubert's comments, and removed some macros that are unnecessary with system header updates.

[MaskRay]

clang/test/Preprocessor/init.c

5633

The file has been split. You'll want to add new tests to init-zos.c or the like.

Not sure it is important to run so many invocations of clang_cc1. Can you pick some essential ones? The many invocations make the test slow.

[abhina.sreeskantharajan]

Thanks MaskRay. I moved the zos testcase to a new file called init-zos.c instead and reduced the number of RUN commands.

[abhina.sreeskantharajan]

clang/test/Preprocessor/init.c

5633

Thanks for the suggestion. I created a new file and reduced the number of invocations.

[hubert.reinterpretcast]

clang/lib/Basic/Targets/OSTargets.h

730

Minor nit: Typo.

The FIXME is okay until there's a reason to fix this. The review necessary for addressing the FIXME deserves another patch anyway.

The situation between z/OS and AIX is different for this case. On AIX, the C ABI compatibility of imaxdiv_t is affected. In other words, on AIX, fixing this might cause surprising behaviour.

737

Sorry for not catching this earlier, but this also needs a FIXME re: strict C89.

[hubert.reinterpretcast]

clang/test/Preprocessor/init-zos.c

5 ↗

(On Diff #286092)

Should this be GNUXX?

[abhina.sreeskantharajan]

Thanks Hubert, I updated the comments, and also the check-prefix to your suggestion.

[abhina.sreeskantharajan]

clang/lib/Basic/Targets/OSTargets.h

737

I've added a comment here.

clang/test/Preprocessor/init-zos.c

5 ↗

(On Diff #286092)

I agree this is a better name, I've updated the name to your suggestion.

[MaskRay]

clang/lib/Basic/Targets/OSTargets.h

737

What is strict -std=c89? !Opts.C99 ?

751

This is strange. On other systems the user requests it.

767

Does it need a value?

clang/test/Preprocessor/init-zos.c

4 ↗

(On Diff #286853)

We usually drop // 'empty' lines. Their absence makes navigation easier.

[hubert.reinterpretcast]

clang/lib/Basic/Targets/OSTargets.h

737

The comment has a typo. The macro should not be defined with strict C89 modes.

What is strict -std=c89? !Opts.C99 ?

In the context of this macro, "strict C89" means !Opts.C99 and the severity of ext_c99_feature diagnostics is at least an error. This occurs, for example, with -std=gnu89 -Werror=c99-extensions.

[abhina.sreeskantharajan]

Thanks for reviewing. I've updated the comments and removed ISOC99_SOURCE macro. I've updated the lit test to reflect these changes.

[abhina.sreeskantharajan]

clang/lib/Basic/Targets/OSTargets.h

737

Thanks, I've fixed the comment.

751

Thanks, I've removed this macro to maintain consistency with other platforms.

767

No, this macro doesn't require a number. This macro is defined when the wchar_t type is available, so that the system headers do not declare it.

[hubert.reinterpretcast]

LGTM from my end; although @MaskRay might want another look.

clang/lib/Basic/Targets/OSTargets.h

752

Minor nit: s/XOPEN_SOURCE/_XOPEN_SOURCE/;

[abhina.sreeskantharajan]

Thanks Hubert, I fixed the comment.

[hubert.reinterpretcast]

In D85324#2233290, @abhina.sreeskantharajan wrote:

Thanks Hubert, I fixed the comment.

Got it; I'll look into committing this.

[abhina.sreeskantharajan]

In D85324#2234712, @hubert.reinterpretcast wrote:

In D85324#2233290, @abhina.sreeskantharajan wrote:

Thanks Hubert, I fixed the comment.

Got it; I'll look into committing this.

Thanks again!

[MaskRay]

clang/test/Preprocessor/init-zos.c

4 ↗

(On Diff #287757)

--match-full-lines is different from --match-full-lines --strict-whitespace. You can freely add leading and trailing spaces to align # for readability.

Might not be necessary changing now.

[abhina.sreeskantharajan]

clang/test/Preprocessor/init-zos.c

4 ↗

(On Diff #287757)

Thanks MaskRay, I will try to update this testcase in upcoming patches that touch this file.

clang/lib/Basic/Targets.cpp

case llvm::Triple::sparcv9:
     default:
       return new SparcV9TargetInfo(Triple, Opts);
     }
 
   case llvm::Triple::systemz:
     switch (os) {
     case llvm::Triple::Linux:
       return new LinuxTargetInfo<SystemZTargetInfo>(Triple, Opts);
+    case llvm::Triple::ZOS:
+      return new ZOSTargetInfo<SystemZTargetInfo>(Triple, Opts);
     default:
       return new SystemZTargetInfo(Triple, Opts);
     }
 
   case llvm::Triple::tce:
     return new TCETargetInfo(Triple, Opts);
 
   case llvm::Triple::tcele:

clang/lib/Basic/Targets/OSTargets.h

AIXTargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts)
     this->UseZeroLengthBitfieldAlignment = true;
   }
 
   // AIX sets FLT_EVAL_METHOD to be 1.
   unsigned getFloatEvalMethod() const override { return 1; }
   bool hasInt128Type() const override { return false; }
 };
 
+// z/OS target
+template <typename Target>
+class LLVM_LIBRARY_VISIBILITY ZOSTargetInfo : public OSTargetInfo<Target> {
+protected:
+  void getOSDefines(const LangOptions &Opts, const llvm::Triple &Triple,
+                    MacroBuilder &Builder) const override {
+    Builder.defineMacro("_LONG_LONG");
+    Builder.defineMacro("_OPEN_DEFAULT");
+    Builder.defineMacro("_UNIX03_WITHDRAWN");
+    Builder.defineMacro("__370__");
+    Builder.defineMacro("__BFP__");
+    Builder.defineMacro("__BOOL__");
+    Builder.defineMacro("__LONGNAME__");
+    Builder.defineMacro("__MVS__");
+    Builder.defineMacro("__THW_370__");
+    Builder.defineMacro("__THW_BIG_ENDIAN__");
+    Builder.defineMacro("__TOS_390__");
+    Builder.defineMacro("__TOS_MVS__");
+    Builder.defineMacro("__XPLINK__");
+
+    if (this->PointerWidth == 64)
+      Builder.defineMacro("__64BIT__");
+
+    if (Opts.C99)
+      Builder.defineMacro("_ISOC99_SOURCE");
+
+    if (Opts.C11 || Opts.GNUMode)
+      Builder.defineMacro("__IBM_UTF_LITERAL");
+
+    if (Opts.C11 || (Opts.GNUMode && !Opts.CPlusPlus))
+      Builder.defineMacro("__IBMC_GENERIC");
+
+    if (Opts.CPlusPlus) {
+      Builder.defineMacro("__DLL__");
+      // Macro __wchar_t exposes the definition of wchar_t data type
+      // in system headers.
+      Builder.defineMacro("__wchar_t");
+      Builder.defineMacro("_XOPEN_SOURCE", "600");
+    }
+
+    if (Opts.C11 || Opts.CPlusPlus11 || Opts.GNUMode) 
+      Builder.defineMacro("__IBMC_NORETURN");
+
+    if (Opts.C11 || (Opts.GNUMode && Opts.CPlusPlus)) {
+      Builder.defineMacro("__IBM_CHAR16_T__");
+      Builder.defineMacro("__IBM_CHAR32_T__");
+      Builder.defineMacro("__IBMCPP_UTF_LITERAL__");
+    }
+
+    if (Opts.GNUMode) {
+      Builder.defineMacro("_MI_BUILTIN");
+      Builder.defineMacro("_EXT");
+    }
+  }
+
+public:
+  ZOSTargetInfo(const llvm::Triple &Triple, const TargetOptions &Opts)
+      : OSTargetInfo<Target>(Triple, Opts) {}
+};
+
 void addWindowsDefines(const llvm::Triple &Triple, const LangOptions &Opts,
                        MacroBuilder &Builder);
 
 // Windows target
 template <typename Target>
 class LLVM_LIBRARY_VISIBILITY WindowsTargetInfo : public OSTargetInfo<Target> {
 protected:
   void getOSDefines(const LangOptions &Opts, const llvm::Triple &Triple,

clang/test/Preprocessor/init.c

 // S390X:#define __WCHAR_MAX__ 2147483647
 // S390X:#define __WCHAR_TYPE__ int
 // S390X:#define __WCHAR_WIDTH__ 32
 // S390X:#define __WINT_TYPE__ int
 // S390X:#define __WINT_WIDTH__ 32
 // S390X:#define __s390__ 1
 // S390X:#define __s390x__ 1
 //
+// RUN: %clang_cc1 -E -dM -ffreestanding -triple=s390x-none-zos -fno-signed-char < /dev/null | FileCheck -match-full-lines -check-prefix S390X-ZOS %s
+// RUN: %clang_cc1 -x c -E -dM -ffreestanding -triple=s390x-none-zos -fno-signed-char < /dev/null | FileCheck -match-full-lines -check-prefix S390X-ZOS -check-prefix S390X-ZOS-C %s
+// RUN: %clang_cc1 -E -dM -std=gnu99 -ffreestanding -triple=s390x-none-zos -fno-signed-char < /dev/null | FileCheck -match-full-lines -check-prefix S390X-ZOS %s
+// RUN: %clang_cc1 -E -dM -std=gnu11 -ffreestanding -triple=s390x-none-zos -fno-signed-char < /dev/null | FileCheck -match-full-lines -check-prefix S390X-ZOS %s
+// RUN: %clang_cc1 -x c++ -E -dM -ffreestanding -triple=s390x-none-zos -fno-signed-char < /dev/null | FileCheck -match-full-lines -check-prefix S390X-ZOS -check-prefix S390X-ZOS-CXX %s
+// RUN: %clang_cc1 -x c -std=c99 -E -dM -ffreestanding -triple=s390x-none-zos -fno-signed-char < /dev/null | FileCheck -match-full-lines -check-prefix S390X-ZOS -check-prefix S390X-ZOS-C99 %s
+// RUN: %clang_cc1 -x c++ -std=c++11 -E -dM -ffreestanding -triple=s390x-none-zos -fno-signed-char < /dev/null | FileCheck -match-full-lines -check-prefix S390X-ZOS -check-prefix S390X-ZOS-CXX %s
+// RUN: %clang_cc1 -x c++ -std=c++14 -E -dM -ffreestanding -triple=s390x-none-zos -fno-signed-char < /dev/null | FileCheck -match-full-lines -check-prefix S390X-ZOS -check-prefix S390X-ZOS-CXX %s
+// RUN: %clang_cc1 -x c++ -std=gnu++11 -E -dM -ffreestanding -triple=s390x-none-zos -fno-signed-char < /dev/null | FileCheck -match-full-lines -check-prefix S390X-ZOS -check-prefix S390X-ZOS-CXX -check-prefix S390X-ZOS-GXX %s
+// RUN: %clang_cc1 -x c++ -std=gnu++14 -E -dM -ffreestanding -triple=s390x-none-zos -fno-signed-char < /dev/null | FileCheck -match-full-lines -check-prefix S390X-ZOS -check-prefix S390X-ZOS-CXX -check-prefix S390X-ZOS-GXX %s
+//
+// S390X-ZOS-GXX:#define _EXT 1
+// S390X-ZOS-C99:#define _ISOC99_SOURCE 1
+// S390X-ZOS:#define _LONG_LONG 1
+// S390X-ZOS-GXX:#define _MI_BUILTIN 1
+// S390X-ZOS:#define _OPEN_DEFAULT 1
+// S390X-ZOS:#define _UNIX03_WITHDRAWN 1
+// S390X-ZOS-CXX:#define _XOPEN_SOURCE 600
+// S390X-ZOS:#define __370__ 1
+// S390X-ZOS:#define __64BIT__ 1
+// S390X-ZOS:#define __BFP__ 1
+// S390X-ZOS:#define __BOOL__ 1
+// S390X-ZOS-CXX:#define __DLL__ 1
+// S390X-ZOS-C:#define __IBMC_GENERIC 1
+// S390X-ZOS-C:#define __IBMC_NORETURN 1
+// S390X-ZOS-C:#define __IBM_UTF_LITERAL 1
+// S390X-ZOS-GXX:#define __IBMCPP_UTF_LITERAL__ 1
+// S390X-ZOS-GXX:#define __IBMC_NORETURN 1
+// S390X-ZOS-GXX:#define __IBM_CHAR16_T__ 1
+// S390X-ZOS-GXX:#define __IBM_CHAR32_T__ 1
+// S390X-ZOS:#define __LONGNAME__ 1
+// S390X-ZOS:#define __MVS__ 1
+// S390X-ZOS:#define __THW_370__ 1
+// S390X-ZOS:#define __THW_BIG_ENDIAN__ 1
+// S390X-ZOS:#define __TOS_390__ 1
+// S390X-ZOS:#define __TOS_MVS__ 1
+// S390X-ZOS:#define __XPLINK__ 1
+// S390X-ZOS-CXX:#define __wchar_t 1
+//
 // RUN: %clang_cc1 -E -dM -ffreestanding -fgnuc-version=4.2.1 -triple=sparc-none-none < /dev/null | FileCheck -match-full-lines -check-prefix SPARC -check-prefix SPARC-DEFAULT %s
 // RUN: %clang_cc1 -E -dM -ffreestanding -fgnuc-version=4.2.1 -triple=sparc-rtems-elf < /dev/null | FileCheck -match-full-lines -check-prefix SPARC -check-prefix SPARC-DEFAULT %s
 // RUN: %clang_cc1 -E -dM -ffreestanding -fgnuc-version=4.2.1 -triple=sparc-none-netbsd < /dev/null | FileCheck -match-full-lines -check-prefix SPARC -check-prefix SPARC-NETOPENBSD %s
 // RUN: %clang_cc1 -E -dM -ffreestanding -fgnuc-version=4.2.1 -triple=sparc-none-openbsd < /dev/null | FileCheck -match-full-lines -check-prefix SPARC -check-prefix SPARC-NETOPENBSD %s
 // RUN: %clang_cc1 -x c++ -E -dM -ffreestanding -fgnuc-version=4.2.1 -triple=sparc-none-none < /dev/null | FileCheck -match-full-lines -check-prefix SPARC -check-prefix SPARC-DEFAULT -check-prefix SPARC-DEFAULT-CXX %s
 // RUN: %clang_cc1 -x c++ -E -dM -ffreestanding -fgnuc-version=4.2.1 -triple=sparc-none-openbsd < /dev/null | FileCheck -match-full-lines -check-prefix SPARC -check-prefix SPARC-NETOPENBSD -check-prefix SPARC-NETOPENBSD-CXX %s
 //
 // SPARC-NOT:#define _LP64