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
|
/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include "FenceSync.h"
#include <EGL/egl.h>
#include <GLES2/gl2.h>
#include <GLES2/gl2ext.h>
#include "base/Optional.h"
#include "base/ConditionVariable.h"
#include "base/Lock.h"
#include "base/Thread.h"
#include "base/ThreadPool.h"
#include "base/MessageChannel.h"
#include "vulkan/VkDecoderGlobalState.h"
#include "virtio_gpu_ops.h"
// SyncThread///////////////////////////////////////////////////////////////////
// The purpose of SyncThread is to track sync device timelines and give out +
// signal FD's that correspond to the completion of host-side GL fence commands.
// We communicate with the sync thread in 3 ways:
enum SyncThreadOpCode {
// Nonblocking command to initialize sync thread's contents,
// such as the EGL context for sync operations
SYNC_THREAD_INIT = 0,
// Nonblocking command to wait on a given FenceSync object
// and timeline handle.
// A fence FD object in the guest is signaled.
SYNC_THREAD_WAIT = 1,
// Blocking command to clean up and exit the sync thread.
SYNC_THREAD_EXIT = 2,
// Blocking command to wait on a given FenceSync object.
// No timeline handling is done.
SYNC_THREAD_BLOCKED_WAIT_NO_TIMELINE = 3,
// Nonblocking command to wait on a given VkFence
// and timeline handle.
// A fence FD object / Zircon eventpair in the guest is signaled.
SYNC_THREAD_WAIT_VK = 4,
};
struct SyncThreadCmd {
// For use with initialization in multiple thread pools.
int workerId = 0;
// For use with ThreadPool::broadcastIndexed
void setIndex(int id) { workerId = id; }
SyncThreadOpCode opCode = SYNC_THREAD_INIT;
union {
FenceSync* fenceSync = nullptr;
VkFence vkFence;
};
uint64_t timeline = 0;
android::base::Lock* lock = nullptr;
android::base::ConditionVariable* cond = nullptr;
android::base::Optional<int>* result = nullptr;
bool useFenceCompletionCallback = false;
FenceCompletionCallback fenceCompletionCallback;;
};
struct RenderThreadInfo;
class SyncThread : public android::base::Thread {
public:
// - constructor: start up the sync worker threads for a given context.
// The initialization of the sync threads is nonblocking.
// - Triggers a |SyncThreadCmd| with op code |SYNC_THREAD_INIT|
SyncThread();
~SyncThread();
// |triggerWait|: async wait with a given FenceSync object.
// We use the wait() method to do a eglClientWaitSyncKHR.
// After wait is over, the timeline will be incremented,
// which should signal the guest-side fence FD.
// This method is how the goldfish sync virtual device
// knows when to increment timelines / signal native fence FD's.
void triggerWait(FenceSync* fenceSync,
uint64_t timeline);
// |triggerWaitVk|: async wait with a given VkFence object.
// The |vkFence| argument is a *boxed* host Vulkan handle of the fence.
//
// We call vkWaitForFences() on host Vulkan device to wait for the fence.
// After wait is over, the timeline will be incremented,
// which should signal the guest-side fence FD / Zircon eventpair.
// This method is how the goldfish sync virtual device
// knows when to increment timelines / signal native fence FD's.
void triggerWaitVk(VkFence vkFence, uint64_t timeline);
// for use with the virtio-gpu path; is meant to have a current context
// while waiting.
void triggerBlockedWaitNoTimeline(FenceSync* fenceSync);
// For use with virtio-gpu and async fence completion callback. This is async like triggerWait, but takes a fence completion callback instead of incrementing some timeline directly.
void triggerWaitWithCompletionCallback(FenceSync* fenceSync, FenceCompletionCallback);
void triggerWaitVkWithCompletionCallback(VkFence fenceHandle, FenceCompletionCallback);
// |cleanup|: for use with destructors and other cleanup functions.
// it destroys the sync context and exits the sync thread.
// This is blocking; after this function returns, we're sure
// the sync thread is gone.
// - Triggers a |SyncThreadCmd| with op code |SYNC_THREAD_EXIT|
void cleanup();
// Obtains the global sync thread.
static SyncThread* get();
// Destroys and recreates the sync thread, for use on snapshot load.
static void destroy();
static void recreate();
private:
// |initSyncContext| creates an EGL context expressly for calling
// eglClientWaitSyncKHR in the processing caused by |triggerWait|.
// This is used by the constructor only. It is non-blocking.
// - Triggers a |SyncThreadCmd| with op code |SYNC_THREAD_INIT|
void initSyncContext();
// Thread function.
// It keeps the workers runner until |mExiting| is set.
virtual intptr_t main() override final;
// These two functions are used to communicate with the sync thread
// from another thread:
// - |sendAndWaitForResult| issues |cmd| to the sync thread,
// and blocks until it receives the result of the command.
// - |sendAsync| issues |cmd| to the sync thread and does not
// wait for the result, returning immediately after.
int sendAndWaitForResult(SyncThreadCmd& cmd);
void sendAsync(SyncThreadCmd& cmd);
// |doSyncThreadCmd| and related functions below
// execute the actual commands. These run on the sync thread.
int doSyncThreadCmd(SyncThreadCmd* cmd);
void doSyncContextInit(SyncThreadCmd* cmd);
void doSyncWait(SyncThreadCmd* cmd);
int doSyncWaitVk(SyncThreadCmd* cmd);
void doSyncBlockedWaitNoTimeline(SyncThreadCmd* cmd);
void doExit(SyncThreadCmd* cmd);
// EGL objects / object handles specific to
// a sync thread.
static const uint32_t kNumWorkerThreads = 4u;
EGLDisplay mDisplay = EGL_NO_DISPLAY;
EGLSurface mSurface[kNumWorkerThreads];
EGLContext mContext[kNumWorkerThreads];
bool mExiting = false;
android::base::Lock mLock;
android::base::ConditionVariable mCv;
android::base::ThreadPool<SyncThreadCmd> mWorkerThreadPool;
};
|
