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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
use std::error;
use std::fmt;
use std::mem;
use std::ptr;
use std::sync::Arc;
use std::sync::atomic::AtomicBool;
use std::sync::atomic::Ordering;
use std::time::Duration;
use smallvec::SmallVec;
use device::Device;
use Error;
use OomError;
use SafeDeref;
use Success;
use VulkanObject;
use VulkanPointers;
use check_errors;
use vk;
#[derive(Debug)]
pub struct Fence<D = Arc<Device>> where D: SafeDeref<Target = Device> {
fence: vk::Fence,
device: D,
signaled: AtomicBool,
}
impl<D> Fence<D> where D: SafeDeref<Target = Device> {
#[inline]
pub fn raw(device: D) -> Result<Fence<D>, OomError> {
Fence::new_impl(device, false)
}
#[inline]
pub fn new(device: D) -> Arc<Fence<D>> {
Arc::new(Fence::raw(device).unwrap())
}
#[inline]
pub fn signaled_raw(device: D) -> Result<Fence<D>, OomError> {
Fence::new_impl(device, true)
}
#[inline]
pub fn signaled(device: D) -> Arc<Fence<D>> {
Arc::new(Fence::signaled_raw(device).unwrap())
}
fn new_impl(device: D, signaled: bool) -> Result<Fence<D>, OomError> {
let fence = unsafe {
let infos = vk::FenceCreateInfo {
sType: vk::STRUCTURE_TYPE_FENCE_CREATE_INFO,
pNext: ptr::null(),
flags: if signaled { vk::FENCE_CREATE_SIGNALED_BIT } else { 0 },
};
let vk = device.pointers();
let mut output = mem::uninitialized();
try!(check_errors(vk.CreateFence(device.internal_object(), &infos,
ptr::null(), &mut output)));
output
};
Ok(Fence {
fence: fence,
device: device,
signaled: AtomicBool::new(signaled),
})
}
#[inline]
pub fn ready(&self) -> Result<bool, OomError> {
unsafe {
if self.signaled.load(Ordering::Relaxed) { return Ok(true); }
let vk = self.device.pointers();
let result = try!(check_errors(vk.GetFenceStatus(self.device.internal_object(),
self.fence)));
match result {
Success::Success => {
self.signaled.store(true, Ordering::Relaxed);
Ok(true)
},
Success::NotReady => Ok(false),
_ => unreachable!()
}
}
}
pub fn wait(&self, timeout: Duration) -> Result<(), FenceWaitError> {
unsafe {
if self.signaled.load(Ordering::Relaxed) { return Ok(()); }
let timeout_ns = timeout.as_secs().saturating_mul(1_000_000_000)
.saturating_add(timeout.subsec_nanos() as u64);
let vk = self.device.pointers();
let r = try!(check_errors(vk.WaitForFences(self.device.internal_object(), 1,
&self.fence, vk::TRUE, timeout_ns)));
match r {
Success::Success => {
self.signaled.store(true, Ordering::Relaxed);
Ok(())
},
Success::Timeout => {
Err(FenceWaitError::Timeout)
},
_ => unreachable!()
}
}
}
pub fn multi_wait<'a, I>(iter: I, timeout: Duration) -> Result<(), FenceWaitError>
where I: IntoIterator<Item = &'a Fence<D>>, D: 'a
{
let mut device: Option<&Device> = None;
let fences: SmallVec<[vk::Fence; 8]> = iter.into_iter().filter_map(|fence| {
match &mut device {
dev @ &mut None => *dev = Some(&*fence.device),
&mut Some(ref dev) if &**dev as *const Device == &*fence.device as *const Device => {},
_ => panic!("Tried to wait for multiple fences that didn't belong to the \
same device"),
};
if fence.signaled.load(Ordering::Relaxed) {
None
} else {
Some(fence.fence)
}
}).collect();
let timeout_ns = timeout.as_secs().saturating_mul(1_000_000_000)
.saturating_add(timeout.subsec_nanos() as u64);
let r = if let Some(device) = device {
unsafe {
let vk = device.pointers();
try!(check_errors(vk.WaitForFences(device.internal_object(), fences.len() as u32,
fences.as_ptr(), vk::TRUE, timeout_ns)))
}
} else {
return Ok(());
};
match r {
Success::Success => Ok(()),
Success::Timeout => Err(FenceWaitError::Timeout),
_ => unreachable!()
}
}
#[inline]
pub fn reset(&mut self) {
unsafe {
let vk = self.device.pointers();
vk.ResetFences(self.device.internal_object(), 1, &self.fence);
self.signaled.store(false, Ordering::Relaxed);
}
}
pub fn multi_reset<'a, I>(iter: I)
where I: IntoIterator<Item = &'a mut Fence<D>>, D: 'a
{
let mut device: Option<&Device> = None;
let fences: SmallVec<[vk::Fence; 8]> = iter.into_iter().map(|fence| {
match &mut device {
dev @ &mut None => *dev = Some(&*fence.device),
&mut Some(ref dev) if &**dev as *const Device == &*fence.device as *const Device => {},
_ => panic!("Tried to reset multiple fences that didn't belong to the same device"),
};
fence.signaled.store(false, Ordering::Relaxed);
fence.fence
}).collect();
if let Some(device) = device {
unsafe {
let vk = device.pointers();
vk.ResetFences(device.internal_object(), fences.len() as u32, fences.as_ptr());
}
}
}
}
unsafe impl<D> VulkanObject for Fence<D> where D: SafeDeref<Target = Device> {
type Object = vk::Fence;
#[inline]
fn internal_object(&self) -> vk::Fence {
self.fence
}
}
impl<D> Drop for Fence<D> where D: SafeDeref<Target = Device> {
#[inline]
fn drop(&mut self) {
unsafe {
let vk = self.device.pointers();
vk.DestroyFence(self.device.internal_object(), self.fence, ptr::null());
}
}
}
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum FenceWaitError {
OomError(OomError),
Timeout,
DeviceLostError,
}
impl error::Error for FenceWaitError {
#[inline]
fn description(&self) -> &str {
match *self {
FenceWaitError::OomError(_) => "no memory available",
FenceWaitError::Timeout => "the timeout has been reached",
FenceWaitError::DeviceLostError => "the device was lost",
}
}
#[inline]
fn cause(&self) -> Option<&error::Error> {
match *self {
FenceWaitError::OomError(ref err) => Some(err),
_ => None
}
}
}
impl fmt::Display for FenceWaitError {
#[inline]
fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
write!(fmt, "{}", error::Error::description(self))
}
}
impl From<Error> for FenceWaitError {
#[inline]
fn from(err: Error) -> FenceWaitError {
match err {
Error::OutOfHostMemory => FenceWaitError::OomError(From::from(err)),
Error::OutOfDeviceMemory => FenceWaitError::OomError(From::from(err)),
Error::DeviceLost => FenceWaitError::DeviceLostError,
_ => panic!("Unexpected error value: {}", err as i32)
}
}
}
#[cfg(test)]
mod tests {
use std::sync::Arc;
use std::time::Duration;
use sync::Fence;
#[test]
fn fence_create() {
let (device, _) = gfx_dev_and_queue!();
let fence = Fence::new(device.clone());
assert!(!fence.ready().unwrap());
}
#[test]
fn fence_create_signaled() {
let (device, _) = gfx_dev_and_queue!();
let fence = Fence::signaled(device.clone());
assert!(fence.ready().unwrap());
}
#[test]
fn fence_signaled_wait() {
let (device, _) = gfx_dev_and_queue!();
let fence = Fence::signaled(device.clone());
fence.wait(Duration::new(0, 10)).unwrap();
}
#[test]
fn fence_reset() {
let (device, _) = gfx_dev_and_queue!();
let mut fence = Fence::signaled(device.clone());
Arc::get_mut(&mut fence).unwrap().reset();
assert!(!fence.ready().unwrap());
}
#[test]
#[should_panic = "Tried to wait for multiple fences that didn't belong to the same device"]
fn multiwait_different_devices() {
let (device1, _) = gfx_dev_and_queue!();
let (device2, _) = gfx_dev_and_queue!();
let fence1 = Fence::signaled(device1.clone());
let fence2 = Fence::signaled(device2.clone());
let _ = Fence::multi_wait([&*fence1, &*fence2].iter().cloned(), Duration::new(0, 10));
}
#[test]
#[should_panic = "Tried to reset multiple fences that didn't belong to the same device"]
fn multireset_different_devices() {
let (device1, _) = gfx_dev_and_queue!();
let (device2, _) = gfx_dev_and_queue!();
let mut fence1 = Fence::signaled(device1.clone());
let mut fence2 = Fence::signaled(device2.clone());
let _ = Fence::multi_reset(Some(Arc::get_mut(&mut fence1).unwrap()).into_iter()
.chain(Some(Arc::get_mut(&mut fence2).unwrap()).into_iter()));
}
}