-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
config.rs
336 lines (309 loc) · 11.2 KB
/
config.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
// Copyright (c) The Libra Core Contributors
// SPDX-License-Identifier: Apache-2.0
use crate::{
keys::{ConsensusKeyPair, NetworkKeyPairs},
seed_peers::SeedPeersConfigHelpers,
trusted_peers::{ConfigHelpers, ConsensusPrivateKey, NetworkPrivateKeys},
utils::get_available_port,
};
use failure::prelude::*;
use libra_tools::tempdir::TempPath;
use libra_types::{
transaction::{SignedTransaction, Transaction},
PeerId,
};
use prost::Message;
use serde::{de::DeserializeOwned, Deserialize, Serialize};
use std::{
convert::TryFrom,
fs::File,
io::{Read, Write},
path::{Path, PathBuf},
str::FromStr,
string::ToString,
};
use toml;
mod admission_control_config;
pub use admission_control_config::*;
mod consensus_config;
pub use consensus_config::*;
mod debug_interface_config;
pub use debug_interface_config::*;
mod execution_config;
pub use execution_config::*;
mod logger_config;
pub use logger_config::*;
mod metrics_config;
pub use metrics_config::*;
mod mempool_config;
pub use mempool_config::*;
mod network_config;
pub use network_config::*;
mod state_sync_config;
pub use state_sync_config::*;
mod storage_config;
pub use storage_config::*;
mod safety_rules_config;
pub use safety_rules_config::*;
mod vm_config;
pub use vm_config::*;
#[cfg(test)]
#[path = "unit_tests/config_test.rs"]
mod config_test;
// path is relative to this file location
static CONFIG_TEMPLATE: &[u8] = include_bytes!("../data/configs/node.config.toml");
/// Config pulls in configuration information from the config file.
/// This is used to set up the nodes and configure various parameters.
/// The config file is broken up into sections for each module
/// so that only that module can be passed around
#[cfg_attr(any(test, feature = "fuzzing"), derive(Clone))]
#[derive(Debug, Deserialize, PartialEq, Serialize)]
pub struct NodeConfig {
//TODO Add configuration for multiple chain's in a future diff
#[serde(default)]
pub base: BaseConfig,
#[serde(default)]
pub metrics: MetricsConfig,
#[serde(default)]
pub execution: ExecutionConfig,
#[serde(default)]
pub admission_control: AdmissionControlConfig,
#[serde(default)]
pub debug_interface: DebugInterfaceConfig,
#[serde(default)]
pub storage: StorageConfig,
#[serde(default)]
pub networks: Vec<NetworkConfig>,
#[serde(default)]
pub consensus: ConsensusConfig,
#[serde(default)]
pub mempool: MempoolConfig,
#[serde(default)]
pub state_sync: StateSyncConfig,
#[serde(default)]
pub logger: LoggerConfig,
#[serde(default)]
pub vm_config: VMConfig,
}
#[derive(Debug, Deserialize, PartialEq, Serialize)]
#[serde(default)]
pub struct BaseConfig {
pub data_dir_path: PathBuf,
#[serde(skip)]
temp_data_dir: Option<TempPath>,
}
impl Default for BaseConfig {
fn default() -> BaseConfig {
BaseConfig {
data_dir_path: PathBuf::from("."),
temp_data_dir: None,
}
}
}
impl BaseConfig {
/// Constructs a new BaseConfig with an empty temp directory
pub fn new(data_dir_path: PathBuf) -> Self {
BaseConfig {
data_dir_path,
temp_data_dir: None,
}
}
}
#[cfg(any(test, feature = "fuzzing"))]
impl Clone for BaseConfig {
fn clone(&self) -> Self {
Self {
data_dir_path: self.data_dir_path.clone(),
temp_data_dir: None,
}
}
}
impl NodeConfig {
/// Reads the config file and returns the configuration object in addition to doing some
/// post-processing of the config
/// Paths used in the config are either absolute or relative to the config location
pub fn load<P: AsRef<Path>>(path: P) -> Result<Self> {
let mut config = Self::load_config(&path);
let mut validator_count = 0;
for network in &mut config.networks {
// We use provided peer id for validator role. Otherwise peer id is generated using
// network identity key.
if network.role == RoleType::Validator {
assert_eq!(
validator_count, 0,
"At most 1 network config should be for a validator"
);
network.load(path.as_ref())?;
validator_count += 1;
} else {
network.load(path.as_ref())?;
}
}
config.consensus.load(path.as_ref())?;
Ok(config)
}
/// Returns true if the node config is for a validator. Otherwise returns false.
pub fn is_validator(&self) -> bool {
self.networks
.iter()
.any(|network| RoleType::Validator == network.role)
}
/// Returns true if the node config is for a validator. Otherwise returns false.
pub fn get_role(&self) -> RoleType {
if self.is_validator() {
RoleType::Validator
} else {
RoleType::FullNode
}
}
/// Returns the validator network config for this node.
pub fn get_validator_network_config(&self) -> Option<&NetworkConfig> {
self.networks
.iter()
.filter(|network| RoleType::Validator == network.role)
.last()
}
pub fn get_genesis_transaction_file(&self) -> PathBuf {
let path = &self.execution.genesis_file_location;
if path.is_relative() {
self.base.data_dir_path.join(path)
} else {
path.clone()
}
}
pub fn get_genesis_transaction(&self) -> Result<Transaction> {
let file_path = self.get_genesis_transaction_file();
let mut file: File = File::open(&file_path).unwrap_or_else(|err| {
panic!(
"Failed to open file: {:?}; error: {:?}",
file_path.clone(),
err
);
});
let mut buffer = vec![];
file.read_to_end(&mut buffer)?;
// TODO: update to use `Transaction::WriteSet` variant when ready.
Ok(Transaction::UserTransaction(SignedTransaction::try_from(
libra_types::proto::types::SignedTransaction::decode(&buffer)?,
)?))
}
pub fn get_storage_dir(&self) -> PathBuf {
let path = self.storage.dir.clone();
if path.is_relative() {
self.base.data_dir_path.join(path)
} else {
path
}
}
pub fn get_metrics_dir(&self) -> Option<PathBuf> {
let path = self.metrics.dir.as_path();
if path.as_os_str().is_empty() {
None
} else if path.is_relative() {
Some(self.base.data_dir_path.join(path))
} else {
Some(path.to_owned())
}
}
/// Returns true if network_config is for an upstream network
pub fn is_upstream_network(&self, network_config: &NetworkConfig) -> bool {
self.state_sync
.upstream_peers
.upstream_peers
.iter()
.any(|peer_id| network_config.network_peers.peers.contains_key(peer_id))
}
pub fn get_upstream_peer_ids(&self) -> Vec<PeerId> {
self.state_sync
.upstream_peers
.upstream_peers
.iter()
.map(|peer_id_str| {
(PeerId::from_str(peer_id_str).unwrap_or_else(|_| {
panic!("Failed to parse peer_id from string: {}", peer_id_str)
}))
})
.collect()
}
}
pub struct NodeConfigHelpers {}
impl NodeConfigHelpers {
/// Returns a simple test config for single node. It does not have correct network_peers_file,
/// consensus_peers_file, network_keypairs_file, consensus_keypair_file, and seed_peers_file
/// set. It is expected that the callee will provide these.
pub fn get_single_node_test_config(random_ports: bool) -> NodeConfig {
let config_string = String::from_utf8_lossy(CONFIG_TEMPLATE);
let mut config =
NodeConfig::parse(&config_string).expect("Error parsing single node test config");
// Create temporary directory for persisting configs.
let dir = TempPath::new();
dir.create_as_dir().expect("error creating tempdir");
config.base.data_dir_path = dir.path().to_owned();
config.base.temp_data_dir = Some(dir);
if random_ports {
NodeConfigHelpers::randomize_config_ports(&mut config);
}
let (mut private_keys, test_consensus_peers, test_network_peers) =
ConfigHelpers::gen_validator_nodes(1, None);
let peer_id = *private_keys.keys().nth(0).unwrap();
let (
ConsensusPrivateKey {
consensus_private_key,
},
NetworkPrivateKeys {
network_signing_private_key,
network_identity_private_key,
},
) = private_keys.remove_entry(&peer_id).unwrap().1;
config.consensus.consensus_keypair = ConsensusKeyPair::load(Some(consensus_private_key));
config.consensus.consensus_peers = test_consensus_peers;
// Setup node's peer id.
let mut network = config.networks.get_mut(0).unwrap();
network.peer_id = peer_id.to_string();
network.network_keypairs =
NetworkKeyPairs::load(network_signing_private_key, network_identity_private_key);
let seed_peers_config = SeedPeersConfigHelpers::get_test_config(&test_network_peers, None);
network.listen_address = seed_peers_config
.seed_peers
.get(&peer_id.to_string())
.unwrap()
.get(0)
.unwrap()
.clone();
network.advertised_address = network.listen_address.clone();
network.seed_peers = seed_peers_config;
network.network_peers = test_network_peers;
config
}
pub fn randomize_config_ports(config: &mut NodeConfig) {
config.admission_control.admission_control_service_port = get_available_port();
config.debug_interface.admission_control_node_debug_port = get_available_port();
config.debug_interface.metrics_server_port = get_available_port();
config.debug_interface.public_metrics_server_port = get_available_port();
config.debug_interface.storage_node_debug_port = get_available_port();
config.execution.port = get_available_port();
config.mempool.mempool_service_port = get_available_port();
config.storage.port = get_available_port();
}
}
pub trait PersistableConfig: Serialize + DeserializeOwned {
// TODO: Return Result<Self> instead of panic.
fn load_config<P: AsRef<Path>>(path: P) -> Self {
let path = path.as_ref();
let mut file =
File::open(path).unwrap_or_else(|_| panic!("Cannot open config file {:?}", path));
let mut contents = String::new();
file.read_to_string(&mut contents)
.unwrap_or_else(|_| panic!("Error reading config file {:?}", path));
Self::parse(&contents).expect("Unable to parse config")
}
fn save_config<P: AsRef<Path>>(&self, output_file: P) {
let contents = toml::to_vec(&self).expect("Error serializing");
let mut file = File::create(output_file).expect("Error opening file");
file.write_all(&contents).expect("Error writing file");
}
fn parse(serialized: &str) -> Result<Self> {
Ok(toml::from_str(&serialized)?)
}
}
impl<T: ?Sized> PersistableConfig for T where T: Serialize + DeserializeOwned {}