Skip to content

[ntuple] Rename kTypeDAOS to kTypeObject64 and kTypeS3 to kTypeMulti #22434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jblomer merged 1 commit into from
Jun 5, 2026
Merged

[ntuple] Rename kTypeDAOS to kTypeObject64 and kTypeS3 to kTypeMulti #22434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions tree/ntuple/inc/ROOT/RNTupleTypes.hxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,8 +234,9 @@ public:
// The kTypeFile locator may translate to an on-disk standard locator (type 0x00) or a large locator (type 0x01),
// if the size of the referenced data block is >2GB
kTypeFile = 0x00,
kTypeDAOS = 0x02,
kTypeS3 = 0x03,
// The following locators are experimental and are not defined in the binary format specification.
kTypeObject64 = 0x02,
Comment thread
JasMehta08 marked this conversation as resolved.
kTypeMulti = 0x03,

kLastSerializableType = 0x7f,
kTypePageZero = kLastSerializableType + 1,
Expand All @@ -249,7 +250,7 @@ private:
static constexpr std::uint64_t kMaskType = 0x07ULL << 61;
static constexpr std::uint64_t kMaskReservedBit = 1ull << 60;

/// To save memory, we use the most significant bits to store the locator type (file, DAOS, zero page,
/// To save memory, we use the most significant bits to store the locator type (file, Object64, zero page,
Comment thread
jblomer marked this conversation as resolved.
/// unkown, kTestLocatorType) as well as one "reserved bit" that can be used in future locators.
/// Consequently, we can only store sizes up to 60 bits (1 EB), which in practice won't be an issue.
std::uint64_t fFlagsAndNBytes = 0;
Expand All @@ -276,7 +277,7 @@ public:
void SetType(ELocatorType type);
void SetReserved(std::uint8_t reserved);

/// Note that for GetPosition() / SetPosition(), the locator type must correspond (kTypeFile, kTypeDAOS).
/// Note that for GetPosition() / SetPosition(), the locator type must correspond (kTypeFile, kTypeObject64).

template <typename T>
T GetPosition() const
Expand Down
10 changes: 5 additions & 5 deletions tree/ntuple/src/RNTupleSerialize.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1086,19 +1086,19 @@
size += SerializeLocatorPayloadLarge(locator, payloadp);
locatorType = 0x01;
break;
case RNTupleLocator::kTypeDAOS:
case RNTupleLocator::kTypeObject64:
size += SerializeLocatorPayloadObject64(locator, payloadp);
locatorType = 0x02;
break;
case RNTupleLocator::kTypeS3:
case RNTupleLocator::kTypeMulti:
size += SerializeLocatorPayloadObject64(locator, payloadp);
Comment thread
jblomer marked this conversation as resolved.
locatorType = 0x03;
break;
default:
if (locator.GetType() == ROOT::Internal::kTestLocatorType) {
// For the testing locator, use the same payload format as Object64. We won't read it back anyway.
RNTupleLocator dummy;
dummy.SetType(RNTupleLocator::kTypeDAOS);
dummy.SetType(RNTupleLocator::kTypeObject64);
size += SerializeLocatorPayloadObject64(dummy, payloadp);
locatorType = 0x7e;
} else {
Expand Down Expand Up @@ -1139,11 +1139,11 @@
DeserializeLocatorPayloadLarge(bytes, locator);
break;
case 0x02:
locator.SetType(RNTupleLocator::kTypeDAOS);
locator.SetType(RNTupleLocator::kTypeObject64);
DeserializeLocatorPayloadObject64(bytes, payloadSize, locator);
break;
case 0x03:
locator.SetType(RNTupleLocator::kTypeS3);
locator.SetType(RNTupleLocator::kTypeMulti);
DeserializeLocatorPayloadObject64(bytes, payloadSize, locator);
break;
default: locator.SetType(RNTupleLocator::kTypeUnknown);
Expand Down Expand Up @@ -1879,7 +1879,7 @@
continue;
// NOTE: this assumes all valid feature flags are consecutive, thus we can just check the highest one set.
unsigned int highestBitSet = 64 * i + (63 - ROOT::Internal::LeadingZeroes(featureFlags[i]));
if (highestBitSet >= ROOT::RNTupleDescriptor::kFeatureFlag_COUNT)

Check warning on line 1882 in tree/ntuple/src/RNTupleSerialize.cxx

View workflow job for this annotation

GitHub Actions / alma8 

comparison of unsigned expression >= 0 is always true [-Wtype-limits]
return R__FAIL("unsupported format feature: " + std::to_string(highestBitSet));
}
return ROOT::RResult<void>::Success();
Expand Down
20 changes: 10 additions & 10 deletions tree/ntuple/src/RNTupleTypes.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ ROOT::RNTupleLocator::ELocatorType ROOT::RNTupleLocator::GetType() const
std::uint64_t compactType = fFlagsAndNBytes >> 61;
switch (compactType) {
case 0: return kTypeFile;
case 1: return kTypeDAOS;
case 2: return kTypePageZero;
case 3: return kTypeUnknown;
case 4: return kTypeS3;
case 1: return kTypeObject64;
case 2: return kTypeMulti;
case 3: return kTypePageZero;
case 4: return kTypeUnknown;
case 5: return Internal::kTestLocatorType;
default: break;
}
Expand All @@ -57,10 +57,10 @@ void ROOT::RNTupleLocator::SetType(ELocatorType type)
std::uint64_t compactType;
switch (type) {
case kTypeFile: compactType = 0; break;
case kTypeDAOS: compactType = 1; break;
case kTypePageZero: compactType = 2; break;
case kTypeUnknown: compactType = 3; break;
case kTypeS3: compactType = 4; break;
case kTypeObject64: compactType = 1; break;
case kTypeMulti: compactType = 2; break;
case kTypePageZero: compactType = 3; break;
case kTypeUnknown: compactType = 4; break;
default:
if (type == Internal::kTestLocatorType)
compactType = 5;
Expand All @@ -80,7 +80,7 @@ void ROOT::RNTupleLocator::SetPosition(std::uint64_t position)

void ROOT::RNTupleLocator::SetPosition(RNTupleLocatorObject64 position)
{
if (GetType() != kTypeDAOS && GetType() != kTypeS3)
if (GetType() != kTypeObject64 && GetType() != kTypeMulti)
throw RException(R__FAIL("cannot set position as 64bit object for type " + std::to_string(GetType())));
fPosition = position.GetLocation();
}
Expand All @@ -95,7 +95,7 @@ std::uint64_t ROOT::Internal::RNTupleLocatorHelper<std::uint64_t>::Get(const RNT
ROOT::RNTupleLocatorObject64
ROOT::Internal::RNTupleLocatorHelper<ROOT::RNTupleLocatorObject64>::Get(const RNTupleLocator &loc)
{
if (loc.GetType() != ROOT::RNTupleLocator::kTypeDAOS && loc.GetType() != ROOT::RNTupleLocator::kTypeS3)
if (loc.GetType() != ROOT::RNTupleLocator::kTypeObject64 && loc.GetType() != ROOT::RNTupleLocator::kTypeMulti)
throw RException(R__FAIL("cannot retrieve position as 64bit object for type " + std::to_string(loc.GetType())));
return RNTupleLocatorObject64{loc.fPosition};
}
6 changes: 3 additions & 3 deletions tree/ntuple/src/RPageStorageDaos.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ ROOT::Experimental::Internal::RPageSinkDaos::CommitSealedPageImpl(ROOT::Descript
}

RNTupleLocator result;
result.SetType(RNTupleLocator::kTypeDAOS);
result.SetType(RNTupleLocator::kTypeObject64);
result.SetNBytesOnStorage(sealedPage.GetDataSize());
result.SetPosition(ROOT::RNTupleLocatorObject64{pageId});
fCounters->fNPageCommitted.Inc();
Expand Down Expand Up @@ -341,7 +341,7 @@ ROOT::Experimental::Internal::RPageSinkDaos::CommitSealedPageVImpl(std::span<RPa
it->second.Insert(daosKey.fAkey, pageIov);

RNTupleLocator locator;
locator.SetType(RNTupleLocator::kTypeDAOS);
locator.SetType(RNTupleLocator::kTypeObject64);
locator.SetNBytesOnStorage(s.GetDataSize());
locator.SetPosition(ROOT::RNTupleLocatorObject64{pageId});
locators.push_back(locator);
Expand Down Expand Up @@ -382,7 +382,7 @@ ROOT::Experimental::Internal::RPageSinkDaos::CommitClusterGroupImpl(unsigned cha
daos_obj_id_t{kOidLowPageList, static_cast<decltype(daos_obj_id_t::hi)>(fNTupleIndex)}, kDistributionKeyDefault,
offsetData, kCidMetadata);
RNTupleLocator result;
result.SetType(RNTupleLocator::kTypeDAOS);
result.SetType(RNTupleLocator::kTypeObject64);
result.SetNBytesOnStorage(szPageListZip);
result.SetPosition(RNTupleLocatorObject64{offsetData});
fCounters->fSzWritePayload.Add(static_cast<int64_t>(szPageListZip));
Expand Down
16 changes: 8 additions & 8 deletions tree/ntuple/test/ntuple_serialize.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,14 +377,14 @@ TEST(RNTuple, SerializeLocator)
EXPECT_EQ(1u, locator.GetPosition<std::uint64_t>());
EXPECT_EQ(RNTupleLocator::kTypeFile, locator.GetType());

locator.SetType(RNTupleLocator::kTypeDAOS);
locator.SetType(RNTupleLocator::kTypeObject64);
locator.SetPosition(RNTupleLocatorObject64{1337U});
locator.SetNBytesOnStorage(420420U);
locator.SetReserved(0);
EXPECT_EQ(16u, RNTupleSerializer::SerializeLocator(locator, buffer).Unwrap());
locator = RNTupleLocator{};
EXPECT_EQ(16u, RNTupleSerializer::DeserializeLocator(buffer, 16, locator).Unwrap());
EXPECT_EQ(locator.GetType(), RNTupleLocator::kTypeDAOS);
EXPECT_EQ(locator.GetType(), RNTupleLocator::kTypeObject64);
EXPECT_EQ(locator.GetNBytesOnStorage(), 420420U);
EXPECT_EQ(locator.GetReserved(), 0);
EXPECT_EQ(1337U, locator.GetPosition<RNTupleLocatorObject64>().GetLocation());
Expand All @@ -394,32 +394,32 @@ TEST(RNTuple, SerializeLocator)
EXPECT_EQ(20u, RNTupleSerializer::SerializeLocator(locator, buffer).Unwrap());
locator = RNTupleLocator{};
EXPECT_EQ(20u, RNTupleSerializer::DeserializeLocator(buffer, 20, locator).Unwrap());
EXPECT_EQ(locator.GetType(), RNTupleLocator::kTypeDAOS);
EXPECT_EQ(locator.GetType(), RNTupleLocator::kTypeObject64);
EXPECT_EQ(locator.GetNBytesOnStorage(), static_cast<std::uint64_t>(std::numeric_limits<std::uint32_t>::max()) + 1);
EXPECT_EQ(locator.GetReserved(), 1);
EXPECT_EQ(1337U, locator.GetPosition<RNTupleLocatorObject64>().GetLocation());

// S3 locator round-trip with 32-bit nBytesOnStorage
// Multi locator round-trip with 32-bit nBytesOnStorage
locator = RNTupleLocator{};
locator.SetType(RNTupleLocator::kTypeS3);
locator.SetType(RNTupleLocator::kTypeMulti);
locator.SetPosition(RNTupleLocatorObject64{42U});
locator.SetNBytesOnStorage(1024U);
locator.SetReserved(0);
EXPECT_EQ(16u, RNTupleSerializer::SerializeLocator(locator, buffer).Unwrap());
locator = RNTupleLocator{};
EXPECT_EQ(16u, RNTupleSerializer::DeserializeLocator(buffer, 16, locator).Unwrap());
EXPECT_EQ(locator.GetType(), RNTupleLocator::kTypeS3);
EXPECT_EQ(locator.GetType(), RNTupleLocator::kTypeMulti);
EXPECT_EQ(locator.GetNBytesOnStorage(), 1024U);
EXPECT_EQ(locator.GetReserved(), 0);
EXPECT_EQ(42U, locator.GetPosition<RNTupleLocatorObject64>().GetLocation());

// S3 locator round-trip with 64-bit nBytesOnStorage and reserved bit
// Multi locator round-trip with 64-bit nBytesOnStorage and reserved bit
locator.SetNBytesOnStorage(static_cast<std::uint64_t>(std::numeric_limits<std::uint32_t>::max()) + 1);
locator.SetReserved(1);
EXPECT_EQ(20u, RNTupleSerializer::SerializeLocator(locator, buffer).Unwrap());
locator = RNTupleLocator{};
EXPECT_EQ(20u, RNTupleSerializer::DeserializeLocator(buffer, 20, locator).Unwrap());
EXPECT_EQ(locator.GetType(), RNTupleLocator::kTypeS3);
EXPECT_EQ(locator.GetType(), RNTupleLocator::kTypeMulti);
EXPECT_EQ(locator.GetNBytesOnStorage(), static_cast<std::uint64_t>(std::numeric_limits<std::uint32_t>::max()) + 1);
EXPECT_EQ(locator.GetReserved(), 1);
EXPECT_EQ(42U, locator.GetPosition<RNTupleLocatorObject64>().GetLocation());
Expand Down
Loading