Skip to content

Commit

Permalink
renderer: detect OpenGL hardware and driver vendor
Browse files Browse the repository at this point in the history
Detect OpenGL hardware and driver vendor.

Start to reuse this information.
  • Loading branch information
illwieckz committed Aug 14, 2024
1 parent 2ee569b commit b7a3aa4
Show file tree
Hide file tree
Showing 4 changed files with 315 additions and 2 deletions.
287 changes: 287 additions & 0 deletions src/engine/renderer/DetectGLVendors.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,287 @@
/*
===========================================================================
Daemon BSD Source Code
Copyright (c) 2024 Daemon Developers
All rights reserved.
This file is part of the Daemon BSD Source Code (Daemon Source Code).
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the Daemon developers nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL DAEMON DEVELOPERS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
===========================================================================
*/

// DetectGLVendors.h

#ifndef __DETECT_OPENGL_VENDORS
#define __DETECT_OPENGL_VENDORS

#include "common/Common.h"

enum class glHardwareVendor_t
{
UNKNOWN,
// Assumed to be slow (running on CPU).
SOFTWARE,
/* Assumed to be fast (running on GPU through a translation, like an OpenGL over Vulkan
driver, or an OpenGL virtualization driver sending commands to an hypervisor. */
TRANSLATION,
// Assumed to be fast (running on GPU directly).
ATI,
BROADCOM,
INTEL,
NVIDIA,
END,
};

inline std::string GetGLHardwareVendorName( glHardwareVendor_t hardwareVendor )
{
ASSERT( hardwareVendor >= glHardwareVendor_t::UNKNOWN && hardwareVendor < glHardwareVendor_t::END );

static const std::string hardwareVendorNames[] = {
"Unknown",
"Software rasterizer",
"Translator",
"AMD/ATI",
"Broadcom",
"Intel",
"Nvidia",
};

return hardwareVendorNames[ Util::ordinal(hardwareVendor) ];
}

enum class glDriverVendor_t
{
UNKNOWN,
MESA,
ATI,
INTEL,
NVIDIA,
END,
};

inline std::string GetGLDriverVendorName( glDriverVendor_t driverVendor )
{
ASSERT( driverVendor >= glDriverVendor_t::UNKNOWN && driverVendor < glDriverVendor_t::END );

static const std::string driverVendorNames[] = {
"Unknown",
"Mesa",
"AMD/ATI",
"Intel",
"Nvidia",
};

return driverVendorNames[ Util::ordinal(driverVendor) ];
}

inline void DetectGLVendors(
const std::string& vendor_string,
const std::string& version_string,
const std::string& renderer_string,
glHardwareVendor_t& hardwareVendor,
glDriverVendor_t& driverVendor )
{
hardwareVendor = glHardwareVendor_t::UNKNOWN;
driverVendor = glDriverVendor_t::UNKNOWN;

using vendorDriverHardware_t = std::unordered_map<std::string, std::pair<glDriverVendor_t, glHardwareVendor_t>>;

// Those vendor strings are assumed to be unambiguous about both driver and hardware vendors.
static const vendorDriverHardware_t vendorDriverHardware = {
// Mesa AMD/ATI.
{ "AMD", { glDriverVendor_t::MESA, glHardwareVendor_t::ATI } },
{ "AMD inc.", { glDriverVendor_t::MESA, glHardwareVendor_t::ATI } },
{ "X.Org R300 Project", { glDriverVendor_t::MESA, glHardwareVendor_t::ATI } },
// Proprietary ATI or AMD drivers on all systems like Linux, Windows, and macOS: OGLP, Catalyst…
{ "ATI Technologies Inc.", { glDriverVendor_t::ATI, glHardwareVendor_t::ATI } },
// Proprietary Intel driver on macOS.
{ "Intel Inc.", { glDriverVendor_t::INTEL, glHardwareVendor_t::INTEL } },
// Mesa Intel.
{ "Intel Open Source Technology Center", { glDriverVendor_t::MESA, glHardwareVendor_t::INTEL } },
{ "Tungsten Graphics, Inc", { glDriverVendor_t::MESA, glHardwareVendor_t::INTEL } },
// Mesa V3D and VC4 (Raspberry Pi).
{ "Broadcom", { glDriverVendor_t::MESA, glHardwareVendor_t::BROADCOM } },
// Mesa Nvidia for supported OpenGL 2+ hardware.
{ "nouveau", { glDriverVendor_t::MESA, glHardwareVendor_t::NVIDIA } },
// Proprietary Nvidia drivers on all systems like Linux, Windows, and macOS.
{ "NVIDIA Corporation", { glDriverVendor_t::NVIDIA, glHardwareVendor_t::NVIDIA } },
// Mesa Amber also provides "Nouveau", but this is for unsupported pre-OpenGL 2 Nvidia.
};

if ( vendorDriverHardware.count( vendor_string ) )
{
auto& p = vendorDriverHardware.at( vendor_string );
driverVendor = p.first;
hardwareVendor = p.second;
return;
}

// This vendor string is used by at least two different Intel drivers.
if ( vendor_string == "Intel Corporation" )
{
// https://stackoverflow.com/a/40441240/9131399
if ( renderer_string.rfind( "SWR ", 0 ) == 0)
{
/* It is part of Mesa Amber, but was merged in Mesa lately after being an internal
Intel product for years. It doesn't share much things with Mesa, and we better
not assume it behaves the same as Mesa, it may even behave like Intel.
We keep driverVendor as glDriverVendor_t::UNKNOWN on purpose. */
hardwareVendor = glHardwareVendor_t::SOFTWARE;
return;
}
else
{
driverVendor = glDriverVendor_t::MESA;
hardwareVendor = glHardwareVendor_t::INTEL;
return;
}
}

// This vendor string is used by at least two different Microsoft drivers.
if ( vendor_string == "Microsoft Corporation" )
{
/* The GL_VENDOR string can also be "Microsoft Corporation" with GL_RENDERER
set to "GDI Generic" which is not Mesa and isn't supported (OpenGL 1.1). */
if ( renderer_string.rfind( "D3D12 ", 0 ) == 0 )
{
driverVendor = glDriverVendor_t::MESA;
// OpenGL over Direct3D12 translation.
hardwareVendor = glHardwareVendor_t::TRANSLATION;
return;
}
}

/* Those substrings at the beginning of a renderer string are assumed to be unambiguous about
both driver and hardware. */
static const std::pair<std::string, glHardwareVendor_t> rendererMesaStartStringHardware[] = {
// "Mesa DRI R200" exists for ATI but isn't supported.
{ "Mesa DRI nv", glHardwareVendor_t::NVIDIA },
{ "Mesa DRI Intel(R)", glHardwareVendor_t::INTEL },
};

for ( auto& p : rendererMesaStartStringHardware )
{
if ( renderer_string.rfind( p.first, 0 ) == 0 )
{
driverVendor = glDriverVendor_t::MESA;
hardwareVendor = p.second;
return;
}
}

// Those vendor strings are assumed to be unambiguous about being from Mesa drivers.
static const std::string mesaVendors[] = {
"Mesa",
"Mesa Project",
"Mesa/X.org",
"X.Org",
// Zink.
"Collabora Ltd",
// virgl.
"Red Hat",
// llvmpipe, softpipe, SVGA3D.
"VMware, Inc.",
};

for ( auto& s : mesaVendors )
{
if ( vendor_string == s )
{
driverVendor = glDriverVendor_t::MESA;
break;
}
}

/* This substring in a version string is assumed to be unambiguous about being from Mesa
drivers. Mesa GL_VENDOR and GL_RENDERER strings are very fluid, but it is believed that
GL_VERSION always contains the " Mesa " substring and that substring always means Mesa. */
if ( driverVendor == glDriverVendor_t::UNKNOWN && version_string.find( " Mesa " ) != std::string::npos )
{
driverVendor = glDriverVendor_t::MESA;
}

if ( driverVendor == glDriverVendor_t::MESA )
{
// This vendor string for a Mesa driver is assumed to be unambiguous about the hardware.
if ( vendor_string == "Intel" )
{
hardwareVendor = glHardwareVendor_t::INTEL;
return;
}

/* Those substrings at the beginning of a renderer string are assumed to be unambiguous about
the hardware or underlying technology. */
static const std::pair<std::string, glHardwareVendor_t> rendererStartStringHardware[] = {
{ "ATI ", glHardwareVendor_t::ATI },
{ "AMD ", glHardwareVendor_t::ATI },
{ "NV", glHardwareVendor_t::NVIDIA },
{ "i915 ", glHardwareVendor_t::INTEL },
// OpenGL over Vulkan translation.
{ "zink ", glHardwareVendor_t::TRANSLATION },
// Virtualization.
{ "virgl", glHardwareVendor_t::TRANSLATION },
};

for ( auto& p : rendererStartStringHardware )
{
if ( renderer_string.rfind( p.first, 0 ) == 0 )
{
hardwareVendor = p.second;
return;
}
}

/* Those substrings within a renderer string are assumed to be unambiguous about
the underlying technology. */
static const std::pair<std::string, glHardwareVendor_t> rendererSubStringHardware[] = {
{ "llvmpipe", glHardwareVendor_t::SOFTWARE },
{ "softpipe", glHardwareVendor_t::SOFTWARE },
// Virtualization.
{ "SVGA3D", glHardwareVendor_t::TRANSLATION },
};

for ( auto& p : rendererSubStringHardware )
{
if ( renderer_string.find( p.first ) != std::string::npos )
{
hardwareVendor = p.second;
return;
}
}
}

/* As both proprietary Intel driver on Windows and Mesa may report "Intel",
we rely on the fact Mesa is already detected to know it is the proprietary
Windows driver if not Mesa. */
if ( vendor_string == "Intel" )
{
driverVendor = glDriverVendor_t::INTEL;
hardwareVendor = glHardwareVendor_t::INTEL;
return;
}
}

#endif // __DETECT_OPENGL_VENDORS
9 changes: 9 additions & 0 deletions src/engine/renderer/tr_init.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
// tr_init.c -- functions that are not called every frame
#include "tr_local.h"
#include "framework/CvarSystem.h"
#include "DetectGLVendors.h"
#include "Material.h"

glconfig_t glConfig;
Expand Down Expand Up @@ -884,6 +885,14 @@ ScreenshotCmd screenshotPNGRegistration("screenshotPNG", ssFormat_t::SSF_PNG, "p
"fullscreen"
};

Log::Notice( "%sOpenGL hardware vendor: %s",
Color::ToString( Util::ordinal(glConfig2.hardwareVendor) ? Color::Green : Color::Yellow ),
GetGLHardwareVendorName( glConfig2.hardwareVendor ) );

Log::Notice( "%sOpenGL driver vendor: %s",
Color::ToString( Util::ordinal(glConfig2.driverVendor) ? Color::Green : Color::Yellow ),
GetGLDriverVendorName( glConfig2.driverVendor ) );

Log::Notice("GL_VENDOR: %s", glConfig.vendor_string );
Log::Notice("GL_RENDERER: %s", glConfig.renderer_string );
Log::Notice("GL_VERSION: %s", glConfig.version_string );
Expand Down
4 changes: 4 additions & 0 deletions src/engine/renderer/tr_public.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Maryland 20850 USA.
#define __TR_PUBLIC_H

#include "tr_types.h"
#include "DetectGLVendors.h"
#include <string>

#define REF_API_VERSION 10
Expand All @@ -59,6 +60,9 @@ struct glconfig2_t
bool glCoreProfile;
bool glForwardCompatibleContext;

glDriverVendor_t driverVendor;
glHardwareVendor_t hardwareVendor;

std::string glExtensionsString;
std::string glEnabledExtensionsString;
std::string glMissingExtensionsString;
Expand Down
17 changes: 15 additions & 2 deletions src/engine/sys/sdl_glimp.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#endif

#include "renderer/tr_local.h"
#include "renderer/DetectGLVendors.h"

#pragma warning(push)
#pragma warning(disable : 4125) // "decimal digit terminates octal escape sequence"
Expand Down Expand Up @@ -2013,7 +2014,8 @@ static void GLimp_InitExtensions()
lighting so it is likely this feature would be disabled to
get acceptable framerate on this hardware anyway, making the
need for such extension and the related shader code useless. */
bool foundNvidia340 = ( Q_stristr( glConfig.vendor_string, "NVIDIA Corporation" ) && Q_stristr( glConfig.version_string, "NVIDIA 340." ) );
bool foundNvidia340 = ( glConfig2.driverVendor == glDriverVendor_t::NVIDIA
&& Q_stristr( glConfig.version_string, "NVIDIA 340." ) );

if ( foundNvidia340 )
{
Expand All @@ -2026,7 +2028,7 @@ static void GLimp_InitExtensions()
}

{
bool foundIntel = Q_stristr( glConfig.vendor_string, "Intel" );
bool foundIntel = glConfig2.hardwareVendor == glHardwareVendor_t::INTEL;

if ( foundIntel
&& LOAD_EXTENSION( ExtFlag_NONE, ARB_provoking_vertex ) )
Expand Down Expand Up @@ -2152,6 +2154,7 @@ static void GLimp_InitExtensions()

// Some of the mesa 24.x driver versions have a bug in their shader compiler related to bindless textures,
// which results in either glitches or the shader compiler crashing (when material system is enabled)
if ( glConfig2.driverVendor == glDriverVendor_t::MESA )
{
bool foundMesa241 = false;
std::string mesaVersion = "";
Expand Down Expand Up @@ -2350,6 +2353,16 @@ bool GLimp_Init()

Q_strncpyz( glConfig.version_string, ( char * ) glGetString( GL_VERSION ), sizeof( glConfig.version_string ) );

DetectGLVendors(
glConfig.vendor_string,
glConfig.version_string,
glConfig.renderer_string,
glConfig2.hardwareVendor,
glConfig2.driverVendor );

Log::Debug( "Detected OpenGL hardware vendor: %s", GetGLHardwareVendorName( glConfig2.hardwareVendor ) );
Log::Debug( "Detected OpenGL driver vendor: %s", GetGLDriverVendorName( glConfig2.driverVendor ) );

glConfig2.glExtensionsString = std::string();

if ( glConfig.driverType == glDriverType_t::GLDRV_OPENGL3 )
Expand Down

0 comments on commit b7a3aa4

Please sign in to comment.