1 /*
2  * Copyright (C) 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_RUNTIME_RUNTIME_OPTIONS_H_
18 #define ART_RUNTIME_RUNTIME_OPTIONS_H_
19 
20 #include <cstdarg>
21 #include <cstdio>
22 #include <string>
23 #include <vector>
24 
25 #include "arch/instruction_set.h"
26 #include "base/variant_map.h"
27 #include "cmdline_types.h"  // TODO: don't need to include this file here
28 #include "gc/collector_type.h"
29 #include "gc/space/large_object_space.h"
30 #include "hidden_api.h"
31 #include "jit/jit.h"
32 #include "jit/jit_code_cache.h"
33 #include "jit/profile_saver_options.h"
34 #include "verifier/verifier_enums.h"
35 
36 namespace art {
37 
38 class CompilerCallbacks;
39 class DexFile;
40 struct XGcOption;
41 struct BackgroundGcOption;
42 
43 #define DECLARE_KEY(Type, Name) static const Key<Type> Name
44 
45 // Define a key that is usable with a RuntimeArgumentMap.
46 // This key will *not* work with other subtypes of VariantMap.
47 template <typename TValue>
48 struct RuntimeArgumentMapKey : VariantMapKey<TValue> {
RuntimeArgumentMapKeyRuntimeArgumentMapKey49   RuntimeArgumentMapKey() {}
RuntimeArgumentMapKeyRuntimeArgumentMapKey50   explicit RuntimeArgumentMapKey(TValue default_value)
51     : VariantMapKey<TValue>(std::move(default_value)) {}
52   // Don't ODR-use constexpr default values, which means that Struct::Fields
53   // that are declared 'static constexpr T Name = Value' don't need to have a matching definition.
54 };
55 
56 // Defines a type-safe heterogeneous key->value map.
57 // Use the VariantMap interface to look up or to store a RuntimeArgumentMapKey,Value pair.
58 //
59 // Example:
60 //    auto map = RuntimeArgumentMap();
61 //    map.Set(RuntimeArgumentMap::HeapTargetUtilization, 5.0);
62 //    double *target_utilization = map.Get(RuntimeArgumentMap);
63 //
64 struct RuntimeArgumentMap : VariantMap<RuntimeArgumentMap, RuntimeArgumentMapKey> {
65   // This 'using' line is necessary to inherit the variadic constructor.
66   using VariantMap<RuntimeArgumentMap, RuntimeArgumentMapKey>::VariantMap;
67 
68   // Make the next many usages of Key slightly shorter to type.
69   template <typename TValue>
70   using Key = RuntimeArgumentMapKey<TValue>;
71 
72   // List of key declarations, shorthand for 'static const Key<T> Name'
73 #define RUNTIME_OPTIONS_KEY(Type, Name, ...) static const Key<Type> (Name);
74 #include "runtime_options.def"
75 };
76 
77 #undef DECLARE_KEY
78 
79   // using RuntimeOptions = RuntimeArgumentMap;
80 }  // namespace art
81 
82 #endif  // ART_RUNTIME_RUNTIME_OPTIONS_H_
83