Skip to content
This repository was archived by the owner on Aug 3, 2021. It is now read-only.

Commit c73f84f

Browse files
dadapdadap
committed
nvidia-query-resource-opengl: initial public release
Import nvidia-query-resource-opengl source from NVIDIA Perforce repository at changelist #19925091 for public release.
0 parents  commit c73f84f

13 files changed

+1781
-0
lines changed

‎.gitignore

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
CMakeCache.txt
2+
CMakeFiles
3+
Makefile
4+
cmake_install.cmake
5+
*.o
6+
*.a
7+
*.so
8+
*.lib
9+
*.exe
10+
nvidia-query-resource-opengl
11+
*.sw[op]
12+
*~

‎CMakeLists.txt

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Copyright (c) 2015, NVIDIA CORPORATION. All rights reserved.
2+
#
3+
# Permission is hereby granted, free of charge, to any person obtaining a
4+
# copy of this software and associated documentation files (the "Software"),
5+
# to deal in the Software without restriction, including without limitation
6+
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
7+
# and/or sell copies of the Software, and to permit persons to whom the
8+
# Software is furnished to do so, subject to the following conditions:
9+
#
10+
# The above copyright notice and this permission notice shall be included in
11+
# all copies or substantial portions of the Software.
12+
#
13+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
16+
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18+
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
19+
# DEALINGS IN THE SOFTWARE.
20+
21+
cmake_minimum_required (VERSION 2.6)
22+
23+
project (nvidia-query-resource-opengl)
24+
25+
include_directories(include)
26+
27+
# The query tool executable
28+
29+
add_executable (nvqrgl-bin
30+
tool/main.c
31+
)
32+
set_target_properties (nvqrgl-bin PROPERTIES
33+
OUTPUT_NAME nvidia-query-resource-opengl
34+
)
35+
36+
# Static library for custom clients
37+
38+
add_library (nvqrgl-lib STATIC
39+
common/nvidia-query-resource-opengl-ipc-util.c
40+
tool/nvidia-query-resource-opengl.c
41+
tool/nvidia-query-resource-opengl-data.c
42+
)
43+
set_target_properties (nvqrgl-lib PROPERTIES
44+
OUTPUT_NAME nvidia-query-resource-opengl
45+
)
46+
47+
# Socket functionality is in a separate libsocket library on Solaris
48+
49+
include (CheckLibraryExists)
50+
51+
CHECK_LIBRARY_EXISTS (socket bind "" SOCKET_LIBRARY)
52+
if (SOCKET_LIBRARY)
53+
set(LINK_SOCKET socket)
54+
endif ()
55+
56+
target_link_libraries (nvqrgl-bin nvqrgl-lib ${LINK_SOCKET})
57+
58+
# Build the preload library on Unix
59+
60+
if (NOT WIN32)
61+
add_library (nvidia-query-resource-opengl-preload SHARED
62+
common/nvidia-query-resource-opengl-ipc-util.c
63+
preload/nvidia-query-resource-opengl-preload.c
64+
)
65+
66+
# Find GL and X11 include / link paths
67+
68+
# XXX find_path() doesn't seem to work on Solaris, but it's okay,
69+
# since the GL and X11 headers tend to be in /usr/include there.
70+
if (NOT "${CMAKE_SYSTEM_NAME}" MATCHES "SunOS")
71+
find_path (GL_INCLUDE_DIR GL/gl.h)
72+
find_path (X11_INCLUDE_DIR X11/Xlib.h)
73+
74+
include_directories("${GL_INCLUDE_DIR}" "${X11_INCLUDE_DIR}")
75+
endif ()
76+
77+
find_library (LIBGL_PATH GL)
78+
find_library (LIBX11_PATH X11)
79+
80+
target_link_libraries (nvidia-query-resource-opengl-preload
81+
${LIBGL_PATH} ${LIBX11_PATH} pthread ${LINK_SOCKET}
82+
)
83+
endif ()

‎LICENSE

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2015, NVIDIA CORPORATION. All rights reserved.
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a
4+
copy of this software and associated documentation files (the "Software"),
5+
to deal in the Software without restriction, including without limitation
6+
the rights to use, copy, modify, merge, publish, distribute, sublicense,
7+
and/or sell copies of the Software, and to permit persons to whom the
8+
Software is furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in
11+
all copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
16+
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
19+
DEALINGS IN THE SOFTWARE.

‎README.md

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
nvidia-query-resource-opengl
2+
============================
3+
4+
About
5+
-----
6+
7+
nvidia-query-resource-opengl queries the NVIDIA OpenGL driver to determine the
8+
OpenGL resource usage of an application. OpenGL applications may query their
9+
own resource usage using the GL\_NVX\_query\_resource extension, but the
10+
nvidia-query-resource-opengl tool allows users to perform resource queries
11+
externally, against unmodified OpenGL applications.
12+
13+
Requirements
14+
------------
15+
16+
* A Windows, Linux, Solaris, or FreeBSD system with an NVIDIA GPU, running a
17+
version of the NVIDIA OpenGL driver supporting the GL\_NVX\_query\_resource
18+
extension. Support for this extension was introduced with the 355.xx driver
19+
release. **Note that this extension is still under development and subject to
20+
change, so applications developed against it, including this query resource
21+
tool, may need to be updated for compatibility with future driver versions.**
22+
* CMake 2.6 or later, and a suitable build system (e.g. Windows SDK and/or
23+
Microsoft Visual Studio on Windows; make and cc/gcc on Unix-like systems)
24+
that is supported by the CMake generators on the target platform. (Not needed
25+
when using precompiled executables on Windows.)
26+
27+
Building
28+
--------
29+
30+
nvidia-query-resource-opengl uses [CMake](http://www.cmake.org) to support
31+
building on multiple platforms. In order to build nvidia-query-resource-opengl,
32+
you will need to first use the CMake graphical or command line interface to
33+
generate a build system that will work on your platform, then use the generated
34+
build system to build the project. For example, on a typical Unix-like system,
35+
the following commands run from within the top level directory of this source
36+
code repository will create a "build" directory and build within it:
37+
38+
mkdir build
39+
cd build
40+
cmake ..
41+
make
42+
43+
On Windows, run `nmake` instead of `make` from the Visual Studio command line
44+
when using the nmake build system generator with the Windows SDK, or choose a
45+
Visual Studio solution generator to create a solution that can be built within
46+
Microsoft Visual Studio. Windows users may also download precompiled executable
47+
files for convenience.
48+
49+
A successful build will produce the following items:
50+
51+
* The resource query tool, 'nvidia-query-resource-opengl' (on Windows, the .exe
52+
file extension is appended to the executable name.)
53+
* A static library, 'libnvidia-query-resource-opengl.a' on Unix-like systems,
54+
or 'nvidia-query-resource-opengl.lib' on Windows. This can be used together
55+
with the API defined in include/nvidia-query-resource-opengl.h to add OpenGL
56+
resource query functionality to your own monitoring tools.
57+
* On Unix-like systems only, the 'libnvidia-query-resource-preload.so' DSO,
58+
which must be preloaded into any OpenGL applications that will be the target
59+
of resource queries. (See "Usage" section below for more details.)
60+
61+
Usage
62+
-----
63+
64+
You can query an application's OpenGL resource usage by executing the command:
65+
66+
nvidia-query-resource-opengl -p <pid> [-qt <query_type>]
67+
68+
* pid: the process ID of the target OpenGL application of the query
69+
* query\_type: this may be 'summary' or 'detailed'. The default is 'summary'.
70+
+ summary: reports a summary, per device, of allocated video and system
71+
memory, the total amount of memory in use by the the driver, and the
72+
total amount of allocated but unused memory.
73+
+ detailed: includes the summary information, and additionally reports
74+
separate allocation amounts for various object types. The current set
75+
of reported object types includes:
76+
- SYSTEM RESERVED - driver allocated memory
77+
- TEXTURE - memory in use by 1D/2D/3D textures
78+
- RENDERBUFFER - render buffer memory
79+
- BUFFEROBJ_ARRAY - buffer object memory
80+
81+
Resource queries are handled asynchronously to the OpenGL applications being
82+
queried. Due to this, and other factors, including object migration between
83+
video and system memory, it is possible for subsequent queries to yield
84+
different results.
85+
86+
On Windows, nvidia-query-resource-opengl will communicate directly with any
87+
OpenGL application to perform resource queries; however, on Unix-like systems,
88+
the libnvidia-query-resource-preload.so DSO must be preloaded into the target
89+
application before a resource query can be performed. This is achieved by
90+
setting a relative or absolute path to the preload DSO in the LD\_PRELOAD
91+
variable of the target application's environment, e.g.:
92+
93+
$ LD_PRELOAD=path/to/libnvidia-query-resource-opengl-preload.so app

‎common/nvidia-query-resource-opengl-ipc-util.c

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
/*
2+
* Copyright (c) 2015, NVIDIA CORPORATION. All rights reserved.
3+
*
4+
* Permission is hereby granted, free of charge, to any person obtaining a
5+
* copy of this software and associated documentation files (the "Software"),
6+
* to deal in the Software without restriction, including without limitation
7+
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
8+
* and/or sell copies of the Software, and to permit persons to whom the
9+
* Software is furnished to do so, subject to the following conditions:
10+
*
11+
* The above copyright notice and this permission notice shall be included in
12+
* all copies or substantial portions of the Software.
13+
*
14+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17+
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19+
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20+
* DEALINGS IN THE SOFTWARE.
21+
*/
22+
23+
#include <stdio.h>
24+
#include <stdlib.h>
25+
#include <string.h>
26+
27+
#include "nvidia-query-resource-opengl-ipc-util.h"
28+
29+
#if defined (_WIN32)
30+
static char *construct_name(const char *basename, DWORD pid)
31+
{
32+
static const char basedir[] = "\\\\.\\pipe\\";
33+
size_t len = strlen(basedir) + strlen(basename) +
34+
NVQR_IPC_MAX_DIGIT_LENGTH;
35+
char *buf = calloc(len + 1, 1);
36+
37+
if (!buf) {
38+
fprintf(stderr, "Failed to allocate memory for connection name!");
39+
exit(1);
40+
}
41+
42+
_snprintf_s(buf, len + 1, len, "%s%s%d", basedir, basename, pid);
43+
return buf;
44+
}
45+
46+
char *nvqr_ipc_client_pipe_name(DWORD pid)
47+
{
48+
return construct_name("clientpipe", pid);
49+
}
50+
51+
char *nvqr_ipc_server_pipe_name(DWORD pid)
52+
{
53+
return construct_name("serverpipe", pid);
54+
}
55+
56+
#else
57+
58+
int nvqr_ipc_get_socket_name(char *dest, size_t len, pid_t pid)
59+
{
60+
int total_len;
61+
static const char *basename = "nvidia-query-resource-opengl-socket.";
62+
63+
#if __linux
64+
// Socket names in the abstract namespace are not strings; rather, the
65+
// entire contents of the sun_path field are considered. Zero out the
66+
// whole buffer to avoid surprises.
67+
memset(dest, 0, len);
68+
69+
total_len = snprintf(dest, len, "0%s%d", basename, pid);
70+
dest[0] = '\0';
71+
#else
72+
const char *basedir = "/tmp";
73+
74+
// Uncomment the below code if you want socket files to be created under
75+
// XDG_RUNTIME_DIR on FreeBSD and Solaris, when that variable is set. The
76+
// hardcoded default to "/tmp" is intentional, to facilitate use cases where
77+
// the user performing the query may not be the same as the user running the
78+
// queried process.
79+
80+
/*
81+
basedir = getenv("XDG_RUNTIME_DIR");
82+
if (!basedir) {
83+
basedir = "/tmp";
84+
}
85+
*/
86+
87+
total_len = snprintf(dest, len, "%s/%s%ld", basedir, basename, (long) pid);
88+
#endif // __linux
89+
90+
// Terminate the string properly if truncation occurred.
91+
if (total_len >= len) {
92+
dest[len - 1] = '\0';
93+
}
94+
95+
return total_len;
96+
}
97+
#endif // _WIN32

0 commit comments

Comments
 (0)