1 // SPDX-License-Identifier: GPL-2.0
3 * linux/fs/nfs/unlink.c
5 * nfs sillydelete handling
9 #include <linux/slab.h>
10 #include <linux/string.h>
11 #include <linux/dcache.h>
12 #include <linux/sunrpc/sched.h>
13 #include <linux/sunrpc/clnt.h>
14 #include <linux/nfs_fs.h>
15 #include <linux/sched.h>
16 #include <linux/wait.h>
17 #include <linux/namei.h>
18 #include <linux/fsnotify.h>
23 #include "delegation.h"
28 * nfs_free_unlinkdata - release data from a sillydelete operation.
29 * @data: pointer to unlink structure.
32 nfs_free_unlinkdata(struct nfs_unlinkdata
*data
)
34 put_rpccred(data
->cred
);
35 kfree(data
->args
.name
.name
);
40 * nfs_async_unlink_done - Sillydelete post-processing
41 * @task: rpc_task of the sillydelete
43 * Do the directory attribute update.
45 static void nfs_async_unlink_done(struct rpc_task
*task
, void *calldata
)
47 struct nfs_unlinkdata
*data
= calldata
;
48 struct inode
*dir
= d_inode(data
->dentry
->d_parent
);
50 trace_nfs_sillyrename_unlink(data
, task
->tk_status
);
51 if (!NFS_PROTO(dir
)->unlink_done(task
, dir
))
52 rpc_restart_call_prepare(task
);
56 * nfs_async_unlink_release - Release the sillydelete data.
57 * @task: rpc_task of the sillydelete
59 * We need to call nfs_put_unlinkdata as a 'tk_release' task since the
60 * rpc_task would be freed too.
62 static void nfs_async_unlink_release(void *calldata
)
64 struct nfs_unlinkdata
*data
= calldata
;
65 struct dentry
*dentry
= data
->dentry
;
66 struct super_block
*sb
= dentry
->d_sb
;
68 up_read_non_owner(&NFS_I(d_inode(dentry
->d_parent
))->rmdir_sem
);
69 d_lookup_done(dentry
);
70 nfs_free_unlinkdata(data
);
75 static void nfs_unlink_prepare(struct rpc_task
*task
, void *calldata
)
77 struct nfs_unlinkdata
*data
= calldata
;
78 struct inode
*dir
= d_inode(data
->dentry
->d_parent
);
79 NFS_PROTO(dir
)->unlink_rpc_prepare(task
, data
);
82 static const struct rpc_call_ops nfs_unlink_ops
= {
83 .rpc_call_done
= nfs_async_unlink_done
,
84 .rpc_release
= nfs_async_unlink_release
,
85 .rpc_call_prepare
= nfs_unlink_prepare
,
88 static void nfs_do_call_unlink(struct nfs_unlinkdata
*data
)
90 struct rpc_message msg
= {
91 .rpc_argp
= &data
->args
,
92 .rpc_resp
= &data
->res
,
93 .rpc_cred
= data
->cred
,
95 struct rpc_task_setup task_setup_data
= {
97 .callback_ops
= &nfs_unlink_ops
,
98 .callback_data
= data
,
99 .workqueue
= nfsiod_workqueue
,
100 .flags
= RPC_TASK_ASYNC
,
102 struct rpc_task
*task
;
103 struct inode
*dir
= d_inode(data
->dentry
->d_parent
);
104 nfs_sb_active(dir
->i_sb
);
105 data
->args
.fh
= NFS_FH(dir
);
106 nfs_fattr_init(data
->res
.dir_attr
);
108 NFS_PROTO(dir
)->unlink_setup(&msg
, dir
);
110 task_setup_data
.rpc_client
= NFS_CLIENT(dir
);
111 task
= rpc_run_task(&task_setup_data
);
113 rpc_put_task_async(task
);
116 static int nfs_call_unlink(struct dentry
*dentry
, struct nfs_unlinkdata
*data
)
118 struct inode
*dir
= d_inode(dentry
->d_parent
);
119 struct dentry
*alias
;
121 down_read_non_owner(&NFS_I(dir
)->rmdir_sem
);
122 alias
= d_alloc_parallel(dentry
->d_parent
, &data
->args
.name
, &data
->wq
);
124 up_read_non_owner(&NFS_I(dir
)->rmdir_sem
);
127 if (!d_in_lookup(alias
)) {
129 void *devname_garbage
= NULL
;
132 * Hey, we raced with lookup... See if we need to transfer
133 * the sillyrename information to the aliased dentry.
135 spin_lock(&alias
->d_lock
);
136 if (d_really_is_positive(alias
) &&
137 !(alias
->d_flags
& DCACHE_NFSFS_RENAMED
)) {
138 devname_garbage
= alias
->d_fsdata
;
139 alias
->d_fsdata
= data
;
140 alias
->d_flags
|= DCACHE_NFSFS_RENAMED
;
144 spin_unlock(&alias
->d_lock
);
146 up_read_non_owner(&NFS_I(dir
)->rmdir_sem
);
148 * If we'd displaced old cached devname, free it. At that
149 * point dentry is definitely not a root, so we won't need
152 kfree(devname_garbage
);
155 data
->dentry
= alias
;
156 nfs_do_call_unlink(data
);
161 * nfs_async_unlink - asynchronous unlinking of a file
162 * @dir: parent directory of dentry
163 * @dentry: dentry to unlink
166 nfs_async_unlink(struct dentry
*dentry
, const struct qstr
*name
)
168 struct nfs_unlinkdata
*data
;
169 int status
= -ENOMEM
;
170 void *devname_garbage
= NULL
;
172 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
175 data
->args
.name
.name
= kstrdup(name
->name
, GFP_KERNEL
);
176 if (!data
->args
.name
.name
)
178 data
->args
.name
.len
= name
->len
;
180 data
->cred
= rpc_lookup_cred();
181 if (IS_ERR(data
->cred
)) {
182 status
= PTR_ERR(data
->cred
);
185 data
->res
.dir_attr
= &data
->dir_attr
;
186 init_waitqueue_head(&data
->wq
);
189 spin_lock(&dentry
->d_lock
);
190 if (dentry
->d_flags
& DCACHE_NFSFS_RENAMED
)
192 dentry
->d_flags
|= DCACHE_NFSFS_RENAMED
;
193 devname_garbage
= dentry
->d_fsdata
;
194 dentry
->d_fsdata
= data
;
195 spin_unlock(&dentry
->d_lock
);
197 * If we'd displaced old cached devname, free it. At that
198 * point dentry is definitely not a root, so we won't need
201 kfree(devname_garbage
);
204 spin_unlock(&dentry
->d_lock
);
205 put_rpccred(data
->cred
);
207 kfree(data
->args
.name
.name
);
215 * nfs_complete_unlink - Initialize completion of the sillydelete
216 * @dentry: dentry to delete
219 * Since we're most likely to be called by dentry_iput(), we
220 * only use the dentry to find the sillydelete. We then copy the name
224 nfs_complete_unlink(struct dentry
*dentry
, struct inode
*inode
)
226 struct nfs_unlinkdata
*data
;
228 spin_lock(&dentry
->d_lock
);
229 dentry
->d_flags
&= ~DCACHE_NFSFS_RENAMED
;
230 data
= dentry
->d_fsdata
;
231 dentry
->d_fsdata
= NULL
;
232 spin_unlock(&dentry
->d_lock
);
234 if (NFS_STALE(inode
) || !nfs_call_unlink(dentry
, data
))
235 nfs_free_unlinkdata(data
);
238 /* Cancel a queued async unlink. Called when a sillyrename run fails. */
240 nfs_cancel_async_unlink(struct dentry
*dentry
)
242 spin_lock(&dentry
->d_lock
);
243 if (dentry
->d_flags
& DCACHE_NFSFS_RENAMED
) {
244 struct nfs_unlinkdata
*data
= dentry
->d_fsdata
;
246 dentry
->d_flags
&= ~DCACHE_NFSFS_RENAMED
;
247 dentry
->d_fsdata
= NULL
;
248 spin_unlock(&dentry
->d_lock
);
249 nfs_free_unlinkdata(data
);
252 spin_unlock(&dentry
->d_lock
);
256 * nfs_async_rename_done - Sillyrename post-processing
257 * @task: rpc_task of the sillyrename
258 * @calldata: nfs_renamedata for the sillyrename
260 * Do the directory attribute updates and the d_move
262 static void nfs_async_rename_done(struct rpc_task
*task
, void *calldata
)
264 struct nfs_renamedata
*data
= calldata
;
265 struct inode
*old_dir
= data
->old_dir
;
266 struct inode
*new_dir
= data
->new_dir
;
267 struct dentry
*old_dentry
= data
->old_dentry
;
269 trace_nfs_sillyrename_rename(old_dir
, old_dentry
,
270 new_dir
, data
->new_dentry
, task
->tk_status
);
271 if (!NFS_PROTO(old_dir
)->rename_done(task
, old_dir
, new_dir
)) {
272 rpc_restart_call_prepare(task
);
277 data
->complete(task
, data
);
281 * nfs_async_rename_release - Release the sillyrename data.
282 * @calldata: the struct nfs_renamedata to be released
284 static void nfs_async_rename_release(void *calldata
)
286 struct nfs_renamedata
*data
= calldata
;
287 struct super_block
*sb
= data
->old_dir
->i_sb
;
289 if (d_really_is_positive(data
->old_dentry
))
290 nfs_mark_for_revalidate(d_inode(data
->old_dentry
));
292 /* The result of the rename is unknown. Play it safe by
293 * forcing a new lookup */
294 if (data
->cancelled
) {
295 spin_lock(&data
->old_dir
->i_lock
);
296 nfs_force_lookup_revalidate(data
->old_dir
);
297 spin_unlock(&data
->old_dir
->i_lock
);
298 if (data
->new_dir
!= data
->old_dir
) {
299 spin_lock(&data
->new_dir
->i_lock
);
300 nfs_force_lookup_revalidate(data
->new_dir
);
301 spin_unlock(&data
->new_dir
->i_lock
);
305 dput(data
->old_dentry
);
306 dput(data
->new_dentry
);
310 put_rpccred(data
->cred
);
314 static void nfs_rename_prepare(struct rpc_task
*task
, void *calldata
)
316 struct nfs_renamedata
*data
= calldata
;
317 NFS_PROTO(data
->old_dir
)->rename_rpc_prepare(task
, data
);
320 static const struct rpc_call_ops nfs_rename_ops
= {
321 .rpc_call_done
= nfs_async_rename_done
,
322 .rpc_release
= nfs_async_rename_release
,
323 .rpc_call_prepare
= nfs_rename_prepare
,
327 * nfs_async_rename - perform an asynchronous rename operation
328 * @old_dir: directory that currently holds the dentry to be renamed
329 * @new_dir: target directory for the rename
330 * @old_dentry: original dentry to be renamed
331 * @new_dentry: dentry to which the old_dentry should be renamed
333 * It's expected that valid references to the dentries and inodes are held
336 nfs_async_rename(struct inode
*old_dir
, struct inode
*new_dir
,
337 struct dentry
*old_dentry
, struct dentry
*new_dentry
,
338 void (*complete
)(struct rpc_task
*, struct nfs_renamedata
*))
340 struct nfs_renamedata
*data
;
341 struct rpc_message msg
= { };
342 struct rpc_task_setup task_setup_data
= {
344 .callback_ops
= &nfs_rename_ops
,
345 .workqueue
= nfsiod_workqueue
,
346 .rpc_client
= NFS_CLIENT(old_dir
),
347 .flags
= RPC_TASK_ASYNC
,
350 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
352 return ERR_PTR(-ENOMEM
);
353 task_setup_data
.callback_data
= data
;
355 data
->cred
= rpc_lookup_cred();
356 if (IS_ERR(data
->cred
)) {
357 struct rpc_task
*task
= ERR_CAST(data
->cred
);
362 msg
.rpc_argp
= &data
->args
;
363 msg
.rpc_resp
= &data
->res
;
364 msg
.rpc_cred
= data
->cred
;
366 /* set up nfs_renamedata */
367 data
->old_dir
= old_dir
;
369 data
->new_dir
= new_dir
;
371 data
->old_dentry
= dget(old_dentry
);
372 data
->new_dentry
= dget(new_dentry
);
373 nfs_fattr_init(&data
->old_fattr
);
374 nfs_fattr_init(&data
->new_fattr
);
375 data
->complete
= complete
;
377 /* set up nfs_renameargs */
378 data
->args
.old_dir
= NFS_FH(old_dir
);
379 data
->args
.old_name
= &old_dentry
->d_name
;
380 data
->args
.new_dir
= NFS_FH(new_dir
);
381 data
->args
.new_name
= &new_dentry
->d_name
;
383 /* set up nfs_renameres */
384 data
->res
.old_fattr
= &data
->old_fattr
;
385 data
->res
.new_fattr
= &data
->new_fattr
;
387 nfs_sb_active(old_dir
->i_sb
);
389 NFS_PROTO(data
->old_dir
)->rename_setup(&msg
, old_dir
);
391 return rpc_run_task(&task_setup_data
);
395 * Perform tasks needed when a sillyrename is done such as cancelling the
396 * queued async unlink if it failed.
399 nfs_complete_sillyrename(struct rpc_task
*task
, struct nfs_renamedata
*data
)
401 struct dentry
*dentry
= data
->old_dentry
;
403 if (task
->tk_status
!= 0) {
404 nfs_cancel_async_unlink(dentry
);
409 * vfs_unlink and the like do not issue this when a file is
410 * sillyrenamed, so do it here.
412 fsnotify_nameremove(dentry
, 0);
415 #define SILLYNAME_PREFIX ".nfs"
416 #define SILLYNAME_PREFIX_LEN ((unsigned)sizeof(SILLYNAME_PREFIX) - 1)
417 #define SILLYNAME_FILEID_LEN ((unsigned)sizeof(u64) << 1)
418 #define SILLYNAME_COUNTER_LEN ((unsigned)sizeof(unsigned int) << 1)
419 #define SILLYNAME_LEN (SILLYNAME_PREFIX_LEN + \
420 SILLYNAME_FILEID_LEN + \
421 SILLYNAME_COUNTER_LEN)
424 * nfs_sillyrename - Perform a silly-rename of a dentry
425 * @dir: inode of directory that contains dentry
426 * @dentry: dentry to be sillyrenamed
428 * NFSv2/3 is stateless and the server doesn't know when the client is
429 * holding a file open. To prevent application problems when a file is
430 * unlinked while it's still open, the client performs a "silly-rename".
431 * That is, it renames the file to a hidden file in the same directory,
432 * and only performs the unlink once the last reference to it is put.
434 * The final cleanup is done during dentry_iput.
436 * (Note: NFSv4 is stateful, and has opens, so in theory an NFSv4 server
437 * could take responsibility for keeping open files referenced. The server
438 * would also need to ensure that opened-but-deleted files were kept over
439 * reboots. However, we may not assume a server does so. (RFC 5661
440 * does provide an OPEN4_RESULT_PRESERVE_UNLINKED flag that a server can
441 * use to advertise that it does this; some day we may take advantage of
445 nfs_sillyrename(struct inode
*dir
, struct dentry
*dentry
)
447 static unsigned int sillycounter
;
448 unsigned char silly
[SILLYNAME_LEN
+ 1];
449 unsigned long long fileid
;
450 struct dentry
*sdentry
;
451 struct rpc_task
*task
;
454 dfprintk(VFS
, "NFS: silly-rename(%pd2, ct=%d)\n",
455 dentry
, d_count(dentry
));
456 nfs_inc_stats(dir
, NFSIOS_SILLYRENAME
);
459 * We don't allow a dentry to be silly-renamed twice.
461 if (dentry
->d_flags
& DCACHE_NFSFS_RENAMED
)
464 fileid
= NFS_FILEID(d_inode(dentry
));
466 /* Return delegation in anticipation of the rename */
467 NFS_PROTO(d_inode(dentry
))->return_delegation(d_inode(dentry
));
474 slen
= scnprintf(silly
, sizeof(silly
),
475 SILLYNAME_PREFIX
"%0*llx%0*x",
476 SILLYNAME_FILEID_LEN
, fileid
,
477 SILLYNAME_COUNTER_LEN
, sillycounter
);
479 dfprintk(VFS
, "NFS: trying to rename %pd to %s\n",
482 sdentry
= lookup_one_len(silly
, dentry
->d_parent
, slen
);
484 * N.B. Better to return EBUSY here ... it could be
485 * dangerous to delete the file while it's in use.
489 } while (d_inode(sdentry
) != NULL
); /* need negative lookup */
491 /* queue unlink first. Can't do this from rpc_release as it
492 * has to allocate memory
494 error
= nfs_async_unlink(dentry
, &sdentry
->d_name
);
498 /* run the rename task, undo unlink if it fails */
499 task
= nfs_async_rename(dir
, dir
, dentry
, sdentry
,
500 nfs_complete_sillyrename
);
503 nfs_cancel_async_unlink(dentry
);
507 /* wait for the RPC task to complete, unless a SIGKILL intervenes */
508 error
= rpc_wait_for_completion_task(task
);
510 error
= task
->tk_status
;
513 /* The rename succeeded */
514 nfs_set_verifier(dentry
, nfs_save_change_attribute(dir
));
515 d_move(dentry
, sdentry
);
518 /* The result of the rename is unknown. Play it safe by
519 * forcing a new lookup */