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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
extern crate pogo_attr;
use chashmap::CHashMap;
use crossbeam::channel::{unbounded, Receiver, Sender};
use libloading::Library;
use once_cell::sync::OnceCell;
use std::error::Error;
use std::io::Write;
use std::path::PathBuf;
use std::sync::atomic::AtomicUsize;
pub use pogo_attr::pogo;
pub type ContextCell = once_cell::sync::OnceCell<PogoFuncCtx>;
#[derive(Clone, Copy, Eq, PartialEq, Debug)]
pub enum Edition {
Rust2015,
Rust2018,
}
#[derive(Debug)]
pub struct PogoFuncDefinition {
pub edition: Edition,
pub name: &'static str,
pub src: &'static str,
}
#[derive(Debug)]
pub struct PogoFuncCtx {
pub info: &'static PogoFuncDefinition,
pub groups: CHashMap<&'static str, GroupState>,
}
#[derive(Debug)]
pub struct GroupState {
pub pgo_state: PgoState,
pub pgo_count: AtomicUsize,
}
#[derive(Debug)]
pub enum PgoState {
Uninitialized,
GatheringData(Library),
Compiling(Library),
Optimized(Library),
CompilationFailed,
}
impl PgoState {
fn to_compiling(&mut self) {
let mut other = PgoState::Uninitialized;
std::mem::swap(self, &mut other);
match other {
PgoState::Uninitialized | PgoState::CompilationFailed => {
*self = PgoState::CompilationFailed;
}
PgoState::GatheringData(lib) | PgoState::Compiling(lib) | PgoState::Optimized(lib) => {
*self = PgoState::Compiling(lib)
}
}
}
}
pub fn init<P: Into<PathBuf>>(
working_dir: P,
funcs: &[(&'static PogoFuncDefinition, &'static OnceCell<PogoFuncCtx>)],
) -> Result<(), Box<dyn Error>> {
let working_dir: PathBuf = working_dir.into();
std::fs::create_dir_all(&working_dir)?;
let (send, recv) = unbounded();
match PGO_REQ_SENDER.set(send) {
Ok(()) => {
let thread_working_dir = working_dir.clone();
std::thread::spawn(|| pgo_worker(thread_working_dir, recv));
}
Err(_) => {}
}
let req_sender = PGO_REQ_SENDER.get().unwrap().clone();
for (func_def, func_ctx_cell) in funcs {
let func_ctx_struct = PogoFuncCtx {
info: func_def,
groups: CHashMap::with_capacity(1),
};
func_ctx_struct.groups.insert_new(
Global::NAME,
GroupState {
pgo_state: PgoState::Uninitialized,
pgo_count: AtomicUsize::new(0),
},
);
match func_ctx_cell.set(func_ctx_struct) {
Ok(()) => {
std::fs::create_dir_all(working_dir.join(func_def.name))?;
let mut src_file = std::fs::OpenOptions::new()
.write(true)
.create(true)
.open(working_dir.join(func_def.name).join("func_src.rs"))?;
src_file.write(
r#"#![crate_type="cdylib"]
#[no_mangle]
pub "#
.as_bytes(),
)?;
src_file.write_all(func_def.src.as_bytes())?;
src_file.flush()?;
req_sender.send(PGORequest::Initial(PGOCompilationInfo {
ctx: &func_ctx_cell.get().unwrap(),
group_name: Global::NAME,
}))?;
}
Err(_) => continue,
}
}
Ok(())
}
static PGO_REQ_SENDER: OnceCell<Sender<PGORequest>> = OnceCell::new();
pub fn submit_optimization_request(ctx: &'static PogoFuncCtx, group_name: &'static str) {
let req_sender = PGO_REQ_SENDER.get().unwrap().clone();
req_sender
.send(PGORequest::Optimized(PGOCompilationInfo {
ctx,
group_name,
}))
.unwrap();
}
pub fn pgo_worker(working_directory: PathBuf, rec_recv: Receiver<PGORequest>) {
while let Ok(req) = rec_recv.recv() {
match req {
PGORequest::Initial(comp_info) => {
println!(
"Got initial compilation request: {}::{}",
comp_info.group_name, comp_info.ctx.info.name
);
let func_base_path = working_directory.join(comp_info.ctx.info.name);
let group_working_dir = func_base_path.join(comp_info.group_name);
match std::fs::create_dir_all(&group_working_dir) {
Ok(_) => {}
Err(_) => {
match comp_info.ctx.groups.get_mut(comp_info.group_name) {
Some(mut group) => {
group.pgo_state = PgoState::CompilationFailed;
}
None => {}
};
continue;
}
}
let mut cmd = std::process::Command::new("rustc");
cmd.arg(format!(
"-Cprofile-generate={}",
group_working_dir.join("profile_data").to_string_lossy()
));
cmd.arg("--edition");
match comp_info.ctx.info.edition {
Edition::Rust2015 => cmd.arg("2015"),
Edition::Rust2018 => cmd.arg("2018"),
};
cmd.arg("-o");
cmd.arg(group_working_dir.join("instrumented.so").as_os_str());
cmd.arg(func_base_path.join("func_src.rs").as_os_str());
println!("{:?}", cmd);
match cmd.status() {
Ok(exit_status) => {
if exit_status.success() {
match comp_info.ctx.groups.get_mut(comp_info.group_name) {
Some(mut group) => {
group.pgo_state = match Library::new(
group_working_dir.join("instrumented.so"),
) {
Ok(lib) => PgoState::GatheringData(lib),
Err(_) => PgoState::CompilationFailed,
};
}
None => {}
}
} else {
match comp_info.ctx.groups.get_mut(comp_info.group_name) {
Some(mut group) => {
group.pgo_state = PgoState::CompilationFailed;
}
None => {}
}
}
}
Err(_) => match comp_info.ctx.groups.get_mut(comp_info.group_name) {
Some(mut group) => {
group.pgo_state = PgoState::CompilationFailed;
}
None => {}
},
}
}
PGORequest::Optimized(comp_info) => {
println!(
"Got optimized compilation request: {}::{}",
comp_info.group_name, comp_info.ctx.info.name
);
match comp_info.ctx.groups.get_mut(comp_info.group_name) {
Some(mut group) => {
group.pgo_state.to_compiling();
match group.pgo_state {
PgoState::CompilationFailed => {
continue;
}
_ => {}
};
}
None => {
continue;
}
}
let func_base_path = working_directory.join(comp_info.ctx.info.name);
let group_working_dir = func_base_path.join(comp_info.group_name);
let profile_data_dir = group_working_dir.join("profile_data");
let mut cmd = std::process::Command::new("cargo");
cmd.args(&["profdata", "--"]);
cmd.arg("merge");
cmd.arg("-o");
cmd.arg(group_working_dir.join("pgo.profdata"));
cmd.arg(profile_data_dir.as_os_str());
println!("{:?}", cmd);
match cmd.status() {
Ok(exit_status) => {
if !exit_status.success() {
match comp_info.ctx.groups.get_mut(comp_info.group_name) {
Some(mut group) => {
group.pgo_state = PgoState::CompilationFailed;
}
None => {}
}
continue;
}
}
Err(_) => {
match comp_info.ctx.groups.get_mut(comp_info.group_name) {
Some(mut group) => {
group.pgo_state = PgoState::CompilationFailed;
}
None => {}
};
continue;
}
}
let mut cmd = std::process::Command::new("rustc");
cmd.arg(format!(
"-Cprofile-use={}",
group_working_dir.join("pgo.profdata").to_string_lossy()
));
cmd.arg("--edition");
match comp_info.ctx.info.edition {
Edition::Rust2015 => cmd.arg("2015"),
Edition::Rust2018 => cmd.arg("2018"),
};
cmd.arg("-o");
cmd.arg(group_working_dir.join("optimized.so").as_os_str());
cmd.arg(func_base_path.join("func_src.rs").as_os_str());
println!("{:?}", cmd);
match cmd.status() {
Ok(exit_status) => {
if exit_status.success() {
match comp_info.ctx.groups.get_mut(comp_info.group_name) {
Some(mut group) => {
group.pgo_state = match Library::new(
group_working_dir.join("optimized.so"),
) {
Ok(lib) => PgoState::Optimized(lib),
Err(_) => PgoState::CompilationFailed,
};
}
None => {}
}
} else {
match comp_info.ctx.groups.get_mut(comp_info.group_name) {
Some(mut group) => {
group.pgo_state = PgoState::CompilationFailed;
}
None => {}
}
}
}
Err(_) => match comp_info.ctx.groups.get_mut(comp_info.group_name) {
Some(mut group) => {
group.pgo_state = PgoState::CompilationFailed;
}
None => {}
},
}
}
}
}
panic!("PGO Worker failed on an error");
}
pub enum PGORequest {
Initial(PGOCompilationInfo),
Optimized(PGOCompilationInfo),
}
pub struct PGOCompilationInfo {
ctx: &'static PogoFuncCtx,
group_name: &'static str,
}
pub trait PogoGroup {
const USE_PGO: bool = true;
const NAME: &'static str;
const PGO_EXEC_COUNT: usize;
}
pub struct Global;
impl PogoGroup for Global {
const NAME: &'static str = "__POGO_GLOBAL";
const PGO_EXEC_COUNT: usize = 5_000;
}
pub struct NoPGO;
impl PogoGroup for NoPGO {
const USE_PGO: bool = false;
const NAME: &'static str = "__NO_PGO";
const PGO_EXEC_COUNT: usize = 0;
}