[OpenMP][bbc][flang] Add _OPENMP macro definition

[domada]

Summary

OpenMP standard (section 3.3 for OpenMP 5.2) requires that _OPENMP macro contains release date of given OpenMP standard version.

[kiranchandramohan]

flang/lib/Frontend/CompilerInvocation.cpp

1003–1038

Can this code be shared with bbc?

I am assuming it is not possible to share the code with the clang driver.

[domada]

Scope of changes:

1. Create one function common for bbc and Flang frontend to set _OPENMP macro
2. Use setOpenMPmacro function inside Flang frontend and bbc source code.

Function is placed in flang/include/flang/Common/OpenMP-features.h header file. flang/include/flang/Common is directory which is shared between bbc and flang frontend.

[domada]

flang/lib/Frontend/CompilerInvocation.cpp

1003–1038

Hi Kiran,
thank you for your feedback.

You are right, that the possibility of code sharing between bbc and clang driver is limited.

I observed that both tools use header files from directory`flang/include/flang/Common`. That's why I decided to create another header and place there function for setting _OPENMP macro.

[kiranchandramohan]

LG.

flang/include/flang/Common/OpenMP-features.h

+//===-- include/flang/Common/OpenMP-features.h -----------------*- C++ -*-====//
+//
+// 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 FORTRAN_COMMON_OPENMP_FEATURES_H_
+#define FORTRAN_COMMON_OPENMP_FEATURES_H_
+
+namespace Fortran::common {
+
+/// Set _OPENMP macro according to given version number
+template <typename FortranPredefinitions>
+void setOpenMPMacro(int version, FortranPredefinitions &predefinitions) {
+  switch (version) {
+  case 20:
+    predefinitions.emplace_back("_OPENMP", "200011");
+    break;
+  case 25:
+    predefinitions.emplace_back("_OPENMP", "200505");
+    break;
+  case 30:
+    predefinitions.emplace_back("_OPENMP", "200805");
+    break;
+  case 31:
+    predefinitions.emplace_back("_OPENMP", "201107");
+    break;
+  case 40:
+    predefinitions.emplace_back("_OPENMP", "201307");
+    break;
+  case 45:
+    predefinitions.emplace_back("_OPENMP", "201511");
+    break;
+  case 50:
+    predefinitions.emplace_back("_OPENMP", "201811");
+    break;
+  case 51:
+    predefinitions.emplace_back("_OPENMP", "202011");
+    break;
+  case 52:
+    predefinitions.emplace_back("_OPENMP", "202111");
+    break;
+  case 11:
+  default:
+    predefinitions.emplace_back("_OPENMP", "199911");
+    break;
+  }
+}
+} // namespace Fortran::common
+#endif // FORTRAN_COMMON_OPENMP_FEATURES_H_

flang/lib/Frontend/CompilerInvocation.cpp

 //===- CompilerInvocation.cpp ---------------------------------------------===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 //
 // Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
 //
 //===----------------------------------------------------------------------===//
 
 #include "flang/Frontend/CompilerInvocation.h"
 #include "flang/Common/Fortran-features.h"
+#include "flang/Common/OpenMP-features.h"
 #include "flang/Common/Version.h"
 #include "flang/Frontend/CodeGenOptions.h"
 #include "flang/Frontend/PreprocessorOptions.h"
 #include "flang/Frontend/TargetOptions.h"
 #include "flang/Semantics/semantics.h"
 #include "flang/Version.inc"
 #include "clang/Basic/AllDiagnostics.h"
 #include "clang/Basic/DiagnosticDriver.h"
void CompilerInvocation::setDefaultFortranOpts() {
 
   // Add the location of omp_lib.h to the search directories. Currently this is
   // identical to the modules' directory.
   fortranOptions.searchDirectories.emplace_back(getOpenMPHeadersDir());
 
   fortranOptions.isFixedForm = false;
 }
 
 // TODO: When expanding this method, consider creating a dedicated API for
 // this. Also at some point we will need to differentiate between different
 // targets and add dedicated predefines for each.
 void CompilerInvocation::setDefaultPredefinitions() {
   auto &fortranOptions = getFortranOpts();
   const auto &frontendOptions = getFrontendOpts();
-
   // Populate the macro list with version numbers and other predefinitions.
   fortranOptions.predefinitions.emplace_back("__flang__", "1");
   fortranOptions.predefinitions.emplace_back("__flang_major__",
                                              FLANG_VERSION_MAJOR_STRING);
   fortranOptions.predefinitions.emplace_back("__flang_minor__",
                                              FLANG_VERSION_MINOR_STRING);
   fortranOptions.predefinitions.emplace_back("__flang_patchlevel__",
                                              FLANG_VERSION_PATCHLEVEL_STRING);
 
   // Add predefinitions based on extensions enabled
   if (frontendOptions.features.IsEnabled(
           Fortran::common::LanguageFeature::OpenACC)) {
     fortranOptions.predefinitions.emplace_back("_OPENACC", "202011");
   }
   if (frontendOptions.features.IsEnabled(
           Fortran::common::LanguageFeature::OpenMP)) {
-    fortranOptions.predefinitions.emplace_back("_OPENMP", "201511");
+    Fortran::common::setOpenMPMacro(getLangOpts().OpenMPVersion,
+                                    fortranOptions.predefinitions);
   }
   llvm::Triple targetTriple{llvm::Triple(this->targetOpts.triple)};
   if (targetTriple.getArch() == llvm::Triple::ArchType::x86_64) {
     fortranOptions.predefinitions.emplace_back("__x86_64__", "1");
     fortranOptions.predefinitions.emplace_back("__x86_64", "1");
   }
 }
 
 void CompilerInvocation::setFortranOpts() {
   auto &fortranOptions = getFortranOpts();
   const auto &frontendOptions = getFrontendOpts();
   const auto &preprocessorOptions = getPreprocessorOpts();
   auto &moduleDirJ = getModuleDir();
 
   if (frontendOptions.fortranForm != FortranForm::Unknown) {
     fortranOptions.isFixedForm =
         frontendOptions.fortranForm == FortranForm::FixedForm;
   }
   fortranOptions.fixedFormColumns = frontendOptions.fixedFormColumns;
 

flang/test/Driver/bbc-openmp-version-macro.f90

+! Test predefined _OPENMP macro which denotes OpenMP version
+
+! RUN: bbc -fopenmp -o -  %s | FileCheck %s --check-prefix=DEFAULT-OPENMP-VERSION
+! RUN: bbc -fopenmp -fopenmp-version=11 -o - %s | FileCheck %s --check-prefix=OPENMP-VERSION-11
+! RUN: bbc -fopenmp -fopenmp-version=11 -o - %s | FileCheck %s --check-prefix=OPENMP-VERSION-11
+! RUN: bbc -fopenmp -fopenmp-version=20 -o - %s | FileCheck %s --check-prefix=OPENMP-VERSION-20
+! RUN: bbc -fopenmp -fopenmp-version=25 -o - %s | FileCheck %s --check-prefix=OPENMP-VERSION-25
+! RUN: bbc -fopenmp -fopenmp-version=30 -o - %s | FileCheck %s --check-prefix=OPENMP-VERSION-30
+! RUN: bbc -fopenmp -fopenmp-version=31 -o - %s | FileCheck %s --check-prefix=OPENMP-VERSION-31
+! RUN: bbc -fopenmp -fopenmp-version=40 -o - %s | FileCheck %s --check-prefix=OPENMP-VERSION-40
+! RUN: bbc -fopenmp -fopenmp-version=45 -o - %s | FileCheck %s --check-prefix=OPENMP-VERSION-45
+! RUN: bbc -fopenmp -fopenmp-version=50 -o - %s | FileCheck %s --check-prefix=OPENMP-VERSION-50
+! RUN: bbc -fopenmp -fopenmp-version=51 -o - %s | FileCheck %s --check-prefix=OPENMP-VERSION-51
+! RUN: bbc -fopenmp -fopenmp-version=52 -o - %s | FileCheck %s --check-prefix=OPENMP-VERSION-52
+
+! DEFAULT-OPENMP-VERSION: {{.*}} = arith.constant 199911 : i32
+! OPENMP-VERSION-11: {{.*}} = arith.constant 199911 : i32
+! OPENMP-VERSION-20: {{.*}} = arith.constant 200011 : i32
+! OPENMP-VERSION-25: {{.*}} = arith.constant 200505 : i32
+! OPENMP-VERSION-30: {{.*}} = arith.constant 200805 : i32
+! OPENMP-VERSION-31: {{.*}} = arith.constant 201107 : i32
+! OPENMP-VERSION-40: {{.*}} = arith.constant 201307 : i32
+! OPENMP-VERSION-45: {{.*}} = arith.constant 201511 : i32
+! OPENMP-VERSION-50: {{.*}} = arith.constant 201811 : i32
+! OPENMP-VERSION-51: {{.*}} = arith.constant 202011 : i32
+! OPENMP-VERSION-52: {{.*}} = arith.constant 202111 : i32
+
+#if _OPENMP
+  integer :: var1 = _OPENMP
+#endif
+end program
+

flang/test/Driver/flang-openmp-version-macro.f90

+! Test predefined _OPENMP macro which denotes OpenMP version
+
+! RUN: %flang_fc1 -fopenmp -cpp -E %s | FileCheck %s --check-prefix=DEFAULT-OPENMP-VERSION
+! RUN: %flang_fc1 -fopenmp -fopenmp-version=11 -cpp -E %s | FileCheck %s --check-prefix=OPENMP-VERSION-11
+! RUN: %flang_fc1 -fopenmp -fopenmp-version=11 -cpp -E %s | FileCheck %s --check-prefix=OPENMP-VERSION-11
+! RUN: %flang_fc1 -fopenmp -fopenmp-version=20 -cpp -E %s | FileCheck %s --check-prefix=OPENMP-VERSION-20
+! RUN: %flang_fc1 -fopenmp -fopenmp-version=25 -cpp -E %s | FileCheck %s --check-prefix=OPENMP-VERSION-25
+! RUN: %flang_fc1 -fopenmp -fopenmp-version=30 -cpp -E %s | FileCheck %s --check-prefix=OPENMP-VERSION-30
+! RUN: %flang_fc1 -fopenmp -fopenmp-version=31 -cpp -E %s | FileCheck %s --check-prefix=OPENMP-VERSION-31
+! RUN: %flang_fc1 -fopenmp -fopenmp-version=40 -cpp -E %s | FileCheck %s --check-prefix=OPENMP-VERSION-40
+! RUN: %flang_fc1 -fopenmp -fopenmp-version=45 -cpp -E %s | FileCheck %s --check-prefix=OPENMP-VERSION-45
+! RUN: %flang_fc1 -fopenmp -fopenmp-version=50 -cpp -E %s | FileCheck %s --check-prefix=OPENMP-VERSION-50
+! RUN: %flang_fc1 -fopenmp -fopenmp-version=51 -cpp -E %s | FileCheck %s --check-prefix=OPENMP-VERSION-51
+! RUN: %flang_fc1 -fopenmp -fopenmp-version=52 -cpp -E %s | FileCheck %s --check-prefix=OPENMP-VERSION-52
+
+! DEFAULT-OPENMP-VERSION: integer :: var1 = 199911
+! OPENMP-VERSION-11: integer :: var1 = 199911
+! OPENMP-VERSION-20: integer :: var1 = 200011
+! OPENMP-VERSION-25: integer :: var1 = 200505
+! OPENMP-VERSION-30: integer :: var1 = 200805
+! OPENMP-VERSION-31: integer :: var1 = 201107
+! OPENMP-VERSION-40: integer :: var1 = 201307
+! OPENMP-VERSION-45: integer :: var1 = 201511
+! OPENMP-VERSION-50: integer :: var1 = 201811
+! OPENMP-VERSION-51: integer :: var1 = 202011
+! OPENMP-VERSION-52: integer :: var1 = 202111
+
+#if _OPENMP
+  integer :: var1 = _OPENMP
+#endif
+end program
+

flang/tools/bbc/bbc.cpp

 //
 //===----------------------------------------------------------------------===//
 ///
 /// This is a tool for translating Fortran sources to the FIR dialect of MLIR.
 ///
 //===----------------------------------------------------------------------===//
 
 #include "flang/Common/Fortran-features.h"
+#include "flang/Common/OpenMP-features.h"
 #include "flang/Common/default-kinds.h"
 #include "flang/Lower/Bridge.h"
 #include "flang/Lower/PFTBuilder.h"
 #include "flang/Lower/Support/Verifier.h"
 #include "flang/Optimizer/Dialect/Support/FIRContext.h"
 #include "flang/Optimizer/Dialect/Support/KindMapping.h"
 #include "flang/Optimizer/Support/InitFIR.h"
 #include "flang/Optimizer/Support/InternalNames.h"
int main(int argc, char **argv) {
   options.predefinitions.emplace_back("__flang_minor__"s,
                                       std::string{FLANG_VERSION_MINOR_STRING});
   options.predefinitions.emplace_back(
       "__flang_patchlevel__"s, std::string{FLANG_VERSION_PATCHLEVEL_STRING});
 
   // enable parsing of OpenMP
   if (enableOpenMP) {
     options.features.Enable(Fortran::common::LanguageFeature::OpenMP);
-    options.predefinitions.emplace_back("_OPENMP", "201511");
+    Fortran::common::setOpenMPMacro(setOpenMPVersion, options.predefinitions);
   }
 
   // enable parsing of OpenACC
   if (enableOpenACC) {
     options.features.Enable(Fortran::common::LanguageFeature::OpenACC);
     options.predefinitions.emplace_back("_OPENACC", "202011");
   }