1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
|
/******************************************************************************
* The MIT License (MIT)
*
* Copyright (c) 2015-2018 Baldur Karlsson
* Copyright (c) 2014 Crytek
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
******************************************************************************/
#include "renderdoccmd.h"
#include <dlfcn.h>
#include <iconv.h>
#include <limits.h>
#include <locale.h>
#include <signal.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <string>
#if defined(RENDERDOC_WINDOWING_XLIB)
#include <X11/Xlib-xcb.h>
#endif
#include <replay/renderdoc_replay.h>
using std::string;
using std::vector;
void Daemonise()
{
// don't change dir, but close stdin/stdou
daemon(1, 0);
}
struct VulkanRegisterCommand : public Command
{
VulkanRegisterCommand(const GlobalEnvironment &env) : Command(env) {}
virtual void AddOptions(cmdline::parser &parser)
{
parser.add("ignore", 'i', "Do nothing and don't warn about Vulkan layer issues.");
parser.add(
"system", '\0',
"Install layer registration to /etc instead of $HOME/.local (requires root privileges)");
}
virtual const char *Description()
{
return "Attempt to automatically fix Vulkan layer registration issues";
}
virtual bool IsInternalOnly() { return false; }
virtual bool IsCaptureCommand() { return false; }
virtual int Execute(cmdline::parser &parser, const CaptureOptions &)
{
bool ignore = (parser.exist("ignore"));
if(ignore)
{
std::cout << "Not fixing vulkan layer issues, and suppressing future warnings." << std::endl;
std::cout << "To undo, remove '$HOME/.renderdoc/ignore_vulkan_layer_issues'." << std::endl;
string ignorePath = string(getenv("HOME")) + "/.renderdoc/";
mkdir(ignorePath.c_str(), S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
ignorePath += "ignore_vulkan_layer";
FILE *f = fopen(ignorePath.c_str(), "w");
if(f)
{
fputs("This file suppresses any checks for vulkan layer issues.\n", f);
fputs("Delete this file to restore default checking.\n", f);
fclose(f);
}
else
{
std::cerr << "Couldn't create '$HOME/.renderdoc/ignore_vulkan_layer_issues'." << std::endl;
}
return 0;
}
RENDERDOC_UpdateVulkanLayerRegistration(parser.exist("system"));
return 0;
}
};
void VerifyVulkanLayer(const GlobalEnvironment &env, int argc, char *argv[])
{
VulkanLayerRegistrationInfo info;
bool needUpdate = RENDERDOC_NeedVulkanLayerRegistration(&info);
if(!needUpdate)
{
if(!(info.flags & VulkanLayerFlags::Unfixable))
add_command("vulkanregister", new VulkanRegisterCommand(env));
return;
}
std::cerr << "*************************************************************************"
<< std::endl;
std::cerr << "** Warning: Vulkan capture possibly not configured. **"
<< std::endl;
std::cerr << std::endl;
if(info.flags & VulkanLayerFlags::OtherInstallsRegistered)
std::cerr << "Multiple RenderDoc layers are registered, possibly from different builds."
<< std::endl;
if(!(info.flags & VulkanLayerFlags::ThisInstallRegistered))
std::cerr << "This build's RenderDoc layer is not registered." << std::endl;
std::cerr << "To fix this, the following actions must take place: " << std::endl << std::endl;
const bool registerAll = bool(info.flags & VulkanLayerFlags::RegisterAll);
const bool updateAllowed = bool(info.flags & VulkanLayerFlags::UpdateAllowed);
for(const rdcstr &j : info.otherJSONs)
std::cerr << (updateAllowed ? "Unregister/update: " : "Unregister: ") << j.c_str() << std::endl;
if(!(info.flags & VulkanLayerFlags::ThisInstallRegistered))
{
if(registerAll)
{
for(const rdcstr &j : info.myJSONs)
std::cerr << (updateAllowed ? "Register/update: " : "Register: ") << j.c_str() << std::endl;
}
else
{
std::cerr << (updateAllowed ? "Register one of:" : "Register/update one of:") << std::endl;
for(const rdcstr &j : info.myJSONs)
std::cerr << " -- " << j.c_str() << "\n";
}
}
std::cerr << std::endl;
if(info.flags & VulkanLayerFlags::Unfixable)
{
std::cerr << "NOTE: The renderdoc layer registered in /usr is reserved for distribution"
<< std::endl;
std::cerr << "controlled packages. RenderDoc cannot automatically unregister this even"
<< std::endl;
std::cerr << "with root permissions, you must fix this conflict manually." << std::endl
<< std::endl;
std::cerr << "*************************************************************************"
<< std::endl;
std::cerr << std::endl;
return;
}
std::cerr << "NOTE: Automatically removing or changing the layer registered in /etc" << std::endl;
std::cerr << "will require root privileges." << std::endl << std::endl;
std::cerr << "To fix these issues run the 'vulkanregister' command." << std::endl;
std::cerr << "Use 'vulkanregister --help' to see more information." << std::endl;
std::cerr << std::endl;
std::cerr << "By default 'vulkanregister' will register the layer to your $HOME folder."
<< std::endl;
std::cerr << "This does not require root permissions." << std::endl;
std::cerr << std::endl;
std::cerr << "If you want to install to the system, run 'vulkanregister --system'." << std::endl;
std::cerr << "This requires root permissions to write to /etc/vulkan/." << std::endl;
// just in case there's a strange install that is misdetected or something then allow
// users to suppress this message and just say "I know what I'm doing".
std::cerr << std::endl;
std::cerr << "To suppress this warning in future, run 'vulkanregister --ignore'." << std::endl;
std::cerr << "*************************************************************************"
<< std::endl;
std::cerr << std::endl;
add_command("vulkanregister", new VulkanRegisterCommand(env));
}
static Display *display = NULL;
WindowingData DisplayRemoteServerPreview(bool active, const rdcarray<WindowingSystem> &systems)
{
static WindowingData remoteServerPreview = {WindowingSystem::Unknown};
// we only have the preview implemented for platforms that have xlib & xcb. It's unlikely
// a meaningful platform exists with only one, and at the time of writing no other windowing
// systems are supported on linux for the replay
#if defined(RENDERDOC_WINDOWING_XLIB) && defined(RENDERDOC_WINDOWING_XCB)
if(active)
{
if(remoteServerPreview.system == WindowingSystem::Unknown)
{
// if we're first initialising, create the window
if(display == NULL)
return remoteServerPreview;
int scr = DefaultScreen(display);
xcb_connection_t *connection = XGetXCBConnection(display);
if(connection == NULL)
{
std::cerr << "Couldn't get XCB connection from Xlib Display" << std::endl;
return remoteServerPreview;
}
XSetEventQueueOwner(display, XCBOwnsEventQueue);
const xcb_setup_t *setup = xcb_get_setup(connection);
xcb_screen_iterator_t iter = xcb_setup_roots_iterator(setup);
while(scr-- > 0)
xcb_screen_next(&iter);
xcb_screen_t *screen = iter.data;
uint32_t value_mask, value_list[32];
xcb_window_t window = xcb_generate_id(connection);
value_mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK;
value_list[0] = screen->black_pixel;
value_list[1] =
XCB_EVENT_MASK_KEY_RELEASE | XCB_EVENT_MASK_EXPOSURE | XCB_EVENT_MASK_STRUCTURE_NOTIFY;
xcb_create_window(connection, XCB_COPY_FROM_PARENT, window, screen->root, 0, 0, 1280, 720, 0,
XCB_WINDOW_CLASS_INPUT_OUTPUT, screen->root_visual, value_mask, value_list);
/* Magic code that will send notification when window is destroyed */
xcb_intern_atom_cookie_t cookie = xcb_intern_atom(connection, 1, 12, "WM_PROTOCOLS");
xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(connection, cookie, 0);
xcb_intern_atom_cookie_t cookie2 = xcb_intern_atom(connection, 0, 16, "WM_DELETE_WINDOW");
xcb_intern_atom_reply_t *atom_wm_delete_window = xcb_intern_atom_reply(connection, cookie2, 0);
xcb_change_property(connection, XCB_PROP_MODE_REPLACE, window, XCB_ATOM_WM_NAME,
XCB_ATOM_STRING, 8, sizeof("Remote Server Preview") - 1,
"Remote Server Preview");
xcb_change_property(connection, XCB_PROP_MODE_REPLACE, window, (*reply).atom, 4, 32, 1,
&(*atom_wm_delete_window).atom);
free(reply);
xcb_map_window(connection, window);
bool xcb = false, xlib = false;
for(size_t i = 0; i < systems.size(); i++)
{
if(systems[i] == WindowingSystem::Xlib)
xlib = true;
if(systems[i] == WindowingSystem::XCB)
xcb = true;
}
// prefer xcb
if(xcb)
remoteServerPreview = CreateXCBWindowingData(connection, window);
else if(xlib)
remoteServerPreview = CreateXlibWindowingData(display, (Drawable)window);
xcb_flush(connection);
}
else
{
// otherwise, we can pump messages here, but we don't actually care to process any. Just clear
// the queue
xcb_generic_event_t *event = NULL;
xcb_connection_t *connection = remoteServerPreview.xcb.connection;
if(remoteServerPreview.system == WindowingSystem::Xlib)
connection = XGetXCBConnection(remoteServerPreview.xlib.display);
if(connection)
{
do
{
event = xcb_poll_for_event(connection);
if(event)
free(event);
} while(event);
}
}
}
else
{
// reset the windowing data to 'no window'
remoteServerPreview = {WindowingSystem::Unknown};
}
#endif
return remoteServerPreview;
}
void DisplayRendererPreview(IReplayController *renderer, TextureDisplay &displayCfg, uint32_t width,
uint32_t height, uint32_t numLoops)
{
// we only have the preview implemented for platforms that have xlib & xcb. It's unlikely
// a meaningful platform exists with only one, and at the time of writing no other windowing
// systems are supported on linux for the replay
#if defined(RENDERDOC_WINDOWING_XLIB) && defined(RENDERDOC_WINDOWING_XCB)
// need to create a hybrid setup xlib and xcb in case only one or the other is supported.
// We'll prefer xcb
if(display == NULL)
{
std::cerr << "Couldn't open X Display" << std::endl;
return;
}
int scr = DefaultScreen(display);
xcb_connection_t *connection = XGetXCBConnection(display);
if(connection == NULL)
{
std::cerr << "Couldn't get XCB connection from Xlib Display" << std::endl;
return;
}
XSetEventQueueOwner(display, XCBOwnsEventQueue);
const xcb_setup_t *setup = xcb_get_setup(connection);
xcb_screen_iterator_t iter = xcb_setup_roots_iterator(setup);
while(scr-- > 0)
xcb_screen_next(&iter);
xcb_screen_t *screen = iter.data;
uint32_t value_mask, value_list[32];
xcb_window_t window = xcb_generate_id(connection);
value_mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK;
value_list[0] = screen->black_pixel;
value_list[1] =
XCB_EVENT_MASK_KEY_RELEASE | XCB_EVENT_MASK_EXPOSURE | XCB_EVENT_MASK_STRUCTURE_NOTIFY;
xcb_create_window(connection, XCB_COPY_FROM_PARENT, window, screen->root, 0, 0, width, height, 0,
XCB_WINDOW_CLASS_INPUT_OUTPUT, screen->root_visual, value_mask, value_list);
/* Magic code that will send notification when window is destroyed */
xcb_intern_atom_cookie_t cookie = xcb_intern_atom(connection, 1, 12, "WM_PROTOCOLS");
xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(connection, cookie, 0);
xcb_intern_atom_cookie_t cookie2 = xcb_intern_atom(connection, 0, 16, "WM_DELETE_WINDOW");
xcb_intern_atom_reply_t *atom_wm_delete_window = xcb_intern_atom_reply(connection, cookie2, 0);
xcb_change_property(connection, XCB_PROP_MODE_REPLACE, window, XCB_ATOM_WM_NAME, XCB_ATOM_STRING,
8, sizeof("renderdoccmd") - 1, "renderdoccmd");
xcb_change_property(connection, XCB_PROP_MODE_REPLACE, window, (*reply).atom, 4, 32, 1,
&(*atom_wm_delete_window).atom);
free(reply);
xcb_map_window(connection, window);
rdcarray<WindowingSystem> systems = renderer->GetSupportedWindowSystems();
bool xcb = false, xlib = false;
for(size_t i = 0; i < systems.size(); i++)
{
if(systems[i] == WindowingSystem::Xlib)
xlib = true;
if(systems[i] == WindowingSystem::XCB)
xcb = true;
}
IReplayOutput *out = NULL;
// prefer xcb
if(xcb)
{
out = renderer->CreateOutput(CreateXCBWindowingData(connection, window),
ReplayOutputType::Texture);
}
else if(xlib)
{
out = renderer->CreateOutput(CreateXlibWindowingData(display, (Drawable)window),
ReplayOutputType::Texture);
}
else
{
std::cerr << "Neither XCB nor XLib are supported, can't create window." << std::endl;
std::cerr << "Supported systems: ";
for(size_t i = 0; i < systems.size(); i++)
std::cerr << (uint32_t)systems[i] << std::endl;
std::cerr << std::endl;
return;
}
out->SetTextureDisplay(displayCfg);
xcb_flush(connection);
uint32_t loopCount = 0;
bool done = false;
while(!done)
{
xcb_generic_event_t *event;
event = xcb_poll_for_event(connection);
if(event)
{
switch(event->response_type & 0x7f)
{
case XCB_EXPOSE: break;
case XCB_CLIENT_MESSAGE:
if((*(xcb_client_message_event_t *)event).data.data32[0] == (*atom_wm_delete_window).atom)
{
done = true;
}
break;
case XCB_KEY_RELEASE:
{
const xcb_key_release_event_t *key = (const xcb_key_release_event_t *)event;
if(key->detail == 0x9)
done = true;
}
break;
case XCB_DESTROY_NOTIFY: done = true; break;
default: break;
}
free(event);
}
renderer->SetFrameEvent(10000000, true);
out->Display();
usleep(100000);
loopCount++;
if(numLoops > 0 && loopCount == numLoops)
break;
}
#else
std::cerr << "No supporting windowing systems defined at build time (xlib and xcb)" << std::endl;
#endif
}
void sig_handler(int signo)
{
if(usingKillSignal)
killSignal = true;
else
exit(1);
}
int main(int argc, char *argv[])
{
setlocale(LC_CTYPE, "");
signal(SIGINT, sig_handler);
signal(SIGTERM, sig_handler);
GlobalEnvironment env;
#if defined(RENDERDOC_WINDOWING_XLIB) || defined(RENDERDOC_WINDOWING_XCB)
// call XInitThreads - although we don't use xlib concurrently the driver might need to.
XInitThreads();
// we don't check if display successfully opened, it's only a problem if it's needed later.
display = env.xlibDisplay = XOpenDisplay(NULL);
#endif
#if defined(RENDERDOC_SUPPORT_VULKAN)
VerifyVulkanLayer(env, argc, argv);
#endif
// add compiled-in support to version line
{
string support = "APIs supported at compile-time: ";
int count = 0;
#if defined(RENDERDOC_SUPPORT_VULKAN)
support += "Vulkan, ";
count++;
#endif
#if defined(RENDERDOC_SUPPORT_GL)
support += "GL, ";
count++;
#endif
#if defined(RENDERDOC_SUPPORT_GLES)
support += "GLES, ";
count++;
#endif
if(count == 0)
{
support += "None.";
}
else
{
// remove trailing ', '
support.pop_back();
support.pop_back();
support += ".";
}
add_version_line(support);
support = "Windowing systems supported at compile-time: ";
count = 0;
#if defined(RENDERDOC_WINDOWING_XLIB)
support += "xlib, ";
count++;
#endif
#if defined(RENDERDOC_WINDOWING_XCB)
support += "XCB, ";
count++;
#endif
#if defined(RENDERDOC_SUPPORT_VULKAN)
support += "Vulkan KHR_display, ";
count++;
#endif
if(count == 0)
{
support += "None.";
}
else
{
// remove trailing ', '
support.pop_back();
support.pop_back();
support += ".";
}
add_version_line(support);
}
int ret = renderdoccmd(env, argc, argv);
#if defined(RENDERDOC_WINDOWING_XLIB) || defined(RENDERDOC_WINDOWING_XCB)
if(display)
XCloseDisplay(display);
#endif
return ret;
}
|