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
|
//! Host-owned immutable file snapshots retained by the native image lifetime.
use super::{ffi, Error, GhosttyResultExt};
use crate::pane_graphics_files::{FileStore, OwnedExport};
use std::ffi::c_void;
use std::ptr;
use std::sync::{Arc, OnceLock};
static SOURCES: OnceLock<FileStore> = OnceLock::new();
// These getters never materialize native pixels. The image borrow protects the
// host's strong reference until we have acquired our own.
pub(super) fn image_source(
image: ffi::GhosttyKittyGraphicsImage,
) -> Result<Option<Arc<OwnedExport>>, Error> {
let mut context: *mut c_void = ptr::null_mut();
let result = unsafe {
ffi::ghostty_kitty_graphics_image_get(
image,
ffi::GhosttyKittyGraphicsImageData_GHOSTTY_KITTY_IMAGE_DATA_FILE_CONTEXT,
(&mut context as *mut *mut c_void).cast(),
)
};
if result == ffi::GhosttyResult_GHOSTTY_NO_VALUE {
return Ok(None);
}
result.into_result()?;
if context.is_null() {
return Ok(None);
}
let mut identity = 0u64;
unsafe {
ffi::ghostty_kitty_graphics_image_get(
image,
ffi::GhosttyKittyGraphicsImageData_GHOSTTY_KITTY_IMAGE_DATA_FILE_IDENTITY,
(&mut identity as *mut u64).cast(),
)
.into_result()?;
let source = context.cast::<OwnedExport>();
// All terminal snapshot callbacks in this wrapper produce this type.
// Identity is immutable and does not depend on decoded pixel storage.
if (*source).fingerprint() != identity {
return Err(Error(ffi::GhosttyResult_GHOSTTY_INVALID_VALUE));
}
Arc::increment_strong_count(source);
Ok(Some(Arc::from_raw(source)))
}
}
pub(super) fn set_forwarding(terminal: ffi::GhosttyTerminal, enabled: bool) -> Result<(), Error> {
let callback = if enabled && cfg!(target_os = "linux") {
snapshot as *const () as *const c_void
} else {
ptr::null()
};
unsafe {
ffi::ghostty_terminal_set(
terminal,
ffi::GhosttyTerminalOption_GHOSTTY_TERMINAL_OPT_KITTY_IMAGE_SNAPSHOT_FILE,
callback,
)
.into_result()
}
}
unsafe extern "C" fn snapshot(
_terminal: ffi::GhosttyTerminal,
_userdata: *mut c_void,
request: *const ffi::GhosttyKittyImageSnapshotFileRequest,
out: *mut ffi::GhosttyKittyImageFileBacking,
) -> bool {
std::panic::catch_unwind(|| {
if request.is_null() || out.is_null() || !cfg!(target_os = "linux") {
return false;
}
let request = unsafe { &*request };
if request.size != std::mem::size_of::<ffi::GhosttyKittyImageSnapshotFileRequest>() {
return false;
}
let Ok(len) = usize::try_from(request.expected_len) else {
return false;
};
let Ok(source) = SOURCES
.get_or_init(FileStore::native_sources)
.snapshot(request.fd, len)
else {
return false;
};
let source = Arc::new(source);
let backing = ffi::GhosttyKittyImageFileBacking {
identity: source.fingerprint(),
len: source.len(),
context: Arc::into_raw(source).cast_mut().cast(),
read: Some(read),
release: Some(release),
};
unsafe {
out.write(backing);
}
true
})
.unwrap_or(false)
}
unsafe extern "C" fn read(context: *mut c_void, dest: *mut u8, len: usize) -> bool {
std::panic::catch_unwind(|| {
if context.is_null() || dest.is_null() {
return false;
}
let source = unsafe { &*context.cast::<OwnedExport>() };
if len != source.len() || len > isize::MAX as usize {
return false;
}
source
.read_into(unsafe { std::slice::from_raw_parts_mut(dest, len) })
.is_ok()
})
.unwrap_or(false)
}
unsafe extern "C" fn release(context: *mut c_void) {
let _ = std::panic::catch_unwind(|| {
if !context.is_null() {
drop(unsafe { Arc::from_raw(context.cast::<OwnedExport>()) });
}
});
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn invalid_requests_decline_without_transferring_ownership() {
let mut out = ffi::GhosttyKittyImageFileBacking::default();
let mut request = ffi::GhosttyKittyImageSnapshotFileRequest {
size: std::mem::size_of::<ffi::GhosttyKittyImageSnapshotFileRequest>(),
fd: -1,
expected_len: 4,
};
unsafe {
assert!(!snapshot(
ptr::null_mut(),
ptr::null_mut(),
&request,
&mut out
));
assert!(out.context.is_null());
request.size = 0;
assert!(!snapshot(
ptr::null_mut(),
ptr::null_mut(),
&request,
&mut out
));
assert!(!snapshot(
ptr::null_mut(),
ptr::null_mut(),
ptr::null(),
&mut out
));
assert!(out.context.is_null());
release(ptr::null_mut());
}
}
}
|
