Compute Library
 19.08
GCScheduler.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2019 ARM Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
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
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
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 THE
22  * SOFTWARE.
23  */
24 
26 
29 
30 using namespace arm_compute;
31 
32 std::once_flag GCScheduler::_initialize_symbols;
33 
34 GCScheduler::GCScheduler()
35  : _display(EGL_NO_DISPLAY), _context(EGL_NO_CONTEXT), _target(GPUTarget::MIDGARD)
36 {
37 }
38 
39 GCScheduler::~GCScheduler()
40 {
41  eglDestroyContext(_display, _context);
42  eglTerminate(_display);
43 
44  _context = EGL_NO_CONTEXT;
45  _display = EGL_NO_DISPLAY;
46 }
47 
49 {
50  setup_context();
51 
52  init(_display, _context);
53 }
54 
55 void GCScheduler::init(EGLDisplay dpy, EGLContext ctx)
56 {
57  _target = get_target_from_device();
58 
59  GCKernelLibrary::get().init("./cs_shaders/", dpy, ctx);
60 }
61 
63 {
64  std::call_once(_initialize_symbols, opengles31_is_available);
65  static GCScheduler scheduler;
66  return scheduler;
67 }
68 
69 void GCScheduler::dispatch(IGCKernel &kernel, bool flush)
70 {
71  kernel.run(kernel.window());
72  if(flush)
73  {
75  }
76 }
77 
79 {
80  ARM_COMPUTE_GL_CHECK(glMemoryBarrier(GL_SHADER_STORAGE_BARRIER_BIT));
81 }
82 
83 void GCScheduler::setup_context()
84 {
85  EGLBoolean res;
86  _display = eglGetDisplay(EGL_DEFAULT_DISPLAY);
87 
88  ARM_COMPUTE_ERROR_ON_MSG(_display == EGL_NO_DISPLAY, "Failed to get display: 0x%x.", eglGetError());
89 
90  res = eglInitialize(_display, nullptr, nullptr);
91 
92  ARM_COMPUTE_ERROR_ON_MSG(res == EGL_FALSE, "Failed to initialize egl: 0x%x.", eglGetError());
93  ARM_COMPUTE_UNUSED(res);
94 
95  const char *egl_extension_st = eglQueryString(_display, EGL_EXTENSIONS);
96  ARM_COMPUTE_ERROR_ON_MSG((strstr(egl_extension_st, "EGL_KHR_create_context") == nullptr), "Failed to query EGL_KHR_create_context");
97  ARM_COMPUTE_ERROR_ON_MSG((strstr(egl_extension_st, "EGL_KHR_surfaceless_context") == nullptr), "Failed to query EGL_KHR_surfaceless_context");
98  ARM_COMPUTE_UNUSED(egl_extension_st);
99 
100  const std::array<EGLint, 3> config_attribs =
101  {
102  EGL_RENDERABLE_TYPE, EGL_OPENGL_ES3_BIT_KHR,
103  EGL_NONE
104  };
105  EGLConfig cfg;
106  EGLint count;
107 
108  res = eglChooseConfig(_display, config_attribs.data(), &cfg, 1, &count);
109 
110  ARM_COMPUTE_ERROR_ON_MSG(res == EGL_FALSE, "Failed to choose config: 0x%x.", eglGetError());
111  ARM_COMPUTE_UNUSED(res);
112 
113  res = eglBindAPI(EGL_OPENGL_ES_API);
114 
115  ARM_COMPUTE_ERROR_ON_MSG(res == EGL_FALSE, "Failed to bind api: 0x%x.", eglGetError());
116 
117  const std::array<EGLint, 3> attribs =
118  {
119  EGL_CONTEXT_CLIENT_VERSION, 3,
120  EGL_NONE
121  };
122  _context = eglCreateContext(_display,
123  cfg,
124  EGL_NO_CONTEXT,
125  attribs.data());
126 
127  ARM_COMPUTE_ERROR_ON_MSG(_context == EGL_NO_CONTEXT, "Failed to create context: 0x%x.", eglGetError());
128  ARM_COMPUTE_UNUSED(res);
129 
130  res = eglMakeCurrent(_display, EGL_NO_SURFACE, EGL_NO_SURFACE, _context);
131 
132  ARM_COMPUTE_ERROR_ON_MSG(res == EGL_FALSE, "Failed to make current: 0x%x.", eglGetError());
133  ARM_COMPUTE_UNUSED(res);
134 }
#define ARM_COMPUTE_GL_CHECK(x)
Definition: OpenGLES.h:45
EGLBoolean EGLAPIENTRY eglMakeCurrent(EGLDisplay dpy, EGLSurface draw, EGLSurface read, EGLContext ctx)
Definition: OpenGLES.cpp:256
virtual void run(const Window &window)=0
Enqueue the OpenGL ES shader to process the given window.
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
EGLBoolean EGLAPIENTRY eglChooseConfig(EGLDisplay dpy, const EGLint *attrib_list, EGLConfig *configs, EGLint config_size, EGLint *num_config)
Definition: OpenGLES.cpp:191
void dispatch(IGCKernel &kernel, bool flush=true)
Schedule the execution of the passed kernel if possible.
Definition: GCScheduler.cpp:69
EGLContext EGLAPIENTRY eglCreateContext(EGLDisplay dpy, EGLConfig config, EGLContext share_context, const EGLint *attrib_list)
Definition: OpenGLES.cpp:204
EGLint EGLAPIENTRY eglGetError()
Definition: OpenGLES.cpp:282
void GL_APIENTRY glFlush(void)
Definition: OpenGLES.cpp:555
EGLBoolean EGLAPIENTRY eglBindAPI(EGLenum api)
Definition: OpenGLES.cpp:178
char const *EGLAPIENTRY eglQueryString(EGLDisplay dpy, EGLint name)
Definition: OpenGLES.cpp:295
void memory_barrier()
Defines a barrier ordering memory transactions.
Definition: GCScheduler.cpp:78
bool opengles31_is_available()
Check if the OpenGL ES 3.1 API is available at runtime.
Definition: OpenGLES.cpp:160
Copyright (c) 2017-2018 ARM Limited.
EGLBoolean EGLAPIENTRY eglDestroyContext(EGLDisplay dpy, EGLContext ctx)
Definition: OpenGLES.cpp:217
static GCScheduler & get()
Access the scheduler singleton.
Definition: GCScheduler.cpp:62
void init(EGLDisplay dpy, EGLContext ctx)
Initialises the display and context to be used by the scheduler.
Definition: GCScheduler.cpp:55
EGLBoolean EGLAPIENTRY eglInitialize(EGLDisplay dpy, EGLint *major, EGLint *minor)
Definition: OpenGLES.cpp:243
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:160
GPUTarget get_target_from_device(const cl::Device &device)
Helper function to get the GPU target from CL device.
Definition: CLHelpers.cpp:131
Provides global access to a OpenGL ES context and command queue.
Definition: GCScheduler.h:36
void GL_APIENTRY glMemoryBarrier(GLbitfield barriers)
Definition: OpenGLES.cpp:620
static GCKernelLibrary & get()
Get the static instance of GCKernelLibrary.
void init(std::string shader_path="./", EGLDisplay dpy=EGL_NO_DISPLAY, EGLContext ctx=EGL_NO_CONTEXT)
Initialises the kernel library.
GPUTarget
Available GPU Targets.
Definition: GPUTarget.h:34
Common interface for all the GLES kernels.
Definition: IGCKernel.h:39
EGLDisplay EGLAPIENTRY eglGetDisplay(EGLNativeDisplayType display_id)
Definition: OpenGLES.cpp:230
EGLBoolean EGLAPIENTRY eglTerminate(EGLDisplay dpy)
Definition: OpenGLES.cpp:269
void default_init()
Initialises the context and command queue used by the scheduler to default values and sets a default ...
Definition: GCScheduler.cpp:48
#define ARM_COMPUTE_ERROR_ON_MSG(cond,...)
Definition: Error.h:328