[flang] Change the default module suffix from .mod to f18.mod

[awarzynski]

Summary

The flang/tools/f18/flang script sets the module suffix to
.f18.mod. With this change:

• .f18.mod becomes the default suffix for module files in Flang
• we no longer require a bash wrapper script for the old driver

[klausler]

This is a bad idea. The default module file name suffix should be ".mod"; the world is full of Makefiles and scripts expecting Fortran modules to be "*.mod".

[awarzynski]

From offline discussions (Slack & a community call): the flang script is needed when calling an external compiler specified via F18_FC. It makes sure that there's no clash between module files generated by Flang and the compiler specified with F18_FC.

[awarzynski]

In D101459#2723050, @klausler wrote:

This is a bad idea. The default module file name suffix should be ".mod"; the world is full of Makefiles and scripts expecting Fortran modules to be "*.mod".

Thank you for your comment. I wasn't sure what the rationale behind flang/tools/f18/flang and -module-suffix .f18.mod was. This is now clear and I see why we should keep .mod. I've already abandoned this.

flang/include/flang/Semantics/semantics.h

private:
   void CheckError(const Symbol &);
 
   const common::IntrinsicTypeDefaultKinds &defaultKinds_;
   const common::LanguageFeatureControl languageFeatures_;
   parser::AllCookedSources &allCookedSources_;
   std::optional<parser::CharBlock> location_;
   std::vector<std::string> searchDirectories_;
   std::string moduleDirectory_{"."s};
-  std::string moduleFileSuffix_{".mod"};
+  std::string moduleFileSuffix_{".f18.mod"};
   bool warnOnNonstandardUsage_{false};
   bool warningsAreErrors_{false};
   bool debugModuleWriter_{false};
   const evaluate::IntrinsicProcTable intrinsics_;
   Scope globalScope_;
   parser::Messages messages_;
   evaluate::FoldingContext foldingContext_;
   ConstructStack constructStack_;

flang/test/Driver/Inputs/basictestmoduleone.f18.mod

 !mod$ v1 sum:1f5a35ada852dc66
 module basictestmoduleone
 type::t1
 end type
 end

flang/test/Driver/Inputs/ieee_arithmetic.f18.mod

 ! DUMMY module
 ! Added for testing purposes. The contents of this file are currently not relevant.
 module ieee_arithmetic
 type::ieee_round_type
 integer(1),private::mode=0_1
 end type
 end

flang/test/Driver/Inputs/iso_fortran_env.f18.mod

 ! DUMMY module
 ! Added for testing purposes. The contents of this file are currently not relevant.
 module iso_fortran_env
 use __fortran_builtins,only:event_type=>__builtin_event_type
 use __fortran_builtins,only:lock_type=>__builtin_lock_type
 use __fortran_builtins,only:team_type=>__builtin_team_type
 end

flang/test/Driver/Inputs/module-dir/basictestmoduleone.f18.mod

 !mod$ v1 sum:d380ce014c8955d8
 module basictestmoduleone
 end

flang/test/Driver/Inputs/module-dir/basictestmoduletwo.f18.mod

 !mod$ v1 sum:6c4101164527e745
 module basictestmoduletwo
 type::t2
 end type
 end

flang/test/Driver/fdefault.f90

 ! Ensure argument -fdefault* work as expected.
 ! TODO: Add checks when actual codegen is possible for this family
 
 !--------------------------
 ! FLANG DRIVER (flang-new)
 !--------------------------
 ! RUN: rm -rf %t/dir-flang-new  && mkdir -p %t/dir-flang-new && %flang -fsyntax-only -module-dir %t/dir-flang-new %s  2>&1
-! RUN: cat %t/dir-flang-new/m.mod | FileCheck %s --check-prefix=NOOPTION
+! RUN: cat %t/dir-flang-new/m.f18.mod | FileCheck %s --check-prefix=NOOPTION
 ! RUN: rm -rf %t/dir-flang-new  && mkdir -p %t/dir-flang-new && %flang -fsyntax-only -fdefault-real-8 -module-dir %t/dir-flang-new %s  2>&1
-! RUN: cat %t/dir-flang-new/m.mod | FileCheck %s --check-prefix=REAL8
+! RUN: cat %t/dir-flang-new/m.f18.mod | FileCheck %s --check-prefix=REAL8
 ! RUN: rm -rf %t/dir-flang-new  && mkdir -p %t/dir-flang-new && %flang -fsyntax-only -fdefault-real-8 -fdefault-double-8 -module-dir %t/dir-flang-new %s  2>&1
-! RUN: cat %t/dir-flang-new/m.mod | FileCheck %s --check-prefix=DOUBLE8
+! RUN: cat %t/dir-flang-new/m.f18.mod | FileCheck %s --check-prefix=DOUBLE8
 ! RUN: not %flang -fsyntax-only -fdefault-double-8 %s  2>&1 | FileCheck %s --check-prefix=ERROR
 
 !-----------------------------------------
 ! FRONTEND FLANG DRIVER (flang-new -fc1)
 !-----------------------------------------
 ! RUN: rm -rf %t/dir-flang-new  && mkdir -p %t/dir-flang-new && %flang_fc1 -fsyntax-only -module-dir %t/dir-flang-new %s  2>&1
-! RUN: cat %t/dir-flang-new/m.mod | FileCheck %s --check-prefix=NOOPTION
+! RUN: cat %t/dir-flang-new/m.f18.mod | FileCheck %s --check-prefix=NOOPTION
 ! RUN: rm -rf %t/dir-flang-new  && mkdir -p %t/dir-flang-new && %flang_fc1 -fsyntax-only -fdefault-real-8 -module-dir %t/dir-flang-new %s  2>&1
-! RUN: cat %t/dir-flang-new/m.mod | FileCheck %s --check-prefix=REAL8
+! RUN: cat %t/dir-flang-new/m.f18.mod | FileCheck %s --check-prefix=REAL8
 ! RUN: rm -rf %t/dir-flang-new  && mkdir -p %t/dir-flang-new && %flang_fc1 -fsyntax-only -fdefault-real-8 -fdefault-double-8 -module-dir %t/dir-flang-new %s  2>&1
-! RUN: cat %t/dir-flang-new/m.mod | FileCheck %s --check-prefix=DOUBLE8
+! RUN: cat %t/dir-flang-new/m.f18.mod | FileCheck %s --check-prefix=DOUBLE8
 ! RUN: not %flang_fc1 -fsyntax-only -fdefault-double-8 %s  2>&1 | FileCheck %s --check-prefix=ERROR
 
 !-----------------------------------------
 ! EXPECTED OUTPUT FOR NO SPECIFICATION
 !-----------------------------------------
 ! NOOPTION: integer(4),parameter::real_kind=4_4
 ! NOOPTION-NEXT: intrinsic::kind
 ! NOOPTION-NEXT: integer(4),parameter::double_kind=8_4

flang/test/Driver/flarge-sizes.f90

 ! Ensure argument -flarge-sizes works as expected.
 ! TODO: Add checks when actual codegen is possible.
 
 !--------------------------
 ! FLANG DRIVER (flang-new)
 !--------------------------
 ! RUN: rm -rf %t/dir-flang-new  && mkdir -p %t/dir-flang-new && %flang -fsyntax-only -module-dir %t/dir-flang-new %s  2>&1
-! RUN: cat %t/dir-flang-new/m.mod | FileCheck %s --check-prefix=NOLARGE
+! RUN: cat %t/dir-flang-new/m.f18.mod | FileCheck %s --check-prefix=NOLARGE
 ! RUN: rm -rf %t/dir-flang-new  && mkdir -p %t/dir-flang-new && %flang -fsyntax-only -flarge-sizes -module-dir %t/dir-flang-new %s  2>&1
-! RUN: cat %t/dir-flang-new/m.mod | FileCheck %s --check-prefix=LARGE
+! RUN: cat %t/dir-flang-new/m.f18.mod | FileCheck %s --check-prefix=LARGE
 
 !-----------------------------------------
 ! FRONTEND FLANG DRIVER (flang-new -fc1)
 !-----------------------------------------
 ! RUN: rm -rf %t/dir-flang-new  && mkdir -p %t/dir-flang-new && %flang_fc1 -fsyntax-only -module-dir %t/dir-flang-new %s  2>&1
-! RUN: cat %t/dir-flang-new/m.mod | FileCheck %s --check-prefix=NOLARGE
+! RUN: cat %t/dir-flang-new/m.f18.mod | FileCheck %s --check-prefix=NOLARGE
 ! RUN: rm -rf %t/dir-flang-new  && mkdir -p %t/dir-flang-new && %flang_fc1 -fsyntax-only -flarge-sizes -module-dir %t/dir-flang-new %s  2>&1
-! RUN: cat %t/dir-flang-new/m.mod | FileCheck %s --check-prefix=LARGE
+! RUN: cat %t/dir-flang-new/m.f18.mod | FileCheck %s --check-prefix=LARGE
 
 !-----------------------------------------
 ! EXPECTED OUTPUT WITHOUT -flarge-sizes
 !-----------------------------------------
 ! NOLARGE: real(4)::z(1_8:10_8)
 ! NOLARGE-NEXT: integer(4),parameter::size_kind=4_4
 
 !-----------------------------------------

flang/test/Driver/write-module.f90

 ! Checks that the module file:
 !   * is _saved_
 !   * is saved in the _directory specified by the user_
 ! We use `-fsyntax-only` as it stops after the semantic checks (the module file is generated when sema checks are run)
 
 !--------------------------
 ! -module-dir
 !--------------------------
 ! RUN: rm -rf %t && mkdir -p %t/dir-flang
 ! RUN: cd %t && %flang -fsyntax-only -module-dir %t/dir-flang %s
-! RUN: ls %t/dir-flang/testmodule.mod && not ls %t/testmodule.mod
+! RUN: ls %t/dir-flang/testmodule.f18.mod && not ls %t/testmodule.f18.mod
 
 !---------------------------
 ! -J <dir> (i.e. with space)
 !---------------------------
 ! RUN: rm -rf %t && mkdir -p %t/dir-flang
 ! RUN: cd %t && %flang -fsyntax-only -J %t/dir-flang %s
-! RUN: ls %t/dir-flang/testmodule.mod && not ls %t/testmodule.mod
+! RUN: ls %t/dir-flang/testmodule.f18.mod && not ls %t/testmodule.f18.mod
 
 !------------------------------
 ! -J<dir> (i.e. without space)
 !------------------------------
 ! RUN: rm -rf %t && mkdir -p %t/dir-flang
 ! RUN: cd %t && %flang -fsyntax-only -J%t/dir-flang %s
-! RUN: ls %t/dir-flang/testmodule.mod && not ls %t/testmodule.mod
+! RUN: ls %t/dir-flang/testmodule.f18.mod && not ls %t/testmodule.f18.mod
 
 module testmodule
   type::t2
   end type
 end

flang/test/Semantics/Inputs/modfile09-a.f90

 module m
   integer :: m1_x
   interface
     module subroutine s()
     end subroutine
   end interface
 end
 
-!Expect: m.mod
+!Expect: m.f18.mod
 !module m
 !integer(4)::m1_x
 !interface
 !module subroutine s()
 !end
 !end interface
 !end

flang/test/Semantics/Inputs/modfile09-b.f90

 submodule(m) s1
   integer s1_x
 end
 
-!Expect: m-s1.mod
+!Expect: m-s1.f18.mod
 !submodule(m) s1
 !integer(4)::s1_x
 !end

flang/test/Semantics/Inputs/modfile09-c.f90

 submodule(m:s1) s2
   integer s2_x
 end
 
-!Expect: m-s2.mod
+!Expect: m-s2.f18.mod
 !submodule(m:s1) s2
 !integer(4)::s2_x
 !end

flang/test/Semantics/Inputs/modfile09-d.f90

 submodule(m:s2) s3
   integer s3_x
 end
 
-!Expect: m-s3.mod
+!Expect: m-s3.f18.mod
 !submodule(m:s2) s3
 !integer(4)::s3_x
 !end

flang/test/Semantics/getsymbols02.f90

 ! Tests -fget-symbols-sources with modules.
 
 PROGRAM helloworld
     use mm2b
     implicit none
     integer::i
     i = callget5()
 ENDPROGRAM
 
 ! RUN: %flang_fc1 -fsyntax-only %S/Inputs/getsymbols02-a.f90
 ! RUN: %flang_fc1 -fsyntax-only %S/Inputs/getsymbols02-b.f90
 ! RUN: %flang_fc1 -fsyntax-only -fget-symbols-sources %s 2>&1 | FileCheck %s
-! CHECK: callget5: .{{[/\\]}}mm2b.mod,
-! CHECK: get5: .{{[/\\]}}mm2a.mod,
+! CHECK: callget5: .{{[/\\]}}mm2b.f18.mod,
+! CHECK: get5: .{{[/\\]}}mm2a.f18.mod,

flang/test/Semantics/resolve12.f90

 ! RUN: %S/test_errors.sh %s %t %flang_fc1
 module m1
 end
 
 subroutine sub
 end
 
 use m1
-!ERROR: Cannot read module file for module 'm2': Source file 'm2.mod' was not found
+!ERROR: Cannot read module file for module 'm2': Source file 'm2.f18.mod' was not found
 use m2
 !ERROR: 'sub' is not a module
 use sub
 end

flang/test/Semantics/resolve26.f90

interface
     module subroutine s()
     end subroutine
   end interface
 end
 
 submodule(m1) s1
 end
 
-!ERROR: Cannot read module file for submodule 's1' of module 'm2': Source file 'm2-s1.mod' was not found
+!ERROR: Cannot read module file for submodule 's1' of module 'm2': Source file 'm2-s1.f18.mod' was not found
 submodule(m2:s1) s2
 end
 
-!ERROR: Cannot read module file for module 'm3': Source file 'm3.mod' was not found
+!ERROR: Cannot read module file for module 'm3': Source file 'm3.f18.mod' was not found
 submodule(m3:s1) s3
 end

flang/test/Semantics/test_modfile.sh

 #!/usr/bin/env bash
 # Compile a source file and compare generated .mod files against expected.
 
 set -e
 FLANG_FC1_OPTIONS="-fsyntax-only"
 srcdir=$(dirname $0)
 source $srcdir/common.sh
 
-actual=$temp/actual.mod
-expect=$temp/expect.mod
+actual=$temp/actual.f18.mod
+expect=$temp/expect.f18.mod
 actual_files=$temp/actual_files
 prev_files=$temp/prev_files
 diffs=$temp/diffs
 
 set $src
 
 touch $actual
 for src in "$@"; do

flang/tools/f18/CMakeLists.txt

add_custom_command(OUTPUT ${base}.f18.mod
     COMMAND ${CMAKE_COMMAND} -E copy ${base}.mod ${base}.f18.mod)
   list(APPEND MODULE_FILES ${base}.mod ${base}.f18.mod)
   install(FILES ${base}.mod ${base}.f18.mod DESTINATION include/flang)
 endforeach()
 
 add_custom_target(module_files ALL DEPENDS ${MODULE_FILES})
 
 install(TARGETS f18 DESTINATION bin)
-
-# This flang shell script will only work in a POSIX shell.
-if (NOT WIN32)
-  file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/flang
-    DESTINATION ${CMAKE_BINARY_DIR}/bin
-    FILE_PERMISSIONS OWNER_EXECUTE OWNER_READ OWNER_WRITE)
-  install(PROGRAMS ${CMAKE_BINARY_DIR}/bin/flang DESTINATION bin)
-endif()

flang/tools/f18/f18.cpp

 
 struct DriverOptions {
   DriverOptions() {}
   bool verbose{false}; // -v
   bool compileOnly{false}; // -c
   std::string outputPath; // -o path
   std::vector<std::string> searchDirectories; // -I dir
   std::string moduleDirectory{"."s}; // -module dir
-  std::string moduleFileSuffix{".mod"}; // -moduleSuffix suff
+  std::string moduleFileSuffix{".f18.mod"}; // -moduleSuffix suff
   bool forcedForm{false}; // -Mfixed or -Mfree appeared
   bool warnOnNonstandardUsage{false}; // -Mstandard
   bool warningsAreErrors{false}; // -Werror
   bool byteswapio{false}; // -byteswapio
   Fortran::parser::Encoding encoding{Fortran::parser::Encoding::UTF_8};
   bool syntaxOnly{false};
   bool dumpProvenance{false};
   bool dumpCookedChars{false};

flang/tools/f18/flang

-#!/bin/bash
-#===-- tools/f18/flang.sh -----------------------------------------*- sh -*-===#
-#
-# 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
-#
-#===------------------------------------------------------------------------===#
-
-wd=$(cd $(dirname "$0")/.. && pwd)
-opts="-module-suffix .f18.mod "
-if ! $wd/bin/f18 $opts "$@"
-then status=$?
-     echo flang: in $PWD, f18 failed with exit status $status: $wd/bin/f18 $opts "$@" >&2
-     exit $status
-fi