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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
use super::awaitable_responses::ArenaArc;
use super::connection::SharedData;
use crate::*;

use core::fmt::Debug;

use std::borrow::Cow;
use std::path::Path;

use std::sync::Arc;

use openssh_sftp_protocol::file_attrs::FileAttrs;
use openssh_sftp_protocol::request::*;
use openssh_sftp_protocol::serde::Serialize;
use openssh_sftp_protocol::ssh_format::Serializer;
use openssh_sftp_protocol::Handle;

use std::io::IoSlice;

/// TODO:
///  - Support IoSlice for data in `send_write_request`

/// It is recommended to create at most one `WriteEnd` per thread.
#[derive(Debug)]
pub struct WriteEnd<Buffer: ToBuffer + 'static> {
    serializer: Serializer,
    shared_data: Arc<SharedData<Buffer>>,
}

impl<Buffer: ToBuffer + 'static> Clone for WriteEnd<Buffer> {
    fn clone(&self) -> Self {
        Self::new(self.shared_data.clone())
    }
}

impl<Buffer: ToBuffer + 'static> Drop for WriteEnd<Buffer> {
    fn drop(&mut self) {
        let shared_data = &self.shared_data;

        // If this is the last reference, except for `ReadEnd`, to the SharedData,
        // then the connection is closed.
        if Arc::strong_count(shared_data) == 2 {
            shared_data.notify_conn_closed();
        }
    }
}

impl<Buffer: ToBuffer + 'static> WriteEnd<Buffer> {
    pub(crate) fn new(shared_data: Arc<SharedData<Buffer>>) -> Self {
        Self {
            serializer: Serializer::new(),
            shared_data,
        }
    }
}

impl<Buffer: ToBuffer + Debug + Send + Sync + 'static> WriteEnd<Buffer> {
    pub(crate) async fn send_hello(&mut self, version: u32) -> Result<(), Error> {
        self.write(Hello { version }).await
    }

    async fn write<T>(&mut self, value: T) -> Result<(), Error>
    where
        T: Serialize,
    {
        self.serializer.reset();
        value.serialize(&mut self.serializer)?;

        self.shared_data
            .writer
            .write_all(self.serializer.get_output()?)
            .await?;

        Ok(())
    }

    /// Create a useable response id.
    pub fn create_response_id(&self) -> Id<Buffer> {
        self.shared_data.responses.insert()
    }

    /// Return true if reserve succeeds, false otherwise.
    pub fn try_reserve_id(&self, new_id_cnt: u32) -> bool {
        self.shared_data.responses.try_reserve(new_id_cnt)
    }

    /// Return true if reserve succeeds, false otherwise.
    pub fn reserve_id(&self, new_id_cnt: u32) {
        self.shared_data.responses.reserve(new_id_cnt);
    }

    /// Send requests.
    ///
    /// **Please use `Self::send_write_request` for sending write requests.**
    async fn send_request(
        &mut self,
        id: Id<Buffer>,
        request: RequestInner<'_>,
        buffer: Option<Buffer>,
    ) -> Result<ArenaArc<Buffer>, Error> {
        // Call id.into_inner to prevent id from being removed
        // if the future is cancelled.
        let arc = id.into_inner();

        arc.reset(buffer);

        self.write(Request {
            request_id: ArenaArc::slot(&arc),
            inner: request,
        })
        .await?;

        self.shared_data.notify_new_packet_event();

        Ok(arc)
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_open_file_request(
        &mut self,
        id: Id<Buffer>,
        params: OpenFile<'_>,
    ) -> Result<AwaitableHandle<Buffer>, Error> {
        Ok(AwaitableHandle::new(
            self.send_request(id, RequestInner::Open(params), None)
                .await?,
        ))
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_close_request(
        &mut self,
        id: Id<Buffer>,
        handle: Cow<'_, Handle>,
    ) -> Result<AwaitableStatus<Buffer>, Error> {
        Ok(AwaitableStatus::new(
            self.send_request(id, RequestInner::Close(handle), None)
                .await?,
        ))
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_read_request(
        &mut self,
        id: Id<Buffer>,
        handle: Cow<'_, Handle>,
        offset: u64,
        len: u32,
        buffer: Option<Buffer>,
    ) -> Result<AwaitableData<Buffer>, Error> {
        Ok(AwaitableData::new(
            self.send_request(
                id,
                RequestInner::Read {
                    handle,
                    offset,
                    len,
                },
                buffer,
            )
            .await?,
        ))
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_remove_request(
        &mut self,
        id: Id<Buffer>,
        path: Cow<'_, Path>,
    ) -> Result<AwaitableStatus<Buffer>, Error> {
        Ok(AwaitableStatus::new(
            self.send_request(id, RequestInner::Remove(path), None)
                .await?,
        ))
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_rename_request(
        &mut self,
        id: Id<Buffer>,
        oldpath: Cow<'_, Path>,
        newpath: Cow<'_, Path>,
    ) -> Result<AwaitableStatus<Buffer>, Error> {
        Ok(AwaitableStatus::new(
            self.send_request(id, RequestInner::Rename { oldpath, newpath }, None)
                .await?,
        ))
    }

    /// * `attrs` - `attrs.get_size()` must be equal to `None`.
    ///
    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_mkdir_request(
        &mut self,
        id: Id<Buffer>,
        path: Cow<'_, Path>,
        attrs: FileAttrs,
    ) -> Result<AwaitableStatus<Buffer>, Error> {
        Ok(AwaitableStatus::new(
            self.send_request(id, RequestInner::Mkdir { path, attrs }, None)
                .await?,
        ))
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_rmdir_request(
        &mut self,
        id: Id<Buffer>,
        path: Cow<'_, Path>,
    ) -> Result<AwaitableStatus<Buffer>, Error> {
        Ok(AwaitableStatus::new(
            self.send_request(id, RequestInner::Rmdir(path), None)
                .await?,
        ))
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_opendir_request(
        &mut self,
        id: Id<Buffer>,
        path: Cow<'_, Path>,
    ) -> Result<AwaitableHandle<Buffer>, Error> {
        Ok(AwaitableHandle::new(
            self.send_request(id, RequestInner::Opendir(path), None)
                .await?,
        ))
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_readdir_request(
        &mut self,
        id: Id<Buffer>,
        handle: Cow<'_, Handle>,
    ) -> Result<AwaitableNameEntries<Buffer>, Error> {
        Ok(AwaitableNameEntries::new(
            self.send_request(id, RequestInner::Readdir(handle), None)
                .await?,
        ))
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_stat_request(
        &mut self,
        id: Id<Buffer>,
        path: Cow<'_, Path>,
    ) -> Result<AwaitableAttrs<Buffer>, Error> {
        Ok(AwaitableAttrs::new(
            self.send_request(id, RequestInner::Stat(path), None)
                .await?,
        ))
    }

    /// Does not follow symlink
    ///
    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_lstat_request(
        &mut self,
        id: Id<Buffer>,
        path: Cow<'_, Path>,
    ) -> Result<AwaitableAttrs<Buffer>, Error> {
        Ok(AwaitableAttrs::new(
            self.send_request(id, RequestInner::Lstat(path), None)
                .await?,
        ))
    }

    /// * `handle` - Must be opened with `FileMode::READ`.
    ///
    /// Does not follow symlink
    ///
    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_fstat_request(
        &mut self,
        id: Id<Buffer>,
        handle: Cow<'_, Handle>,
    ) -> Result<AwaitableAttrs<Buffer>, Error> {
        Ok(AwaitableAttrs::new(
            self.send_request(id, RequestInner::Fstat(handle), None)
                .await?,
        ))
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_setstat_request(
        &mut self,
        id: Id<Buffer>,
        path: Cow<'_, Path>,
        attrs: FileAttrs,
    ) -> Result<AwaitableStatus<Buffer>, Error> {
        Ok(AwaitableStatus::new(
            self.send_request(id, RequestInner::Setstat { path, attrs }, None)
                .await?,
        ))
    }

    /// * `handle` - Must be opened with `FileMode::WRITE`.
    ///
    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_fsetstat_request(
        &mut self,
        id: Id<Buffer>,
        handle: Cow<'_, Handle>,
        attrs: FileAttrs,
    ) -> Result<AwaitableStatus<Buffer>, Error> {
        Ok(AwaitableStatus::new(
            self.send_request(id, RequestInner::Fsetstat { handle, attrs }, None)
                .await?,
        ))
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_readlink_request(
        &mut self,
        id: Id<Buffer>,
        path: Cow<'_, Path>,
    ) -> Result<AwaitableName<Buffer>, Error> {
        Ok(AwaitableName::new(
            self.send_request(id, RequestInner::Readlink(path), None)
                .await?,
        ))
    }

    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_realpath_request(
        &mut self,
        id: Id<Buffer>,
        path: Cow<'_, Path>,
    ) -> Result<AwaitableName<Buffer>, Error> {
        Ok(AwaitableName::new(
            self.send_request(id, RequestInner::Realpath(path), None)
                .await?,
        ))
    }

    /// Create symlink
    ///
    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_symlink_request(
        &mut self,
        id: Id<Buffer>,
        targetpath: Cow<'_, Path>,
        linkpath: Cow<'_, Path>,
    ) -> Result<AwaitableStatus<Buffer>, Error> {
        Ok(AwaitableStatus::new(
            self.send_request(
                id,
                RequestInner::Symlink {
                    linkpath,
                    targetpath,
                },
                None,
            )
            .await?,
        ))
    }

    /// Send write requests
    ///
    /// # Cancel Safety
    ///
    /// This function is not cancel safe
    pub async fn send_write_request(
        &mut self,
        id: Id<Buffer>,
        handle: &[u8],
        offset: u64,
        data: &[u8],
    ) -> Result<AwaitableStatus<Buffer>, Error> {
        // Call id.into_inner to prevent id from being removed
        // if the future is cancelled.
        let arc = id.into_inner();

        let header = Request::serialize_write_request(
            &mut self.serializer,
            ArenaArc::slot(&arc),
            handle,
            offset,
            data.len().try_into()?,
        )?;

        arc.reset(None);
        self.shared_data
            .writer
            .write_vectored_all(&mut [IoSlice::new(header), IoSlice::new(data)])
            .await?;

        self.shared_data.notify_new_packet_event();

        Ok(AwaitableStatus::new(arc))
    }
}