cannam@149: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors cannam@149: // Licensed under the MIT License: cannam@149: // cannam@149: // Permission is hereby granted, free of charge, to any person obtaining a copy cannam@149: // of this software and associated documentation files (the "Software"), to deal cannam@149: // in the Software without restriction, including without limitation the rights cannam@149: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell cannam@149: // copies of the Software, and to permit persons to whom the Software is cannam@149: // furnished to do so, subject to the following conditions: cannam@149: // cannam@149: // The above copyright notice and this permission notice shall be included in cannam@149: // all copies or substantial portions of the Software. cannam@149: // cannam@149: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR cannam@149: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, cannam@149: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE cannam@149: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER cannam@149: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, cannam@149: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN cannam@149: // THE SOFTWARE. cannam@149: cannam@149: #ifndef CAPNP_RAW_SCHEMA_H_ cannam@149: #define CAPNP_RAW_SCHEMA_H_ cannam@149: cannam@149: #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS) cannam@149: #pragma GCC system_header cannam@149: #endif cannam@149: cannam@149: #include "common.h" // for uint and friends cannam@149: cannam@149: #if _MSC_VER cannam@149: #include cannam@149: #endif cannam@149: cannam@149: namespace capnp { cannam@149: namespace _ { // private cannam@149: cannam@149: struct RawSchema; cannam@149: cannam@149: struct RawBrandedSchema { cannam@149: // Represents a combination of a schema and bindings for its generic parameters. cannam@149: // cannam@149: // Note that while we generate one `RawSchema` per type, we generate a `RawBrandedSchema` for cannam@149: // every _instance_ of a generic type -- or, at least, every instance that is actually used. For cannam@149: // generated-code types, we use template magic to initialize these. cannam@149: cannam@149: const RawSchema* generic; cannam@149: // Generic type which we're branding. cannam@149: cannam@149: struct Binding { cannam@149: uint8_t which; // Numeric value of one of schema::Type::Which. cannam@149: cannam@149: bool isImplicitParameter; cannam@149: // For AnyPointer, true if it's an implicit method parameter. cannam@149: cannam@149: uint16_t listDepth; // Number of times to wrap the base type in List(). cannam@149: cannam@149: uint16_t paramIndex; cannam@149: // For AnyPointer. If it's a type parameter (scopeId is non-zero) or it's an implicit parameter cannam@149: // (isImplicitParameter is true), then this is the parameter index. Otherwise this is a numeric cannam@149: // value of one of schema::Type::AnyPointer::Unconstrained::Which. cannam@149: cannam@149: union { cannam@149: const RawBrandedSchema* schema; // for struct, enum, interface cannam@149: uint64_t scopeId; // for AnyPointer, if it's a type parameter cannam@149: }; cannam@149: cannam@149: Binding() = default; cannam@149: inline constexpr Binding(uint8_t which, uint16_t listDepth, const RawBrandedSchema* schema) cannam@149: : which(which), isImplicitParameter(false), listDepth(listDepth), paramIndex(0), cannam@149: schema(schema) {} cannam@149: inline constexpr Binding(uint8_t which, uint16_t listDepth, cannam@149: uint64_t scopeId, uint16_t paramIndex) cannam@149: : which(which), isImplicitParameter(false), listDepth(listDepth), paramIndex(paramIndex), cannam@149: scopeId(scopeId) {} cannam@149: inline constexpr Binding(uint8_t which, uint16_t listDepth, uint16_t implicitParamIndex) cannam@149: : which(which), isImplicitParameter(true), listDepth(listDepth), cannam@149: paramIndex(implicitParamIndex), scopeId(0) {} cannam@149: }; cannam@149: cannam@149: struct Scope { cannam@149: uint64_t typeId; cannam@149: // Type ID whose parameters are being bound. cannam@149: cannam@149: const Binding* bindings; cannam@149: uint bindingCount; cannam@149: // Bindings for those parameters. cannam@149: cannam@149: bool isUnbound; cannam@149: // This scope is unbound, in the sense of SchemaLoader::getUnbound(). cannam@149: }; cannam@149: cannam@149: const Scope* scopes; cannam@149: // Array of enclosing scopes for which generic variables have been bound, sorted by type ID. cannam@149: cannam@149: struct Dependency { cannam@149: uint location; cannam@149: const RawBrandedSchema* schema; cannam@149: }; cannam@149: cannam@149: const Dependency* dependencies; cannam@149: // Map of branded schemas for dependencies of this type, given our brand. Only dependencies that cannam@149: // are branded are included in this map; if a dependency is missing, use its `defaultBrand`. cannam@149: cannam@149: uint32_t scopeCount; cannam@149: uint32_t dependencyCount; cannam@149: cannam@149: enum class DepKind { cannam@149: // Component of a Dependency::location. Specifies what sort of dependency this is. cannam@149: cannam@149: INVALID, cannam@149: // Mostly defined to ensure that zero is not a valid location. cannam@149: cannam@149: FIELD, cannam@149: // Binding needed for a field's type. The index is the field index (NOT ordinal!). cannam@149: cannam@149: METHOD_PARAMS, cannam@149: // Bindings needed for a method's params type. The index is the method number. cannam@149: cannam@149: METHOD_RESULTS, cannam@149: // Bindings needed for a method's results type. The index is the method ordinal. cannam@149: cannam@149: SUPERCLASS, cannam@149: // Bindings needed for a superclass type. The index is the superclass's index in the cannam@149: // "extends" list. cannam@149: cannam@149: CONST_TYPE cannam@149: // Bindings needed for the type of a constant. The index is zero. cannam@149: }; cannam@149: cannam@149: static inline uint makeDepLocation(DepKind kind, uint index) { cannam@149: // Make a number representing the location of a particular dependency within its parent cannam@149: // schema. cannam@149: cannam@149: return (static_cast(kind) << 24) | index; cannam@149: } cannam@149: cannam@149: class Initializer { cannam@149: public: cannam@149: virtual void init(const RawBrandedSchema* generic) const = 0; cannam@149: }; cannam@149: cannam@149: const Initializer* lazyInitializer; cannam@149: // Lazy initializer, invoked by ensureInitialized(). cannam@149: cannam@149: inline void ensureInitialized() const { cannam@149: // Lazy initialization support. Invoke to ensure that initialization has taken place. This cannam@149: // is required in particular when traversing the dependency list. RawSchemas for compiled-in cannam@149: // types are always initialized; only dynamically-loaded schemas may be lazy. cannam@149: cannam@149: #if __GNUC__ cannam@149: const Initializer* i = __atomic_load_n(&lazyInitializer, __ATOMIC_ACQUIRE); cannam@149: #elif _MSC_VER cannam@149: const Initializer* i = *static_cast(&lazyInitializer); cannam@149: std::atomic_thread_fence(std::memory_order_acquire); cannam@149: #else cannam@149: #error "Platform not supported" cannam@149: #endif cannam@149: if (i != nullptr) i->init(this); cannam@149: } cannam@149: cannam@149: inline bool isUnbound() const; cannam@149: // Checks if this schema is the result of calling SchemaLoader::getUnbound(), in which case cannam@149: // binding lookups need to be handled specially. cannam@149: }; cannam@149: cannam@149: struct RawSchema { cannam@149: // The generated code defines a constant RawSchema for every compiled declaration. cannam@149: // cannam@149: // This is an internal structure which could change in the future. cannam@149: cannam@149: uint64_t id; cannam@149: cannam@149: const word* encodedNode; cannam@149: // Encoded SchemaNode, readable via readMessageUnchecked(encodedNode). cannam@149: cannam@149: uint32_t encodedSize; cannam@149: // Size of encodedNode, in words. cannam@149: cannam@149: const RawSchema* const* dependencies; cannam@149: // Pointers to other types on which this one depends, sorted by ID. The schemas in this table cannam@149: // may be uninitialized -- you must call ensureInitialized() on the one you wish to use before cannam@149: // using it. cannam@149: // cannam@149: // TODO(someday): Make this a hashtable. cannam@149: cannam@149: const uint16_t* membersByName; cannam@149: // Indexes of members sorted by name. Used to implement name lookup. cannam@149: // TODO(someday): Make this a hashtable. cannam@149: cannam@149: uint32_t dependencyCount; cannam@149: uint32_t memberCount; cannam@149: // Sizes of above tables. cannam@149: cannam@149: const uint16_t* membersByDiscriminant; cannam@149: // List of all member indexes ordered by discriminant value. Those which don't have a cannam@149: // discriminant value are listed at the end, in order by ordinal. cannam@149: cannam@149: const RawSchema* canCastTo; cannam@149: // Points to the RawSchema of a compiled-in type to which it is safe to cast any DynamicValue cannam@149: // with this schema. This is null for all compiled-in types; it is only set by SchemaLoader on cannam@149: // dynamically-loaded types. cannam@149: cannam@149: class Initializer { cannam@149: public: cannam@149: virtual void init(const RawSchema* schema) const = 0; cannam@149: }; cannam@149: cannam@149: const Initializer* lazyInitializer; cannam@149: // Lazy initializer, invoked by ensureInitialized(). cannam@149: cannam@149: inline void ensureInitialized() const { cannam@149: // Lazy initialization support. Invoke to ensure that initialization has taken place. This cannam@149: // is required in particular when traversing the dependency list. RawSchemas for compiled-in cannam@149: // types are always initialized; only dynamically-loaded schemas may be lazy. cannam@149: cannam@149: #if __GNUC__ cannam@149: const Initializer* i = __atomic_load_n(&lazyInitializer, __ATOMIC_ACQUIRE); cannam@149: #elif _MSC_VER cannam@149: const Initializer* i = *static_cast(&lazyInitializer); cannam@149: std::atomic_thread_fence(std::memory_order_acquire); cannam@149: #else cannam@149: #error "Platform not supported" cannam@149: #endif cannam@149: if (i != nullptr) i->init(this); cannam@149: } cannam@149: cannam@149: RawBrandedSchema defaultBrand; cannam@149: // Specifies the brand to use for this schema if no generic parameters have been bound to cannam@149: // anything. Generally, in the default brand, all generic parameters are treated as if they were cannam@149: // bound to `AnyPointer`. cannam@149: }; cannam@149: cannam@149: inline bool RawBrandedSchema::isUnbound() const { cannam@149: // The unbound schema is the only one that has no scopes but is not the default schema. cannam@149: return scopeCount == 0 && this != &generic->defaultBrand; cannam@149: } cannam@149: cannam@149: } // namespace _ (private) cannam@149: } // namespace capnp cannam@149: cannam@149: #endif // CAPNP_RAW_SCHEMA_H_