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
|
#![allow(clippy::module_name_repetitions)]
use std::io::{Read as _, Write as _};
type AsyncPty = tokio::io::unix::AsyncFd<crate::sys::Pty>;
/// An allocated pty
pub struct Pty(AsyncPty);
impl Pty {
/// Allocate and return a new pty.
///
/// # Errors
/// Returns an error if the pty failed to be allocated, or if we were
/// unable to put it into non-blocking mode.
pub fn new() -> crate::Result<Self> {
let pty = crate::sys::Pty::open()?;
pty.set_nonblocking()?;
Ok(Self(tokio::io::unix::AsyncFd::new(pty)?))
}
/// Change the terminal size associated with the pty.
///
/// # Errors
/// Returns an error if we were unable to set the terminal size.
pub fn resize(&self, size: crate::Size) -> crate::Result<()> {
self.0.get_ref().set_term_size(size)
}
/// Opens a file descriptor for the other end of the pty, which should be
/// attached to the child process running in it. See
/// [`Command::spawn`](crate::Command::spawn).
///
/// # Errors
/// Returns an error if the device node to open could not be determined,
/// or if the device node could not be opened.
pub fn pts(&self) -> crate::Result<Pts> {
Ok(Pts(self.0.get_ref().pts()?))
}
/// Splits a `Pty` into a read half and a write half, which can be used to
/// read from and write to the pty concurrently. Does not allocate, but
/// the returned halves cannot be moved to independent tasks.
pub fn split(&mut self) -> (ReadPty<'_>, WritePty<'_>) {
(ReadPty(&self.0), WritePty(&self.0))
}
/// Splits a `Pty` into a read half and a write half, which can be used to
/// read from and write to the pty concurrently. This method requires an
/// allocation, but the returned halves can be moved to independent tasks.
/// The original `Pty` instance can be recovered via the
/// [`OwnedReadPty::unsplit`] method.
#[must_use]
pub fn into_split(self) -> (OwnedReadPty, OwnedWritePty) {
let Self(pt) = self;
let read_pt = std::sync::Arc::new(pt);
let write_pt = std::sync::Arc::clone(&read_pt);
(OwnedReadPty(read_pt), OwnedWritePty(write_pt))
}
}
impl std::os::unix::io::AsRawFd for Pty {
fn as_raw_fd(&self) -> std::os::unix::io::RawFd {
self.0.as_raw_fd()
}
}
impl tokio::io::AsyncRead for Pty {
fn poll_read(
self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
buf: &mut tokio::io::ReadBuf,
) -> std::task::Poll<std::io::Result<()>> {
loop {
let mut guard = match self.0.poll_read_ready(cx) {
std::task::Poll::Ready(guard) => guard,
std::task::Poll::Pending => return std::task::Poll::Pending,
}?;
let mut b = [0u8; 4096];
match guard.try_io(|inner| (&inner.get_ref().0).read(&mut b)) {
Ok(Ok(bytes)) => {
// XXX this is safe, but not particularly efficient
buf.clear();
buf.initialize_unfilled_to(bytes);
buf.set_filled(bytes);
buf.filled_mut().copy_from_slice(&b[..bytes]);
return std::task::Poll::Ready(Ok(()));
}
Ok(Err(e)) => return std::task::Poll::Ready(Err(e)),
Err(_would_block) => continue,
}
}
}
}
impl tokio::io::AsyncWrite for Pty {
fn poll_write(
self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
buf: &[u8],
) -> std::task::Poll<std::io::Result<usize>> {
loop {
let mut guard = match self.0.poll_write_ready(cx) {
std::task::Poll::Ready(guard) => guard,
std::task::Poll::Pending => return std::task::Poll::Pending,
}?;
match guard.try_io(|inner| (&inner.get_ref().0).write(buf)) {
Ok(result) => return std::task::Poll::Ready(result),
Err(_would_block) => continue,
}
}
}
fn poll_flush(
self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<std::io::Result<()>> {
loop {
let mut guard = match self.0.poll_write_ready(cx) {
std::task::Poll::Ready(guard) => guard,
std::task::Poll::Pending => return std::task::Poll::Pending,
}?;
match guard.try_io(|inner| (&inner.get_ref().0).flush()) {
Ok(_) => return std::task::Poll::Ready(Ok(())),
Err(_would_block) => continue,
}
}
}
fn poll_shutdown(
self: std::pin::Pin<&mut Self>,
_cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Result<(), std::io::Error>> {
std::task::Poll::Ready(Ok(()))
}
}
/// The child end of the pty
///
/// See [`Pty::pts`] and [`Command::spawn`](crate::Command::spawn)
pub struct Pts(pub(crate) crate::sys::Pts);
/// Borrowed read half of a [`Pty`]
pub struct ReadPty<'a>(&'a AsyncPty);
impl<'a> tokio::io::AsyncRead for ReadPty<'a> {
fn poll_read(
self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
buf: &mut tokio::io::ReadBuf,
) -> std::task::Poll<std::io::Result<()>> {
loop {
let mut guard = match self.0.poll_read_ready(cx) {
std::task::Poll::Ready(guard) => guard,
std::task::Poll::Pending => return std::task::Poll::Pending,
}?;
let mut b = [0u8; 4096];
match guard.try_io(|inner| (&inner.get_ref().0).read(&mut b)) {
Ok(Ok(bytes)) => {
// XXX this is safe, but not particularly efficient
buf.clear();
buf.initialize_unfilled_to(bytes);
buf.set_filled(bytes);
buf.filled_mut().copy_from_slice(&b[..bytes]);
return std::task::Poll::Ready(Ok(()));
}
Ok(Err(e)) => return std::task::Poll::Ready(Err(e)),
Err(_would_block) => continue,
}
}
}
}
/// Borrowed write half of a [`Pty`]
pub struct WritePty<'a>(&'a AsyncPty);
impl<'a> WritePty<'a> {
/// Change the terminal size associated with the pty.
///
/// # Errors
/// Returns an error if we were unable to set the terminal size.
pub fn resize(&self, size: crate::Size) -> crate::Result<()> {
self.0.get_ref().set_term_size(size)
}
}
impl<'a> tokio::io::AsyncWrite for WritePty<'a> {
fn poll_write(
self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
buf: &[u8],
) -> std::task::Poll<std::io::Result<usize>> {
loop {
let mut guard = match self.0.poll_write_ready(cx) {
std::task::Poll::Ready(guard) => guard,
std::task::Poll::Pending => return std::task::Poll::Pending,
}?;
match guard.try_io(|inner| (&inner.get_ref().0).write(buf)) {
Ok(result) => return std::task::Poll::Ready(result),
Err(_would_block) => continue,
}
}
}
fn poll_flush(
self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<std::io::Result<()>> {
loop {
let mut guard = match self.0.poll_write_ready(cx) {
std::task::Poll::Ready(guard) => guard,
std::task::Poll::Pending => return std::task::Poll::Pending,
}?;
match guard.try_io(|inner| (&inner.get_ref().0).flush()) {
Ok(_) => return std::task::Poll::Ready(Ok(())),
Err(_would_block) => continue,
}
}
}
fn poll_shutdown(
self: std::pin::Pin<&mut Self>,
_cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Result<(), std::io::Error>> {
std::task::Poll::Ready(Ok(()))
}
}
/// Owned read half of a [`Pty`]
#[derive(Debug)]
pub struct OwnedReadPty(std::sync::Arc<AsyncPty>);
impl OwnedReadPty {
/// Attempt to join the two halves of a `Pty` back into a single instance.
/// The two halves must have originated from calling
/// [`into_split`](Pty::into_split) on a single instance.
///
/// # Errors
/// Returns an error if the two halves came from different [`Pty`]
/// instances. The mismatched halves are returned as part of the error.
pub fn unsplit(self, write_half: OwnedWritePty) -> crate::Result<Pty> {
let Self(read_pt) = self;
let OwnedWritePty(write_pt) = write_half;
if std::sync::Arc::ptr_eq(&read_pt, &write_pt) {
drop(write_pt);
Ok(Pty(std::sync::Arc::try_unwrap(read_pt)
// it shouldn't be possible for more than two references to
// the same pty to exist
.unwrap_or_else(|_| unreachable!())))
} else {
Err(crate::Error::Unsplit(
Self(read_pt),
OwnedWritePty(write_pt),
))
}
}
}
impl tokio::io::AsyncRead for OwnedReadPty {
fn poll_read(
self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
buf: &mut tokio::io::ReadBuf,
) -> std::task::Poll<std::io::Result<()>> {
loop {
let mut guard = match self.0.poll_read_ready(cx) {
std::task::Poll::Ready(guard) => guard,
std::task::Poll::Pending => return std::task::Poll::Pending,
}?;
let mut b = [0u8; 4096];
match guard.try_io(|inner| (&inner.get_ref().0).read(&mut b)) {
Ok(Ok(bytes)) => {
// XXX this is safe, but not particularly efficient
buf.clear();
buf.initialize_unfilled_to(bytes);
buf.set_filled(bytes);
buf.filled_mut().copy_from_slice(&b[..bytes]);
return std::task::Poll::Ready(Ok(()));
}
Ok(Err(e)) => return std::task::Poll::Ready(Err(e)),
Err(_would_block) => continue,
}
}
}
}
/// Owned write half of a [`Pty`]
#[derive(Debug)]
pub struct OwnedWritePty(std::sync::Arc<AsyncPty>);
impl OwnedWritePty {
/// Change the terminal size associated with the pty.
///
/// # Errors
/// Returns an error if we were unable to set the terminal size.
pub fn resize(&self, size: crate::Size) -> crate::Result<()> {
self.0.get_ref().set_term_size(size)
}
}
impl tokio::io::AsyncWrite for OwnedWritePty {
fn poll_write(
self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
buf: &[u8],
) -> std::task::Poll<std::io::Result<usize>> {
loop {
let mut guard = match self.0.poll_write_ready(cx) {
std::task::Poll::Ready(guard) => guard,
std::task::Poll::Pending => return std::task::Poll::Pending,
}?;
match guard.try_io(|inner| (&inner.get_ref().0).write(buf)) {
Ok(result) => return std::task::Poll::Ready(result),
Err(_would_block) => continue,
}
}
}
fn poll_flush(
self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<std::io::Result<()>> {
loop {
let mut guard = match self.0.poll_write_ready(cx) {
std::task::Poll::Ready(guard) => guard,
std::task::Poll::Pending => return std::task::Poll::Pending,
}?;
match guard.try_io(|inner| (&inner.get_ref().0).flush()) {
Ok(_) => return std::task::Poll::Ready(Ok(())),
Err(_would_block) => continue,
}
}
}
fn poll_shutdown(
self: std::pin::Pin<&mut Self>,
_cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Result<(), std::io::Error>> {
std::task::Poll::Ready(Ok(()))
}
}
|
