Files
swift-mirror/stdlib/public/stubs/GlobalObjects.cpp
Mike Ash f2fb53967c [Runtime] Unify debug variable parsing from the environment and avoid getenv when possible.
There are a few environment variables used to enable debugging options in the
runtime, and we'll likely add more over time. These are implemented with
scattered getenv() calls at the point of use. This is inefficient, as most/all
OSes have to do a linear scan of the environment for each call. It's also not
discoverable, since the only way to find these variables is to inspect the
source.

This commit places all of these variables in a central location.
stdlib/public/runtime/EnvironmentVariables.def defines all of the debug
variables including their name, type, default value, and a help string. On OSes
which make an `environ` array available, the entire array is scanned in a single
pass the first time any debug variable is requested. By quickly rejecting
variables that do not start with `SWIFT_`, we optimize for the common case where
no debug variables are set. We also have a fallback to repeated `getenv()` calls
when a full scan is not possible.

Setting `SWIFT_HELP=YES` will print out all available debug variables along with
a brief description of what they do.
2020-06-04 10:00:06 -04:00

137 lines
4.7 KiB
C++

//===--- GlobalObjects.cpp - Statically-initialized objects ---------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// Objects that are allocated at global scope instead of on the heap,
// and statically initialized to avoid synchronization costs, are
// defined here.
//
//===----------------------------------------------------------------------===//
#include "../SwiftShims/GlobalObjects.h"
#include "../SwiftShims/Random.h"
#include "swift/Runtime/Metadata.h"
#include "swift/Runtime/Debug.h"
#include "swift/Runtime/EnvironmentVariables.h"
#include <stdlib.h>
namespace swift {
// FIXME(ABI)#76 : does this declaration need SWIFT_RUNTIME_STDLIB_API?
// _direct type metadata for Swift.__EmptyArrayStorage
SWIFT_RUNTIME_STDLIB_API
ClassMetadata CLASS_METADATA_SYM(s19__EmptyArrayStorage);
// _direct type metadata for Swift.__EmptyDictionarySingleton
SWIFT_RUNTIME_STDLIB_API
ClassMetadata CLASS_METADATA_SYM(s26__EmptyDictionarySingleton);
// _direct type metadata for Swift.__EmptySetSingleton
SWIFT_RUNTIME_STDLIB_API
ClassMetadata CLASS_METADATA_SYM(s19__EmptySetSingleton);
} // namespace swift
SWIFT_RUNTIME_STDLIB_API
swift::_SwiftEmptyArrayStorage swift::_swiftEmptyArrayStorage = {
// HeapObject header;
{
&swift::CLASS_METADATA_SYM(s19__EmptyArrayStorage), // isa pointer
InlineRefCounts::Immortal
},
// _SwiftArrayBodyStorage body;
{
0, // int count;
1 // unsigned int _capacityAndFlags; 1 means elementTypeIsBridgedVerbatim
}
};
SWIFT_RUNTIME_STDLIB_API
swift::_SwiftEmptyDictionarySingleton swift::_swiftEmptyDictionarySingleton = {
// HeapObject header;
{
&swift::CLASS_METADATA_SYM(s26__EmptyDictionarySingleton), // isa pointer
InlineRefCounts::Immortal
},
// _SwiftDictionaryBodyStorage body;
{
// Setting the scale to 0 makes for a bucketCount of 1 -- so that the
// storage consists of a single unoccupied bucket. The capacity is set to
// 0 so that any insertion will lead to real storage being allocated.
0, // int count;
0, // int capacity;
0, // int8 scale;
0, // int8 reservedScale;
0, // int16 extra;
0, // int32 age;
0, // int seed;
(void *)1, // void* keys; (non-null garbage)
(void *)1 // void* values; (non-null garbage)
},
// bucket 0 is unoccupied; other buckets are out-of-bounds
static_cast<__swift_uintptr_t>(~1) // int metadata;
};
SWIFT_RUNTIME_STDLIB_API
swift::_SwiftEmptySetSingleton swift::_swiftEmptySetSingleton = {
// HeapObject header;
{
&swift::CLASS_METADATA_SYM(s19__EmptySetSingleton), // isa pointer
InlineRefCounts::Immortal
},
// _SwiftSetBodyStorage body;
{
// Setting the scale to 0 makes for a bucketCount of 1 -- so that the
// storage consists of a single unoccupied bucket. The capacity is set to
// 0 so that any insertion will lead to real storage being allocated.
0, // int count;
0, // int capacity;
0, // int8 scale;
0, // int8 reservedScale;
0, // int16 extra;
0, // int32 age;
0, // int seed;
(void *)1, // void *rawElements; (non-null garbage)
},
// bucket 0 is unoccupied; other buckets are out-of-bounds
static_cast<__swift_uintptr_t>(~1) // int metadata;
};
static swift::_SwiftHashingParameters initializeHashingParameters() {
// Setting the environment variable SWIFT_DETERMINISTIC_HASHING to "1"
// disables randomized hash seeding. This is useful in cases we need to ensure
// results are repeatable, e.g., in certain test environments. (Note that
// even if the seed override is enabled, hash values aren't guaranteed to
// remain stable across even minor stdlib releases.)
if (swift::runtime::environment::SWIFT_DETERMINISTIC_HASHING()) {
return { 0, 0, true };
}
__swift_uint64_t seed0 = 0, seed1 = 0;
swift::swift_stdlib_random(&seed0, sizeof(seed0));
swift::swift_stdlib_random(&seed1, sizeof(seed1));
return { seed0, seed1, false };
}
SWIFT_ALLOWED_RUNTIME_GLOBAL_CTOR_BEGIN
swift::_SwiftHashingParameters swift::_swift_stdlib_Hashing_parameters =
initializeHashingParameters();
SWIFT_ALLOWED_RUNTIME_GLOBAL_CTOR_END
SWIFT_RUNTIME_STDLIB_API
void swift::_swift_instantiateInertHeapObject(void *address,
const HeapMetadata *metadata) {
::new (address) HeapObject{metadata};
}