nfs-rs 0.7.1

An asynchronous pure Rust client library for NFSv3, experimental NFSv4.0, and NFSv4.1
Documentation 
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

use bytes::{Buf, Bytes};
use tracing::{debug, warn};

use super::compound::OpResponse;
use super::mount::{Mount41, decode_fh};
use crate::error::Result;
use crate::mount;
use crate::nfs4::attrs::{decode_getattr_response, encode_setattr, standard_getattr_bitmap};

/// Parse change_info4 from an operation result.
/// Returns (atomic, before_changeid, after_changeid).
fn parse_change_info(op: &OpResponse) -> Option<(bool, u64, u64)> {
    let mut data = op.data.clone();
    if data.remaining() < 20 {
        return None;
    }
    let atomic = data.get_u32() != 0;
    let before = data.get_u64();
    let after = data.get_u64();
    Some((atomic, before, after))
}

impl Mount41 {
    pub(crate) async fn remove(&self, dir_fh: Bytes, filename: &str) -> Result<()> {
        let resp = self
            .compound("remove", |b| b.putfh(&dir_fh).remove(filename))
            .await?;
        resp.op_ok(1)?; // PUTFH
        resp.op_ok(2)?; // REMOVE
        if let Some(remove_op) = resp.results.get(2)
            && let Some((atomic, before, after)) = parse_change_info(remove_op)
        {
            debug!(atomic, before, after, name = filename, "REMOVE change_info");
        }
        Ok(())
    }

    pub(crate) async fn remove_path(&self, path: &str) -> Result<()> {
        let (dir, name) = crate::split_path(path)?;
        let dir_obj = self.lookup_path(&dir).await?;
        self.remove(dir_obj.fh, &name).await
    }

    pub(crate) async fn rmdir(&self, dir_fh: Bytes, dirname: &str) -> Result<()> {
        // NFSv4 REMOVE works for both files and directories
        self.remove(dir_fh, dirname).await
    }

    pub(crate) async fn rmdir_path(&self, path: &str) -> Result<()> {
        self.remove_path(path).await
    }

    pub(crate) async fn rename(
        &self,
        from_dir_fh: Bytes,
        from_filename: &str,
        to_dir_fh: Bytes,
        to_filename: &str,
    ) -> Result<()> {
        // NFSv4 RENAME: PUTFH(src_dir) + SAVEFH + PUTFH(dst_dir) + RENAME(old, new)
        let resp = self
            .compound("rename", |b| {
                b.putfh(&from_dir_fh)
                    .savefh()
                    .putfh(&to_dir_fh)
                    .rename(from_filename, to_filename)
            })
            .await?;
        resp.op_ok(1)?; // PUTFH
        resp.op_ok(2)?; // SAVEFH
        resp.op_ok(3)?; // PUTFH
        resp.op_ok(4)?; // RENAME
        if let Some(rename_op) = resp.results.get(4) {
            let mut data = rename_op.data.clone();
            if data.remaining() >= 40 {
                let src_atomic = data.get_u32() != 0;
                let src_before = data.get_u64();
                let src_after = data.get_u64();
                let dst_atomic = data.get_u32() != 0;
                let dst_before = data.get_u64();
                let dst_after = data.get_u64();
                debug!(
                    src_atomic,
                    src_before,
                    src_after,
                    dst_atomic,
                    dst_before,
                    dst_after,
                    from = from_filename,
                    to = to_filename,
                    "RENAME change_info"
                );
            }
        }
        Ok(())
    }

    pub(crate) async fn rename_path(&self, from_path: &str, to_path: &str) -> Result<()> {
        let (from_dir, from_name) = crate::split_path(from_path)?;
        let (to_dir, to_name) = crate::split_path(to_path)?;
        let from_obj = self.lookup_path(&from_dir).await?;
        let to_obj = self.lookup_path(&to_dir).await?;
        self.rename(from_obj.fh, &from_name, to_obj.fh, &to_name)
            .await
    }

    pub(crate) async fn link(
        &self,
        src_fh: Bytes,
        dst_dir_fh: Bytes,
        dst_filename: &str,
    ) -> Result<mount::Attr> {
        // NFSv4 LINK: PUTFH(src) + SAVEFH + PUTFH(dst_dir) + LINK(newname)
        let bitmap = standard_getattr_bitmap();
        let resp = self
            .compound("link", |b| {
                b.putfh(&src_fh)
                    .savefh()
                    .putfh(&dst_dir_fh)
                    .link(dst_filename)
                    .putfh(&src_fh)
                    .getattr(&bitmap)
            })
            .await?;
        resp.op_ok(1)?; // PUTFH(src)
        resp.op_ok(2)?; // SAVEFH
        resp.op_ok(3)?; // PUTFH(dst_dir)
        resp.op_ok(4)?; // LINK
        if let Some(link_op) = resp.results.get(4)
            && let Some((atomic, before, after)) = parse_change_info(link_op)
        {
            debug!(
                atomic,
                before,
                after,
                name = dst_filename,
                "LINK change_info"
            );
        }
        resp.op_ok(5)?; // PUTFH(src) again for getattr
        let getattr = resp.op_ok(6)?;
        let mut data = getattr.data.clone();
        decode_getattr_response(&mut data)
    }

    pub(crate) async fn link_path(&self, src_path: &str, dst_path: &str) -> Result<mount::Attr> {
        let src_obj = self.lookup_path(src_path).await?;
        let (dst_dir, dst_name) = crate::split_path(dst_path)?;
        let dst_dir_obj = self.lookup_path(&dst_dir).await?;
        self.link(src_obj.fh, dst_dir_obj.fh, &dst_name).await
    }

    pub(crate) async fn symlink(
        &self,
        target: &str,
        dst_dir_fh: Bytes,
        dst_filename: &str,
    ) -> Result<mount::ObjRes> {
        // NFSv4 symlink: CREATE with NF4LNK type
        let bitmap = standard_getattr_bitmap();
        let resp = self
            .compound("symlink", |b| {
                b.putfh(&dst_dir_fh)
                    .create_symlink(dst_filename, target, &[], &[])
                    .getfh()
                    .getattr(&bitmap)
            })
            .await?;
        resp.op_ok(1)?; // PUTFH
        resp.op_ok(2)?; // CREATE(NF4LNK)
        let getfh = resp.op_ok(3)?;
        let mut fh_data = getfh.data.clone();
        let fh = decode_fh(&mut fh_data)?;
        let getattr = resp.op_ok(4)?;
        let mut attr_data = getattr.data.clone();
        let attr = decode_getattr_response(&mut attr_data)?;
        Ok(mount::ObjRes {
            fh,
            attr: Some(attr),
        })
    }

    pub(crate) async fn symlink_path(&self, target: &str, dst_path: &str) -> Result<mount::ObjRes> {
        let (dst_dir, dst_name) = crate::split_path(dst_path)?;
        let dst_dir_obj = self.lookup_path(&dst_dir).await?;
        self.symlink(target, dst_dir_obj.fh, &dst_name).await
    }

    /// CREATE(NF4LNK) 与 SETATTR 合并到单个 COMPOUND 的实现。
    ///
    /// 当 uid/gid/atime/mtime 至少一个 `Some` 时，向 COMPOUND 追加 SETATTR
    /// 与第二个 GETATTR，省一次 RPC 往返；全部为 `None` 时等价于 `symlink()`。
    /// SETATTR 走 anonymous stateid（all-zero），适用于非 file 对象（RFC 5661 §8.2.3）。
    /// 注意：mode 不参与 — symlink 的 POSIX mode 没有可移植语义，data-mover 调用方也不传。
    /// SETATTR 写入 createattrs 会触发部分服务端的 NFS4ERR_ATTRNOTSUPP，
    /// 因此沿用 mkdir/file create 的保守模式：CREATE 用空 attrs，SETATTR 紧随其后。
    /// 若服务端连 in-compound 的 SETATTR 都拒绝，内部用独立 SETATTR + GETATTR 兜底。
    #[allow(clippy::too_many_arguments)]
    pub(crate) async fn symlink_with_attrs(
        &self,
        target: &str,
        dst_dir_fh: Bytes,
        dst_filename: &str,
        uid: Option<u32>,
        gid: Option<u32>,
        atime: Option<crate::Time>,
        mtime: Option<crate::Time>,
    ) -> Result<mount::ObjRes> {
        let (setattr_mask, setattr_vals) = encode_setattr(None, uid, gid, None, atime, mtime);
        if setattr_mask.is_empty() {
            // 无属性要写：等价于旧 symlink，省去 SETATTR 这一 op
            return self.symlink(target, dst_dir_fh, dst_filename).await;
        }

        let bitmap = standard_getattr_bitmap();
        let stateid = [0u8; 16]; // anonymous stateid（RFC 5661 §8.2.3）
        let resp = self
            .compound("symlink_with_attrs", |b| {
                b.putfh(&dst_dir_fh)
                    .create_symlink(dst_filename, target, &[], &[])
                    .getfh()
                    .setattr(&stateid, &setattr_mask, &setattr_vals)
                    .getattr(&bitmap)
            })
            .await?;

        resp.op_ok(1)?; // PUTFH
        resp.op_ok(2)?; // CREATE(NF4LNK) — 此点之后 symlink 已落地
        let getfh = resp.op_ok(3)?;
        let mut fh_data = getfh.data.clone();
        let fh = decode_fh(&mut fh_data)?;

        // SETATTR 失败时 GETATTR 不会执行；symlink 已存在但属性是默认值。
        // 内部用独立 SETATTR + GETATTR 兜底，让上层看到的语义保持不变。
        if let Err(e) = resp.op_ok(4) {
            warn!(
                error = ?e,
                "symlink_with_attrs: in-compound SETATTR failed, falling back to separate SETATTR"
            );
            self.setattr(fh.clone(), None, None, uid, gid, None, atime, mtime)
                .await?;
            let attr = self.getattr(fh.clone()).await?;
            return Ok(mount::ObjRes {
                fh,
                attr: Some(attr),
            });
        }

        let getattr = resp.op_ok(5)?;
        let mut attr_data = getattr.data.clone();
        let attr = decode_getattr_response(&mut attr_data)?;
        Ok(mount::ObjRes {
            fh,
            attr: Some(attr),
        })
    }
}