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 "base/variant_map.h"
21#include "cmdline_types.h"  // TODO: don't need to include this file here
22
23// Map keys
24#include <vector>
25#include <string>
26#include "base/logging.h"
27#include "jdwp/jdwp.h"
28#include "jit/jit.h"
29#include "jit/jit_code_cache.h"
30#include "gc/collector_type.h"
31#include "gc/space/large_object_space.h"
32#include "profiler_options.h"
33#include "arch/instruction_set.h"
34#include "verifier/verify_mode.h"
35#include <stdio.h>
36#include <stdarg.h>
37
38namespace art {
39
40class CompilerCallbacks;
41class DexFile;
42struct XGcOption;
43struct BackgroundGcOption;
44struct TestProfilerOptions;
45
46#define DECLARE_KEY(Type, Name) static const Key<Type> Name
47
48  // Define a key that is usable with a RuntimeArgumentMap.
49  // This key will *not* work with other subtypes of VariantMap.
50  template <typename TValue>
51  struct RuntimeArgumentMapKey : VariantMapKey<TValue> {
52    RuntimeArgumentMapKey() {}
53    explicit RuntimeArgumentMapKey(TValue default_value)
54      : VariantMapKey<TValue>(std::move(default_value)) {}
55    // Don't ODR-use constexpr default values, which means that Struct::Fields
56    // that are declared 'static constexpr T Name = Value' don't need to have a matching definition.
57  };
58
59  // Defines a type-safe heterogeneous key->value map.
60  // Use the VariantMap interface to look up or to store a RuntimeArgumentMapKey,Value pair.
61  //
62  // Example:
63  //    auto map = RuntimeArgumentMap();
64  //    map.Set(RuntimeArgumentMap::HeapTargetUtilization, 5.0);
65  //    double *target_utilization = map.Get(RuntimeArgumentMap);
66  //
67  struct RuntimeArgumentMap : VariantMap<RuntimeArgumentMap, RuntimeArgumentMapKey> {
68    // This 'using' line is necessary to inherit the variadic constructor.
69    using VariantMap<RuntimeArgumentMap, RuntimeArgumentMapKey>::VariantMap;
70
71    // Make the next many usages of Key slightly shorter to type.
72    template <typename TValue>
73    using Key = RuntimeArgumentMapKey<TValue>;
74
75    // List of key declarations, shorthand for 'static const Key<T> Name'
76#define RUNTIME_OPTIONS_KEY(Type, Name, ...) static const Key<Type> Name;
77#include "runtime_options.def"
78  };
79
80#undef DECLARE_KEY
81
82  // using RuntimeOptions = RuntimeArgumentMap;
83}  // namespace art
84
85#endif  // ART_RUNTIME_RUNTIME_OPTIONS_H_
86