Files
carbon-lang/toolchain/base/relational_value_store.h
T
Dana Jansens c64117d0e0 Make IdTag typesafe (#6574)
The IdTag knows the type of the Id its tagging and the type of the Id
being used as the tag. This prevents mixing up tagged and untagged ids,
and avoids having to work with untyped integers.

Adds an Untagged marker struct that's used as the tag type in IdTag when
no tag is desired.

The complexity of ConstantIds and TypeIds became a bit visible: TypeIds
are concrete ConstantIds. And ConstantIds have two different tagging
schemes, one for concrete and one for symbolic ids. And ConstantIds are
actually re-cast InstIds with the same index. The LoweredTypeStore needs
to work with tagged TypeIds, but the tags actually come from an InstId
store in ConstantValueStore. Now this is expressed in the type system by
getting the tags for TypeIds from the ConstantValueStore.

ValueStores without an TagId type parameter are now visibly untagged.

IdTag is now only default constructible when it does not have a tag,
which means ValueStore is only default constructible when the TagId is
untagged. This forces tagged value stores to be constructed correctly
with a tag at compile time, and untagged ones to be constructed without.

FixedSizeValueStore has overloads for dealing with tagged and untagged
Ids, since it can't default-construct ValueStore for tagged ids, and no
longer requires passing in default-constructed tags when there is no tag
in the ids.
2026-01-13 22:44:38 +00:00

86 lines
3.3 KiB
C++

// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#ifndef CARBON_TOOLCHAIN_BASE_RELATIONAL_VALUE_STORE_H_
#define CARBON_TOOLCHAIN_BASE_RELATIONAL_VALUE_STORE_H_
#include <optional>
#include "common/check.h"
#include "toolchain/base/value_store.h"
#include "toolchain/base/value_store_types.h"
namespace Carbon {
// A ValueStore that builds a 1:1 relationship between two IDs.
// * `RelatedStoreT` represents a related ValueStore with ids that can be used
// to find values in this store.
// * `IdT` is the actual ID of values in this store, and `IdT::ValueType` is the
// value type being stored.
//
// The value store builds a mapping so that either ID can be used later to find
// a value. And the user can query if a related `RelatedStoreT::IdType` has been
// used to add a value to the store or not.
//
// When adding to the store, the user provides the related
// `RelatedStoreT::IdType` along with the value being stored, and gets back the
// ID of the value in the store.
//
// This store requires more storage space than normal ValueStore does, as it
// requires storing a bit for presence of each `RelatedStore::IdType`. And it
// allocates memory for values for all IDs up largest ID present in the store,
// even if they are not yet used.
template <typename RelatedStoreT, typename IdT, typename ValueT>
class RelationalValueStore {
public:
using RelatedIdType = RelatedStoreT::IdType;
using RelatedIdTagType = RelatedStoreT::IdTagType;
using RelatedTagIdType = RelatedIdTagType::TagIdType;
using ValueType = ValueStoreTypes<ValueT>::ValueType;
using ConstRefType = ValueStoreTypes<ValueT>::ConstRefType;
explicit RelationalValueStore(const RelatedStoreT* related_store)
: values_(related_store->GetIdTag()), related_store_(related_store) {}
// Given the related ID and a value, stores the value and returns a mapped ID
// to reference it in the store.
auto Add(RelatedIdType related_id, ValueType value) -> IdT {
auto related_index = related_store_->GetRawIndex(related_id);
values_.Resize(related_index + 1, std::nullopt);
auto& opt = values_.Get(related_id);
CARBON_CHECK(!opt.has_value(),
"Add with `related_id` that was already added to the store");
opt.emplace(std::move(value));
return IdT(related_store_->GetIdTag().Apply(related_index).index);
}
// Returns the ID of a value in the store if the `related_id` was previously
// used to add a value to the store, or None.
auto TryGetId(RelatedIdType related_id) const -> IdT {
auto related_index = related_store_->GetRawIndex(related_id);
if (static_cast<size_t>(related_index) >= values_.size()) {
return IdT::None;
}
auto& opt = values_.Get(related_id);
if (!opt.has_value()) {
return IdT::None;
}
return IdT(related_store_->GetIdTag().Apply(related_index).index);
}
// Returns a value for an ID.
auto Get(IdT id) const -> ConstRefType {
return *values_.Get(RelatedIdType(id.index));
}
private:
ValueStore<RelatedIdType, std::optional<ValueType>, Tag<RelatedTagIdType>>
values_;
const RelatedStoreT* related_store_;
};
} // namespace Carbon
#endif // CARBON_TOOLCHAIN_BASE_RELATIONAL_VALUE_STORE_H_