Skip to content

Commit 166192e

Browse files
committed
[flang] Add POSIX implementation for CPU_TIME
Add an implementation for CPU_TIME using the POSIX function clock_gettime. I think on most POSIX systems this will be included for free via <ctime>, which corresponds to "time.h" (YMMV, we can fix the code if the need arises). Detecting that clock_gettime is available is tricky. For instance, commit 827407a used the following incantation in f18-parse-demo.cpp: #if _POSIX_C_SOURCE >= 199309L && _POSIX_TIMERS > 0 && _POSIX_CPUTIME && \ defined CLOCK_PROCESS_CPUTIME_ID This doesn't work on my AArch64 Ubuntu system, which provides clock_gettime but doesn't define _POSIX_TIMERS. Since finding the right combination of macros requires infinite time, patience and access to sundry POSIX systems, we should probably try a different approach. This patch attempts to use SFINAE instead of the preprocessor to choose an implementation for CPU_TIME. We define a helper function template which helps us check if clock_gettime is available (and has the interface we expect). I hope the comments explain it well enough. This approach has the advantage that it keeps the detection of clock_gettime close to the code that uses it. An alternative would be to use CMake to check for the symbol (I personally haven't used this before so I don't know if there are any quirks). Differential Revision: https://reviews.llvm.org/D104020
1 parent f583029 commit 166192e

File tree

1 file changed

+53
-7
lines changed

1 file changed

+53
-7
lines changed

flang/runtime/time-intrinsic.cpp

+53-7
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,29 @@
1212

1313
#include <ctime>
1414

15-
namespace Fortran::runtime {
16-
extern "C" {
17-
1815
// CPU_TIME (Fortran 2018 16.9.57)
19-
double RTNAME(CpuTime)() {
20-
// This is part of the c++ standard, so it should at least exist everywhere.
21-
// It probably does not have the best resolution, so we prefer other
22-
// platform-specific alternatives if they exist.
16+
// We can use std::clock() from the <ctime> header as a fallback implementation
17+
// that should be available everywhere. This may not provide the best resolution
18+
// and is particularly troublesome on (some?) POSIX systems where CLOCKS_PER_SEC
19+
// is defined as 10^6 regardless of the actual precision of std::clock().
20+
// Therefore, we will usually prefer platform-specific alternatives when they
21+
// are available.
22+
//
23+
// We can use SFINAE to choose a platform-specific alternative. To do so, we
24+
// introduce a helper function template, whose overload set will contain only
25+
// implementations relying on interfaces which are actually available. Each
26+
// overload will have a dummy parameter whose type indicates whether or not it
27+
// should be preferred. Any other parameters required for SFINAE should have
28+
// default values provided.
29+
namespace {
30+
// Types for the dummy parameter indicating the priority of a given overload.
31+
// We will invoke our helper with an integer literal argument, so the overload
32+
// with the highest priority should have the type int.
33+
using fallback_implementation = double;
34+
using preferred_implementation = int;
35+
36+
// This is the fallback implementation, which should work everywhere.
37+
template <typename Unused = void> double getCpuTime(fallback_implementation) {
2338
std::clock_t timestamp{std::clock()};
2439
if (timestamp != std::clock_t{-1}) {
2540
return static_cast<double>(timestamp) / CLOCKS_PER_SEC;
@@ -28,5 +43,36 @@ double RTNAME(CpuTime)() {
2843
// Return some negative value to represent failure.
2944
return -1.0;
3045
}
46+
47+
// POSIX implementation using clock_gettime. This is only enabled if
48+
// clock_gettime is available.
49+
template <typename T = int, typename U = struct timespec>
50+
double getCpuTime(preferred_implementation,
51+
// We need some dummy parameters to pass to decltype(clock_gettime).
52+
T ClockId = 0, U *Timespec = nullptr,
53+
decltype(clock_gettime(ClockId, Timespec)) *Enabled = nullptr) {
54+
#if defined CLOCK_THREAD_CPUTIME_ID
55+
#define CLOCKID CLOCK_THREAD_CPUTIME_ID
56+
#elif defined CLOCK_PROCESS_CPUTIME_ID
57+
#define CLOCKID CLOCK_PROCESS_CPUTIME_ID
58+
#elif defined CLOCK_MONOTONIC
59+
#define CLOCKID CLOCK_MONOTONIC
60+
#else
61+
#define CLOCKID CLOCK_REALTIME
62+
#endif
63+
struct timespec tspec;
64+
if (clock_gettime(CLOCKID, &tspec) == 0) {
65+
return tspec.tv_nsec * 1.0e-9 + tspec.tv_sec;
66+
}
67+
68+
// Return some negative value to represent failure.
69+
return -1.0;
70+
}
71+
} // anonymous namespace
72+
73+
namespace Fortran::runtime {
74+
extern "C" {
75+
76+
double RTNAME(CpuTime)() { return getCpuTime(0); }
3177
} // extern "C"
3278
} // namespace Fortran::runtime

0 commit comments

Comments
 (0)