[flang] Implement CHDIR intrinsic #124280

JDPailleux · 2025-01-24T14:57:56Z

This intrinsic is a gnu extension (https://gcc.gnu.org/onlinedocs/gfortran/CHDIR.html) and is used in FLEUR (https://github.com/JuDFTteam/FLEUR).

github-actions · 2025-01-24T14:58:15Z

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

llvmbot · 2025-01-24T14:58:48Z

@llvm/pr-subscribers-flang-runtime
@llvm/pr-subscribers-flang-semantics

@llvm/pr-subscribers-flang-fir-hlfir

Author: Jean-Didier PAILLEUX (JDPailleux)

Changes

This intrinsic is a gnu extension (https://gcc.gnu.org/onlinedocs/gfortran/CHDIR.html) and is used in FLEUR (https://github.com/JuDFTteam/FLEUR).

Full diff: https://github.com/llvm/llvm-project/pull/124280.diff

8 Files Affected:

(modified) flang/include/flang/Optimizer/Builder/IntrinsicCall.h (+1)
(modified) flang/include/flang/Optimizer/Builder/Runtime/Intrinsics.h (+4)
(modified) flang/include/flang/Runtime/extensions.h (+3)
(modified) flang/lib/Evaluate/intrinsics.cpp (+5)
(modified) flang/lib/Optimizer/Builder/IntrinsicCall.cpp (+17)
(modified) flang/lib/Optimizer/Builder/Runtime/Intrinsics.cpp (+10)
(modified) flang/runtime/extensions.cpp (+8)
(added) flang/test/Lower/Intrinsics/chdir.f90 (+15)

diff --git a/flang/include/flang/Optimizer/Builder/IntrinsicCall.h b/flang/include/flang/Optimizer/Builder/IntrinsicCall.h
index 9c9c0609f4fc3c..9b6da461e18549 100644
--- a/flang/include/flang/Optimizer/Builder/IntrinsicCall.h
+++ b/flang/include/flang/Optimizer/Builder/IntrinsicCall.h
@@ -202,6 +202,7 @@ struct IntrinsicLibrary {
   mlir::Value genBtest(mlir::Type, llvm::ArrayRef<mlir::Value>);
   mlir::Value genCeiling(mlir::Type, llvm::ArrayRef<mlir::Value>);
   fir::ExtendedValue genChar(mlir::Type, llvm::ArrayRef<fir::ExtendedValue>);
+  void genChdir(llvm::ArrayRef<fir::ExtendedValue>);
   template <mlir::arith::CmpIPredicate pred>
   fir::ExtendedValue genCharacterCompare(mlir::Type,
                                          llvm::ArrayRef<fir::ExtendedValue>);
diff --git a/flang/include/flang/Optimizer/Builder/Runtime/Intrinsics.h b/flang/include/flang/Optimizer/Builder/Runtime/Intrinsics.h
index 02b9b68da0db4b..34a2edb5b0971d 100644
--- a/flang/include/flang/Optimizer/Builder/Runtime/Intrinsics.h
+++ b/flang/include/flang/Optimizer/Builder/Runtime/Intrinsics.h
@@ -90,6 +90,10 @@ void genSignal(fir::FirOpBuilder &builder, mlir::Location loc,
 void genSleep(fir::FirOpBuilder &builder, mlir::Location loc,
               mlir::Value seconds);
 
+/// generate chdir runtime call
+void genChdir(fir::FirOpBuilder &builder, mlir::Location loc, mlir::Value dir,
+              mlir::Value status);
+
 } // namespace runtime
 } // namespace fir
 
diff --git a/flang/include/flang/Runtime/extensions.h b/flang/include/flang/Runtime/extensions.h
index a855c694e0090d..929dbeeafd8fd6 100644
--- a/flang/include/flang/Runtime/extensions.h
+++ b/flang/include/flang/Runtime/extensions.h
@@ -62,6 +62,9 @@ std::int64_t RTNAME(Signal)(std::int64_t number, void (*handler)(int));
 // GNU extension subroutine SLEEP(SECONDS)
 void RTNAME(Sleep)(std::int64_t seconds);
 
+// GNU extension subroutine CHDIR(DIR, [STATUS])
+void RTNAME(Chdir)(const char *dir, int *status);
+
 // GNU extension function ACCESS(NAME, MODE)
 // TODO: not supported on Windows
 #ifndef _WIN32
diff --git a/flang/lib/Evaluate/intrinsics.cpp b/flang/lib/Evaluate/intrinsics.cpp
index f234241cfe14a6..e65af98f266e80 100644
--- a/flang/lib/Evaluate/intrinsics.cpp
+++ b/flang/lib/Evaluate/intrinsics.cpp
@@ -1403,6 +1403,11 @@ static const IntrinsicInterface intrinsicSubroutine[]{
             {"stat", AnyInt, Rank::scalar, Optionality::optional,
                 common::Intent::Out}},
         {}, Rank::elemental, IntrinsicClass::atomicSubroutine},
+    {"chdir",
+        {{"dir", AnyChar, Rank::anyOrAssumedRank},
+            {"stat", AnyInt, Rank::scalar, Optionality::optional,
+                common::Intent::Out}},
+        {}, Rank::elemental, IntrinsicClass::impureSubroutine},
     {"co_broadcast",
         {{"a", AnyData, Rank::anyOrAssumedRank, Optionality::required,
              common::Intent::InOut},
diff --git a/flang/lib/Optimizer/Builder/IntrinsicCall.cpp b/flang/lib/Optimizer/Builder/IntrinsicCall.cpp
index 6a343645ab8786..a512439308a2df 100644
--- a/flang/lib/Optimizer/Builder/IntrinsicCall.cpp
+++ b/flang/lib/Optimizer/Builder/IntrinsicCall.cpp
@@ -185,6 +185,10 @@ static constexpr IntrinsicHandler handlers[]{
     {"c_ptr_ne", &I::genCPtrCompare<mlir::arith::CmpIPredicate::ne>},
     {"ceiling", &I::genCeiling},
     {"char", &I::genChar},
+    {"chdir",
+     &I::genChdir,
+     {{{"dir", asValue}, {"status", asAddr, handleDynamicOptional}}},
+     /*isElemental=*/false},
     {"cmplx",
      &I::genCmplx,
      {{{"x", asValue}, {"y", asValue, handleDynamicOptional}}}},
@@ -3075,6 +3079,19 @@ IntrinsicLibrary::genChar(mlir::Type type,
   return fir::CharBoxValue{cast, len};
 }
 
+// CHDIR
+void IntrinsicLibrary::genChdir(llvm::ArrayRef<fir::ExtendedValue> args) {
+  assert(args.size() == 2);
+  mlir::Value status =
+      isStaticallyAbsent(args[1])
+          ? builder
+                .create<fir::AbsentOp>(
+                    loc, builder.getRefType(builder.getNoneType()))
+                .getResult()
+          : fir::getBase(args[1]);
+  fir::runtime::genChdir(builder, loc, fir::getBase(args[0]), status);
+}
+
 // CMPLX
 mlir::Value IntrinsicLibrary::genCmplx(mlir::Type resultType,
                                        llvm::ArrayRef<mlir::Value> args) {
diff --git a/flang/lib/Optimizer/Builder/Runtime/Intrinsics.cpp b/flang/lib/Optimizer/Builder/Runtime/Intrinsics.cpp
index ded9579f2c1df0..66aa04d25c4ece 100644
--- a/flang/lib/Optimizer/Builder/Runtime/Intrinsics.cpp
+++ b/flang/lib/Optimizer/Builder/Runtime/Intrinsics.cpp
@@ -385,3 +385,13 @@ void fir::runtime::genSleep(fir::FirOpBuilder &builder, mlir::Location loc,
       fir::runtime::getRuntimeFunc<mkRTKey(Sleep)>(loc, builder)};
   builder.create<fir::CallOp>(loc, func, seconds);
 }
+
+/// generate chdir runtime call
+void fir::runtime::genChdir(fir::FirOpBuilder &builder, mlir::Location loc,
+                            mlir::Value dir, mlir::Value status) {
+  mlir::func::FuncOp func{
+      fir::runtime::getRuntimeFunc<mkRTKey(Chdir)>(loc, builder)};
+  llvm::SmallVector<mlir::Value> args = fir::runtime::createArguments(
+      builder, loc, func.getFunctionType(), dir, status);
+  builder.create<fir::CallOp>(loc, func, args);
+}
diff --git a/flang/runtime/extensions.cpp b/flang/runtime/extensions.cpp
index 50d3c72fe650d0..7426072d324f91 100644
--- a/flang/runtime/extensions.cpp
+++ b/flang/runtime/extensions.cpp
@@ -21,6 +21,7 @@
 #include <ctime>
 #include <signal.h>
 #include <thread>
+#include <unistd.h>
 
 #ifdef _WIN32
 #define WIN32_LEAN_AND_MEAN
@@ -248,5 +249,12 @@ std::int64_t FORTRAN_PROCEDURE_NAME(access)(const char *name,
 }
 #endif
 
+// CHDIR(DIR)
+void RTNAME(Chdir)(const char *dir, int *status) {
+  int stat = chdir(dir);
+  if (status)
+    *status = stat;
+}
+
 } // namespace Fortran::runtime
 } // extern "C"
diff --git a/flang/test/Lower/Intrinsics/chdir.f90 b/flang/test/Lower/Intrinsics/chdir.f90
new file mode 100644
index 00000000000000..6194f831d8003e
--- /dev/null
+++ b/flang/test/Lower/Intrinsics/chdir.f90
@@ -0,0 +1,15 @@
+! RUN: bbc -emit-hlfir %s -o - | FileCheck %s
+
+subroutine test_chdir()
+  implicit none
+! CHECK-LABEL:   func.func @_QPtest_chdir() {
+
+  call chdir("..")
+! CHECK:  %[[VAL_0:.*]] = fir.address_of(@_QQclX2E2E) : !fir.ref<!fir.char<1,2>>
+! CHECK:  %[[C_2:.*]] = arith.constant 2 : index
+! CHECK:  %[[VAL_1:.*]] = hlfir.declare %[[VAL_0]] typeparams %[[C_2]] {fortran_attrs = #fir.var_attrs<parameter>, uniq_name = "_QQclX2E2E"} : (!fir.ref<!fir.char<1,2>>, index) -> (!fir.ref<!fir.char<1,2>>, !fir.ref<!fir.char<1,2>>)
+! CHECK:  %[[VAL_2:.*]] = fir.absent !fir.ref<none>
+! CHECK:  %[[VAL_3:.*]] = fir.convert %{{.*}} : (!fir.ref<!fir.char<1,2>>) -> !fir.ref<i8>
+! CHECK:  %[[VAL_4:.*]] = fir.convert %{{.*}} : (!fir.ref<none>) -> !fir.ref<i32>
+! CHECK:  %[[VAL_5:.*]] = fir.call @_FortranAChdir(%[[VAL_3]], %[[VAL_4]]) fastmath<contract> : (!fir.ref<i8>, !fir.ref<i32>) -> none
+end subroutine

jeanPerier

Thanks for adding this, I think this should be added as both a subroutine and function since the documentation defines both versions (similar to how getcwd was added, see this commit).

Please also list this extension in flang/docs/Intrinsics.md.

flang/lib/Evaluate/intrinsics.cpp

flang/runtime/extensions.cpp

flang/lib/Optimizer/Builder/IntrinsicCall.cpp

flang/test/Lower/Intrinsics/chdir.f90

flang/runtime/extensions.cpp

kkwli · 2025-01-27T21:32:07Z

LG Thanks

tblah

One comment on the documentation, otherwise LGTM. Thanks for adding another intrinsic!

flang/docs/Intrinsics.md

tblah

Thanks for the quick update

jeanPerier

Small question, looks good to me otherwise, thanks for the update.

flang/lib/Evaluate/intrinsics.cpp

jeanPerier

LGTM, thanks!

JDPailleux · 2025-01-29T08:28:04Z

Hello and Thanks for your feedbacks, if there is no other review, is it possible for someone to do the merge ?

github-actions · 2025-01-29T08:45:16Z

@JDPailleux Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

llvmbot added flang:runtime flang Flang issues not falling into any other category flang:fir-hlfir flang:semantics labels Jan 24, 2025

jeanPerier reviewed Jan 24, 2025

View reviewed changes

jeanPerier requested review from mjklemm, klausler, tblah and kkwli January 24, 2025 16:51

klausler requested changes Jan 24, 2025

View reviewed changes

flang/runtime/extensions.cpp Outdated Show resolved Hide resolved

JDPailleux force-pushed the jdp/flang/chdir-intrinsic branch from 2bb97d1 to 9866662 Compare January 27, 2025 20:19

tblah reviewed Jan 28, 2025

View reviewed changes

flang/docs/Intrinsics.md Show resolved Hide resolved

JDPailleux force-pushed the jdp/flang/chdir-intrinsic branch 2 times, most recently from d820754 to d4adb2e Compare January 28, 2025 10:48

tblah approved these changes Jan 28, 2025

View reviewed changes

jeanPerier reviewed Jan 28, 2025

View reviewed changes

flang/lib/Evaluate/intrinsics.cpp Outdated Show resolved Hide resolved

[flang] Implement CHDIR intrinsic

49108eb

JDPailleux force-pushed the jdp/flang/chdir-intrinsic branch from d4adb2e to 49108eb Compare January 28, 2025 13:02

jeanPerier approved these changes Jan 28, 2025

View reviewed changes

jeanPerier merged commit 5a34e6f into llvm:main Jan 29, 2025
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[flang] Implement CHDIR intrinsic #124280

[flang] Implement CHDIR intrinsic #124280

Uh oh!

JDPailleux commented Jan 24, 2025

Uh oh!

github-actions bot commented Jan 24, 2025

Uh oh!

llvmbot commented Jan 24, 2025 •

edited

Loading

Uh oh!

jeanPerier left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kkwli commented Jan 27, 2025

Uh oh!

tblah left a comment

Uh oh!

Uh oh!

tblah left a comment

Uh oh!

jeanPerier left a comment

Uh oh!

Uh oh!

jeanPerier left a comment

Uh oh!

JDPailleux commented Jan 29, 2025

Uh oh!

Uh oh!

github-actions bot commented Jan 29, 2025

Uh oh!

Uh oh!

[flang] Implement CHDIR intrinsic #124280

[flang] Implement CHDIR intrinsic #124280

Uh oh!

Conversation

JDPailleux commented Jan 24, 2025

Uh oh!

github-actions bot commented Jan 24, 2025

Uh oh!

llvmbot commented Jan 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeanPerier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kkwli commented Jan 27, 2025

Uh oh!

tblah left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tblah left a comment

Choose a reason for hiding this comment

Uh oh!

jeanPerier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jeanPerier left a comment

Choose a reason for hiding this comment

Uh oh!

JDPailleux commented Jan 29, 2025

Uh oh!

Uh oh!

github-actions bot commented Jan 29, 2025

Uh oh!

Uh oh!

llvmbot commented Jan 24, 2025 •

edited

Loading