//----------------------------------------------------------------------------------------------------------------------
// init_command_line_params
//----------------------------------------------------------------------------------------------------------------------
static bool init_command_line_params(int argc, char *argv[])
{
VOGL_FUNC_TRACER
command_line_params::parse_config parse_cfg;
parse_cfg.m_single_minus_params = true;
parse_cfg.m_double_minus_params = true;
if (!g_command_line_params().parse(get_command_line_params(argc, argv),
VOGL_ARRAY_SIZE(g_command_line_param_descs),
g_command_line_param_descs, parse_cfg))
{
vogl_error_printf("%s: Failed parsing command line parameters!\n", VOGL_FUNCTION_NAME);
return false;
}
if (!init_logfile())
return false;
if (g_command_line_params().get_value_as_bool("help") || g_command_line_params().get_value_as_bool("?"))
{
tool_print_help();
return false;
}
return true;
}
//----------------------------------------------------------------------------------------------------------------------
// init_logfile
//----------------------------------------------------------------------------------------------------------------------
static bool init_logfile()
{
VOGL_FUNC_TRACER
dynamic_string log_file(g_command_line_params().get_value_as_string_or_empty("logfile"));
dynamic_string log_file_append(g_command_line_params().get_value_as_string_or_empty("logfile_append"));
if (log_file.is_empty() && log_file_append.is_empty())
return true;
dynamic_string filename(log_file_append.is_empty() ? log_file : log_file_append);
// This purposely leaks, don't care
g_vogl_pLog_stream = vogl_new(cfile_stream);
if (!g_vogl_pLog_stream->open(filename.get_ptr(), cDataStreamWritable, !log_file_append.is_empty()))
{
vogl_error_printf("%s: Failed opening log file \"%s\"\n", VOGL_FUNCTION_NAME, filename.get_ptr());
return false;
}
else
{
vogl_message_printf("Opened log file \"%s\"\n", filename.get_ptr());
console::set_log_stream(g_vogl_pLog_stream);
}
return true;
}
//----------------------------------------------------------------------------------------------------------------------
// main
//----------------------------------------------------------------------------------------------------------------------
int main(int argc, char *argv[])
{
#if VOGL_FUNCTION_TRACING
fflush(stdout);
fflush(stderr);
setvbuf(stdout, NULL, _IONBF, 0);
setvbuf(stderr, NULL, _IONBF, 0);
#endif
VOGL_FUNC_TRACER
// Initialize vogl_core.
vogl_core_init();
XSetErrorHandler(xerror_handler);
if (!voglbench_init(argc, argv))
{
voglbench_deinit();
return EXIT_FAILURE;
}
if (g_command_line_params().get_count("") < 2)
{
vogl_error_printf("No trace file specified!\n");
tool_print_help();
voglbench_deinit();
return EXIT_FAILURE;
}
if (g_command_line_params().get_value_as_bool("pause"))
{
vogl_message_printf("Press key to continue\n");
vogl_sleep(1000);
getchar();
}
bool success = tool_replay_mode();
vogl_printf("%u warning(s), %u error(s)\n",
console::get_total_messages(cWarningConsoleMessage),
console::get_total_messages(cErrorConsoleMessage));
voglbench_deinit();
return success ? EXIT_SUCCESS : EXIT_FAILURE;
}
//----------------------------------------------------------------------------------------------------------------------
// voglbench_init
//----------------------------------------------------------------------------------------------------------------------
static bool voglbench_init(int argc, char *argv[])
{
VOGL_FUNC_TRACER
colorized_console::init();
colorized_console::set_exception_callback();
//console::set_tool_prefix("(voglbench) ");
tool_print_title();
if (!init_command_line_params(argc, argv))
return false;
#ifdef USE_TELEMETRY
int telemetry_level = g_command_line_params().get_value_as_int("telemetry_level", 0,
TELEMETRY_LEVEL_MIN + 1, TELEMETRY_LEVEL_MIN, TELEMETRY_LEVEL_MAX);
telemetry_set_level(telemetry_level);
telemetry_tick();
#endif
vogl_common_lib_early_init();
vogl_common_lib_global_init();
if (g_command_line_params().get_value_as_bool("quiet"))
console::set_output_level(cMsgError);
else if (g_command_line_params().get_value_as_bool("debug"))
console::set_output_level(cMsgDebug);
else if (g_command_line_params().get_value_as_bool("verbose"))
console::set_output_level(cMsgVerbose);
if (g_command_line_params().get_value_as_bool("gl_debug_log"))
{
vogl_set_direct_gl_func_prolog(vogl_direct_gl_func_prolog, NULL);
vogl_set_direct_gl_func_epilog(vogl_direct_gl_func_epilog, NULL);
}
#if VOGL_PLATFORM_HAS_SDL
if (SDL_Init(SDL_INIT_VIDEO) < 0)
return false;
#endif
if (!load_gl())
return false;
bool wrap_all_gl_calls = false;
vogl_init_actual_gl_entrypoints(vogl_get_proc_address_helper, wrap_all_gl_calls);
return true;
}
//----------------------------------------------------------------------------------------------------------------------
// get_replayer_flags_from_command_line_params
//----------------------------------------------------------------------------------------------------------------------
static uint get_replayer_flags_from_command_line_params()
{
uint replayer_flags = cGLReplayerBenchmarkMode;
static struct
{
const char *m_pCommand;
uint m_flag;
} s_replayer_command_line_params[] =
{
{ "verbose", cGLReplayerVerboseMode },
{ "force_debug_context", cGLReplayerForceDebugContexts },
{ "debug", cGLReplayerDebugMode },
{ "lock_window_dimensions", cGLReplayerLockWindowDimensions },
{ "fs_preprocessor", cGLReplayerFSPreprocessor },
};
for (uint i = 0; i < sizeof(s_replayer_command_line_params) / sizeof(s_replayer_command_line_params[0]); i++)
{
if (g_command_line_params().get_value_as_bool(s_replayer_command_line_params[i].m_pCommand))
replayer_flags |= s_replayer_command_line_params[i].m_flag;
}
return replayer_flags;
}
//----------------------------------------------------------------------------------------------------------------------
// init_logfile
//----------------------------------------------------------------------------------------------------------------------
static bool init_logfile()
{
VOGL_FUNC_TRACER
dynamic_string backbuffer_hash_file;
if (g_command_line_params().get_value_as_string(backbuffer_hash_file, "dump_backbuffer_hashes"))
{
remove(backbuffer_hash_file.get_ptr());
vogl_message_printf("Deleted backbuffer hash file \"%s\"\n", backbuffer_hash_file.get_ptr());
}
dynamic_string filename(g_command_line_params().get_value_as_string_or_empty("logfile"));
if (filename.is_empty())
return true;
return console::set_log_stream_filename(filename.c_str(), false);
}
//----------------------------------------------------------------------------------------------------------------------
// main
//----------------------------------------------------------------------------------------------------------------------
int main(int argc, char *argv[])
{
#if VOGL_FUNCTION_TRACING
fflush(stdout);
fflush(stderr);
setvbuf(stdout, NULL, _IONBF, 0);
setvbuf(stderr, NULL, _IONBF, 0);
#endif
VOGL_FUNC_TRACER
// Initialize vogl_core.
vogl_core_init();
if (!voglsyms_init(argc, argv))
{
voglsyms_deinit();
return EXIT_FAILURE;
}
if (g_command_line_params().get_count("") < 2)
{
vogl_error_printf("No trace file specified!\n");
tool_print_help();
voglsyms_deinit();
return EXIT_FAILURE;
}
if (g_command_line_params().get_value_as_bool("pause"))
{
vogl_message_printf("Press key to continue\n");
vogl_sleep(1000);
getchar();
}
bool success = voglsym_main_loop(argv);
voglsyms_deinit();
return success ? EXIT_SUCCESS : EXIT_FAILURE;
}
//----------------------------------------------------------------------------------------------------------------------
// init_logfile
//----------------------------------------------------------------------------------------------------------------------
static bool init_logfile()
{
VOGL_FUNC_TRACER
dynamic_string filename(g_command_line_params().get_value_as_string_or_empty("logfile"));
if (filename.is_empty())
return true;
return console::set_log_stream_filename(filename.c_str(), false);
}
//----------------------------------------------------------------------------------------------------------------------
// voglsyms_init
//----------------------------------------------------------------------------------------------------------------------
static bool voglsyms_init(int argc, char *argv[])
{
VOGL_FUNC_TRACER
console::disable_prefixes();
colorized_console::init();
colorized_console::set_exception_callback();
//console::set_tool_prefix("(voglsyms) ");
tool_print_title();
if (!init_command_line_params(argc, argv))
return false;
if (g_command_line_params().get_value_as_bool("quiet"))
console::disable_output();
return true;
}
//----------------------------------------------------------------------------------------------------------------------
// voglsym_main_loop
//----------------------------------------------------------------------------------------------------------------------
static bool
voglsym_main_loop(char *argv[])
{
VOGL_FUNC_TRACER
dynamic_string tracefile_arch;
dynamic_string actual_trace_filename;
vector<addr_data_t> addr_data_arr;
vector<btrace_module_info> module_infos;
dynamic_string trace_filename(g_command_line_params().get_value_as_string_or_empty("", 1));
if (trace_filename.is_empty())
{
vogl_error_printf("%s: No trace file specified!\n", VOGL_FUNCTION_NAME);
return false;
}
vogl_unique_ptr<vogl_trace_file_reader> pTrace_reader(vogl_open_trace_file(
trace_filename,
actual_trace_filename,
g_command_line_params().get_value_as_string_or_empty("loose_file_path").get_ptr()));
if (!pTrace_reader.get())
{
vogl_error_printf("%s: File not found, or unable to determine file type of trace file \"%s\"\n", VOGL_FUNCTION_NAME, trace_filename.get_ptr());
return false;
}
bool resolve_symbols = g_command_line_params().get_value_as_bool("resolve_symbols");
if (resolve_symbols)
vogl_printf("Resolving symbols in trace file %s\n\n", actual_trace_filename.get_ptr());
else
vogl_printf("Reading trace file %s\n\n", actual_trace_filename.get_ptr());
// compiler_info.json
dump_compiler_info(pTrace_reader.get(), tracefile_arch);
if (resolve_symbols)
{
if (tracefile_arch.size())
{
bool is_64bit = (sizeof(void *) == 8);
bool trace_file_arch_is_64bits = !tracefile_arch.compare("64bit");
if (trace_file_arch_is_64bits != is_64bit)
{
const char *arch_str = is_64bit ? "64-bit" : "32-bit";
vogl_error_printf("ERROR: %s is %s, tracefile is %s.\n", argv[0], arch_str, tracefile_arch.c_str());
vogl_error_printf("ERROR: Same architecture required to resolve symbols.\n");
return -1;
}
}
if (pTrace_reader->get_archive_blob_manager().does_exist(VOGL_TRACE_ARCHIVE_BACKTRACE_MAP_SYMS_FILENAME))
{
vogl_error_printf("ERROR: Symbols have already resolved for this tracefile.\n");
return -1;
}
}
// machine_info.json
dump_machine_info(pTrace_reader.get(), module_infos);
// backtrace_map_addrs.json
get_backtrace_map_addrs(pTrace_reader.get(), addr_data_arr);
// backtrace_map_syms.json
dump_backtrace_map_syms(pTrace_reader.get());
// Spew our module information
if (module_infos.size())
{
vogl_header1_printf("%s\n", std::string(78, '*').c_str());
vogl_header1_printf("%s\n", "Modules");
vogl_header1_printf("%s\n", std::string(78, '*').c_str());
for (uint i = 0; i < module_infos.size(); i++)
{
char uuid_str[41];
const btrace_module_info &module_info = module_infos[i];
btrace_uuid_to_str(uuid_str, module_info.uuid, module_info.uuid_len);
vogl_printf("0x%" PRIxPTR " (%u) %s %s %s",
module_info.base_address, module_info.address_size, uuid_str,
module_info.filename, module_info.is_exe ? "(exe)" : "");
if (resolve_symbols)
{
const char *debug_filename = NULL;
if (btrace_dlopen_add_module(module_info))
{
debug_filename = btrace_get_debug_filename(module_info.filename);
}
if (debug_filename)
{
vogl_printf(" [%s]", debug_filename);
}
}
vogl_printf("\n");
}
vogl_printf("\n");
}
// Spew our backtrace addresses
if (addr_data_arr.size())
{
vogl_header1_printf("%s\n", std::string(78, '*').c_str());
vogl_header1_printf("%s\n", VOGL_TRACE_ARCHIVE_BACKTRACE_MAP_ADDRS_FILENAME);
vogl_header1_printf("%s\n", std::string(78, '*').c_str());
vogl_printf("index (count): addr0, addr1, ...\n");
for (uint i = 0; i < addr_data_arr.size(); i++)
{
const addr_data_t &addr_data = addr_data_arr[i];
vogl_printf("0x%x (%u): ", addr_data.index, addr_data.count);
for (uint j = 0; j < addr_data.addrs.size(); j++)
{
vogl_printf("%" PRIxPTR " ", addr_data.addrs[j]);
}
vogl_printf("\n");
}
vogl_printf("\n");
}
// Resolve symbols if we're supposed to.
//$ TODO: The resolve symbols should be added to the trace file?
if (resolve_symbols)
{
json_document doc;
json_node *pRoot = doc.get_root();
pRoot->init_array();
vogl_header1_printf("%s\n", std::string(78, '*').c_str());
vogl_header1_printf("%s\n", "Resolving symbols...");
vogl_header1_printf("%s\n", std::string(78, '*').c_str());
for (uint i = 0; i < addr_data_arr.size(); i++)
{
const addr_data_t &addr_data = addr_data_arr[i];
json_node &syms_arr = pRoot->add_array();
for (uint j = 0; j < addr_data.addrs.size(); j++)
{
btrace_info trace_info;
uintptr_t addr = addr_data.addrs[j];
bool success = btrace_resolve_addr(&trace_info, addr,
BTRACE_RESOLVE_ADDR_GET_FILENAME | BTRACE_RESOLVE_ADDR_DEMANGLE_FUNC);
dynamic_string sym;
if (!success)
{
sym = "?";
}
else if (trace_info.function[0] && trace_info.filename[0])
{
// Got function and/or filename.
sym.format("%s (%s+0x%" PRIx64 ") at %s:%i",
trace_info.function,
trace_info.module[0] ? trace_info.module : "?",
cast_val_to_uint64(trace_info.offset),
trace_info.filename,
trace_info.linenumber);
}
else if (trace_info.function[0])
{
// Got function, no filename.
sym.format("%s (%s+0x%" PRIx64 ")",
trace_info.function,
trace_info.module[0] ? trace_info.module : "?",
cast_val_to_uint64(trace_info.offset));
}
else
{
// Only got modulename (no debugging information found).
sym.format("(%s+0x%" PRIx64 ")",
trace_info.module[0] ? trace_info.module : "?",
cast_val_to_uint64(trace_info.offset));
}
syms_arr.add_value(sym);
}
}
doc.print(true, 0, 0);
}
return true;
}
//----------------------------------------------------------------------------------------------------------------------
// tool_replay_mode
//----------------------------------------------------------------------------------------------------------------------
static bool tool_replay_mode()
{
VOGL_FUNC_TRACER
dynamic_string trace_filename(g_command_line_params().get_value_as_string_or_empty("", 1));
if (trace_filename.is_empty())
{
vogl_error_printf("No trace file specified!\n");
return false;
}
dynamic_string actual_trace_filename;
vogl_unique_ptr<vogl_trace_file_reader> pTrace_reader(
vogl_open_trace_file(
trace_filename,
actual_trace_filename,
g_command_line_params().get_value_as_string_or_empty("loose_file_path").get_ptr()
)
);
if (!pTrace_reader.get())
{
vogl_error_printf("File not found, or unable to determine file type of trace file \"%s\"\n", trace_filename.get_ptr());
return false;
}
vogl_printf("Reading trace file %s\n", actual_trace_filename.get_ptr());
vogl_gl_replayer replayer;
vogl_replay_window window;
#if defined(PLATFORM_WINDOWS)
// We need to get proc addresses for windows late.
replayer.set_proc_address_helper(vogl_get_proc_address_helper, false);
#endif
uint replayer_flags = get_replayer_flags_from_command_line_params();
// TODO: This will create a window with default attributes, which seems fine for the majority of traces.
// Unfortunately, some GL call streams *don't* want an alpha channel, or depth, or stencil etc. in the default framebuffer so this may become a problem.
// Also, this design only supports a single window, which is going to be a problem with multiple window traces.
if (!window.open(g_command_line_params().get_value_as_int("width", 0, 1024, 1, 65535), g_command_line_params().get_value_as_int("height", 0, 768, 1, 65535), g_command_line_params().get_value_as_int("msaa", 0, 0, 0, 65535)))
{
vogl_error_printf("Failed initializing replay window\n");
return false;
}
if (!replayer.init(replayer_flags, &window, pTrace_reader->get_sof_packet(), pTrace_reader->get_multi_blob_manager()))
{
vogl_error_printf("Failed initializing GL replayer\n");
return false;
}
// Disable all glGetError() calls in vogl_utils.cpp.
vogl_disable_gl_get_error();
// Bool win_mapped = false;
vogl_gl_state_snapshot *pSnapshot = NULL;
int64_t snapshot_loop_start_frame = -1;
int64_t snapshot_loop_end_frame = -1;
vogl::hash_map<SDL_Keycode> keys_pressed, keys_down;
int loop_frame = g_command_line_params().get_value_as_int("loop_frame", 0, -1);
int loop_len = math::maximum<int>(g_command_line_params().get_value_as_int("loop_len", 0, 1), 1);
int loop_count = math::maximum<int>(g_command_line_params().get_value_as_int("loop_count", 0, cINT32_MAX), 1);
bool endless_mode = g_command_line_params().get_value_as_bool("endless");
timer tm;
tm.start();
for (;;)
{
tmZone(TELEMETRY_LEVEL0, TMZF_NONE, "Main Loop");
SDL_Event wnd_event;
while (SDL_PollEvent(&wnd_event))
{
switch (wnd_event.type)
{
case SDL_KEYDOWN:
{
keys_down.insert(wnd_event.key.keysym.sym);
keys_pressed.insert(wnd_event.key.keysym.sym);
break;
}
case SDL_KEYUP:
{
keys_down.erase(wnd_event.key.keysym.sym);
break;
}
case SDL_WINDOWEVENT:
{
switch(wnd_event.window.event)
{
case SDL_WINDOWEVENT_FOCUS_GAINED:
case SDL_WINDOWEVENT_FOCUS_LOST:
keys_down.reset();
break;
case SDL_WINDOWEVENT_CLOSE:
vogl_message_printf("Window told to close, exiting.\n");
goto normal_exit;
break;
default:
break;
};
break;
}
default:
// TODO: Handle these somehow?
break;
};
}
if (replayer.get_at_frame_boundary())
{
if ((!pSnapshot) && (loop_frame != -1) && (static_cast<int64_t>(replayer.get_frame_index()) == loop_frame))
{
vogl_debug_printf("Capturing replayer state at start of frame %u\n", replayer.get_frame_index());
pSnapshot = replayer.snapshot_state();
if (pSnapshot)
{
vogl_printf("Snapshot succeeded\n");
snapshot_loop_start_frame = pTrace_reader->get_cur_frame();
snapshot_loop_end_frame = pTrace_reader->get_cur_frame() + loop_len;
vogl_debug_printf("Loop start: %" PRIi64 " Loop end: %" PRIi64 "\n", snapshot_loop_start_frame, snapshot_loop_end_frame);
}
else
{
vogl_error_printf("Snapshot failed!\n");
loop_frame = -1;
}
}
}
vogl_gl_replayer::status_t status = replayer.process_pending_window_resize();
if (status == vogl_gl_replayer::cStatusOK)
{
for (;;)
{
status = replayer.process_pending_packets();
if (status == vogl_gl_replayer::cStatusOK)
{
status = replayer.process_next_packet(*pTrace_reader);
}
if ((status == vogl_gl_replayer::cStatusNextFrame) ||
(status == vogl_gl_replayer::cStatusResizeWindow) ||
(status == vogl_gl_replayer::cStatusAtEOF) ||
(status == vogl_gl_replayer::cStatusHardFailure))
{
break;
}
}
}
if (status == vogl_gl_replayer::cStatusHardFailure)
break;
if (status == vogl_gl_replayer::cStatusAtEOF)
{
vogl_message_printf("At trace EOF, frame index %u\n", replayer.get_frame_index());
}
if (replayer.get_at_frame_boundary() &&
pSnapshot &&
(loop_count > 0) &&
((pTrace_reader->get_cur_frame() == snapshot_loop_end_frame) || (status == vogl_gl_replayer::cStatusAtEOF)))
{
status = replayer.begin_applying_snapshot(pSnapshot, false);
if ((status != vogl_gl_replayer::cStatusOK) && (status != vogl_gl_replayer::cStatusResizeWindow))
goto error_exit;
pTrace_reader->seek_to_frame(static_cast<uint>(snapshot_loop_start_frame));
vogl_debug_printf("Applying snapshot and seeking back to frame %" PRIi64 "\n", snapshot_loop_start_frame);
loop_count--;
}
else
{
bool print_progress = (status == vogl_gl_replayer::cStatusAtEOF) ||
((replayer.get_at_frame_boundary()) && ((replayer.get_frame_index() % 100) == 0));
if (print_progress)
{
if (pTrace_reader->get_type() == cBINARY_TRACE_FILE_READER)
{
vogl_binary_trace_file_reader &binary_trace_reader = *static_cast<vogl_binary_trace_file_reader *>(pTrace_reader.get());
vogl_printf("Replay now at frame index %u, trace file offet %" PRIu64 ", GL call counter %" PRIu64 ", %3.2f%% percent complete\n",
replayer.get_frame_index(),
binary_trace_reader.get_cur_file_ofs(),
replayer.get_last_parsed_call_counter(),
binary_trace_reader.get_trace_file_size() ? (binary_trace_reader.get_cur_file_ofs() * 100.0f) / binary_trace_reader.get_trace_file_size() : 0);
}
}
if (status == vogl_gl_replayer::cStatusAtEOF)
{
if (!endless_mode)
{
double time_since_start = tm.get_elapsed_secs();
vogl_printf("%u total swaps, %.3f secs, %3.3f avg fps\n", replayer.get_total_swaps(), time_since_start, replayer.get_frame_index() / time_since_start);
break;
}
vogl_printf("Resetting state and rewinding back to frame 0\n");
replayer.reset_state();
if (!pTrace_reader->seek_to_frame(0))
{
vogl_error_printf("Failed rewinding trace reader!\n");
goto error_exit;
}
}
}
telemetry_tick();
}
normal_exit:
return true;
error_exit:
return false;
}
}
//----------------------------------------------------------------------------------------------------------------------
// tool_find_mode
//----------------------------------------------------------------------------------------------------------------------
bool tool_find_mode(vogl::vector<command_line_param_desc> *desc)
{
VOGL_FUNC_TRACER
if (desc)
{
desc->append(g_command_line_param_descs_find, VOGL_ARRAY_SIZE(g_command_line_param_descs_find));
return true;
}
dynamic_string input_base_filename(g_command_line_params().get_value_as_string_or_empty("", 1));
if (input_base_filename.is_empty())
{
vogl_error_printf("Must specify filename of input JSON/blob trace files!\n");
return false;
}
dynamic_string actual_input_filename;
vogl_unique_ptr<vogl_trace_file_reader> pTrace_reader(vogl_open_trace_file(input_base_filename,
actual_input_filename,
g_command_line_params().get_value_as_string_or_empty("loose_file_path").get_ptr()));
if (!pTrace_reader.get())
return false;
bigint128 value_to_find(static_cast<uint64_t>(gl_enums::cUnknownEnum));
bool has_find_param = g_command_line_params().has_key("find_param");
//----------------------------------------------------------------------------------------------------------------------
// tool_replay_mode
//----------------------------------------------------------------------------------------------------------------------
static bool tool_replay_mode()
{
VOGL_FUNC_TRACER
dynamic_string trace_filename(g_command_line_params().get_value_as_string_or_empty("", 1));
if (trace_filename.is_empty())
{
vogl_error_printf("%s: No trace file specified!\n", VOGL_FUNCTION_INFO_CSTR);
return false;
}
dynamic_string actual_trace_filename;
vogl_unique_ptr<vogl_trace_file_reader> pTrace_reader(vogl_open_trace_file(
trace_filename,
actual_trace_filename,
g_command_line_params().get_value_as_string_or_empty("loose_file_path").get_ptr()));
if (!pTrace_reader.get())
{
vogl_error_printf("%s: File not found, or unable to determine file type of trace file \"%s\"\n", VOGL_FUNCTION_INFO_CSTR, trace_filename.get_ptr());
return false;
}
vogl_printf("Reading trace file %s\n", actual_trace_filename.get_ptr());
vogl_gl_replayer replayer;
vogl_replay_window window;
uint replayer_flags = get_replayer_flags_from_command_line_params();
// TODO: This will create a window with default attributes, which seems fine for the majority of traces.
// Unfortunately, some GL call streams *don't* want an alpha channel, or depth, or stencil etc. in the default framebuffer so this may become a problem.
// Also, this design only supports a single window, which is going to be a problem with multiple window traces.
if (!window.open(g_command_line_params().get_value_as_int("width", 0, 1024, 1, 65535), g_command_line_params().get_value_as_int("height", 0, 768, 1, 65535), g_command_line_params().get_value_as_int("msaa", 0, 0, 0, 65535)))
{
vogl_error_printf("%s: Failed initializing replay window\n", VOGL_FUNCTION_INFO_CSTR);
return false;
}
if (!replayer.init(replayer_flags, &window, pTrace_reader->get_sof_packet(), pTrace_reader->get_multi_blob_manager()))
{
vogl_error_printf("%s: Failed initializing GL replayer\n", VOGL_FUNCTION_INFO_CSTR);
return false;
}
// Disable all glGetError() calls in vogl_utils.cpp.
vogl_disable_gl_get_error();
XSelectInput(window.get_display(), window.get_xwindow(),
EnterWindowMask | LeaveWindowMask | ButtonPressMask | ButtonReleaseMask | PointerMotionMask | ExposureMask | FocusChangeMask | KeyPressMask | KeyReleaseMask | PropertyChangeMask | StructureNotifyMask | KeymapStateMask);
Atom wmDeleteMessage = XInternAtom(window.get_display(), "WM_DELETE_WINDOW", False);
XSetWMProtocols(window.get_display(), window.get_xwindow(), &wmDeleteMessage, 1);
// Bool win_mapped = false;
vogl_gl_state_snapshot *pSnapshot = NULL;
int64_t snapshot_loop_start_frame = -1;
int64_t snapshot_loop_end_frame = -1;
vogl::hash_map<uint64_t> keys_pressed, keys_down;
int loop_frame = g_command_line_params().get_value_as_int("loop_frame", 0, -1);
int loop_len = math::maximum<int>(g_command_line_params().get_value_as_int("loop_len", 0, 1), 1);
int loop_count = math::maximum<int>(g_command_line_params().get_value_as_int("loop_count", 0, cINT32_MAX), 1);
bool endless_mode = g_command_line_params().get_value_as_bool("endless");
timer tm;
tm.start();
for (;;)
{
tmZone(TELEMETRY_LEVEL0, TMZF_NONE, "Main Loop");
while (X11_Pending(window.get_display()))
{
XEvent newEvent;
// Watch for new X eventsn
XNextEvent(window.get_display(), &newEvent);
switch (newEvent.type)
{
case KeyPress:
{
KeySym xsym = XLookupKeysym(&newEvent.xkey, 0);
//printf("KeyPress 0%04llX %" PRIu64 "\n", (uint64_t)xsym, (uint64_t)xsym);
keys_down.insert(xsym);
keys_pressed.insert(xsym);
break;
}
case KeyRelease:
{
KeySym xsym = XLookupKeysym(&newEvent.xkey, 0);
//printf("KeyRelease 0x%04llX %" PRIu64 "\n", (uint64_t)xsym, (uint64_t)xsym);
keys_down.erase(xsym);
break;
}
case FocusIn:
case FocusOut:
{
//printf("FocusIn/FocusOut\n");
keys_down.reset();
break;
}
case MappingNotify:
{
//XRefreshKeyboardMapping(&newEvent);
break;
}
case UnmapNotify:
{
// printf("UnmapNotify\n");
// win_mapped = false;
keys_down.reset();
break;
}
case MapNotify:
{
// printf("MapNotify\n");
// win_mapped = true;
keys_down.reset();
if (!replayer.update_window_dimensions())
goto error_exit;
break;
}
case ConfigureNotify:
{
if (!replayer.update_window_dimensions())
goto error_exit;
break;
}
case DestroyNotify:
{
vogl_message_printf("Exiting\n");
goto normal_exit;
}
case ClientMessage:
{
if (newEvent.xclient.data.l[0] == (int)wmDeleteMessage)
{
vogl_message_printf("Exiting\n");
goto normal_exit;
}
break;
}
default:
break;
}
}
if (replayer.get_at_frame_boundary())
{
if ((!pSnapshot) && (loop_frame != -1) && (static_cast<int64_t>(replayer.get_frame_index()) == loop_frame))
{
vogl_debug_printf("%s: Capturing replayer state at start of frame %u\n", VOGL_FUNCTION_INFO_CSTR, replayer.get_frame_index());
pSnapshot = replayer.snapshot_state();
if (pSnapshot)
{
vogl_printf("Snapshot succeeded\n");
snapshot_loop_start_frame = pTrace_reader->get_cur_frame();
snapshot_loop_end_frame = pTrace_reader->get_cur_frame() + loop_len;
vogl_debug_printf("%s: Loop start: %" PRIi64 " Loop end: %" PRIi64 "\n", VOGL_FUNCTION_INFO_CSTR, snapshot_loop_start_frame, snapshot_loop_end_frame);
}
else
{
vogl_error_printf("Snapshot failed!\n");
loop_frame = -1;
}
}
}
vogl_gl_replayer::status_t status = replayer.process_pending_window_resize();
if (status == vogl_gl_replayer::cStatusOK)
{
for (;;)
{
status = replayer.process_next_packet(*pTrace_reader);
if ((status == vogl_gl_replayer::cStatusNextFrame) ||
(status == vogl_gl_replayer::cStatusResizeWindow) ||
(status == vogl_gl_replayer::cStatusAtEOF) ||
(status == vogl_gl_replayer::cStatusHardFailure))
{
break;
}
}
}
if (status == vogl_gl_replayer::cStatusHardFailure)
break;
if (status == vogl_gl_replayer::cStatusAtEOF)
{
vogl_message_printf("%s: At trace EOF, frame index %u\n", VOGL_FUNCTION_INFO_CSTR, replayer.get_frame_index());
}
if (replayer.get_at_frame_boundary() &&
pSnapshot &&
(loop_count > 0) &&
((pTrace_reader->get_cur_frame() == snapshot_loop_end_frame) || (status == vogl_gl_replayer::cStatusAtEOF)))
{
status = replayer.begin_applying_snapshot(pSnapshot, false);
if ((status != vogl_gl_replayer::cStatusOK) && (status != vogl_gl_replayer::cStatusResizeWindow))
goto error_exit;
pTrace_reader->seek_to_frame(static_cast<uint>(snapshot_loop_start_frame));
vogl_debug_printf("%s: Applying snapshot and seeking back to frame %" PRIi64 "\n", VOGL_FUNCTION_INFO_CSTR, snapshot_loop_start_frame);
loop_count--;
}
else
{
bool print_progress = (status == vogl_gl_replayer::cStatusAtEOF) ||
((replayer.get_at_frame_boundary()) && ((replayer.get_frame_index() % 100) == 0));
if (print_progress)
{
if (pTrace_reader->get_type() == cBINARY_TRACE_FILE_READER)
{
vogl_binary_trace_file_reader &binary_trace_reader = *static_cast<vogl_binary_trace_file_reader *>(pTrace_reader.get());
vogl_printf("Replay now at frame index %u, trace file offet %" PRIu64 ", GL call counter %" PRIu64 ", %3.2f%% percent complete\n",
replayer.get_frame_index(),
binary_trace_reader.get_cur_file_ofs(),
replayer.get_last_parsed_call_counter(),
binary_trace_reader.get_trace_file_size() ? (binary_trace_reader.get_cur_file_ofs() * 100.0f) / binary_trace_reader.get_trace_file_size() : 0);
}
}
if (status == vogl_gl_replayer::cStatusAtEOF)
{
if (!endless_mode)
{
double time_since_start = tm.get_elapsed_secs();
vogl_printf("%u total swaps, %.3f secs, %3.3f avg fps\n", replayer.get_total_swaps(), time_since_start, replayer.get_frame_index() / time_since_start);
break;
}
vogl_printf("Resetting state and rewinding back to frame 0\n");
replayer.reset_state();
if (!pTrace_reader->seek_to_frame(0))
{
vogl_error_printf("%s: Failed rewinding trace reader!\n", VOGL_FUNCTION_INFO_CSTR);
goto error_exit;
}
}
}
telemetry_tick();
}
normal_exit:
return true;
error_exit:
return false;
}
bool
tool_trace_mode(vogl::vector<command_line_param_desc> *desc)
{
arguments_t args;
if (desc)
{
desc->append(g_command_line_param_descs_dump, VOGL_ARRAY_SIZE(g_command_line_param_descs_dump));
desc->append(g_tracer_cmdline_opts, VOGL_ARRAY_SIZE(g_tracer_cmdline_opts));
return true;
}
// Get steam gameid / local application name.
args.gameid = g_command_line_params().get_value_as_string_or_empty("", 1);
if (!args.gameid.size())
errorf(VOGL_FUNCTION_INFO_CSTR, "ERROR: No application or steamid specified.\n");
// Get logfile and tracefile names.
args.vogl_tracefile = g_command_line_params().get_value_as_string("vogl_tracefile");
args.vogl_logfile = g_command_line_params().get_value_as_string("vogl_logfile");
args.dryrun = g_command_line_params().get_value_as_bool("dry-run");
args.xterm = g_command_line_params().get_value_as_bool("xterm");
// Loop through all the arguments looking for "vogl_*".
for (vogl::command_line_params::param_map_const_iterator param = g_command_line_params().begin();
param != g_command_line_params().end();
++param)
{
const dynamic_string &first = param->first;
// If this is a vogl command and it's not logfile / tracefile, add it to the vogl_cmdline.
const dynamic_string prefix = param->first.get_clone().left(5);
if (prefix == "vogl_" && (first != "vogl_logfile" && first != "vogl_tracefile"))
{
args.vogl_cmdline += " --" + first;
for (uint32_t i = 0; i < param->second.m_values.size(); i++)
{
args.vogl_cmdline += " " + param->second.m_values[i];
}
}
}
// Check for -- or --args and add everything after to game_args.
const dynamic_string& command_line = get_command_line();
int args_index = command_line.find_left("-- ");
if (args_index == -1)
args_index = command_line.find_left("--args ");
if (args_index != -1)
{
args_index = command_line.find_left(' ', args_index);
if (args_index != -1)
{
args.game_args += command_line.get_clone().right(args_index + 1);
}
}
bool is_steam_file = true;
if (atoi(args.gameid.c_str()) == 0)
{
if (access(args.gameid.c_str(), F_OK))
errorf(VOGL_FUNCTION_INFO_CSTR, "\nCould not find executable '%s'\n", args.gameid.c_str());
char *filename = realpath(args.gameid.c_str(), NULL);
if (filename)
{
// This is a local executable.
is_steam_file = false;
args.gameid = filename;
free(filename);
}
}
int steam_appid = is_steam_file ? atoi(args.gameid.c_str()) : -1;
if (!steam_appid)
errorf(VOGL_FUNCTION_INFO_CSTR, "ERROR: Could not find game number for %s\n", args.gameid.c_str());
dynamic_string gameid_str;
if (is_steam_file)
{
gameid_str = "appid" + args.gameid;
vogl_printf("\nGame AppID: %d", steam_appid);
const char *game_name = get_game_name(steam_appid);
if (game_name)
{
dynamic_string game_name_str(cVarArg, "%s", game_name);
vogl_printf(" (%s)", game_name_str.c_str());
// Trim some characters that don't go well with filenames.
game_name_str.replace(" ", "_");
game_name_str.replace(":", "");
game_name_str.replace("'", "");
game_name_str.replace("!", "");
game_name_str.replace("?", "");
gameid_str += "_" + game_name_str;
}
vogl_printf("\n");
}
else
{
gameid_str = basename((char *)args.gameid.c_str());
vogl_printf("\nGame: %s\n", args.gameid.c_str());
}
// If a tracefile / logfile wasn't specified, set em up.
if (!args.vogl_tracefile.size() || !args.vogl_logfile.size())
{
char timestr[200];
time_t t = time(NULL);
timestr[0] = 0;
struct tm *tmp = localtime(&t);
if (tmp)
{
strftime(timestr, sizeof(timestr), "%Y_%m_%d-%H_%M_%S", tmp);
}
dynamic_string fname(cVarArg, "%s/vogltrace.%s.%s", P_tmpdir, gameid_str.c_str(), timestr);
if (!args.vogl_tracefile.size())
args.vogl_tracefile = fname + ".bin";
if (!args.vogl_logfile.size())
args.vogl_logfile = fname + ".log";
}
vogl_printf("\n");
vogl_message_printf("Tracefile: %s\n", args.vogl_tracefile.c_str());
vogl_message_printf("Logfile: %s", args.vogl_logfile.c_str());
vogl_printf(" (will have PID appended)\n");
dynamic_string vogltracepath32 = getfullpath("libvogltrace32.so");
dynamic_string vogltracepath64 = getfullpath("libvogltrace64.so");
// set up LD_PRELOAD string
dynamic_string LD_PRELOAD = "LD_PRELOAD=\"";
LD_PRELOAD += vogltracepath32 + ":" + vogltracepath64;
if (is_steam_file || getenv("LD_PRELOAD"))
LD_PRELOAD += ":$LD_PRELOAD";
LD_PRELOAD += "\" ";
vogl_printf("\n%s\n", LD_PRELOAD.c_str());
// set up VOGL_CMD_LINE string
dynamic_string VOGL_CMD_LINE = "VOGL_CMD_LINE=\"";
VOGL_CMD_LINE += "--vogl_tracefile " + args.vogl_tracefile;
VOGL_CMD_LINE += " --vogl_logfile " + args.vogl_logfile;
VOGL_CMD_LINE += args.vogl_cmdline;
VOGL_CMD_LINE += "\"";
vogl_printf("\n%s\n", VOGL_CMD_LINE.c_str());
dynamic_string xterm_str;
if (args.xterm)
{
xterm_str = "xterm -geom 120x80+20+20";
const char *env_user = getenv("USER");
// If this is mikesart, specify using the Consolas font (which he likes).
if (env_user && !strcmp(env_user, "mikesart"))
xterm_str += " -fa Consolas -fs 10";
// Add the xterm command part.
xterm_str += " -e ";
}
if (is_steam_file)
{
// set up xterm string
dynamic_string steam_cmd_str;
steam_cmd_str = xterm_str + "%command% " + args.game_args;
steam_cmd_str.trim();
// set up steam string
dynamic_string steam_str = "steam steam://run/" + args.gameid + "//";
dynamic_string steam_args = VOGL_CMD_LINE + " " + LD_PRELOAD + steam_cmd_str;
dynamic_string steam_fullcmd = steam_str + url_encode(steam_args.c_str());
// Spew this whole mess out.
vogl_printf("\nLaunch string:\n%s\n", (steam_str + steam_args).c_str());
vogl_printf("\nURL encoded launch string:\n%s\n", steam_fullcmd.c_str());
// And launch it...
if (!args.dryrun)
system(steam_fullcmd.c_str());
}
else
{
dynamic_string system_cmd;
system_cmd = VOGL_CMD_LINE + " " + LD_PRELOAD + " " + xterm_str + args.gameid + " " + args.game_args;
vogl_printf("\nlaunch string:\n%s\n", system_cmd.c_str());
if (!args.dryrun)
system(system_cmd.c_str());
}
return true;
}
