1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
//===-- runtime/random.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
//
//===----------------------------------------------------------------------===//
// Implements the intrinsic subroutines RANDOM_INIT, RANDOM_NUMBER, and
// RANDOM_SEED.
#include "flang/Runtime/random.h"
#include "lock.h"
#include "flang/Common/leading-zero-bit-count.h"
#include "flang/Common/uint128.h"
#include "flang/Runtime/cpp-type.h"
#include "flang/Runtime/descriptor.h"
#include <algorithm>
#include <cmath>
#include <cstdint>
#include <ctime>
#include <limits>
#include <memory>
#include <random>
namespace Fortran::runtime {
// Newer "Minimum standard", recommended by Park, Miller, and Stockmeyer in
// 1993. Same as C++17 std::minstd_rand, but explicitly instantiated for
// permanence.
using Generator =
std::linear_congruential_engine<std::uint_fast32_t, 48271, 0, 2147483647>;
using GeneratedWord = typename Generator::result_type;
static constexpr std::uint64_t range{
static_cast<std::uint64_t>(Generator::max() - Generator::min() + 1)};
static constexpr bool rangeIsPowerOfTwo{(range & (range - 1)) == 0};
static constexpr int rangeBits{
64 - common::LeadingZeroBitCount(range) - !rangeIsPowerOfTwo};
static Lock lock;
static Generator generator;
template <typename REAL, int PREC>
inline void Generate(const Descriptor &harvest) {
static constexpr std::size_t minBits{
std::max<std::size_t>(PREC, 8 * sizeof(GeneratedWord))};
using Int = common::HostUnsignedIntType<minBits>;
static constexpr std::size_t words{
static_cast<std::size_t>(PREC + rangeBits - 1) / rangeBits};
std::size_t elements{harvest.Elements()};
SubscriptValue at[maxRank];
harvest.GetLowerBounds(at);
{
CriticalSection critical{lock};
for (std::size_t j{0}; j < elements; ++j) {
Int fraction{generator()};
if constexpr (words > 1) {
for (std::size_t k{1}; k < words; ++k) {
static constexpr auto rangeMask{(GeneratedWord{1} << rangeBits) - 1};
GeneratedWord word{(generator() - generator.min()) & rangeMask};
fraction = (fraction << rangeBits) | word;
}
}
fraction >>= words * rangeBits - PREC;
*harvest.Element<REAL>(at) =
std::ldexp(static_cast<REAL>(fraction), -(PREC + 1));
harvest.IncrementSubscripts(at);
}
}
}
extern "C" {
void RTNAME(RandomInit)(bool repeatable, bool /*image_distinct*/) {
// TODO: multiple images and image_distinct: add image number
{
CriticalSection critical{lock};
if (repeatable) {
generator.seed(0);
} else {
generator.seed(std::time(nullptr));
}
}
}
void RTNAME(RandomNumber)(
const Descriptor &harvest, const char *source, int line) {
Terminator terminator{source, line};
auto typeCode{harvest.type().GetCategoryAndKind()};
RUNTIME_CHECK(terminator, typeCode && typeCode->first == TypeCategory::Real);
int kind{typeCode->second};
switch (kind) {
// TODO: REAL (2 & 3)
case 4:
Generate<CppTypeFor<TypeCategory::Real, 4>, 24>(harvest);
break;
case 8:
Generate<CppTypeFor<TypeCategory::Real, 8>, 53>(harvest);
break;
#if LONG_DOUBLE == 80
case 10:
Generate<CppTypeFor<TypeCategory::Real, 10>, 64>(harvest);
break;
#elif LONG_DOUBLE == 128
case 16:
Generate<CppTypeFor<TypeCategory::Real, 16>, 113>(harvest);
break;
#endif
default:
terminator.Crash("RANDOM_NUMBER(): unsupported REAL kind %d", kind);
}
}
void RTNAME(RandomSeedSize)(
const Descriptor &size, const char *source, int line) {
Terminator terminator{source, line};
auto typeCode{size.type().GetCategoryAndKind()};
RUNTIME_CHECK(terminator,
size.rank() == 0 && typeCode && typeCode->first == TypeCategory::Integer);
int kind{typeCode->second};
switch (kind) {
case 4:
*size.OffsetElement<CppTypeFor<TypeCategory::Integer, 4>>() = 1;
break;
case 8:
*size.OffsetElement<CppTypeFor<TypeCategory::Integer, 8>>() = 1;
break;
default:
terminator.Crash("RANDOM_SEED(SIZE=): bad kind %d\n", kind);
}
}
void RTNAME(RandomSeedPut)(
const Descriptor &put, const char *source, int line) {
Terminator terminator{source, line};
auto typeCode{put.type().GetCategoryAndKind()};
RUNTIME_CHECK(terminator,
put.rank() == 1 && typeCode && typeCode->first == TypeCategory::Integer &&
put.GetDimension(0).Extent() >= 1);
int kind{typeCode->second};
GeneratedWord seed;
switch (kind) {
case 4:
seed = *put.OffsetElement<CppTypeFor<TypeCategory::Integer, 4>>();
break;
case 8:
seed = *put.OffsetElement<CppTypeFor<TypeCategory::Integer, 8>>();
break;
default:
terminator.Crash("RANDOM_SEED(PUT=): bad kind %d\n", kind);
}
{
CriticalSection critical{lock};
generator.seed(seed);
}
}
void RTNAME(RandomSeedDefaultPut)() {
// TODO: should this be time &/or image dependent?
{
CriticalSection critical{lock};
generator.seed(0);
}
}
void RTNAME(RandomSeedGet)(
const Descriptor &got, const char *source, int line) {
Terminator terminator{source, line};
auto typeCode{got.type().GetCategoryAndKind()};
RUNTIME_CHECK(terminator,
got.rank() == 1 && typeCode && typeCode->first == TypeCategory::Integer &&
got.GetDimension(0).Extent() >= 1);
int kind{typeCode->second};
GeneratedWord seed;
{
CriticalSection critical{lock};
seed = generator();
generator.seed(seed);
}
switch (kind) {
case 4:
*got.OffsetElement<CppTypeFor<TypeCategory::Integer, 4>>() = seed;
break;
case 8:
*got.OffsetElement<CppTypeFor<TypeCategory::Integer, 8>>() = seed;
break;
default:
terminator.Crash("RANDOM_SEED(GET=): bad kind %d\n", kind);
}
}
} // extern "C"
} // namespace Fortran::runtime
|