1 /**************************************************************************
3 * Copyright 2013-2014 RAD Game Tools and Valve Software
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 **************************************************************************/
26 #include <QFileDialog>
27 #include <QHBoxLayout>
28 #include <QItemSelection>
31 #include <QSortFilterProxyModel>
32 #include <QSpacerItem>
33 #include <QToolButton>
34 #include <QMessageBox>
36 #include "ui_vogleditor.h"
37 #include "vogleditor.h"
39 #include "vogleditor_qapicalltreemodel.h"
40 #include "vogleditor_apicalltimelinemodel.h"
42 #include "vogl_platform.h"
43 #include "vogl_assert.h"
44 #include "vogl_file_utils.h"
45 #include "vogl_find_files.h"
47 #include "vogl_texture_format.h"
48 #include "vogl_trace_file_reader.h"
49 #include "vogl_trace_file_writer.h"
50 #include "vogleditor_output.h"
51 #include "vogleditor_settings.h"
52 #include "vogleditor_statetreetextureitem.h"
53 #include "vogleditor_statetreeprogramitem.h"
54 #include "vogleditor_statetreeshaderitem.h"
55 #include "vogleditor_statetreeframebufferitem.h"
56 #include "vogleditor_qstatetreemodel.h"
57 #include "vogleditor_qtextureexplorer.h"
58 #include "vogleditor_qtrimdialog.h"
60 #define VOGLEDITOR_DISABLE_STATE_TAB(tab) ui->tabWidget->setTabEnabled(ui->tabWidget->indexOf(tab), false);
61 #define VOGLEDITOR_ENABLE_STATE_TAB(tab) ui->tabWidget->setTabEnabled(ui->tabWidget->indexOf(tab), true);
63 #define VOGLEDITOR_DISABLE_BOTTOM_TAB(tab) ui->bottomTabWidget->setTabEnabled(ui->bottomTabWidget->indexOf(tab), false);
64 #define VOGLEDITOR_ENABLE_BOTTOM_TAB(tab) ui->bottomTabWidget->setTabEnabled(ui->bottomTabWidget->indexOf(tab), true);
66 //----------------------------------------------------------------------------------------------------------------------
68 //----------------------------------------------------------------------------------------------------------------------
69 static void *g_actual_libgl_module_handle;
70 static QString g_PROJECT_NAME = "Vogl Editor";
71 static vogleditor_settings g_settings;
72 static const char* g_SETTINGS_FILE = "./vogleditor_settings.json";
74 //----------------------------------------------------------------------------------------------------------------------
75 // vogl_get_proc_address_helper
76 //----------------------------------------------------------------------------------------------------------------------
77 static vogl_void_func_ptr_t vogl_get_proc_address_helper(const char *pName)
81 vogl_void_func_ptr_t pFunc = g_actual_libgl_module_handle ? reinterpret_cast<vogl_void_func_ptr_t>(dlsym(g_actual_libgl_module_handle, pName)) : NULL;
83 if ((!pFunc) && (GL_ENTRYPOINT(glXGetProcAddress)))
84 pFunc = reinterpret_cast<vogl_void_func_ptr_t>( GL_ENTRYPOINT(glXGetProcAddress)(reinterpret_cast<const GLubyte*>(pName)) );
90 //----------------------------------------------------------------------------------------------------------------------
92 //----------------------------------------------------------------------------------------------------------------------
97 g_actual_libgl_module_handle = dlopen("libGL.so.1", RTLD_LAZY);
98 if (!g_actual_libgl_module_handle)
100 vogl_error_printf("%s: Failed loading libGL.so.1!\n", VOGL_FUNCTION_NAME);
104 GL_ENTRYPOINT(glXGetProcAddress) = reinterpret_cast<glXGetProcAddress_func_ptr_t>(dlsym(g_actual_libgl_module_handle, "glXGetProcAddress"));
105 if (!GL_ENTRYPOINT(glXGetProcAddress))
107 vogl_error_printf("%s: Failed getting address of glXGetProcAddress() from libGL.so.1!\n", VOGL_FUNCTION_NAME);
114 VoglEditor::VoglEditor(QWidget *parent) :
116 ui(new Ui::VoglEditor),
117 m_pFramebufferExplorer(NULL),
118 m_pTextureExplorer(NULL),
119 m_pRenderbufferExplorer(NULL),
120 m_pProgramExplorer(NULL),
121 m_pShaderExplorer(NULL),
123 m_pFramebufferTab_layout(NULL),
124 m_pTextureTab_layout(NULL),
125 m_pRenderbufferTab_layout(NULL),
126 m_pProgramTab_layout(NULL),
127 m_pShaderTab_layout(NULL),
128 m_currentSnapshot(NULL),
129 m_pCurrentCallTreeItem(NULL),
130 m_pVoglReplayProcess(new QProcess()),
133 m_pTraceReader(NULL),
134 m_pTimelineModel(NULL),
135 m_pApiCallTreeModel(NULL),
136 m_pStateTreeModel(NULL)
142 vogl_init_actual_gl_entrypoints(vogl_get_proc_address_helper);
145 // load the settings file. This will only succeed if the file already exists
146 g_settings.load(g_SETTINGS_FILE);
148 // always save/resave the file wiill either be created or so that new settings will be added
149 g_settings.save(g_SETTINGS_FILE);
151 this->move(g_settings.window_position_left(), g_settings.window_position_top());
152 this->resize(g_settings.window_size_width(), g_settings.window_size_height());
154 vogleditor_output_init(ui->outputTextEdit);
155 vogleditor_output_message("Welcome to VoglEditor!");
157 // cache the original background color of the search text box
158 m_searchTextboxBackgroundColor = ui->searchTextBox->palette().base().color();
160 // setup framebuffer tab
161 m_pFramebufferTab_layout = new QGridLayout();
162 m_pFramebufferExplorer = new vogleditor_QFramebufferExplorer(ui->framebufferTab);
163 m_pFramebufferTab_layout->addWidget(m_pFramebufferExplorer, 0, 0);
164 ui->framebufferTab->setLayout(m_pFramebufferTab_layout);
167 m_pTextureTab_layout = new QGridLayout();
168 m_pTextureExplorer = new vogleditor_QTextureExplorer(ui->textureTab);
169 m_pTextureTab_layout->addWidget(m_pTextureExplorer, 0, 0);
170 ui->textureTab->setLayout(m_pTextureTab_layout);
172 // setup renderbuffer tab
173 m_pRenderbufferTab_layout = new QGridLayout();
174 m_pRenderbufferExplorer = new vogleditor_QTextureExplorer(ui->renderbufferTab);
175 m_pRenderbufferTab_layout->addWidget(m_pRenderbufferExplorer, 0, 0);
176 ui->renderbufferTab->setLayout(m_pRenderbufferTab_layout);
179 m_pProgramTab_layout = new QGridLayout();
180 m_pProgramExplorer = new vogleditor_QProgramExplorer(ui->programTab);
181 m_pProgramTab_layout->addWidget(m_pProgramExplorer, 0, 0);
182 ui->programTab->setLayout(m_pProgramTab_layout);
185 m_pShaderTab_layout = new QGridLayout();
186 m_pShaderExplorer = new vogleditor_QShaderExplorer(ui->shaderTab);
187 m_pShaderTab_layout->addWidget(m_pShaderExplorer, 0, 0);
188 ui->shaderTab->setLayout(m_pShaderTab_layout);
191 m_timeline = new vogleditor_QTimelineView();
192 m_timeline->setMinimumHeight(100);
193 ui->verticalLayout->addWidget(m_timeline);
194 ui->verticalLayout->removeWidget(ui->timelineViewPlaceholder);
196 // add buttons to toolbar
197 m_pPlayButton = new QToolButton(ui->mainToolBar);
198 m_pPlayButton->setText("Play Trace");
199 m_pPlayButton->setEnabled(false);
201 m_pTrimButton = new QToolButton(ui->mainToolBar);
202 m_pTrimButton->setText("Trim Trace");
203 m_pTrimButton->setEnabled(false);
205 ui->mainToolBar->addWidget(m_pPlayButton);
206 ui->mainToolBar->addWidget(m_pTrimButton);
208 connect(m_pPlayButton, SIGNAL(clicked()), this, SLOT(playCurrentTraceFile()));
209 connect(m_pTrimButton, SIGNAL(clicked()), this, SLOT(trimCurrentTraceFile()));
211 connect(m_pProgramExplorer, SIGNAL(program_edited(vogl_program_state*)), this, SLOT(slot_program_edited(vogl_program_state*)));
213 connect(m_pVoglReplayProcess, SIGNAL(readyReadStandardOutput()), this, SLOT(slot_readReplayStandardOutput()));
214 connect(m_pVoglReplayProcess, SIGNAL(readyReadStandardError()), this, SLOT(slot_readReplayStandardError()));
216 reset_tracefile_ui();
219 VoglEditor::~VoglEditor()
221 // update any settings and save the settings file
222 g_settings.set_window_position_left(this->x());
223 g_settings.set_window_position_top(this->y());
224 g_settings.set_window_size_width(this->width());
225 g_settings.set_window_size_height(this->height());
226 g_settings.save(g_SETTINGS_FILE);
230 vogleditor_output_deinit();
232 if (m_pFramebufferExplorer != NULL)
234 delete m_pFramebufferExplorer;
235 m_pFramebufferExplorer = NULL;
238 if (m_pTextureExplorer != NULL)
240 delete m_pTextureExplorer;
241 m_pTextureExplorer = NULL;
244 if (m_pRenderbufferExplorer != NULL)
246 delete m_pRenderbufferExplorer;
247 m_pRenderbufferExplorer = NULL;
250 if (m_pProgramExplorer != NULL)
252 delete m_pProgramExplorer;
253 m_pProgramExplorer = NULL;
256 if (m_pShaderExplorer != NULL)
258 delete m_pShaderExplorer;
259 m_pShaderExplorer = NULL;
262 if (m_pPlayButton != NULL)
264 delete m_pPlayButton;
265 m_pPlayButton = NULL;
268 if (m_pTrimButton != NULL)
270 delete m_pTrimButton;
271 m_pTrimButton = NULL;
274 if (m_pFramebufferTab_layout != NULL)
276 delete m_pFramebufferTab_layout;
277 m_pFramebufferTab_layout = NULL;
280 if (m_pTextureTab_layout != NULL)
282 delete m_pTextureTab_layout;
283 m_pTextureTab_layout = NULL;
286 if (m_pRenderbufferTab_layout != NULL)
288 delete m_pRenderbufferTab_layout;
289 m_pRenderbufferTab_layout = NULL;
292 if (m_pProgramTab_layout != NULL)
294 delete m_pProgramTab_layout;
295 m_pProgramTab_layout = NULL;
298 if (m_pShaderTab_layout != NULL)
300 delete m_pShaderTab_layout;
301 m_pShaderTab_layout = NULL;
304 if (m_pStateTreeModel != NULL)
306 delete m_pStateTreeModel;
307 m_pStateTreeModel = NULL;
310 if (m_pVoglReplayProcess != NULL)
312 delete m_pVoglReplayProcess;
313 m_pVoglReplayProcess = NULL;
317 void VoglEditor::playCurrentTraceFile()
319 QCursor origCursor = cursor();
320 setCursor(Qt::WaitCursor);
323 m_pPlayButton->setEnabled(false);
324 m_pTrimButton->setEnabled(false);
326 m_traceReplayer.replay(m_pTraceReader, m_pApiCallTreeModel->root(), NULL, 0, true);
328 m_pPlayButton->setEnabled(true);
329 m_pTrimButton->setEnabled(true);
331 setCursor(origCursor);
334 void VoglEditor::trimCurrentTraceFile()
336 trim_trace_file(m_openFilename, static_cast<uint>(m_pTraceReader->get_max_frame_index()), g_settings.trim_large_trace_prompt_size());
339 /// \return True if the new trim file is now open in the editor
340 /// \return False if there was an error, or the user elected NOT to open the new trim file
341 bool VoglEditor::trim_trace_file(QString filename, uint maxFrameIndex, uint maxAllowedTrimLen)
343 // open a dialog to gather parameters for the replayer
344 vogleditor_QTrimDialog trimDialog(filename, maxFrameIndex, maxAllowedTrimLen, this);
345 int code = trimDialog.exec();
347 if (code == QDialog::Rejected)
352 QStringList arguments;
353 arguments << "--trim_frame" << trimDialog.trim_frame() << "--trim_len" << trimDialog.trim_len() << "--trim_file" << trimDialog.trim_file() << filename;
356 QString executable = "./voglreplay32";
358 QString executable = "./voglreplay64";
361 QString cmdLine = executable + " " + arguments.join(" ");
363 vogleditor_output_message("Trimming trace file");
364 vogleditor_output_message(cmdLine.toStdString().c_str());
365 m_pVoglReplayProcess->start(executable, arguments);
366 if (m_pVoglReplayProcess->waitForStarted() == false)
368 vogleditor_output_error("voglreplay could not be executed.");
372 // This is a bad idea as it will wait forever,
373 // but if the replay is taking forever then we have bigger problems.
374 if(m_pVoglReplayProcess->waitForFinished(-1))
376 vogleditor_output_message("Trim Completed!");
379 int procRetValue = m_pVoglReplayProcess->exitCode();
381 bool bCompleted = false;
382 if (procRetValue == -2)
384 // proc failed to starts
385 vogleditor_output_error("voglreplay could not be executed.");
387 else if (procRetValue == -1)
390 vogleditor_output_error("voglreplay aborted unexpectedly.");
392 else if (procRetValue == 0)
399 // some other return value
405 int ret = QMessageBox::warning(this, tr("Trim Trace"), tr("Would you like to load the new trimmed trace file?"),
406 QMessageBox::Yes | QMessageBox::No, QMessageBox::Yes);
408 if (ret == QMessageBox::Yes)
411 if (open_trace_file(trimDialog.trim_file().toStdString().c_str()))
417 vogleditor_output_error("Could not open trace file.");
418 QMessageBox::critical(this, tr("Error"), tr("Could not open trace file."));
424 vogleditor_output_error("Failed to trim the trace file.");
425 QMessageBox::critical(this, tr("Error"), tr("Failed to trim the trace file."));
430 void VoglEditor::on_actionE_xit_triggered()
435 void VoglEditor::on_action_Open_triggered()
437 QString fileName = QFileDialog::getOpenFileName(this, tr("Open File"), QString(),
438 tr("VOGL Binary Files (*.bin);;VOGL JSON Files (*.json)"));
440 if (!fileName.isEmpty()) {
441 vogl::dynamic_string filename;
442 filename.set(fileName.toStdString().c_str());
444 if (open_trace_file(filename) == false) {
445 QMessageBox::critical(this, tr("Error"), tr("Could not open trace file."));
451 void VoglEditor::on_action_Close_triggered()
456 void VoglEditor::close_trace_file()
458 if (m_pTraceReader != NULL)
460 vogleditor_output_message("Closing trace file.");
461 vogleditor_output_message("-------------------");
462 m_pTraceReader->close();
463 vogl_delete(m_pTraceReader);
464 m_pTraceReader = NULL;
466 setWindowTitle(g_PROJECT_NAME);
468 m_openFilename.clear();
469 m_backtraceToJsonMap.clear();
470 m_backtraceDoc.clear();
472 reset_tracefile_ui();
474 ui->treeView->setModel(NULL);
475 ui->machineInfoText->clear();
476 ui->backtraceText->clear();
477 m_timeline->setModel(NULL);
478 m_timeline->repaint();
480 if (m_pTimelineModel != NULL)
482 delete m_pTimelineModel;
483 m_pTimelineModel = NULL;
486 if (m_pApiCallTreeModel != NULL)
488 delete m_pApiCallTreeModel;
489 m_pApiCallTreeModel = NULL;
494 void VoglEditor::write_child_api_calls(vogleditor_apiCallTreeItem* pItem, FILE* pFile)
496 QString string = pItem->columnData(VOGL_ACTC_APICALL, Qt::DisplayRole).toString();
497 vogl_fwrite(string.toStdString().c_str(), 1, string.size(), pFile);
498 vogl_fwrite("\r\n", 1, 2, pFile);
500 for (int i = 0; i < pItem->childCount(); i++)
502 write_child_api_calls(pItem->child(i), pFile);
506 void VoglEditor::on_actionExport_API_Calls_triggered()
508 QString suggestedName = m_openFilename;
510 int lastIndex = suggestedName.lastIndexOf('-');
513 suggestedName = suggestedName.remove(lastIndex, suggestedName.size() - lastIndex);
515 suggestedName += "-ApiCalls.txt";
517 QString fileName = QFileDialog::getSaveFileName(this, tr("Export API Calls"), suggestedName, tr("Text (*.txt)"));
519 if (!fileName.isEmpty())
521 vogl::dynamic_string filename;
522 filename.set(fileName.toStdString().c_str());
524 FILE* pFile = vogl_fopen(filename.c_str(), "w");
525 vogleditor_QApiCallTreeModel* pModel = static_cast<vogleditor_QApiCallTreeModel*>(ui->treeView->model());
526 vogleditor_apiCallTreeItem* pRoot = pModel->root();
527 for (int i = 0; i < pRoot->childCount(); i++)
529 write_child_api_calls(pRoot->child(i), pFile);
535 static const unsigned int VOGLEDITOR_SESSION_FILE_FORMAT_VERSION_1 = 1;
536 static const unsigned int VOGLEDITOR_SESSION_FILE_FORMAT_VERSION = VOGLEDITOR_SESSION_FILE_FORMAT_VERSION_1;
538 bool VoglEditor::load_session_from_disk(QString sessionFile)
541 json_document sessionDoc;
542 if (!sessionDoc.deserialize_file(sessionFile.toStdString().c_str()))
547 // look for expected metadata
548 json_node* pMetadata = sessionDoc.get_root()->find_child_object("metadata");
549 if (pMetadata == NULL)
554 const json_value& rFormatVersion = pMetadata->find_value("session_file_format_version");
555 if (!rFormatVersion.is_valid())
560 if (rFormatVersion.as_uint32() != VOGLEDITOR_SESSION_FILE_FORMAT_VERSION_1)
565 // load base trace file
566 json_node* pBaseTraceFile = sessionDoc.get_root()->find_child_object("base_trace_file");
567 if (pBaseTraceFile == NULL)
572 const json_value& rBaseTraceFilePath = pBaseTraceFile->find_value("rel_path");
573 const json_value& rBaseTraceFileUuid = pBaseTraceFile->find_value("uuid");
575 if (!rBaseTraceFilePath.is_valid() || !rBaseTraceFileUuid.is_valid())
580 dynamic_string sessionPathName;
581 dynamic_string sessionFileName;
582 file_utils::split_path(sessionFile.toStdString().c_str(), sessionPathName, sessionFileName);
584 dynamic_string traceFilePath = sessionPathName;
585 traceFilePath.append(rBaseTraceFilePath.as_string());
587 if (!open_trace_file(traceFilePath))
592 // TODO: verify UUID of the loaded trace file
594 // load session data if it is available
595 json_node* pSessionData = sessionDoc.get_root()->find_child_object("session_data");
596 if (pSessionData != NULL)
598 const json_value& rSessionPath = pSessionData->find_value("rel_path");
599 if (!rSessionPath.is_valid())
604 dynamic_string sessionDataPath = sessionPathName;
605 sessionDataPath.append(rSessionPath.as_string());
607 vogl_loose_file_blob_manager file_blob_manager;
608 file_blob_manager.init(cBMFReadWrite, sessionDataPath.c_str());
609 vogl_blob_manager* pBlob_manager = static_cast<vogl_blob_manager*>(&file_blob_manager);
612 const json_node* pSnapshots = pSessionData->find_child_array("snapshots");
613 for (unsigned int i = 0; i < pSnapshots->size(); i++)
615 const json_node* pSnapshotNode = pSnapshots->get_value_as_object(i);
617 const json_value& uuid = pSnapshotNode->find_value("uuid");
618 const json_value& isValid = pSnapshotNode->find_value("is_valid");
619 const json_value& isEdited = pSnapshotNode->find_value("is_edited");
620 const json_value& isOutdated = pSnapshotNode->find_value("is_outdated");
621 const json_value& frameNumber = pSnapshotNode->find_value("frame_number");
622 const json_value& callIndex = pSnapshotNode->find_value("call_index");
623 const json_value& path = pSnapshotNode->find_value("rel_path");
625 // make sure expected nodes are valid
626 if (!isValid.is_valid() || !isEdited.is_valid() || !isOutdated.is_valid())
631 vogl_gl_state_snapshot* pSnapshot = NULL;
633 if (path.is_valid() && isValid.as_bool() && uuid.is_valid())
635 dynamic_string snapshotPath = sessionDataPath;
636 snapshotPath.append(path.as_string());
639 json_document snapshotDoc;
640 if (!snapshotDoc.deserialize_file(snapshotPath.c_str()))
645 // attempt to verify the snapshot file
646 json_node* pSnapshotRoot = snapshotDoc.get_root();
647 if (pSnapshotRoot == NULL)
649 vogl_warning_printf("Invalid snapshot file at %s.", path.as_string_ptr());
653 const json_value& snapshotUuid = pSnapshotRoot->find_value("uuid");
654 if (!snapshotUuid.is_valid())
656 vogl_warning_printf("Invalid 'uuid' in snapshot file at %s.", path.as_string_ptr());
660 if (snapshotUuid.as_string() != uuid.as_string())
662 vogl_warning_printf("Mismatching 'uuid' between snapshot file at %s and that stored in the session file at %s.", path.as_string_ptr(), sessionFile.toStdString().c_str());
666 vogl_ctypes trace_gl_ctypes(m_pTraceReader->get_sof_packet().m_pointer_sizes);
667 pSnapshot = vogl_new(vogl_gl_state_snapshot);
668 if (!pSnapshot->deserialize(*snapshotDoc.get_root(), *pBlob_manager, &trace_gl_ctypes))
670 vogl_delete(pSnapshot);
672 vogl_warning_printf("Unable to deserialize the snapshot with uuid %s.", uuid.as_string_ptr());
677 vogleditor_gl_state_snapshot* pContainer = vogl_new(vogleditor_gl_state_snapshot, pSnapshot);
678 pContainer->set_edited(isEdited.as_bool());
679 pContainer->set_outdated(isOutdated.as_bool());
681 if (callIndex.is_valid())
683 // the snapshot is associated with an api call
684 vogleditor_apiCallTreeItem* pItem = m_pApiCallTreeModel->find_call_number(callIndex.as_uint64());
687 pItem->set_snapshot(pContainer);
691 vogl_warning_printf("Unable to find API call index %" PRIu64 " to load the snapshot into.", callIndex.as_uint64());
692 if (pSnapshot != NULL) { vogl_delete(pSnapshot); pSnapshot = NULL; }
693 if (pContainer != NULL) { vogl_delete(pContainer); pContainer = NULL; }
696 else if (frameNumber.is_valid())
698 // the snapshot is associated with a frame.
699 // frame snapshots have the additional requirement that the snapshot itself MUST exist since
700 // we only save a frame snapshot if it is the inital frame and it has been edited.
701 // If we allow NULL snapshots, that we could accidently remove the initial snapshot that was loaded with the trace file.
702 if (pSnapshot != NULL)
704 vogleditor_apiCallTreeItem* pItem = m_pApiCallTreeModel->find_frame_number(frameNumber.as_uint64());
707 pItem->set_snapshot(pContainer);
711 vogl_warning_printf("Unable to find frame number %" PRIu64 " to load the snapshot into.", frameNumber.as_uint64());
712 if (pSnapshot != NULL) { vogl_delete(pSnapshot); pSnapshot = NULL; }
713 if (pContainer != NULL) { vogl_delete(pContainer); pContainer = NULL; }
719 vogl_warning_printf("Session file contains invalid call or frame number for snapshot with uuid %s", uuid.as_string_ptr());
720 if (pSnapshot != NULL) { vogl_delete(pSnapshot); pSnapshot = NULL; }
721 if (pContainer != NULL) { vogl_delete(pContainer); pContainer = NULL; }
730 * Below is a summary of the information that needs to be saved out in a session's json file so that we can reload the session and be fully-featured.
731 * Note that not all of this information is currently supported (either by VoglEditor or the save/load functionality).
733 * sample data structure for version 1:
736 "session_file_format_version" : "0x1" <- would need to be updated when organization of existing data is changed
738 "base_trace_file" : {
739 "path" : "../traces/trimmed4.bin",
740 "uuid" : [ 2761638124, 1361789091, 2623121922, 1789156619 ]
743 "path" : "/home/peterl/voglproj/vogl_build/traces/trimmed4-vogleditor-sessiondata/",
746 "uuid" : "B346B680801ED2F5144E421DEA5EFDCC",
749 "is_outdated" : false,
753 "uuid" : "BC261B884088DBEADF376A03A489F2B9",
756 "is_outdated" : false,
757 "call_index" : 881069,
758 "path" : "/home/peterl/voglproj/vogl_build/traces/trimmed4-vogleditor-sessiondata/snapshot_call_881069.json"
761 "uuid" : "176DE3DEAA437B871FE122C84D5432E3",
764 "is_outdated" : false,
765 "call_index" : 881075,
766 "path" : "/home/peterl/voglproj/vogl_build/traces/trimmed4-vogleditor-sessiondata/snapshot_call_881075.json"
771 "is_outdated" : true,
772 "call_index" : 881080
778 bool VoglEditor::save_session_to_disk(QString sessionFile)
780 dynamic_string sessionPathName;
781 dynamic_string sessionFileName;
782 file_utils::split_path(sessionFile.toStdString().c_str(), sessionPathName, sessionFileName);
784 // modify the session file name to make a sessiondata folder
785 QString sessionDataFolder(sessionFileName.c_str());
786 int lastIndex = sessionDataFolder.lastIndexOf('.');
789 sessionDataFolder = sessionDataFolder.remove(lastIndex, sessionDataFolder.size() - lastIndex);
791 sessionDataFolder += "-sessiondata/";
793 dynamic_string sessionDataPath = sessionPathName;
794 sessionDataPath.append(sessionDataFolder.toStdString().c_str());
795 file_utils::create_directories(sessionDataPath, false);
797 vogl_loose_file_blob_manager file_blob_manager;
798 file_blob_manager.init(cBMFReadWrite, sessionDataPath.c_str());
799 vogl_blob_manager* pBlob_manager = static_cast<vogl_blob_manager*>(&file_blob_manager);
801 QCursor origCursor = this->cursor();
802 setCursor(Qt::WaitCursor);
804 json_document sessionDoc;
805 json_node& metadata = sessionDoc.get_root()->add_object("metadata");
806 metadata.add_key_value("session_file_format_version", to_hex_string(VOGLEDITOR_SESSION_FILE_FORMAT_VERSION));
808 // find relative path from session file to trace file
810 QString absoluteTracePath = relativeAppDir.absoluteFilePath(m_openFilename.toStdString().c_str());
811 QDir absoluteSessionFileDir(sessionPathName.c_str());
812 QString tracePathRelativeToSessionFile = absoluteSessionFileDir.relativeFilePath(absoluteTracePath);
814 json_node& baseTraceFile = sessionDoc.get_root()->add_object("base_trace_file");
815 baseTraceFile.add_key_value("rel_path", tracePathRelativeToSessionFile.toStdString().c_str());
816 json_node &uuid_array = baseTraceFile.add_array("uuid");
817 for (uint i = 0; i < VOGL_ARRAY_SIZE(m_pTraceReader->get_sof_packet().m_uuid); i++)
819 uuid_array.add_value(m_pTraceReader->get_sof_packet().m_uuid[i]);
822 json_node& sessionDataNode = sessionDoc.get_root()->add_object("session_data");
823 sessionDataNode.add_key_value("rel_path", sessionDataFolder.toStdString().c_str());
824 json_node& snapshotArray = sessionDataNode.add_array("snapshots");
826 vogleditor_apiCallTreeItem* pItem = m_pApiCallTreeModel->find_next_snapshot(NULL);
827 vogleditor_apiCallTreeItem* pLastItem = NULL;
828 bool bSavedSuccessfully = true;
829 while (pItem != pLastItem && pItem != NULL)
831 dynamic_string filename;
833 json_node& snapshotNode = snapshotArray.add_object();
834 if (pItem->get_snapshot()->get_snapshot() != NULL)
836 dynamic_string strUUID;
837 snapshotNode.add_key_value("uuid", pItem->get_snapshot()->get_snapshot()->get_uuid().get_string(strUUID));
839 snapshotNode.add_key_value("is_valid", pItem->get_snapshot()->is_valid());
840 snapshotNode.add_key_value("is_edited", pItem->get_snapshot()->is_edited());
841 snapshotNode.add_key_value("is_outdated", pItem->get_snapshot()->is_outdated());
843 if (pItem->apiCallItem() != NULL)
845 uint64_t callIndex = pItem->apiCallItem()->globalCallIndex();
846 snapshotNode.add_key_value("call_index", callIndex);
847 if (pItem->get_snapshot()->get_snapshot() != NULL)
849 filename = filename.format("snapshot_call_%" PRIu64 ".json", callIndex);
850 snapshotNode.add_key_value("rel_path", filename);
851 dynamic_string filepath = sessionDataPath;
852 filepath.append(filename);
853 if (!save_snapshot_to_disk(pItem->get_snapshot()->get_snapshot(), filepath, pBlob_manager))
855 bSavedSuccessfully = false;
860 else if (pItem->frameItem() != NULL)
862 // the first frame of a trim will have a snapshot.
863 // this should only be saved out if the snapshot has been edited
864 uint64_t frameNumber = pItem->frameItem()->frameNumber();
865 snapshotNode.add_key_value("frame_number", frameNumber);
866 if (pItem->get_snapshot()->is_edited())
868 filename = filename.format("snapshot_frame_%" PRIu64 ".json", frameNumber);
869 snapshotNode.add_key_value("rel_path", filename);
870 dynamic_string filepath = sessionDataPath;
871 filepath.append(filename);
872 if (!save_snapshot_to_disk(pItem->get_snapshot()->get_snapshot(), filepath, pBlob_manager))
874 bSavedSuccessfully = false;
881 pItem = m_pApiCallTreeModel->find_next_snapshot(pLastItem);
884 if (bSavedSuccessfully)
886 bSavedSuccessfully = sessionDoc.serialize_to_file(sessionFile.toStdString().c_str());
889 setCursor(origCursor);
891 return bSavedSuccessfully;
894 bool VoglEditor::save_snapshot_to_disk(vogl_gl_state_snapshot *pSnapshot, dynamic_string filename, vogl_blob_manager *pBlob_manager)
896 if (pSnapshot == NULL)
903 vogl_ctypes trace_gl_ctypes(m_pTraceReader->get_sof_packet().m_pointer_sizes);
905 if (!pSnapshot->serialize(*doc.get_root(), *pBlob_manager, &trace_gl_ctypes))
907 vogl_error_printf("Failed serializing state snapshot document!\n");
910 else if (!doc.serialize_to_file(filename.get_ptr(), true))
912 vogl_error_printf("Failed writing state snapshot to file \"%s\"!\n", filename.get_ptr());
917 vogl_printf("Successfully wrote JSON snapshot to file \"%s\"\n", filename.get_ptr());
923 //----------------------------------------------------------------------------------------------------------------------
924 // read_state_snapshot_from_trace
925 //----------------------------------------------------------------------------------------------------------------------
926 vogl_gl_state_snapshot* VoglEditor::read_state_snapshot_from_trace(vogl_trace_file_reader* pTrace_reader)
928 vogl_ctypes trace_gl_ctypes(pTrace_reader->get_sof_packet().m_pointer_sizes);
930 vogl_trace_packet keyframe_trace_packet(&trace_gl_ctypes);
932 pTrace_reader->seek_to_frame(0);
934 vogl_gl_state_snapshot *pSnapshot = NULL;
935 bool found_snapshot = false;
938 vogl_trace_file_reader::trace_file_reader_status_t read_status = pTrace_reader->read_next_packet();
940 if ((read_status != vogl_trace_file_reader::cOK) && (read_status != vogl_trace_file_reader::cEOF))
942 vogl_error_printf("%s: Failed reading from keyframe trace file!\n", VOGL_FUNCTION_NAME);
946 if ((read_status == vogl_trace_file_reader::cEOF) || (pTrace_reader->get_packet_type() == cTSPTEOF))
948 vogl_error_printf("%s: Failed finding state snapshot in keyframe file!\n", VOGL_FUNCTION_NAME);
952 if (pTrace_reader->get_packet_type() != cTSPTGLEntrypoint)
955 if (!keyframe_trace_packet.deserialize(pTrace_reader->get_packet_buf().get_ptr(), pTrace_reader->get_packet_buf().size(), false))
957 vogl_error_printf("%s: Failed parsing GL entrypoint packet in keyframe file\n", VOGL_FUNCTION_NAME);
961 const vogl_trace_gl_entrypoint_packet *pGL_packet = &pTrace_reader->get_packet<vogl_trace_gl_entrypoint_packet>();
962 gl_entrypoint_id_t entrypoint_id = static_cast<gl_entrypoint_id_t>(pGL_packet->m_entrypoint_id);
964 if (vogl_is_swap_buffers_entrypoint(entrypoint_id) || vogl_is_draw_entrypoint(entrypoint_id) || vogl_is_make_current_entrypoint(entrypoint_id))
966 vogl_error_printf("Failed finding state snapshot in keyframe file!\n");
970 switch (entrypoint_id)
972 case VOGL_ENTRYPOINT_glInternalTraceCommandRAD:
974 GLuint cmd = keyframe_trace_packet.get_param_value<GLuint>(0);
975 GLuint size = keyframe_trace_packet.get_param_value<GLuint>(1); VOGL_NOTE_UNUSED(size);
977 if (cmd == cITCRKeyValueMap)
979 key_value_map &kvm = keyframe_trace_packet.get_key_value_map();
981 dynamic_string cmd_type(kvm.get_string("command_type"));
982 if (cmd_type == "state_snapshot")
984 dynamic_string id(kvm.get_string("binary_id"));
987 vogl_error_printf("%s: Missing binary_id field in glInternalTraceCommandRAD key_valye_map command type: \"%s\"\n", VOGL_FUNCTION_NAME, cmd_type.get_ptr());
991 uint8_vec snapshot_data;
993 timed_scope ts("get_multi_blob_manager().get");
994 if (!pTrace_reader->get_multi_blob_manager().get(id, snapshot_data) || (snapshot_data.is_empty()))
996 vogl_error_printf("%s: Failed reading snapshot blob data \"%s\"!\n", VOGL_FUNCTION_NAME, id.get_ptr());
1001 vogl_message_printf("%s: Deserializing state snapshot \"%s\", %u bytes\n", VOGL_FUNCTION_NAME, id.get_ptr(), snapshot_data.size());
1005 timed_scope ts("doc.binary_deserialize");
1006 if (!doc.binary_deserialize(snapshot_data) || (!doc.get_root()))
1008 vogl_error_printf("%s: Failed deserializing JSON snapshot blob data \"%s\"!\n", VOGL_FUNCTION_NAME, id.get_ptr());
1013 pSnapshot = vogl_new(vogl_gl_state_snapshot);
1015 timed_scope ts("pSnapshot->deserialize");
1016 if (!pSnapshot->deserialize(*doc.get_root(), pTrace_reader->get_multi_blob_manager(), &trace_gl_ctypes))
1018 vogl_delete(pSnapshot);
1021 vogl_error_printf("%s: Failed deserializing snapshot blob data \"%s\"!\n", VOGL_FUNCTION_NAME, id.get_ptr());
1025 found_snapshot = true;
1034 } while (!found_snapshot);
1039 bool VoglEditor::open_trace_file(dynamic_string filename)
1041 QCursor origCursor = this->cursor();
1042 this->setCursor(Qt::WaitCursor);
1044 vogl_loose_file_blob_manager file_blob_manager;
1045 dynamic_string keyframe_trace_path(file_utils::get_pathname(filename.get_ptr()));
1046 file_blob_manager.init(cBMFReadable, keyframe_trace_path.get_ptr());
1048 dynamic_string actual_keyframe_filename;
1050 vogleditor_output_message("*********************");
1051 vogleditor_output_message("Opening trace file...");
1052 vogleditor_output_message(filename.c_str());
1054 vogl_trace_file_reader* tmpReader = vogl_open_trace_file(filename, actual_keyframe_filename, NULL);
1056 if (tmpReader == NULL)
1058 vogleditor_output_error("Unable to open trace file.");
1059 this->setCursor(origCursor);
1064 vogleditor_output_message("... success!");
1067 if (tmpReader->get_max_frame_index() > g_settings.trim_large_trace_prompt_size())
1069 int ret = QMessageBox::warning(this, tr(g_PROJECT_NAME.toStdString().c_str()), tr("The loaded trace file has many frames and debugging may be difficult.\nWould you like to trim the trace?"),
1070 QMessageBox::Yes | QMessageBox::No, QMessageBox::Yes);
1072 if (ret == QMessageBox::Yes)
1074 if (trim_trace_file(filename.c_str(), static_cast<uint>(tmpReader->get_max_frame_index()), g_settings.trim_large_trace_prompt_size()))
1076 // user decided to open the new trim file, and the UI should already be updated
1077 // clean up here and return
1078 vogl_delete(tmpReader);
1079 this->setCursor(origCursor);
1084 // either there was an error, or the user decided NOT to open the trim file,
1085 // so continue to load the original file
1086 vogleditor_output_warning("Large trace files may be difficult to debug.");
1091 // now that we know the new trace file can be opened,
1092 // close the old one, and update the trace reader
1094 m_pTraceReader = tmpReader;
1096 vogl_ctypes trace_ctypes;
1097 trace_ctypes.init(m_pTraceReader->get_sof_packet().m_pointer_sizes);
1099 m_pApiCallTreeModel = new vogleditor_QApiCallTreeModel(m_pTraceReader);
1100 ui->treeView->setModel(m_pApiCallTreeModel);
1102 if (ui->treeView->selectionModel() != NULL)
1104 connect(ui->treeView->selectionModel(), SIGNAL(currentChanged(const QModelIndex &, const QModelIndex &)), this, SLOT(slot_treeView_currentChanged(const QModelIndex &, const QModelIndex &)));
1107 if (m_pApiCallTreeModel->hasChildren())
1109 ui->treeView->setExpanded(m_pApiCallTreeModel->index(0,0), true);
1110 ui->treeView->setCurrentIndex(m_pApiCallTreeModel->index(0,0));
1113 int flagsColumnWidth = 30;
1114 ui->treeView->header()->setMinimumSectionSize(flagsColumnWidth);
1115 ui->treeView->header()->moveSection(VOGL_ACTC_FLAGS, 0);
1116 ui->treeView->setColumnWidth(VOGL_ACTC_FLAGS, flagsColumnWidth);
1118 int width = ui->treeView->width() - flagsColumnWidth - 30; // subtract a little extra for the scrollbar width
1119 ui->treeView->setColumnWidth(VOGL_ACTC_APICALL, width * 0.7);
1120 ui->treeView->setColumnWidth(VOGL_ACTC_INDEX, width * 0.15);
1121 ui->treeView->setColumnWidth(VOGL_ACTC_DURATION, width * 0.15);
1123 ui->searchTextBox->setEnabled(true);
1124 ui->searchPrevButton->setEnabled(true);
1125 ui->searchNextButton->setEnabled(true);
1127 ui->action_Close->setEnabled(true);
1128 ui->actionSave_Session->setEnabled(true);
1129 ui->actionExport_API_Calls->setEnabled(true);
1131 ui->prevSnapshotButton->setEnabled(true);
1132 ui->nextSnapshotButton->setEnabled(true);
1133 ui->prevDrawcallButton->setEnabled(true);
1134 ui->nextDrawcallButton->setEnabled(true);
1136 m_backtraceToJsonMap.clear();
1137 m_backtraceDoc.clear();
1139 // Extract backtrace map and machine info from trace archive
1140 if (m_pTraceReader->get_archive_blob_manager().is_initialized())
1143 uint8_vec backtrace_data;
1144 bool bBacktraceVisible = false;
1145 if (m_pTraceReader->get_archive_blob_manager().does_exist(VOGL_TRACE_ARCHIVE_BACKTRACE_MAP_ADDRS_FILENAME))
1147 //$ TODO mikesart: read MAP_SYMS data here when symbols have been resolved.
1148 if (m_pTraceReader->get_archive_blob_manager().get(VOGL_TRACE_ARCHIVE_BACKTRACE_MAP_ADDRS_FILENAME, backtrace_data))
1150 json_node* pRoot = m_backtraceDoc.get_root();
1151 if (m_backtraceDoc.deserialize((const char*)backtrace_data.get_ptr(), backtrace_data.size()))
1153 bBacktraceVisible = pRoot->size() > 0;
1154 for (uint i = 0; i < pRoot->size(); i++)
1156 json_node* pChild = pRoot->get_child(i);
1158 VOGL_ASSERT("Backtrace node does not have an 'index' child" && pChild != NULL && pChild->get_value_as_uint32("index", index));
1159 if (pChild != NULL && pChild->get_value_as_uint32("index", index))
1161 m_backtraceToJsonMap.insert(index, pChild);
1168 if (bBacktraceVisible)
1170 if (ui->bottomTabWidget->indexOf(ui->callStackTab) == -1)
1173 ui->bottomTabWidget->insertTab(1, ui->callStackTab, "Call Stack");
1174 VOGLEDITOR_ENABLE_BOTTOM_TAB(ui->callStackTab);
1178 VOGLEDITOR_ENABLE_BOTTOM_TAB(ui->callStackTab);
1183 ui->bottomTabWidget->removeTab(ui->bottomTabWidget->indexOf(ui->callStackTab));
1187 displayMachineInfo();
1190 m_openFilename = filename.c_str();
1192 setWindowTitle(m_openFilename + " - " + g_PROJECT_NAME);
1194 ui->tabWidget->setCurrentWidget(ui->framebufferTab);
1197 m_pPlayButton->setEnabled(true);
1198 m_pTrimButton->setEnabled(true);
1201 m_pTimelineModel = new vogleditor_apiCallTimelineModel(m_pApiCallTreeModel->root());
1202 m_timeline->setModel(m_pTimelineModel);
1203 m_timeline->repaint();
1205 this->setCursor(origCursor);
1209 void VoglEditor::displayMachineInfoHelper(QString prefix, const QString& sectionKeyStr, const vogl::json_value& value, QString& rMachineInfoStr)
1211 if (value.is_array())
1213 const json_node* pNode = value.get_node_ptr();
1214 for (uint element = 0; element < pNode->size(); element++)
1216 dynamic_string elementStr = pNode->get_value(element).as_string();
1218 elementStr = elementStr.replace("\n", "\n\t");
1220 rMachineInfoStr += "\t";
1221 rMachineInfoStr += elementStr.get_ptr();
1222 rMachineInfoStr += "\n";
1225 rMachineInfoStr += "\n";
1227 else if (value.is_node())
1229 // Check if this is the modoule list.
1230 bool is_module_list = (sectionKeyStr == "module_list");
1231 const json_node* pNode = value.get_node_ptr();
1233 for (uint i = 0; i < pNode->size(); i++)
1235 dynamic_string key = pNode->get_key(i);
1236 const json_value &value2 = pNode->get_value(i);
1238 rMachineInfoStr += prefix;
1239 // If it's the module list, then the key is the filename and we want to display that last.
1240 if (!is_module_list)
1241 rMachineInfoStr += key.c_str();
1243 if (value2.is_array())
1245 const json_node* pNode2 = value2.get_node_ptr();
1247 // If this it module_list, then we get these items: base address, address size, uuid
1248 // Check in btrace_get_machine_info() to see what's written there.
1249 for (uint element = 0; element < pNode2->size(); element++)
1251 const json_value &json_val = pNode2->get_value(element);
1253 if (json_val.is_string())
1255 dynamic_string str = pNode2->get_value(element).as_string();
1256 rMachineInfoStr += str.c_str();
1261 buf.format("%" PRIx64, json_val.as_uint64());
1262 rMachineInfoStr += buf.c_str();
1265 rMachineInfoStr += "\t";
1270 rMachineInfoStr += ": ";
1271 rMachineInfoStr += value2.as_string_ptr();
1274 // Display the filename if this is the module_list.
1276 rMachineInfoStr += key.c_str();
1277 rMachineInfoStr += "\n";
1280 rMachineInfoStr += "\n";
1282 else if (value.is_string())
1284 rMachineInfoStr += value.as_string_ptr();
1288 rMachineInfoStr += value.as_string_ptr();
1292 void VoglEditor::displayMachineInfo()
1294 VOGL_ASSERT(m_pTraceReader != NULL);
1295 if (m_pTraceReader == NULL)
1300 bool bMachineInfoVisible = false;
1301 if (m_pTraceReader->get_archive_blob_manager().does_exist(VOGL_TRACE_ARCHIVE_MACHINE_INFO_FILENAME))
1303 uint8_vec machine_info_data;
1304 if (m_pTraceReader->get_archive_blob_manager().get(VOGL_TRACE_ARCHIVE_MACHINE_INFO_FILENAME, machine_info_data))
1306 bMachineInfoVisible = true;
1308 json_node *pRoot = doc.get_root();
1309 if (doc.deserialize((const char*)machine_info_data.get_ptr(), machine_info_data.size()))
1312 for (uint i = 0; i < pRoot->size(); i++)
1314 dynamic_string sectionKeyStr = pRoot->get_key(i);
1315 text += pRoot->get_key(i).c_str();
1318 QString keyStr = sectionKeyStr.c_str();
1319 displayMachineInfoHelper("\t", keyStr, pRoot->get_value(i), text);
1322 ui->machineInfoText->setText(text);
1327 if (bMachineInfoVisible)
1329 if (ui->bottomTabWidget->indexOf(ui->machineInfoTab) == -1)
1332 ui->bottomTabWidget->insertTab(1, ui->machineInfoTab, "Machine Info");
1333 VOGLEDITOR_ENABLE_BOTTOM_TAB(ui->machineInfoTab);
1337 VOGLEDITOR_ENABLE_BOTTOM_TAB(ui->machineInfoTab);
1342 ui->bottomTabWidget->removeTab(ui->bottomTabWidget->indexOf(ui->machineInfoTab));
1346 void VoglEditor::reset_tracefile_ui()
1348 ui->action_Close->setEnabled(false);
1349 ui->actionExport_API_Calls->setEnabled(false);
1350 ui->actionSave_Session->setEnabled(false);
1352 ui->prevSnapshotButton->setEnabled(false);
1353 ui->nextSnapshotButton->setEnabled(false);
1354 ui->prevDrawcallButton->setEnabled(false);
1355 ui->nextDrawcallButton->setEnabled(false);
1356 ui->searchTextBox->clear();
1357 ui->searchTextBox->setEnabled(false);
1358 ui->searchPrevButton->setEnabled(false);
1359 ui->searchNextButton->setEnabled(false);
1361 m_pPlayButton->setEnabled(false);
1362 m_pTrimButton->setEnabled(false);
1364 VOGLEDITOR_DISABLE_BOTTOM_TAB(ui->machineInfoTab);
1365 VOGLEDITOR_DISABLE_BOTTOM_TAB(ui->callStackTab);
1367 reset_snapshot_ui();
1370 void VoglEditor::reset_snapshot_ui()
1372 m_currentSnapshot = NULL;
1374 m_pFramebufferExplorer->clear();
1375 m_pTextureExplorer->clear();
1376 m_pRenderbufferExplorer->clear();
1377 m_pProgramExplorer->clear();
1378 m_pShaderExplorer->clear();
1380 ui->stateTreeView->setModel(NULL);
1382 QWidget* pCurrentTab = ui->tabWidget->currentWidget();
1384 VOGLEDITOR_DISABLE_STATE_TAB(ui->stateTab);
1385 VOGLEDITOR_DISABLE_STATE_TAB(ui->framebufferTab);
1386 VOGLEDITOR_DISABLE_STATE_TAB(ui->programTab);
1387 VOGLEDITOR_DISABLE_STATE_TAB(ui->shaderTab);
1388 VOGLEDITOR_DISABLE_STATE_TAB(ui->textureTab);
1389 VOGLEDITOR_DISABLE_STATE_TAB(ui->renderbufferTab);
1391 ui->tabWidget->setCurrentWidget(pCurrentTab);
1394 /// This helper will most often return a pointer equal to the pCurSnapshot that is passed in, or NULL if the node does not have a snapshot
1395 /// and also has no children. The pMostRecentSnapshot parameter will be updated to point to the desired snapshot.
1396 /// This function does not follow a traditional DFS search because we need to find the desired snapshot then return the one before it.
1397 /// An alternative approach would be to keep a stack of the found snapshots, or even to build up that stack / list as the user
1398 /// generates new snapshots.
1399 vogleditor_gl_state_snapshot* VoglEditor::findMostRecentSnapshot_helper(vogleditor_apiCallTreeItem* pItem, vogleditor_gl_state_snapshot*& pMostRecentSnapshot, const vogleditor_gl_state_snapshot* pCurSnapshot)
1401 // check if this item has a snapshot shot
1402 if (pItem->has_snapshot() && pItem->get_snapshot()->is_valid())
1404 vogleditor_gl_state_snapshot* pTmp = pItem->get_snapshot();
1405 if (pTmp == pCurSnapshot)
1407 // if we've reached the item with the current snapshot, we want to return the previous snapshot.
1412 // update most recent snapshot
1413 pMostRecentSnapshot = pTmp;
1417 for (int i = 0; i < pItem->childCount(); i++)
1419 vogleditor_gl_state_snapshot* pTmp = findMostRecentSnapshot_helper(pItem->child(i), pMostRecentSnapshot, pCurSnapshot);
1422 if (pTmp == pCurSnapshot)
1424 // if we've reached the item with the current snapshot, we want to return the previous snapshot.
1429 // update most recent snapshot
1430 pMostRecentSnapshot = pTmp;
1438 /// This function exists just to simplify the interaction with the helper, so that there no confusion between
1439 /// whether the returned value, or passed in reference parameter should be used as the most recent snapshot.
1440 /// It will either return NULL if there is no recent snapshot (which should only happen for the very first snapshot
1441 /// in a trace), or a pointer to a valid snapshot.
1442 vogleditor_gl_state_snapshot* VoglEditor::findMostRecentSnapshot(vogleditor_apiCallTreeItem* pItem, const vogleditor_gl_state_snapshot* pCurSnapshot)
1444 vogleditor_gl_state_snapshot* pMostRecentSnapshot = NULL;
1445 findMostRecentSnapshot_helper(pItem, pMostRecentSnapshot, pCurSnapshot);
1446 return pMostRecentSnapshot;
1449 void VoglEditor::update_ui_for_snapshot(vogleditor_gl_state_snapshot* pStateSnapshot)
1451 if (pStateSnapshot == NULL)
1453 reset_snapshot_ui();
1457 if (pStateSnapshot->is_valid() == false)
1459 reset_snapshot_ui();
1463 if (m_currentSnapshot == pStateSnapshot)
1465 // no need to update if it is the same snapshot
1469 m_currentSnapshot = pStateSnapshot;
1471 if (ui->stateTreeView->model() != NULL)
1473 if (static_cast<vogleditor_QStateTreeModel*>(ui->stateTreeView->model())->get_snapshot() == m_currentSnapshot)
1475 // displaying the same snapshot, return
1480 QCursor origCursor = this->cursor();
1481 this->setCursor(Qt::WaitCursor);
1484 if (m_pStateTreeModel != NULL)
1486 delete m_pStateTreeModel;
1488 m_pStateTreeModel = new vogleditor_QStateTreeModel(NULL);
1490 vogleditor_gl_state_snapshot* pBaseSnapshot = findMostRecentSnapshot(m_pApiCallTreeModel->root(), m_currentSnapshot);
1491 m_pStateTreeModel->set_diff_base_snapshot(pBaseSnapshot);
1493 m_pStateTreeModel->set_snapshot(pStateSnapshot);
1495 ui->stateTreeView->setModel(m_pStateTreeModel);
1496 ui->stateTreeView->expandToDepth(1);
1497 ui->stateTreeView->setColumnWidth(0, ui->stateTreeView->width() * 0.5);
1499 VOGLEDITOR_ENABLE_STATE_TAB(ui->stateTab);
1501 if (pStateSnapshot->get_contexts().size() > 0)
1503 vogl_trace_ptr_value curContextHandle = pStateSnapshot->get_cur_trace_context();
1504 if (curContextHandle != 0)
1506 vogl_context_snapshot* pContext = pStateSnapshot->get_context(curContextHandle);
1509 vogl_gl_object_state_ptr_vec textureObjects;
1510 pContext->get_all_objects_of_category(cGLSTTexture, textureObjects);
1511 m_pTextureExplorer->set_texture_objects(textureObjects);
1513 GLuint curActiveTextureUnit = pContext->get_general_state().get_value<GLuint>(GL_ACTIVE_TEXTURE);
1514 if (curActiveTextureUnit >= GL_TEXTURE0 && curActiveTextureUnit < (GL_TEXTURE0 + pContext->get_context_info().get_max_texture_image_units()))
1516 GLuint cur2DBinding = pContext->get_general_state().get_value<GLuint>(GL_TEXTURE_2D_BINDING_EXT, curActiveTextureUnit - GL_TEXTURE0);
1517 displayTexture(cur2DBinding, false);
1519 if (textureObjects.size() > 0) { VOGLEDITOR_ENABLE_STATE_TAB(ui->textureTab); }
1522 vogl_gl_object_state_ptr_vec renderbufferObjects;
1523 pContext->get_all_objects_of_category(cGLSTRenderbuffer, renderbufferObjects);
1524 m_pRenderbufferExplorer->set_texture_objects(renderbufferObjects);
1525 if (renderbufferObjects.size() > 0) { VOGLEDITOR_ENABLE_STATE_TAB(ui->renderbufferTab); }
1528 vogl_gl_object_state_ptr_vec framebufferObjects;
1529 pContext->get_all_objects_of_category(cGLSTFramebuffer, framebufferObjects);
1530 m_pFramebufferExplorer->set_framebuffer_objects(framebufferObjects, *pContext, pStateSnapshot->get_default_framebuffer());
1531 GLuint64 curDrawFramebuffer = pContext->get_general_state().get_value<GLuint64>(GL_DRAW_FRAMEBUFFER_BINDING);
1532 displayFramebuffer(curDrawFramebuffer, false);
1533 if (framebufferObjects.size() > 0) { VOGLEDITOR_ENABLE_STATE_TAB(ui->framebufferTab); }
1536 vogl_gl_object_state_ptr_vec programObjects;
1537 pContext->get_all_objects_of_category(cGLSTProgram, programObjects);
1538 m_pProgramExplorer->set_program_objects(programObjects);
1539 GLuint64 curProgram = pContext->get_general_state().get_value<GLuint64>(GL_CURRENT_PROGRAM);
1540 m_pProgramExplorer->set_active_program(curProgram);
1541 if (programObjects.size() > 0) { VOGLEDITOR_ENABLE_STATE_TAB(ui->programTab); }
1544 vogl_gl_object_state_ptr_vec shaderObjects;
1545 pContext->get_all_objects_of_category(cGLSTShader, shaderObjects);
1546 m_pShaderExplorer->set_shader_objects(shaderObjects);
1547 if (curProgram != 0)
1549 for (vogl_gl_object_state_ptr_vec::iterator iter = programObjects.begin(); iter != programObjects.end(); iter++)
1551 if ((*iter)->get_snapshot_handle() == curProgram)
1553 vogl_program_state* pProgramState = static_cast<vogl_program_state*>(*iter);
1554 if (pProgramState->get_attached_shaders().size() > 0)
1556 uint curShader = pProgramState->get_attached_shaders()[0];
1557 m_pShaderExplorer->set_active_shader(curShader);
1563 if (shaderObjects.size() > 0) { VOGLEDITOR_ENABLE_STATE_TAB(ui->shaderTab); }
1567 this->setCursor(origCursor);
1570 void VoglEditor::on_stateTreeView_clicked(const QModelIndex &index)
1572 vogleditor_stateTreeItem* pStateItem = static_cast<vogleditor_stateTreeItem*>(index.internalPointer());
1573 if (pStateItem == NULL)
1578 switch(pStateItem->getStateType())
1580 case vogleditor_stateTreeItem::cTEXTURE:
1582 vogleditor_stateTreeTextureItem* pTextureItem = static_cast<vogleditor_stateTreeTextureItem*>(pStateItem);
1583 if (pTextureItem == NULL)
1588 displayTexture(pTextureItem->get_texture_state()->get_snapshot_handle(), true);
1592 case vogleditor_stateTreeItem::cPROGRAM:
1594 vogleditor_stateTreeProgramItem* pProgramItem = static_cast<vogleditor_stateTreeProgramItem*>(pStateItem);
1595 if (pProgramItem == NULL)
1600 displayProgram(pProgramItem->get_current_state()->get_snapshot_handle(), true);
1604 case vogleditor_stateTreeItem::cSHADER:
1606 vogleditor_stateTreeShaderItem* pShaderItem = static_cast<vogleditor_stateTreeShaderItem*>(pStateItem);
1607 if (pShaderItem == NULL)
1612 displayShader(pShaderItem->get_current_state()->get_snapshot_handle(), true);
1616 case vogleditor_stateTreeItem::cFRAMEBUFFER:
1618 vogleditor_stateTreeFramebufferItem* pFramebufferItem = static_cast<vogleditor_stateTreeFramebufferItem*>(pStateItem);
1619 if (pFramebufferItem == NULL)
1624 displayFramebuffer(pFramebufferItem->get_framebuffer_state()->get_snapshot_handle(), true);
1628 case vogleditor_stateTreeItem::cDEFAULT:
1635 bool VoglEditor::displayShader(GLuint64 shaderHandle, bool bBringTabToFront)
1637 bool bDisplayed = false;
1638 if (m_pShaderExplorer->set_active_shader(shaderHandle))
1640 if (bBringTabToFront)
1642 ui->tabWidget->setCurrentWidget(ui->shaderTab);
1649 void VoglEditor::displayProgram(GLuint64 programHandle, bool bBringTabToFront)
1651 if (m_pProgramExplorer->set_active_program(programHandle))
1653 if (bBringTabToFront)
1655 ui->tabWidget->setCurrentWidget(ui->programTab);
1660 void VoglEditor::displayFramebuffer(GLuint64 framebufferHandle, bool bBringTabToFront)
1662 bool bDisplayedFBO = m_pFramebufferExplorer->set_active_framebuffer(framebufferHandle);
1666 VOGLEDITOR_ENABLE_STATE_TAB(ui->framebufferTab);
1667 if (bBringTabToFront)
1669 ui->tabWidget->setCurrentWidget(ui->framebufferTab);
1674 bool VoglEditor::displayTexture(GLuint64 textureHandle, bool bBringTabToFront)
1676 bool bDisplayedTexture = m_pTextureExplorer->set_active_texture(textureHandle);
1678 if (bDisplayedTexture)
1680 VOGLEDITOR_ENABLE_STATE_TAB(ui->textureTab);
1681 if (bBringTabToFront)
1683 ui->tabWidget->setCurrentWidget(ui->textureTab);
1687 return bDisplayedTexture;
1690 void VoglEditor::slot_treeView_currentChanged(const QModelIndex & current, const QModelIndex & previous)
1692 VOGL_NOTE_UNUSED(previous);
1693 onApiCallSelected(current, false);
1696 void VoglEditor::on_treeView_clicked(const QModelIndex &index)
1698 onApiCallSelected(index, true);
1701 void VoglEditor::onApiCallSelected(const QModelIndex &index, bool bAllowStateSnapshot)
1703 vogleditor_apiCallTreeItem* pCallTreeItem = static_cast<vogleditor_apiCallTreeItem*>(index.internalPointer());
1704 if (pCallTreeItem == NULL)
1709 vogleditor_frameItem* pFrameItem = pCallTreeItem->frameItem();
1710 vogleditor_apiCallItem* pApiCallItem = pCallTreeItem->apiCallItem();
1712 if (bAllowStateSnapshot && pCallTreeItem == m_pCurrentCallTreeItem)
1714 // we can only get snapshots for specific API calls
1715 if (pApiCallItem != NULL && pApiCallItem->needs_snapshot())
1717 // get the snapshot after the current api call
1718 vogleditor_gl_state_snapshot* pNewSnapshot = NULL;
1719 QCursor origCursor = cursor();
1720 setCursor(Qt::WaitCursor);
1721 m_traceReplayer.replay(m_pTraceReader, m_pApiCallTreeModel->root(), &pNewSnapshot, pApiCallItem->globalCallIndex(), false);
1722 setCursor(origCursor);
1723 pCallTreeItem->set_snapshot(pNewSnapshot);
1727 update_ui_for_snapshot(pCallTreeItem->get_snapshot());
1729 if (pApiCallItem != NULL && m_pCurrentCallTreeItem != pCallTreeItem)
1731 if (m_backtraceToJsonMap.size() > 0)
1734 json_node* pBacktraceNode = m_backtraceToJsonMap[(uint)pApiCallItem->backtraceHashIndex()];
1735 if (pBacktraceNode != NULL)
1737 json_node* pAddrs = pBacktraceNode->find_child_array("addrs");
1738 json_node* pSyms = pBacktraceNode->find_child_array("syms");
1740 for (uint i = 0; i < pAddrs->size(); i++)
1742 tmp += pAddrs->get_value(i).as_string_ptr();
1746 tmp += pSyms->get_value(i).as_string_ptr();
1751 ui->backtraceText->setText(tmp);
1755 if (pApiCallItem != NULL)
1757 m_timeline->setCurrentApiCall(pApiCallItem->globalCallIndex());
1760 if (pFrameItem != NULL)
1762 m_timeline->setCurrentFrame(pFrameItem->frameNumber());
1765 m_timeline->repaint();
1767 m_pCurrentCallTreeItem = pCallTreeItem;
1770 void VoglEditor::selectApicallModelIndex(QModelIndex index, bool scrollTo, bool select)
1772 // make sure the index is visible
1773 QModelIndex parentIndex = index.parent();
1774 while (parentIndex.isValid())
1776 if (ui->treeView->isExpanded(parentIndex) == false)
1778 ui->treeView->expand(parentIndex);
1780 parentIndex = parentIndex.parent();
1783 // scroll to the index
1786 ui->treeView->scrollTo(index);
1792 ui->treeView->setCurrentIndex(index);
1796 void VoglEditor::on_searchTextBox_textChanged(const QString &searchText)
1798 QPalette palette(ui->searchTextBox->palette());
1799 palette.setColor(QPalette::Base, m_searchTextboxBackgroundColor);
1800 ui->searchTextBox->setPalette(palette);
1802 if (m_pApiCallTreeModel != NULL)
1804 m_pApiCallTreeModel->set_highlight_search_string(searchText);
1807 // need to briefly give the treeview focus so that it properly redraws and highlights the matching rows
1808 // then return focus to the search textbox so that typed keys are not lost
1809 ui->treeView->setFocus();
1810 ui->searchTextBox->setFocus();
1813 void VoglEditor::on_searchNextButton_clicked()
1815 if (m_pApiCallTreeModel != NULL)
1817 QModelIndex index = m_pApiCallTreeModel->find_next_search_result(m_pCurrentCallTreeItem, ui->searchTextBox->text());
1818 if (index.isValid())
1820 selectApicallModelIndex(index, true, true);
1821 ui->treeView->setFocus();
1826 void VoglEditor::on_searchPrevButton_clicked()
1828 if (m_pApiCallTreeModel != NULL)
1830 QModelIndex index = m_pApiCallTreeModel->find_prev_search_result(m_pCurrentCallTreeItem, ui->searchTextBox->text());
1831 if (index.isValid())
1833 selectApicallModelIndex(index, true, true);
1834 ui->treeView->setFocus();
1839 void VoglEditor::on_prevSnapshotButton_clicked()
1841 if (m_pApiCallTreeModel != NULL)
1843 vogleditor_apiCallTreeItem* pPrevItemWithSnapshot = m_pApiCallTreeModel->find_prev_snapshot(m_pCurrentCallTreeItem);
1844 if (pPrevItemWithSnapshot != NULL)
1846 selectApicallModelIndex(m_pApiCallTreeModel->indexOf(pPrevItemWithSnapshot), true, true);
1847 ui->treeView->setFocus();
1852 void VoglEditor::on_nextSnapshotButton_clicked()
1854 if (m_pApiCallTreeModel != NULL)
1856 vogleditor_apiCallTreeItem* pNextItemWithSnapshot = m_pApiCallTreeModel->find_next_snapshot(m_pCurrentCallTreeItem);
1857 if (pNextItemWithSnapshot != NULL)
1859 selectApicallModelIndex(m_pApiCallTreeModel->indexOf(pNextItemWithSnapshot), true, true);
1860 ui->treeView->setFocus();
1865 void VoglEditor::on_prevDrawcallButton_clicked()
1867 if (m_pApiCallTreeModel != NULL)
1869 vogleditor_apiCallTreeItem* pPrevItem = m_pApiCallTreeModel->find_prev_drawcall(m_pCurrentCallTreeItem);
1870 if (pPrevItem != NULL)
1872 selectApicallModelIndex(m_pApiCallTreeModel->indexOf(pPrevItem), true, true);
1873 ui->treeView->setFocus();
1878 void VoglEditor::on_nextDrawcallButton_clicked()
1880 if (m_pApiCallTreeModel != NULL)
1882 vogleditor_apiCallTreeItem* pNextItem = m_pApiCallTreeModel->find_next_drawcall(m_pCurrentCallTreeItem);
1883 if (pNextItem != NULL)
1885 selectApicallModelIndex(m_pApiCallTreeModel->indexOf(pNextItem), true, true);
1886 ui->treeView->setFocus();
1891 void VoglEditor::slot_program_edited(vogl_program_state* pNewProgramState)
1893 VOGL_NOTE_UNUSED(pNewProgramState);
1895 m_currentSnapshot->set_edited(true);
1897 // update all the snapshot flags
1898 bool bFoundEditedSnapshot = false;
1899 recursive_update_snapshot_flags(m_pApiCallTreeModel->root(), bFoundEditedSnapshot);
1901 // give the tree view focus so that it redraws. This is something of a hack, we don't really want to be changing around which control has focus,
1902 // but right now I don't see it being a major issue. It may be an issue later on depending on how we implement more state editing (ie, if arrow
1903 // keys are used to cycle through options in a drop-down, and the tree view gets focus, the arrow keys would then start changing the selected
1904 // API call instead of cycling through state options).
1905 ui->treeView->setFocus();
1908 // if an edited snapshot has already been found, mark the node (and all children) as dirty.
1909 void VoglEditor::recursive_update_snapshot_flags(vogleditor_apiCallTreeItem* pItem, bool& bFoundEditedSnapshot)
1911 // check if this item has a snapshot shot
1912 if (pItem->has_snapshot())
1914 if (!bFoundEditedSnapshot)
1916 if (pItem->get_snapshot()->is_edited())
1918 bFoundEditedSnapshot = true;
1922 pItem->get_snapshot()->set_outdated(false);
1927 pItem->get_snapshot()->set_outdated(true);
1931 for (int i = 0; i < pItem->childCount(); i++)
1933 recursive_update_snapshot_flags(pItem->child(i), bFoundEditedSnapshot);
1937 #undef VOGLEDITOR_DISABLE_STATE_TAB
1938 #undef VOGLEDITOR_ENABLE_STATE_TAB
1940 #undef VOGLEDITOR_DISABLE_BOTTOM_TAB
1941 #undef VOGLEDITOR_ENABLE_BOTTOM_TAB
1943 void VoglEditor::on_actionSave_Session_triggered()
1945 QString baseName = m_openFilename;
1947 int lastIndex = baseName.lastIndexOf('.');
1948 if (lastIndex != -1)
1950 baseName = baseName.remove(lastIndex, baseName.size() - lastIndex);
1953 QString suggestedName = baseName + "-vogleditor.json";
1955 QString sessionFilename = QFileDialog::getSaveFileName(this, tr("Save Debug Session"), suggestedName, tr("JSON (*.json)"));
1957 if (!save_session_to_disk(sessionFilename))
1959 vogleditor_output_error("Failed to save session.");
1963 void VoglEditor::on_actionOpen_Session_triggered()
1965 QString sessionFilename = QFileDialog::getOpenFileName(this, tr("Load Debug Session"), QString(), tr("JSON (*.json)"));
1967 QCursor origCursor = this->cursor();
1968 setCursor(Qt::WaitCursor);
1970 if (!load_session_from_disk(sessionFilename))
1972 vogleditor_output_error("Failed to load session.");
1975 setCursor(origCursor);
1978 void VoglEditor::on_searchTextBox_returnPressed()
1980 if (m_pApiCallTreeModel != NULL)
1982 QModelIndex index = m_pApiCallTreeModel->find_next_search_result(m_pCurrentCallTreeItem, ui->searchTextBox->text());
1983 if (index.isValid())
1985 // a valid item was found, scroll to it and select it
1986 selectApicallModelIndex(index, true, true);
1990 // no items were found, so set the textbox background to red (it will get cleared to the original color if the user edits the search text)
1991 QPalette palette(ui->searchTextBox->palette());
1992 palette.setColor(QPalette::Base, Qt::red);
1993 ui->searchTextBox->setPalette(palette);
1998 void VoglEditor::slot_readReplayStandardOutput()
2000 m_pVoglReplayProcess->setReadChannel(QProcess::StandardOutput);
2001 while (m_pVoglReplayProcess->canReadLine())
2003 QByteArray output = m_pVoglReplayProcess->readLine();
2004 if (output.endsWith("\n"))
2006 output.remove(output.size() - 1, 1);
2008 vogleditor_output_message(output.constData());
2012 void VoglEditor::slot_readReplayStandardError()
2014 m_pVoglReplayProcess->setReadChannel(QProcess::StandardError);
2015 while (m_pVoglReplayProcess->canReadLine())
2017 QByteArray output = m_pVoglReplayProcess->readLine();
2018 if (output.endsWith("\n"))
2020 output.remove(output.size() - 1, 1);
2022 vogleditor_output_error(output.constData());