Skip to content

Commit f65f830

Browse files
klauslerklausler
committed
[flang] runtime: fix output B/O/Z editing of "negative" values
B/O/Z integer output editing must not reflect any sign extension of scalar output values. Add more size-dependent OutputInteger I/O APIs and kind instantiations of EditIntegerOutput. Differential Revision: https://reviews.llvm.org/D111678
1 parent 6ee2aa1 commit f65f830

File tree

7 files changed

+113
-52
lines changed

7 files changed

+113
-52
lines changed

‎flang/include/flang/Common/uint128.h

+14-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
//
77
//===----------------------------------------------------------------------===//
88

9-
// Portable 128-bit unsigned integer arithmetic for use in impoverished
10-
// C++ implementations lacking __uint128_t.
9+
// Portable 128-bit integer arithmetic for use in impoverished C++
10+
// implementations lacking __uint128_t & __int128_t.
1111

1212
#ifndef FORTRAN_COMMON_UINT128_H_
1313
#define FORTRAN_COMMON_UINT128_H_
@@ -47,6 +47,18 @@ template <bool IS_SIGNED = false> class Int128 {
4747
constexpr Int128 &operator=(const Int128 &) = default;
4848
constexpr Int128 &operator=(Int128 &&) = default;
4949

50+
constexpr Int128(const Int128<!IS_SIGNED> &n)
51+
: low_{n.low()}, high_{n.high()} {}
52+
constexpr Int128(Int128<!IS_SIGNED> &&n) : low_{n.low()}, high_{n.high()} {}
53+
constexpr Int128 &operator=(const Int128<!IS_SIGNED> &n) {
54+
low_ = n.low();
55+
high_ = n.high();
56+
}
57+
constexpr Int128 &operator=(Int128<!IS_SIGNED> &&n) {
58+
low_ = n.low();
59+
high_ = n.high();
60+
}
61+
5062
constexpr Int128 operator+() const { return *this; }
5163
constexpr Int128 operator~() const { return {~high_, ~low_}; }
5264
constexpr Int128 operator-() const { return ~*this + 1; }

‎flang/include/flang/Runtime/io-api.h

+8-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
#ifndef FORTRAN_RUNTIME_IO_API_H_
1212
#define FORTRAN_RUNTIME_IO_API_H_
1313

14+
#include "flang/Common/uint128.h"
1415
#include "flang/Runtime/entry-names.h"
1516
#include "flang/Runtime/iostat.h"
1617
#include <cinttypes>
@@ -56,7 +57,7 @@ extern "C" {
5657
// These functions initiate data transfer statements (READ, WRITE, PRINT).
5758
// Example: PRINT *, 666 is implemented as the series of calls:
5859
// Cookie cookie{BeginExternalListOutput(DefaultUnit,__FILE__,__LINE__)};
59-
// OutputInteger64(cookie, 666);
60+
// OutputInteger32(cookie, 666);
6061
// EndIoStatement(cookie);
6162

6263
// Internal I/O initiation
@@ -225,7 +226,13 @@ bool IONAME(OutputUnformattedBlock)(
225226
bool IONAME(InputUnformattedBlock)(
226227
Cookie, char *, std::size_t, std::size_t elementBytes);
227228
// Formatted (including list directed) I/O data items
229+
bool IONAME(OutputInteger8)(Cookie, std::int8_t);
230+
bool IONAME(OutputInteger16)(Cookie, std::int16_t);
231+
bool IONAME(OutputInteger32)(Cookie, std::int32_t);
228232
bool IONAME(OutputInteger64)(Cookie, std::int64_t);
233+
#ifdef __SIZEOF_INT128__
234+
bool IONAME(OutputInteger128)(Cookie, common::int128_t);
235+
#endif
229236
bool IONAME(InputInteger)(Cookie, std::int64_t &, int kind = 8);
230237
bool IONAME(OutputReal32)(Cookie, float);
231238
bool IONAME(InputReal32)(Cookie, float &);

‎flang/runtime/descriptor-io.h

+17-25
Original file line numberDiff line numberDiff line change
@@ -42,22 +42,22 @@ inline A &ExtractElement(IoStatementState &io, const Descriptor &descriptor,
4242
// automatic repetition counts, like "10*3.14159", for list-directed and
4343
// NAMELIST array output.
4444

45-
template <typename A, Direction DIR>
45+
template <int KIND, Direction DIR>
4646
inline bool FormattedIntegerIO(
4747
IoStatementState &io, const Descriptor &descriptor) {
4848
std::size_t numElements{descriptor.Elements()};
4949
SubscriptValue subscripts[maxRank];
5050
descriptor.GetLowerBounds(subscripts);
51+
using IntType = CppTypeFor<TypeCategory::Integer, KIND>;
5152
for (std::size_t j{0}; j < numElements; ++j) {
5253
if (auto edit{io.GetNextDataEdit()}) {
53-
A &x{ExtractElement<A>(io, descriptor, subscripts)};
54+
IntType &x{ExtractElement<IntType>(io, descriptor, subscripts)};
5455
if constexpr (DIR == Direction::Output) {
55-
if (!EditIntegerOutput(io, *edit, static_cast<std::int64_t>(x))) {
56+
if (!EditIntegerOutput<KIND>(io, *edit, x)) {
5657
return false;
5758
}
5859
} else if (edit->descriptor != DataEdit::ListDirectedNullValue) {
59-
if (!EditIntegerInput(io, *edit, reinterpret_cast<void *>(&x),
60-
static_cast<int>(sizeof(A)))) {
60+
if (!EditIntegerInput(io, *edit, reinterpret_cast<void *>(&x), KIND)) {
6161
return false;
6262
}
6363
}
@@ -183,15 +183,16 @@ inline bool FormattedCharacterIO(
183183
return true;
184184
}
185185

186-
template <typename A, Direction DIR>
186+
template <int KIND, Direction DIR>
187187
inline bool FormattedLogicalIO(
188188
IoStatementState &io, const Descriptor &descriptor) {
189189
std::size_t numElements{descriptor.Elements()};
190190
SubscriptValue subscripts[maxRank];
191191
descriptor.GetLowerBounds(subscripts);
192192
auto *listOutput{io.get_if<ListDirectedStatementState<Direction::Output>>()};
193+
using IntType = CppTypeFor<TypeCategory::Integer, KIND>;
193194
for (std::size_t j{0}; j < numElements; ++j) {
194-
A &x{ExtractElement<A>(io, descriptor, subscripts)};
195+
IntType &x{ExtractElement<IntType>(io, descriptor, subscripts)};
195196
if (listOutput) {
196197
if (!ListDirectedLogicalOutput(io, *listOutput, x != 0)) {
197198
return false;
@@ -377,20 +378,15 @@ static bool DescriptorIO(IoStatementState &io, const Descriptor &descriptor) {
377378
case TypeCategory::Integer:
378379
switch (kind) {
379380
case 1:
380-
return FormattedIntegerIO<CppTypeFor<TypeCategory::Integer, 1>, DIR>(
381-
io, descriptor);
381+
return FormattedIntegerIO<1, DIR>(io, descriptor);
382382
case 2:
383-
return FormattedIntegerIO<CppTypeFor<TypeCategory::Integer, 2>, DIR>(
384-
io, descriptor);
383+
return FormattedIntegerIO<2, DIR>(io, descriptor);
385384
case 4:
386-
return FormattedIntegerIO<CppTypeFor<TypeCategory::Integer, 4>, DIR>(
387-
io, descriptor);
385+
return FormattedIntegerIO<4, DIR>(io, descriptor);
388386
case 8:
389-
return FormattedIntegerIO<CppTypeFor<TypeCategory::Integer, 8>, DIR>(
390-
io, descriptor);
387+
return FormattedIntegerIO<8, DIR>(io, descriptor);
391388
case 16:
392-
return FormattedIntegerIO<CppTypeFor<TypeCategory::Integer, 16>, DIR>(
393-
io, descriptor);
389+
return FormattedIntegerIO<16, DIR>(io, descriptor);
394390
default:
395391
handler.Crash(
396392
"DescriptorIO: Unimplemented INTEGER kind (%d) in descriptor",
@@ -452,17 +448,13 @@ static bool DescriptorIO(IoStatementState &io, const Descriptor &descriptor) {
452448
case TypeCategory::Logical:
453449
switch (kind) {
454450
case 1:
455-
return FormattedLogicalIO<CppTypeFor<TypeCategory::Integer, 1>, DIR>(
456-
io, descriptor);
451+
return FormattedLogicalIO<1, DIR>(io, descriptor);
457452
case 2:
458-
return FormattedLogicalIO<CppTypeFor<TypeCategory::Integer, 2>, DIR>(
459-
io, descriptor);
453+
return FormattedLogicalIO<2, DIR>(io, descriptor);
460454
case 4:
461-
return FormattedLogicalIO<CppTypeFor<TypeCategory::Integer, 4>, DIR>(
462-
io, descriptor);
455+
return FormattedLogicalIO<4, DIR>(io, descriptor);
463456
case 8:
464-
return FormattedLogicalIO<CppTypeFor<TypeCategory::Integer, 8>, DIR>(
465-
io, descriptor);
457+
return FormattedLogicalIO<8, DIR>(io, descriptor);
466458
default:
467459
handler.Crash(
468460
"DescriptorIO: Unimplemented LOGICAL kind (%d) in descriptor",

‎flang/runtime/edit-output.cpp

+22-17
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,27 @@
1212

1313
namespace Fortran::runtime::io {
1414

15-
template <typename INT, typename UINT>
16-
bool EditIntegerOutput(IoStatementState &io, const DataEdit &edit, INT n) {
17-
char buffer[130], *end = &buffer[sizeof buffer], *p = end;
18-
bool isNegative{false};
19-
if constexpr (std::is_same_v<INT, UINT>) {
20-
isNegative = (n >> (8 * sizeof(INT) - 1)) != 0;
21-
} else {
22-
isNegative = n < 0;
23-
}
24-
UINT un{static_cast<UINT>(isNegative ? -n : n)};
15+
template <int KIND>
16+
bool EditIntegerOutput(IoStatementState &io, const DataEdit &edit,
17+
common::HostSignedIntType<8 * KIND> n) {
18+
char buffer[130], *end{&buffer[sizeof buffer]}, *p{end};
19+
bool isNegative{n < 0};
20+
using Unsigned = common::HostUnsignedIntType<8 * KIND>;
21+
Unsigned un{static_cast<Unsigned>(n)};
2522
int signChars{0};
2623
switch (edit.descriptor) {
2724
case DataEdit::ListDirected:
2825
case 'G':
2926
case 'I':
27+
if (isNegative) {
28+
un = -n;
29+
}
3030
if (isNegative || (edit.modes.editingFlags & signPlus)) {
3131
signChars = 1; // '-' or '+'
3232
}
3333
while (un > 0) {
3434
auto quotient{un / 10u};
35-
*--p = '0' + static_cast<int>(un - UINT{10} * quotient);
35+
*--p = '0' + static_cast<int>(un - 10u * quotient);
3636
un = quotient;
3737
}
3838
break;
@@ -382,8 +382,7 @@ bool RealOutputEditing<binaryPrecision>::EditEXOutput(const DataEdit &) {
382382
"EX output editing is not yet implemented"); // TODO
383383
}
384384

385-
template <int binaryPrecision>
386-
bool RealOutputEditing<binaryPrecision>::Edit(const DataEdit &edit) {
385+
template <int KIND> bool RealOutputEditing<KIND>::Edit(const DataEdit &edit) {
387386
switch (edit.descriptor) {
388387
case 'D':
389388
return EditEorDOutput(edit);
@@ -398,7 +397,7 @@ bool RealOutputEditing<binaryPrecision>::Edit(const DataEdit &edit) {
398397
case 'B':
399398
case 'O':
400399
case 'Z':
401-
return EditIntegerOutput(io_, edit,
400+
return EditIntegerOutput<KIND>(io_, edit,
402401
decimal::BinaryFloatingPointNumber<binaryPrecision>{x_}.raw());
403402
case 'G':
404403
return Edit(EditForGOutput(edit));
@@ -503,10 +502,16 @@ bool EditDefaultCharacterOutput(IoStatementState &io, const DataEdit &edit,
503502
io.Emit(x, std::min(width, len));
504503
}
505504

506-
template bool EditIntegerOutput<std::int64_t, std::uint64_t>(
505+
template bool EditIntegerOutput<1>(
506+
IoStatementState &, const DataEdit &, std::int8_t);
507+
template bool EditIntegerOutput<2>(
508+
IoStatementState &, const DataEdit &, std::int16_t);
509+
template bool EditIntegerOutput<4>(
510+
IoStatementState &, const DataEdit &, std::int32_t);
511+
template bool EditIntegerOutput<8>(
507512
IoStatementState &, const DataEdit &, std::int64_t);
508-
template bool EditIntegerOutput<common::uint128_t, common::uint128_t>(
509-
IoStatementState &, const DataEdit &, common::uint128_t);
513+
template bool EditIntegerOutput<16>(
514+
IoStatementState &, const DataEdit &, common::int128_t);
510515

511516
template class RealOutputEditing<2>;
512517
template class RealOutputEditing<3>;

‎flang/runtime/edit-output.h

+12-5
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ namespace Fortran::runtime::io {
2929
// The DataEdit reference is const here (and elsewhere in this header) so that
3030
// one edit descriptor with a repeat factor may safely serve to edit
3131
// multiple elements of an array.
32-
template <typename INT = std::int64_t, typename UINT = std::uint64_t>
33-
bool EditIntegerOutput(IoStatementState &, const DataEdit &, INT);
32+
template <int KIND>
33+
bool EditIntegerOutput(
34+
IoStatementState &, const DataEdit &, common::HostSignedIntType<8 * KIND>);
3435

3536
// Encapsulates the state of a REAL output conversion.
3637
class RealOutputEditingBase {
@@ -98,10 +99,16 @@ bool ListDirectedDefaultCharacterOutput(IoStatementState &,
9899
bool EditDefaultCharacterOutput(
99100
IoStatementState &, const DataEdit &, const char *, std::size_t);
100101

101-
extern template bool EditIntegerOutput<std::int64_t, std::uint64_t>(
102+
extern template bool EditIntegerOutput<1>(
103+
IoStatementState &, const DataEdit &, std::int8_t);
104+
extern template bool EditIntegerOutput<2>(
105+
IoStatementState &, const DataEdit &, std::int16_t);
106+
extern template bool EditIntegerOutput<4>(
107+
IoStatementState &, const DataEdit &, std::int32_t);
108+
extern template bool EditIntegerOutput<8>(
102109
IoStatementState &, const DataEdit &, std::int64_t);
103-
extern template bool EditIntegerOutput<common::uint128_t, common::uint128_t>(
104-
IoStatementState &, const DataEdit &, common::uint128_t);
110+
extern template bool EditIntegerOutput<16>(
111+
IoStatementState &, const DataEdit &, common::int128_t);
105112

106113
extern template class RealOutputEditing<2>;
107114
extern template class RealOutputEditing<3>;

‎flang/runtime/io-api.cpp

+39-1
Original file line numberDiff line numberDiff line change
@@ -949,14 +949,52 @@ bool IONAME(InputUnformattedBlock)(
949949
return false;
950950
}
951951

952+
bool IONAME(OutputInteger8)(Cookie cookie, std::int8_t n) {
953+
cookie->CheckFormattedStmtType<Direction::Output>("OutputInteger8");
954+
StaticDescriptor staticDescriptor;
955+
Descriptor &descriptor{staticDescriptor.descriptor()};
956+
descriptor.Establish(
957+
TypeCategory::Integer, 1, reinterpret_cast<void *>(&n), 0);
958+
return descr::DescriptorIO<Direction::Output>(*cookie, descriptor);
959+
}
960+
961+
bool IONAME(OutputInteger16)(Cookie cookie, std::int16_t n) {
962+
cookie->CheckFormattedStmtType<Direction::Output>("OutputInteger16");
963+
StaticDescriptor staticDescriptor;
964+
Descriptor &descriptor{staticDescriptor.descriptor()};
965+
descriptor.Establish(
966+
TypeCategory::Integer, 2, reinterpret_cast<void *>(&n), 0);
967+
return descr::DescriptorIO<Direction::Output>(*cookie, descriptor);
968+
}
969+
970+
bool IONAME(OutputInteger32)(Cookie cookie, std::int32_t n) {
971+
cookie->CheckFormattedStmtType<Direction::Output>("OutputInteger32");
972+
StaticDescriptor staticDescriptor;
973+
Descriptor &descriptor{staticDescriptor.descriptor()};
974+
descriptor.Establish(
975+
TypeCategory::Integer, 4, reinterpret_cast<void *>(&n), 0);
976+
return descr::DescriptorIO<Direction::Output>(*cookie, descriptor);
977+
}
978+
952979
bool IONAME(OutputInteger64)(Cookie cookie, std::int64_t n) {
953980
cookie->CheckFormattedStmtType<Direction::Output>("OutputInteger64");
954981
StaticDescriptor staticDescriptor;
955982
Descriptor &descriptor{staticDescriptor.descriptor()};
956983
descriptor.Establish(
957-
TypeCategory::Integer, sizeof n, reinterpret_cast<void *>(&n), 0);
984+
TypeCategory::Integer, 8, reinterpret_cast<void *>(&n), 0);
985+
return descr::DescriptorIO<Direction::Output>(*cookie, descriptor);
986+
}
987+
988+
#ifdef __SIZEOF_INT128__
989+
bool IONAME(OutputInteger128)(Cookie cookie, common::int128_t n) {
990+
cookie->CheckFormattedStmtType<Direction::Output>("OutputInteger128");
991+
StaticDescriptor staticDescriptor;
992+
Descriptor &descriptor{staticDescriptor.descriptor()};
993+
descriptor.Establish(
994+
TypeCategory::Integer, 16, reinterpret_cast<void *>(&n), 0);
958995
return descr::DescriptorIO<Direction::Output>(*cookie, descriptor);
959996
}
997+
#endif
960998

961999
bool IONAME(InputInteger)(Cookie cookie, std::int64_t &n, int kind) {
9621000
cookie->CheckFormattedStmtType<Direction::Input>("InputInteger");

‎flang/unittests/Runtime/NumericalFormatTest.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ TEST(IOApiTests, HelloWorldOutputTest) {
6666
// Write string, integer, and logical values to buffer
6767
IONAME(OutputAscii)(cookie, "WORLD", 5);
6868
IONAME(OutputInteger64)(cookie, 678);
69-
IONAME(OutputInteger64)(cookie, 0xfeedface);
69+
IONAME(OutputInteger32)(cookie, 0xfeedface);
7070
IONAME(OutputLogical)(cookie, true);
7171

7272
// Ensure IO succeeded

0 commit comments

Comments
 (0)