Skip to content

Commit

Permalink
Implement an EGL driver
Browse files Browse the repository at this point in the history 
This is needed by Wayland and could potentially be used by other
platforms too, such as Android.

This driver has been written in a platform-agnostic way, requiring the
implementing platform to create a platform-specific manager inheriting
from the EGLManager class, implementing the `_get_platform_extension_*`
methods.

It also includes its own GLAD loader and some extra logic for loading it
automatically.
  • Loading branch information
@Riteo
Riteo committed Dec 24, 2022
1 parent daf168f commit 682f9f0
Show file tree
Hide file tree
Showing 10 changed files with 1,846 additions and 7 deletions.
1 change: 1 addition & 0 deletions drivers/SCsub
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ if env["vulkan"]:
if env["opengl3"]:
SConscript("gl_context/SCsub")
SConscript("gles3/SCsub")
SConscript("egl/SCsub")

# Core dependencies
SConscript("png/SCsub")
Expand Down
6 changes: 6 additions & 0 deletions drivers/egl/SCsub
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/usr/bin/env python

Import("env")

# Godot source files
env.add_source_files(env.drivers_sources, "*.cpp")
220 changes: 220 additions & 0 deletions drivers/egl/detect_prime_egl.cpp
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
/*************************************************************************/
/* detect_prime_egl.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
/* */
/* 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. */
/*************************************************************************/

#ifdef GLES3_ENABLED
#ifdef EGL_ENABLED

#include "detect_prime_egl.h"

#include "core/string/print_string.h"
#include "core/string/ustring.h"

#include <stdlib.h>

#include <GL/glcorearb.h>

#include <EGL/egl.h>
#include <EGL/eglext.h>

#include <cstring>

#include <sys/types.h>
#include <sys/wait.h>
#include <unistd.h>

struct vendor {
const char *glxvendor = nullptr;
int priority = 0;
};

vendor vendormap[] = {
{ "Advanced Micro Devices, Inc.", 30 },
{ "AMD", 30 },
{ "NVIDIA Corporation", 30 },
{ "X.Org", 30 },
{ "Intel Open Source Technology Center", 20 },
{ "Intel", 20 },
{ "nouveau", 10 },
{ "Mesa Project", 0 },
{ nullptr, 0 }
};

// Runs inside a child. Exiting will not quit the engine.
void create_context() {
EGLDisplay egl_display = eglGetDisplay(EGL_DEFAULT_DISPLAY);
EGLConfig egl_config;
EGLContext egl_context = EGL_NO_CONTEXT;

eglInitialize(egl_display, NULL, NULL);

EGLint attribs[] = {
EGL_RED_SIZE,
1,
EGL_BLUE_SIZE,
1,
EGL_GREEN_SIZE,
1,
EGL_DEPTH_SIZE,
24,
EGL_NONE,
};

EGLint config_count = 0;
eglChooseConfig(egl_display, attribs, &egl_config, 1, &config_count);

EGLint context_attribs[] = {
EGL_CONTEXT_MAJOR_VERSION, 3,
EGL_CONTEXT_MINOR_VERSION, 3,
EGL_NONE
};

egl_context = eglCreateContext(egl_display, egl_config, EGL_NO_CONTEXT, context_attribs);

eglMakeCurrent(egl_display, EGL_NO_SURFACE, EGL_NO_SURFACE, egl_context);
}

int detect_prime() {
pid_t p;
int priorities[2] = {};
String vendors[2];
String renderers[2];

vendors[0] = "Unknown";
vendors[1] = "Unknown";
renderers[0] = "Unknown";
renderers[1] = "Unknown";

for (int i = 0; i < 2; ++i) {
int fdset[2];

if (pipe(fdset) == -1) {
print_verbose("Failed to pipe(), using default GPU");
return 0;
}

// Fork so the driver initialization can crash without taking down the engine.
p = fork();

if (p > 0) {
// Main thread

int stat_loc = 0;
char string[201];
string[200] = '\0';

close(fdset[1]);

waitpid(p, &stat_loc, 0);

if (!stat_loc) {
// No need to do anything complicated here. Anything less than
// PIPE_BUF will be delivered in one read() call.
// Leave it 'Unknown' otherwise.
if (read(fdset[0], string, sizeof(string) - 1) > 0) {
vendors[i] = string;
renderers[i] = string + strlen(string) + 1;
}
}

close(fdset[0]);

} else {
// In child, exit() here will not quit the engine.

// Prevent false leak reports as we will not be properly
// cleaning up these processes, and fork() makes a copy
// of all globals.
CoreGlobals::leak_reporting_enabled = false;

char string[201];

close(fdset[0]);

if (i) {
setenv("DRI_PRIME", "1", 1);
}
create_context();

PFNGLGETSTRINGPROC glGetString = (PFNGLGETSTRINGPROC)eglGetProcAddress("glGetString");
const char *vendor = (const char *)glGetString(GL_VENDOR);
const char *renderer = (const char *)glGetString(GL_RENDERER);

unsigned int vendor_len = strlen(vendor) + 1;
unsigned int renderer_len = strlen(renderer) + 1;

if (vendor_len + renderer_len >= sizeof(string)) {
renderer_len = 200 - vendor_len;
}

memcpy(&string, vendor, vendor_len);
memcpy(&string[vendor_len], renderer, renderer_len);

if (write(fdset[1], string, vendor_len + renderer_len) == -1) {
print_verbose("Couldn't write vendor/renderer string.");
}
close(fdset[1]);
exit(0);
}
}

int preferred = 0;
int priority = 0;

if (vendors[0] == vendors[1]) {
print_verbose("Only one GPU found, using default.");
return 0;
}

for (int i = 1; i >= 0; --i) {
vendor *v = vendormap;
while (v->glxvendor) {
if (v->glxvendor == vendors[i]) {
priorities[i] = v->priority;

if (v->priority >= priority) {
priority = v->priority;
preferred = i;
}
}
++v;
}
}

print_verbose("Found renderers:");
for (int i = 0; i < 2; ++i) {
print_verbose("Renderer " + itos(i) + ": " + renderers[i] + " with priority: " + itos(priorities[i]));
}

print_verbose("Using renderer: " + renderers[preferred]);
return preferred;
}

#endif // EGL_ENABLED
#endif // GLES3_ENABLED
42 changes: 42 additions & 0 deletions drivers/egl/detect_prime_egl.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*************************************************************************/
/* detect_prime_egl.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
/* */
/* 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. */
/*************************************************************************/

#ifndef DETECT_PRIME_EGL_H
#define DETECT_PRIME_EGL_H

#ifdef GLES3_ENABLED
#ifdef EGL_ENABLED

int detect_prime();

#endif // GLES3_ENABLED
#endif // EGL_ENABLED

#endif // DETECT_PRIME_EGL_H
Loading

0 comments on commit 682f9f0

Please sign in to comment.