/* * Copyright (c) 2018-2021, Andreas Kling * Copyright (c) 2021, Julius Heijmen * Copyright (c) 2023, Jelle Raaijmakers * * SPDX-License-Identifier: BSD-2-Clause */ #include "FlameGraphView.h" #include "IndividualSampleModel.h" #include "Profile.h" #include "ProfileModel.h" #include "TimelineContainer.h" #include "TimelineHeader.h" #include "TimelineTrack.h" #include "TimelineView.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace Profiler; static bool generate_profile(pid_t& pid); ErrorOr serenity_main(Main::Arguments arguments) { int pid = 0; StringView perfcore_file_arg; Core::ArgsParser args_parser; args_parser.add_option(pid, "PID to profile", "pid", 'p', "PID"); args_parser.add_positional_argument(perfcore_file_arg, "Path of perfcore file", "perfcore-file", Core::ArgsParser::Required::No); args_parser.parse(arguments); if (pid && !perfcore_file_arg.is_empty()) { warnln("-p/--pid option and perfcore-file argument must not be used together!"); return 1; } auto app = TRY(GUI::Application::try_create(arguments)); auto app_icon = TRY(GUI::Icon::try_create_default_icon("app-profiler"sv)); DeprecatedString perfcore_file; if (perfcore_file_arg.is_empty()) { if (!generate_profile(pid)) return 0; perfcore_file = DeprecatedString::formatted("/proc/{}/perf_events", pid); } else { perfcore_file = perfcore_file_arg; } auto profile_or_error = Profile::load_from_perfcore_file(perfcore_file); if (profile_or_error.is_error()) { GUI::MessageBox::show(nullptr, DeprecatedString::formatted("{}", profile_or_error.error()), "Profiler"sv, GUI::MessageBox::Type::Error); return 0; } auto& profile = profile_or_error.value(); auto window = TRY(GUI::Window::try_create()); TRY(Desktop::Launcher::add_allowed_handler_with_only_specific_urls("/bin/Help", { URL::create_with_file_scheme("/usr/share/man/man1/Profiler.md") })); TRY(Desktop::Launcher::seal_allowlist()); window->set_title("Profiler"); window->set_icon(app_icon.bitmap_for_size(16)); window->resize(800, 600); auto main_widget = TRY(window->set_main_widget()); main_widget->set_fill_with_background_color(true); main_widget->set_layout(); auto timeline_header_container = TRY(GUI::Widget::try_create()); timeline_header_container->set_layout(); timeline_header_container->set_fill_with_background_color(true); timeline_header_container->set_shrink_to_fit(true); auto timeline_view = TRY(TimelineView::try_create(*profile)); for (auto const& process : profile->processes()) { bool matching_event_found = false; for (auto const& event : profile->events()) { if (event.pid == process.pid && process.valid_at(event.serial)) { matching_event_found = true; break; } } if (!matching_event_found) continue; auto timeline_header = TRY(timeline_header_container->try_add(*profile, process)); timeline_header->set_shrink_to_fit(true); timeline_header->on_selection_change = [&](bool selected) { auto end_valid = process.end_valid == EventSerialNumber {} ? EventSerialNumber::max_valid_serial() : process.end_valid; if (selected) profile->add_process_filter(process.pid, process.start_valid, end_valid); else profile->remove_process_filter(process.pid, process.start_valid, end_valid); timeline_header_container->for_each_child_widget([](auto& other_timeline_header) { static_cast(other_timeline_header).update_selection(); return IterationDecision::Continue; }); }; (void)TRY(timeline_view->try_add(*timeline_view, *profile, process)); } auto main_splitter = TRY(main_widget->try_add()); [[maybe_unused]] auto timeline_container = TRY(main_splitter->try_add(*timeline_header_container, *timeline_view)); auto tab_widget = TRY(main_splitter->try_add()); auto tree_tab = TRY(tab_widget->try_add_tab("Call Tree")); TRY(tree_tab->try_set_layout(4)); auto bottom_splitter = TRY(tree_tab->try_add()); auto tree_view = TRY(bottom_splitter->try_add()); tree_view->set_should_fill_selected_rows(true); tree_view->set_column_headers_visible(true); tree_view->set_selection_behavior(GUI::TreeView::SelectionBehavior::SelectRows); tree_view->set_model(profile->model()); auto disassembly_view = TRY(bottom_splitter->try_add()); disassembly_view->set_visible(false); auto update_disassembly_model = [&] { if (disassembly_view->is_visible() && !tree_view->selection().is_empty()) { profile->set_disassembly_index(tree_view->selection().first()); disassembly_view->set_model(profile->disassembly_model()); } else { disassembly_view->set_model(nullptr); } }; auto source_view = TRY(bottom_splitter->try_add()); source_view->set_visible(false); auto update_source_model = [&] { if (source_view->is_visible() && !tree_view->selection().is_empty()) { profile->set_source_index(tree_view->selection().first()); source_view->set_model(profile->source_model()); } else { source_view->set_model(nullptr); } }; tree_view->on_selection_change = [&] { update_disassembly_model(); update_source_model(); }; auto disassembly_action = GUI::Action::create_checkable("Show &Disassembly", { Mod_Ctrl, Key_D }, Gfx::Bitmap::load_from_file("/res/icons/16x16/x86.png"sv).release_value_but_fixme_should_propagate_errors(), [&](auto& action) { disassembly_view->set_visible(action.is_checked()); update_disassembly_model(); }); auto source_action = GUI::Action::create_checkable("Show &Source", { Mod_Ctrl, Key_S }, Gfx::Bitmap::load_from_file("/res/icons/16x16/x86.png"sv).release_value_but_fixme_should_propagate_errors(), [&](auto& action) { source_view->set_visible(action.is_checked()); update_source_model(); }); auto samples_tab = TRY(tab_widget->try_add_tab("Samples")); TRY(samples_tab->try_set_layout(4)); auto samples_splitter = TRY(samples_tab->try_add()); auto samples_table_view = TRY(samples_splitter->try_add()); samples_table_view->set_model(profile->samples_model()); auto individual_sample_view = TRY(samples_splitter->try_add()); samples_table_view->on_selection_change = [&] { auto const& index = samples_table_view->selection().first(); auto model = IndividualSampleModel::create(*profile, index.data(GUI::ModelRole::Custom).to_integer()); individual_sample_view->set_model(move(model)); }; auto signposts_tab = TRY(tab_widget->try_add_tab("Signposts")); TRY(signposts_tab->try_set_layout(4)); auto signposts_splitter = TRY(signposts_tab->try_add()); auto signposts_table_view = TRY(signposts_splitter->try_add()); signposts_table_view->set_model(profile->signposts_model()); auto individual_signpost_view = TRY(signposts_splitter->try_add()); signposts_table_view->on_selection_change = [&] { auto const& index = signposts_table_view->selection().first(); auto model = IndividualSampleModel::create(*profile, index.data(GUI::ModelRole::Custom).to_integer()); individual_signpost_view->set_model(move(model)); }; auto flamegraph_tab = TRY(tab_widget->try_add_tab("Flame Graph")); TRY(flamegraph_tab->try_set_layout(GUI::Margins { 4, 4, 4, 4 })); auto flamegraph_view = TRY(flamegraph_tab->try_add(profile->model(), ProfileModel::Column::StackFrame, ProfileModel::Column::SampleCount)); u64 const start_of_trace = profile->first_timestamp(); u64 const end_of_trace = start_of_trace + profile->length_in_ms(); auto const clamp_timestamp = [start_of_trace, end_of_trace](u64 timestamp) -> u64 { return min(end_of_trace, max(timestamp, start_of_trace)); }; // FIXME: Make this constexpr once String is able to. auto const format_sample_count = [&profile](auto const sample_count) { if (profile->show_percentages()) return DeprecatedString::formatted("{}%", sample_count.as_string()); return DeprecatedString::formatted("{} Samples", sample_count.to_i32()); }; auto statusbar = TRY(main_widget->try_add()); auto statusbar_update = [&] { auto& view = *timeline_view; StringBuilder builder; auto flamegraph_hovered_index = flamegraph_view->hovered_index(); if (flamegraph_hovered_index.is_valid()) { auto stack = profile->model().data(flamegraph_hovered_index.sibling_at_column(ProfileModel::Column::StackFrame)).to_deprecated_string(); auto sample_count = profile->model().data(flamegraph_hovered_index.sibling_at_column(ProfileModel::Column::SampleCount)); auto self_count = profile->model().data(flamegraph_hovered_index.sibling_at_column(ProfileModel::Column::SelfCount)); builder.appendff("{}, ", stack); builder.appendff("Samples: {}, ", format_sample_count(sample_count)); builder.appendff("Self: {}", format_sample_count(self_count)); } else { u64 normalized_start_time = clamp_timestamp(min(view.select_start_time(), view.select_end_time())); u64 normalized_end_time = clamp_timestamp(max(view.select_start_time(), view.select_end_time())); u64 normalized_hover_time = clamp_timestamp(view.hover_time()); builder.appendff("Time: {} ms", normalized_hover_time - start_of_trace); if (normalized_start_time != normalized_end_time) { auto start = normalized_start_time - start_of_trace; auto end = normalized_end_time - start_of_trace; builder.appendff(", Selection: {} - {} ms", start, end); builder.appendff(", Duration: {} ms", end - start); } } statusbar->set_text(builder.to_deprecated_string()); }; timeline_view->on_selection_change = [&] { statusbar_update(); }; flamegraph_view->on_hover_change = [&] { statusbar_update(); }; auto filesystem_events_tab = TRY(tab_widget->try_add_tab("Filesystem events")); TRY(filesystem_events_tab->try_set_layout(4)); auto filesystem_events_tree_view = TRY(filesystem_events_tab->try_add()); filesystem_events_tree_view->set_should_fill_selected_rows(true); filesystem_events_tree_view->set_column_headers_visible(true); filesystem_events_tree_view->set_selection_behavior(GUI::TreeView::SelectionBehavior::SelectRows); filesystem_events_tree_view->set_model(profile->file_event_model()); auto file_menu = TRY(window->try_add_menu("&File")); TRY(file_menu->try_add_action(GUI::CommonActions::make_quit_action([&](auto&) { app->quit(); }))); auto view_menu = TRY(window->try_add_menu("&View")); auto invert_action = GUI::Action::create_checkable("&Invert Tree", { Mod_Ctrl, Key_I }, [&](auto& action) { profile->set_inverted(action.is_checked()); }); invert_action->set_checked(false); TRY(view_menu->try_add_action(invert_action)); auto top_functions_action = GUI::Action::create_checkable("&Top Functions", { Mod_Ctrl, Key_T }, [&](auto& action) { profile->set_show_top_functions(action.is_checked()); }); top_functions_action->set_checked(false); TRY(view_menu->try_add_action(top_functions_action)); auto percent_action = GUI::Action::create_checkable("Show &Percentages", { Mod_Ctrl, Key_P }, [&](auto& action) { profile->set_show_percentages(action.is_checked()); tree_view->update(); disassembly_view->update(); source_view->update(); }); percent_action->set_checked(false); TRY(view_menu->try_add_action(percent_action)); TRY(view_menu->try_add_action(disassembly_action)); TRY(view_menu->try_add_action(source_action)); auto help_menu = TRY(window->try_add_menu("&Help")); TRY(help_menu->try_add_action(GUI::CommonActions::make_command_palette_action(window))); TRY(help_menu->try_add_action(GUI::CommonActions::make_help_action([](auto&) { Desktop::Launcher::open(URL::create_with_file_scheme("/usr/share/man/man1/Profiler.md"), "/bin/Help"); }))); TRY(help_menu->try_add_action(GUI::CommonActions::make_about_action("Profiler", app_icon, window))); window->show(); return app->exec(); } static bool prompt_to_stop_profiling(pid_t pid, DeprecatedString const& process_name) { auto window = GUI::Window::construct(); window->set_title(DeprecatedString::formatted("Profiling {}({})", process_name, pid)); window->resize(240, 100); window->set_icon(Gfx::Bitmap::load_from_file("/res/icons/16x16/app-profiler.png"sv).release_value_but_fixme_should_propagate_errors()); window->center_on_screen(); auto widget = window->set_main_widget().release_value_but_fixme_should_propagate_errors(); widget->set_fill_with_background_color(true); widget->set_layout(GUI::Margins { 0, 0, 16 }); auto& timer_label = widget->add("..."); Core::ElapsedTimer clock; clock.start(); auto update_timer = Core::Timer::create_repeating(100, [&] { timer_label.set_text(DeprecatedString::formatted("{:.1} seconds", static_cast(clock.elapsed()) / 1000.0f)); }).release_value_but_fixme_should_propagate_errors(); update_timer->start(); auto& stop_button = widget->add("Stop"_short_string); stop_button.set_fixed_size(140, 22); stop_button.on_click = [&](auto) { GUI::Application::the()->quit(); }; window->show(); return GUI::Application::the()->exec() == 0; } bool generate_profile(pid_t& pid) { if (!pid) { auto process_chooser = GUI::ProcessChooser::construct("Profiler"sv, "Profile"_short_string, Gfx::Bitmap::load_from_file("/res/icons/16x16/app-profiler.png"sv).release_value_but_fixme_should_propagate_errors()); if (process_chooser->exec() == GUI::Dialog::ExecResult::Cancel) return false; pid = process_chooser->pid(); } DeprecatedString process_name; auto all_processes = Core::ProcessStatisticsReader::get_all(); if (!all_processes.is_error()) { auto& processes = all_processes.value().processes; if (auto it = processes.find_if([&](auto& entry) { return entry.pid == pid; }); it != processes.end()) process_name = it->name; else process_name = "(unknown)"; } else { process_name = "(unknown)"; } static constexpr u64 event_mask = PERF_EVENT_SAMPLE | PERF_EVENT_MMAP | PERF_EVENT_MUNMAP | PERF_EVENT_PROCESS_CREATE | PERF_EVENT_PROCESS_EXEC | PERF_EVENT_PROCESS_EXIT | PERF_EVENT_THREAD_CREATE | PERF_EVENT_THREAD_EXIT; if (profiling_enable(pid, event_mask) < 0) { int saved_errno = errno; GUI::MessageBox::show(nullptr, DeprecatedString::formatted("Unable to profile process {}({}): {}", process_name, pid, strerror(saved_errno)), "Profiler"sv, GUI::MessageBox::Type::Error); return false; } if (!prompt_to_stop_profiling(pid, process_name)) return false; if (profiling_disable(pid) < 0) { return false; } return true; }