-
Notifications
You must be signed in to change notification settings - Fork 90
/
main.rs
executable file
·604 lines (543 loc) · 20.3 KB
/
main.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
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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
/**
*
* Copyright 2024 Netflix, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
use crate::helpers::format_percent;
use anyhow::{anyhow, Context, Result};
use app::SortColumn;
use app::{App, Mode};
use bpf_program::BpfProgram;
use crossterm::event::{self, poll, Event, KeyCode, KeyModifiers};
use crossterm::execute;
use crossterm::terminal::{
disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen,
};
use libbpf_rs::skel::{OpenSkel, Skel, SkelBuilder};
use libbpf_sys::bpf_enable_stats;
use pid_iter::PidIterSkelBuilder;
use procfs::KernelVersion;
use ratatui::backend::{Backend, CrosstermBackend};
use ratatui::layout::{Constraint, Direction, Layout, Rect};
use ratatui::style::{Color, Modifier, Style, Stylize};
use ratatui::text::Line;
use ratatui::widgets::{
Axis, Block, BorderType, Borders, Cell, Chart, Dataset, GraphType, Padding, Paragraph, Row,
Table,
};
use ratatui::{symbols, Frame, Terminal};
use std::fs;
use std::io;
use std::os::fd::{FromRawFd, OwnedFd};
use std::panic;
use std::time::Duration;
use tracing::info;
use tracing_subscriber::layer::SubscriberExt;
use tracing_subscriber::util::SubscriberInitExt;
use tui_input::backend::crossterm::EventHandler;
mod app;
mod bpf_program;
mod helpers;
mod pid_iter {
include!(concat!(
env!("CARGO_MANIFEST_DIR"),
"/src/bpf/pid_iter.skel.rs"
));
}
const TABLE_FOOTER: &str =
"(q) quit | (↑,k) move up | (↓,j) move down | (↵) show graphs | (f) filter | (s) sort";
const GRAPHS_FOOTER: &str = "(q) quit | (↵) show program list";
const FILTER_FOOTER: &str = "(↵,Esc) back";
const SORT_CONTROLS_FOOTER: &str =
"(↑) asc | (↓) desc | (Backspace) clear | (←) move left | (→) move right";
const SORT_INFO_FOOTER: &str = "(Esc) back";
const PROCFS_BPF_STATS_ENABLED: &str = "/proc/sys/kernel/bpf_stats_enabled";
impl From<&BpfProgram> for Row<'_> {
fn from(bpf_program: &BpfProgram) -> Self {
let height = 1;
let cells = vec![
Cell::from(bpf_program.id.to_string()),
Cell::from(bpf_program.bpf_type.to_string()),
Cell::from(bpf_program.name.to_string()),
Cell::from(bpf_program.period_average_runtime_ns().to_string()),
Cell::from(bpf_program.total_average_runtime_ns().to_string()),
Cell::from(bpf_program.events_per_second().to_string()),
Cell::from(format_percent(bpf_program.cpu_time_percent())),
];
Row::new(cells).height(height as u16).bottom_margin(1)
}
}
fn main() -> Result<()> {
if !running_as_root() {
return Err(anyhow!("This program must be run as root"));
}
// Initialize the tracing subscriber with the journald layer
let registry = tracing_subscriber::registry()
.with(tracing_journald::layer()?)
.with(tracing_subscriber::filter::LevelFilter::INFO);
// Try to set this subscriber as the global default
registry.try_init()?;
let kernel_version = KernelVersion::current()?;
let _owned_fd: OwnedFd;
let mut stats_enabled_via_procfs = false;
let mut iter_link = None;
info!("Starting bpftop...");
info!("Kernel: {:?}", kernel_version);
// enable BPF stats via syscall if kernel version >= 5.8
if kernel_version >= KernelVersion::new(5, 8, 0) {
let fd = unsafe { bpf_enable_stats(libbpf_sys::BPF_STATS_RUN_TIME) };
if fd < 0 {
return Err(anyhow!("Failed to enable BPF stats via syscall"));
}
_owned_fd = unsafe { OwnedFd::from_raw_fd(fd) };
info!("Enabled BPF stats via syscall");
// load and attach pid_iter BPF program to get process information
let skel_builder = PidIterSkelBuilder::default();
let open_skel = skel_builder.open()?;
let mut skel = open_skel.load()?;
skel.attach()?;
iter_link = skel.links.bpftop_iter;
} else {
// otherwise, enable via procfs
// but first check if procfs bpf stats were already enabled
if procfs_bpf_stats_is_enabled()? {
info!("BPF stats already enabled via procfs");
} else {
fs::write(PROCFS_BPF_STATS_ENABLED, b"1").context(format!(
"Failed to enable BPF stats via {}",
PROCFS_BPF_STATS_ENABLED
))?;
stats_enabled_via_procfs = true;
info!("Enabled BPF stats via procfs");
}
}
// setup terminal
enable_raw_mode()?;
let mut stdout = io::stdout();
execute!(stdout, EnterAlternateScreen)?;
let backend = CrosstermBackend::new(stdout);
let mut terminal = Terminal::new(backend)?;
terminal.clear()?;
// capture panic to disable BPF stats via procfs and restore terminal
let previous_hook = panic::take_hook();
panic::set_hook(Box::new(move |panic_info| {
if stats_enabled_via_procfs {
if let Err(err) = procs_bfs_stats_disable() {
eprintln!("Failed to disable BPF stats via procfs: {:?}", err);
}
}
if let Err(err) = disable_raw_mode() {
eprintln!("Failed to disable raw mode: {:?}", err);
}
previous_hook(panic_info);
}));
// create app and run the draw loop
let app = App::new();
app.start_background_thread(iter_link);
let res = run_draw_loop(&mut terminal, app);
// restore terminal
disable_raw_mode()?;
execute!(terminal.backend_mut(), LeaveAlternateScreen,)?;
terminal.show_cursor()?;
terminal.clear()?;
// disable BPF stats via procfs if needed
if stats_enabled_via_procfs {
procs_bfs_stats_disable()?;
}
#[allow(clippy::question_mark)]
if res.is_err() {
return res;
}
Ok(())
}
fn procs_bfs_stats_disable() -> Result<()> {
fs::write(PROCFS_BPF_STATS_ENABLED, b"0").context(format!(
"Failed to disable BPF stats via {}",
PROCFS_BPF_STATS_ENABLED
))?;
Ok(())
}
fn procfs_bpf_stats_is_enabled() -> Result<bool> {
fs::read_to_string(PROCFS_BPF_STATS_ENABLED)
.context(format!("Failed to read from {}", PROCFS_BPF_STATS_ENABLED))
.map(|value| value.trim() == "1")
}
fn run_draw_loop<B: Backend>(terminal: &mut Terminal<B>, mut app: App) -> Result<()> {
loop {
terminal.draw(|f| ui(f, &mut app))?;
// wait up to 100ms for a keyboard event
if poll(Duration::from_millis(50))? {
if let Event::Key(key) = event::read()? {
match app.mode {
Mode::Table => match key.code {
KeyCode::Down | KeyCode::Char('j') => app.next_program(),
KeyCode::Up | KeyCode::Char('k') => app.previous_program(),
KeyCode::Enter => app.show_graphs(),
KeyCode::Char('f') => app.toggle_filter(),
KeyCode::Char('s') => app.toggle_sort(),
KeyCode::Char('q') | KeyCode::Esc => return Ok(()),
_ => {}
},
Mode::Graph => match key.code {
KeyCode::Enter | KeyCode::Esc => app.show_table(),
KeyCode::Char('q') => return Ok(()),
_ => {}
},
Mode::Filter => match key.code {
KeyCode::Enter | KeyCode::Esc => app.toggle_filter(),
_ => {
app.filter_input
.lock()
.unwrap()
.handle_event(&Event::Key(key));
}
},
Mode::Sort => match key.code {
KeyCode::Esc => app.toggle_sort(),
KeyCode::Up => app.sort_column(SortColumn::Ascending(
app.selected_column.unwrap_or_default(),
)),
KeyCode::Down => app.sort_column(SortColumn::Descending(
app.selected_column.unwrap_or_default(),
)),
KeyCode::Backspace => app.sort_column(SortColumn::NoOrder),
KeyCode::Left => app.previous_column(),
KeyCode::Right => app.next_column(),
KeyCode::Enter => app.cycle_sort_exit(),
_ => {}
},
}
if let (KeyModifiers::CONTROL, KeyCode::Char('c')) = (key.modifiers, key.code) {
return Ok(());
}
}
}
}
}
fn ui(f: &mut Frame, app: &mut App) {
let rects = Layout::vertical([Constraint::Min(5), Constraint::Length(3)]).split(f.size());
match app.mode {
Mode::Table | Mode::Filter | Mode::Sort => render_table(f, app, rects[0]),
Mode::Graph => render_graphs(f, app, rects[0]),
}
render_footer(f, app, rects[1]);
}
fn render_graphs(f: &mut Frame, app: &mut App, area: Rect) {
let data_buf = app.data_buf.lock().unwrap();
let mut cpu_data: Vec<(f64, f64)> = vec![(0.0, 0.0); data_buf.len()];
let mut eps_data: Vec<(f64, f64)> = vec![(0.0, 0.0); data_buf.len()];
let mut runtime_data: Vec<(f64, f64)> = vec![(0.0, 0.0); data_buf.len()];
let mut total_cpu = 0.0;
let mut total_eps = 0;
let mut total_runtime = 0;
let mut moving_max_cpu = 0.0;
let mut moving_max_eps = 0;
let mut moving_max_runtime = 0;
for (i, val) in data_buf.iter().enumerate() {
cpu_data[i] = (i as f64, val.cpu_time_percent);
eps_data[i] = (i as f64, val.events_per_sec as f64);
runtime_data[i] = (i as f64, val.average_runtime_ns as f64);
if val.cpu_time_percent > app.max_cpu {
app.max_cpu = val.cpu_time_percent;
}
if val.cpu_time_percent > moving_max_cpu {
moving_max_cpu = val.cpu_time_percent;
}
if val.events_per_sec > app.max_eps {
app.max_eps = val.events_per_sec;
}
if val.events_per_sec > moving_max_eps {
moving_max_eps = val.events_per_sec;
}
if val.average_runtime_ns > app.max_runtime {
app.max_runtime = val.average_runtime_ns;
}
if val.average_runtime_ns > moving_max_runtime {
moving_max_runtime = val.average_runtime_ns;
}
total_cpu += val.cpu_time_percent;
total_eps += val.events_per_sec;
total_runtime += val.average_runtime_ns;
}
let max_cpu = moving_max_cpu;
let max_eps = moving_max_eps as f64;
let max_runtime = moving_max_runtime as f64;
let mut avg_cpu = 0.0;
let mut avg_eps = 0.0;
let mut avg_runtime = 0.0;
if data_buf.len() > 0 {
avg_cpu = total_cpu / data_buf.len() as f64;
avg_eps = total_eps as f64 / data_buf.len() as f64;
avg_runtime = total_runtime as f64 / data_buf.len() as f64;
}
let cpu_y_max = app.max_cpu.ceil();
let eps_y_max = (app.max_eps as f64 * 2.0).ceil();
let runtime_y_max = (app.max_runtime as f64 * 2.0).ceil();
// CPU
let cpu_dataset = Dataset::default()
.marker(symbols::Marker::Braille)
.graph_type(GraphType::Line)
.style(Style::default().green())
.data(&cpu_data);
let cpu_datasets = vec![cpu_dataset];
let x_axis = Axis::default()
.style(Style::default())
.bounds([0.0, cpu_data.len() as f64]);
let y_axis = Axis::default()
.style(Style::default())
.bounds([0.0, cpu_y_max])
.labels(vec![
"0%".into(),
((cpu_y_max / 2.0).to_string() + "%").into(),
(cpu_y_max.to_string() + "%").into(),
]);
let cpu_chart = Chart::new(cpu_datasets)
.block(
Block::default()
.title(format!(
" Total CPU % | Moving Avg: {} | Max: {} ",
format_percent(avg_cpu),
format_percent(max_cpu)
))
.borders(Borders::ALL),
)
.x_axis(x_axis)
.y_axis(y_axis);
// Events per second
let eps_dataset = Dataset::default()
.marker(symbols::Marker::Braille)
.graph_type(GraphType::Line)
.style(Style::default().cyan())
.data(&eps_data);
let eps_datasets = vec![eps_dataset];
let x_axis = Axis::default()
.style(Style::default())
.bounds([0.0, eps_data.len() as f64]);
let y_axis = Axis::default()
.style(Style::default())
.bounds([0.0, eps_y_max])
.labels(vec![
"0".into(),
((eps_y_max / 2.0).to_string()).into(),
(eps_y_max.to_string()).into(),
]);
let eps_chart = Chart::new(eps_datasets)
.block(
Block::default()
.title(format!(
" Events per second | Moving Avg: {} | Max: {} ",
avg_eps.ceil(),
max_eps.ceil()
))
.borders(Borders::ALL),
)
.x_axis(x_axis)
.y_axis(y_axis);
// Runtime
let runtime_dataset = Dataset::default()
.marker(symbols::Marker::Braille)
.graph_type(GraphType::Line)
.style(Style::default().magenta())
.data(&runtime_data);
let runtime_datasets = vec![runtime_dataset];
let x_axis = Axis::default()
.style(Style::default())
.bounds([0.0, runtime_data.len() as f64]);
let y_axis = Axis::default()
.style(Style::default())
.bounds([0.0, runtime_y_max])
.labels(vec![
"0".into(),
((runtime_y_max / 2.0).to_string()).into(),
(runtime_y_max.to_string()).into(),
]);
let runtime_chart = Chart::new(runtime_datasets)
.block(
Block::default()
.title(format!(
" Avg Runtime (ns) | Moving Avg: {} | Max: {} ",
avg_runtime.ceil(),
max_runtime.ceil()
))
.borders(Borders::ALL),
)
.x_axis(x_axis)
.y_axis(y_axis);
let chunks = Layout::default()
.direction(Direction::Vertical)
.constraints([Constraint::Percentage(50), Constraint::Percentage(50)].as_ref())
.split(area);
let sub_chunks = chunks
.iter()
.map(|chunk| {
Layout::default()
.direction(Direction::Horizontal)
.constraints([Constraint::Percentage(50), Constraint::Percentage(50)].as_ref())
.split(*chunk)
})
.collect::<Vec<_>>();
let mut items = vec![
Row::new(vec![Cell::from("Program ID"), Cell::from("Unknown")]),
Row::new(vec![Cell::from("Program Type"), Cell::from("Unknown")]),
Row::new(vec![Cell::from("Program Name"), Cell::from("Unknown")]),
];
let widths = [Constraint::Length(15), Constraint::Min(0)];
if let Some(bpf_program) = app.graphs_bpf_program.lock().unwrap().clone() {
items = vec![
Row::new(vec![
Cell::from("Program ID".bold()),
Cell::from(bpf_program.id.to_string()),
])
.height(2),
Row::new(vec![
Cell::from("Program Type".bold()),
Cell::from(bpf_program.bpf_type),
])
.height(2),
Row::new(vec![
Cell::from("Program Name".bold()),
Cell::from(bpf_program.name),
])
.height(2),
Row::new(vec![
Cell::from("PIDs".bold()),
Cell::from(
bpf_program
.processes
.iter()
.map(|pid| pid.to_string())
.collect::<Vec<String>>()
.join(", "),
),
])
.height(2),
];
}
let table = Table::new(items, widths)
.block(
Block::default()
.title(" Program Information ")
.padding(Padding::new(3, 0, 1, 0))
.borders(Borders::ALL),
)
.style(Style::default());
f.render_widget(table, sub_chunks[0][0]); // Top left
f.render_widget(cpu_chart.clone(), sub_chunks[0][1]); // Top right
f.render_widget(eps_chart, sub_chunks[1][0]); // Bottom left
f.render_widget(runtime_chart, sub_chunks[1][1]); // Bottom right
}
fn render_table(f: &mut Frame, app: &mut App, area: Rect) {
let selected_style = Style::default().add_modifier(Modifier::REVERSED);
let normal_style = Style::default().bg(Color::Blue);
let columns: Vec<Cell<'_>> = app
.header_columns
.iter()
.enumerate()
.map(|(i, col)| {
Cell::new(&**col).style(
if app.selected_column.is_some_and(|selected| selected == i) {
selected_style
} else {
normal_style
},
)
})
.collect();
let header = Row::new(columns)
.style(normal_style)
.height(1)
.bottom_margin(1);
let items = app.items.lock().unwrap();
let rows: Vec<Row> = items.iter().map(|item| item.into()).collect();
let widths = [
Constraint::Percentage(5),
Constraint::Percentage(17),
Constraint::Percentage(17),
Constraint::Percentage(17),
Constraint::Percentage(17),
Constraint::Percentage(17),
Constraint::Percentage(10),
];
let t = Table::new(rows, widths)
.header(header)
.block(
Block::default()
.borders(Borders::ALL)
.title(" eBPF programs "),
)
.highlight_style(selected_style)
.highlight_symbol(">> ");
f.render_stateful_widget(t, area, &mut app.table_state);
}
fn render_footer(f: &mut Frame, app: &mut App, area: Rect) {
let info_text = match app.mode {
Mode::Table => TABLE_FOOTER,
Mode::Graph => GRAPHS_FOOTER,
Mode::Filter => FILTER_FOOTER,
Mode::Sort => SORT_INFO_FOOTER,
};
let info_footer = Paragraph::new(Line::from(info_text)).centered().block(
Block::default()
.borders(Borders::ALL)
.border_type(BorderType::Double),
);
// Only single footer in table and graph mode
if let Mode::Table | Mode::Graph = app.mode {
f.render_widget(info_footer, area);
return;
}
// Two footers in filter and sort mode
let split_area = Layout::default()
.direction(Direction::Horizontal)
.constraints([Constraint::Percentage(75), Constraint::Percentage(25)].as_ref())
.split(area);
// Right footer
f.render_widget(info_footer, split_area[1]);
// Left footer
match app.mode {
Mode::Filter => {
let filter_input = app.filter_input.lock().unwrap();
let filter_footer = Paragraph::new(filter_input.value()).block(
Block::default()
.padding(Padding::horizontal(1))
.borders(Borders::ALL)
.border_type(BorderType::Double)
.title(" Filter Name/Type "),
);
f.render_widget(filter_footer, split_area[0]);
// Displays cursor when inputting
f.set_cursor(
split_area[0].x + filter_input.visual_cursor() as u16 + 2,
split_area[0].y + 1,
);
drop(filter_input);
}
Mode::Sort => {
let sort_footer = Paragraph::new(Line::from(SORT_CONTROLS_FOOTER))
.centered()
.block(
Block::default()
.borders(Borders::ALL)
.border_type(BorderType::Double)
.title(" Sort Column "),
);
f.render_widget(sort_footer, split_area[0]);
}
_ => {}
}
}
fn running_as_root() -> bool {
matches!(nix::unistd::getuid().as_raw(), 0)
}