]> git.ipfire.org Git - thirdparty/kernel/stable.git/blob - fs/smb/client/cached_dir.c
Merge tag 'loongarch-kvm-6.8' of git://git.kernel.org/pub/scm/linux/kernel/git/chenhu...
[thirdparty/kernel/stable.git] / fs / smb / client / cached_dir.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * Functions to handle the cached directory entries
4 *
5 * Copyright (c) 2022, Ronnie Sahlberg <lsahlber@redhat.com>
6 */
7
8 #include <linux/namei.h>
9 #include "cifsglob.h"
10 #include "cifsproto.h"
11 #include "cifs_debug.h"
12 #include "smb2proto.h"
13 #include "cached_dir.h"
14
15 static struct cached_fid *init_cached_dir(const char *path);
16 static void free_cached_dir(struct cached_fid *cfid);
17 static void smb2_close_cached_fid(struct kref *ref);
18 static void cfids_laundromat_worker(struct work_struct *work);
19
20 static struct cached_fid *find_or_create_cached_dir(struct cached_fids *cfids,
21 const char *path,
22 bool lookup_only,
23 __u32 max_cached_dirs)
24 {
25 struct cached_fid *cfid;
26
27 spin_lock(&cfids->cfid_list_lock);
28 list_for_each_entry(cfid, &cfids->entries, entry) {
29 if (!strcmp(cfid->path, path)) {
30 /*
31 * If it doesn't have a lease it is either not yet
32 * fully cached or it may be in the process of
33 * being deleted due to a lease break.
34 */
35 if (!cfid->time || !cfid->has_lease) {
36 spin_unlock(&cfids->cfid_list_lock);
37 return NULL;
38 }
39 kref_get(&cfid->refcount);
40 spin_unlock(&cfids->cfid_list_lock);
41 return cfid;
42 }
43 }
44 if (lookup_only) {
45 spin_unlock(&cfids->cfid_list_lock);
46 return NULL;
47 }
48 if (cfids->num_entries >= max_cached_dirs) {
49 spin_unlock(&cfids->cfid_list_lock);
50 return NULL;
51 }
52 cfid = init_cached_dir(path);
53 if (cfid == NULL) {
54 spin_unlock(&cfids->cfid_list_lock);
55 return NULL;
56 }
57 cfid->cfids = cfids;
58 cfids->num_entries++;
59 list_add(&cfid->entry, &cfids->entries);
60 cfid->on_list = true;
61 kref_get(&cfid->refcount);
62 spin_unlock(&cfids->cfid_list_lock);
63 return cfid;
64 }
65
66 static struct dentry *
67 path_to_dentry(struct cifs_sb_info *cifs_sb, const char *path)
68 {
69 struct dentry *dentry;
70 const char *s, *p;
71 char sep;
72
73 sep = CIFS_DIR_SEP(cifs_sb);
74 dentry = dget(cifs_sb->root);
75 s = path;
76
77 do {
78 struct inode *dir = d_inode(dentry);
79 struct dentry *child;
80
81 if (!S_ISDIR(dir->i_mode)) {
82 dput(dentry);
83 dentry = ERR_PTR(-ENOTDIR);
84 break;
85 }
86
87 /* skip separators */
88 while (*s == sep)
89 s++;
90 if (!*s)
91 break;
92 p = s++;
93 /* next separator */
94 while (*s && *s != sep)
95 s++;
96
97 child = lookup_positive_unlocked(p, dentry, s - p);
98 dput(dentry);
99 dentry = child;
100 } while (!IS_ERR(dentry));
101 return dentry;
102 }
103
104 static const char *path_no_prefix(struct cifs_sb_info *cifs_sb,
105 const char *path)
106 {
107 size_t len = 0;
108
109 if (!*path)
110 return path;
111
112 if ((cifs_sb->mnt_cifs_flags & CIFS_MOUNT_USE_PREFIX_PATH) &&
113 cifs_sb->prepath) {
114 len = strlen(cifs_sb->prepath) + 1;
115 if (unlikely(len > strlen(path)))
116 return ERR_PTR(-EINVAL);
117 }
118 return path + len;
119 }
120
121 /*
122 * Open the and cache a directory handle.
123 * If error then *cfid is not initialized.
124 */
125 int open_cached_dir(unsigned int xid, struct cifs_tcon *tcon,
126 const char *path,
127 struct cifs_sb_info *cifs_sb,
128 bool lookup_only, struct cached_fid **ret_cfid)
129 {
130 struct cifs_ses *ses;
131 struct TCP_Server_Info *server;
132 struct cifs_open_parms oparms;
133 struct smb2_create_rsp *o_rsp = NULL;
134 struct smb2_query_info_rsp *qi_rsp = NULL;
135 int resp_buftype[2];
136 struct smb_rqst rqst[2];
137 struct kvec rsp_iov[2];
138 struct kvec open_iov[SMB2_CREATE_IOV_SIZE];
139 struct kvec qi_iov[1];
140 int rc, flags = 0;
141 __le16 *utf16_path = NULL;
142 u8 oplock = SMB2_OPLOCK_LEVEL_II;
143 struct cifs_fid *pfid;
144 struct dentry *dentry = NULL;
145 struct cached_fid *cfid;
146 struct cached_fids *cfids;
147 const char *npath;
148
149 if (tcon == NULL || tcon->cfids == NULL || tcon->nohandlecache ||
150 is_smb1_server(tcon->ses->server) || (dir_cache_timeout == 0))
151 return -EOPNOTSUPP;
152
153 ses = tcon->ses;
154 server = ses->server;
155 cfids = tcon->cfids;
156
157 if (!server->ops->new_lease_key)
158 return -EIO;
159
160 if (cifs_sb->root == NULL)
161 return -ENOENT;
162
163 utf16_path = cifs_convert_path_to_utf16(path, cifs_sb);
164 if (!utf16_path)
165 return -ENOMEM;
166
167 cfid = find_or_create_cached_dir(cfids, path, lookup_only, tcon->max_cached_dirs);
168 if (cfid == NULL) {
169 kfree(utf16_path);
170 return -ENOENT;
171 }
172 /*
173 * Return cached fid if it has a lease. Otherwise, it is either a new
174 * entry or laundromat worker removed it from @cfids->entries. Caller
175 * will put last reference if the latter.
176 */
177 spin_lock(&cfids->cfid_list_lock);
178 if (cfid->has_lease) {
179 spin_unlock(&cfids->cfid_list_lock);
180 *ret_cfid = cfid;
181 kfree(utf16_path);
182 return 0;
183 }
184 spin_unlock(&cfids->cfid_list_lock);
185
186 /*
187 * Skip any prefix paths in @path as lookup_positive_unlocked() ends up
188 * calling ->lookup() which already adds those through
189 * build_path_from_dentry(). Also, do it earlier as we might reconnect
190 * below when trying to send compounded request and then potentially
191 * having a different prefix path (e.g. after DFS failover).
192 */
193 npath = path_no_prefix(cifs_sb, path);
194 if (IS_ERR(npath)) {
195 rc = PTR_ERR(npath);
196 goto out;
197 }
198
199 if (!npath[0]) {
200 dentry = dget(cifs_sb->root);
201 } else {
202 dentry = path_to_dentry(cifs_sb, npath);
203 if (IS_ERR(dentry)) {
204 rc = -ENOENT;
205 goto out;
206 }
207 }
208 cfid->dentry = dentry;
209
210 /*
211 * We do not hold the lock for the open because in case
212 * SMB2_open needs to reconnect.
213 * This is safe because no other thread will be able to get a ref
214 * to the cfid until we have finished opening the file and (possibly)
215 * acquired a lease.
216 */
217 if (smb3_encryption_required(tcon))
218 flags |= CIFS_TRANSFORM_REQ;
219
220 pfid = &cfid->fid;
221 server->ops->new_lease_key(pfid);
222
223 memset(rqst, 0, sizeof(rqst));
224 resp_buftype[0] = resp_buftype[1] = CIFS_NO_BUFFER;
225 memset(rsp_iov, 0, sizeof(rsp_iov));
226
227 /* Open */
228 memset(&open_iov, 0, sizeof(open_iov));
229 rqst[0].rq_iov = open_iov;
230 rqst[0].rq_nvec = SMB2_CREATE_IOV_SIZE;
231
232 oparms = (struct cifs_open_parms) {
233 .tcon = tcon,
234 .path = path,
235 .create_options = cifs_create_options(cifs_sb, CREATE_NOT_FILE),
236 .desired_access = FILE_READ_DATA | FILE_READ_ATTRIBUTES,
237 .disposition = FILE_OPEN,
238 .fid = pfid,
239 };
240
241 rc = SMB2_open_init(tcon, server,
242 &rqst[0], &oplock, &oparms, utf16_path);
243 if (rc)
244 goto oshr_free;
245 smb2_set_next_command(tcon, &rqst[0]);
246
247 memset(&qi_iov, 0, sizeof(qi_iov));
248 rqst[1].rq_iov = qi_iov;
249 rqst[1].rq_nvec = 1;
250
251 rc = SMB2_query_info_init(tcon, server,
252 &rqst[1], COMPOUND_FID,
253 COMPOUND_FID, FILE_ALL_INFORMATION,
254 SMB2_O_INFO_FILE, 0,
255 sizeof(struct smb2_file_all_info) +
256 PATH_MAX * 2, 0, NULL);
257 if (rc)
258 goto oshr_free;
259
260 smb2_set_related(&rqst[1]);
261
262 /*
263 * Set @cfid->has_lease to true before sending out compounded request so
264 * its lease reference can be put in cached_dir_lease_break() due to a
265 * potential lease break right after the request is sent or while @cfid
266 * is still being cached. Concurrent processes won't be to use it yet
267 * due to @cfid->time being zero.
268 */
269 cfid->has_lease = true;
270
271 rc = compound_send_recv(xid, ses, server,
272 flags, 2, rqst,
273 resp_buftype, rsp_iov);
274 if (rc) {
275 if (rc == -EREMCHG) {
276 tcon->need_reconnect = true;
277 pr_warn_once("server share %s deleted\n",
278 tcon->tree_name);
279 }
280 goto oshr_free;
281 }
282 cfid->tcon = tcon;
283 cfid->is_open = true;
284
285 spin_lock(&cfids->cfid_list_lock);
286
287 o_rsp = (struct smb2_create_rsp *)rsp_iov[0].iov_base;
288 oparms.fid->persistent_fid = o_rsp->PersistentFileId;
289 oparms.fid->volatile_fid = o_rsp->VolatileFileId;
290 #ifdef CONFIG_CIFS_DEBUG2
291 oparms.fid->mid = le64_to_cpu(o_rsp->hdr.MessageId);
292 #endif /* CIFS_DEBUG2 */
293
294
295 if (o_rsp->OplockLevel != SMB2_OPLOCK_LEVEL_LEASE) {
296 spin_unlock(&cfids->cfid_list_lock);
297 rc = -EINVAL;
298 goto oshr_free;
299 }
300
301 rc = smb2_parse_contexts(server, rsp_iov,
302 &oparms.fid->epoch,
303 oparms.fid->lease_key,
304 &oplock, NULL, NULL);
305 if (rc) {
306 spin_unlock(&cfids->cfid_list_lock);
307 goto oshr_free;
308 }
309
310 rc = -EINVAL;
311 if (!(oplock & SMB2_LEASE_READ_CACHING_HE)) {
312 spin_unlock(&cfids->cfid_list_lock);
313 goto oshr_free;
314 }
315 qi_rsp = (struct smb2_query_info_rsp *)rsp_iov[1].iov_base;
316 if (le32_to_cpu(qi_rsp->OutputBufferLength) < sizeof(struct smb2_file_all_info)) {
317 spin_unlock(&cfids->cfid_list_lock);
318 goto oshr_free;
319 }
320 if (!smb2_validate_and_copy_iov(
321 le16_to_cpu(qi_rsp->OutputBufferOffset),
322 sizeof(struct smb2_file_all_info),
323 &rsp_iov[1], sizeof(struct smb2_file_all_info),
324 (char *)&cfid->file_all_info))
325 cfid->file_all_info_is_valid = true;
326
327 cfid->time = jiffies;
328 spin_unlock(&cfids->cfid_list_lock);
329 /* At this point the directory handle is fully cached */
330 rc = 0;
331
332 oshr_free:
333 SMB2_open_free(&rqst[0]);
334 SMB2_query_info_free(&rqst[1]);
335 free_rsp_buf(resp_buftype[0], rsp_iov[0].iov_base);
336 free_rsp_buf(resp_buftype[1], rsp_iov[1].iov_base);
337 if (rc) {
338 spin_lock(&cfids->cfid_list_lock);
339 if (cfid->on_list) {
340 list_del(&cfid->entry);
341 cfid->on_list = false;
342 cfids->num_entries--;
343 }
344 if (cfid->has_lease) {
345 /*
346 * We are guaranteed to have two references at this
347 * point. One for the caller and one for a potential
348 * lease. Release the Lease-ref so that the directory
349 * will be closed when the caller closes the cached
350 * handle.
351 */
352 cfid->has_lease = false;
353 spin_unlock(&cfids->cfid_list_lock);
354 kref_put(&cfid->refcount, smb2_close_cached_fid);
355 goto out;
356 }
357 spin_unlock(&cfids->cfid_list_lock);
358 }
359 out:
360 if (rc) {
361 if (cfid->is_open)
362 SMB2_close(0, cfid->tcon, cfid->fid.persistent_fid,
363 cfid->fid.volatile_fid);
364 free_cached_dir(cfid);
365 } else {
366 *ret_cfid = cfid;
367 atomic_inc(&tcon->num_remote_opens);
368 }
369 kfree(utf16_path);
370 return rc;
371 }
372
373 int open_cached_dir_by_dentry(struct cifs_tcon *tcon,
374 struct dentry *dentry,
375 struct cached_fid **ret_cfid)
376 {
377 struct cached_fid *cfid;
378 struct cached_fids *cfids = tcon->cfids;
379
380 if (cfids == NULL)
381 return -ENOENT;
382
383 spin_lock(&cfids->cfid_list_lock);
384 list_for_each_entry(cfid, &cfids->entries, entry) {
385 if (dentry && cfid->dentry == dentry) {
386 cifs_dbg(FYI, "found a cached root file handle by dentry\n");
387 kref_get(&cfid->refcount);
388 *ret_cfid = cfid;
389 spin_unlock(&cfids->cfid_list_lock);
390 return 0;
391 }
392 }
393 spin_unlock(&cfids->cfid_list_lock);
394 return -ENOENT;
395 }
396
397 static void
398 smb2_close_cached_fid(struct kref *ref)
399 {
400 struct cached_fid *cfid = container_of(ref, struct cached_fid,
401 refcount);
402
403 spin_lock(&cfid->cfids->cfid_list_lock);
404 if (cfid->on_list) {
405 list_del(&cfid->entry);
406 cfid->on_list = false;
407 cfid->cfids->num_entries--;
408 }
409 spin_unlock(&cfid->cfids->cfid_list_lock);
410
411 dput(cfid->dentry);
412 cfid->dentry = NULL;
413
414 if (cfid->is_open) {
415 SMB2_close(0, cfid->tcon, cfid->fid.persistent_fid,
416 cfid->fid.volatile_fid);
417 atomic_dec(&cfid->tcon->num_remote_opens);
418 }
419
420 free_cached_dir(cfid);
421 }
422
423 void drop_cached_dir_by_name(const unsigned int xid, struct cifs_tcon *tcon,
424 const char *name, struct cifs_sb_info *cifs_sb)
425 {
426 struct cached_fid *cfid = NULL;
427 int rc;
428
429 rc = open_cached_dir(xid, tcon, name, cifs_sb, true, &cfid);
430 if (rc) {
431 cifs_dbg(FYI, "no cached dir found for rmdir(%s)\n", name);
432 return;
433 }
434 spin_lock(&cfid->cfids->cfid_list_lock);
435 if (cfid->has_lease) {
436 cfid->has_lease = false;
437 kref_put(&cfid->refcount, smb2_close_cached_fid);
438 }
439 spin_unlock(&cfid->cfids->cfid_list_lock);
440 close_cached_dir(cfid);
441 }
442
443
444 void close_cached_dir(struct cached_fid *cfid)
445 {
446 kref_put(&cfid->refcount, smb2_close_cached_fid);
447 }
448
449 /*
450 * Called from cifs_kill_sb when we unmount a share
451 */
452 void close_all_cached_dirs(struct cifs_sb_info *cifs_sb)
453 {
454 struct rb_root *root = &cifs_sb->tlink_tree;
455 struct rb_node *node;
456 struct cached_fid *cfid;
457 struct cifs_tcon *tcon;
458 struct tcon_link *tlink;
459 struct cached_fids *cfids;
460
461 for (node = rb_first(root); node; node = rb_next(node)) {
462 tlink = rb_entry(node, struct tcon_link, tl_rbnode);
463 tcon = tlink_tcon(tlink);
464 if (IS_ERR(tcon))
465 continue;
466 cfids = tcon->cfids;
467 if (cfids == NULL)
468 continue;
469 list_for_each_entry(cfid, &cfids->entries, entry) {
470 dput(cfid->dentry);
471 cfid->dentry = NULL;
472 }
473 }
474 }
475
476 /*
477 * Invalidate all cached dirs when a TCON has been reset
478 * due to a session loss.
479 */
480 void invalidate_all_cached_dirs(struct cifs_tcon *tcon)
481 {
482 struct cached_fids *cfids = tcon->cfids;
483 struct cached_fid *cfid, *q;
484 LIST_HEAD(entry);
485
486 if (cfids == NULL)
487 return;
488
489 spin_lock(&cfids->cfid_list_lock);
490 list_for_each_entry_safe(cfid, q, &cfids->entries, entry) {
491 list_move(&cfid->entry, &entry);
492 cfids->num_entries--;
493 cfid->is_open = false;
494 cfid->on_list = false;
495 /* To prevent race with smb2_cached_lease_break() */
496 kref_get(&cfid->refcount);
497 }
498 spin_unlock(&cfids->cfid_list_lock);
499
500 list_for_each_entry_safe(cfid, q, &entry, entry) {
501 list_del(&cfid->entry);
502 cancel_work_sync(&cfid->lease_break);
503 if (cfid->has_lease) {
504 /*
505 * We lease was never cancelled from the server so we
506 * need to drop the reference.
507 */
508 spin_lock(&cfids->cfid_list_lock);
509 cfid->has_lease = false;
510 spin_unlock(&cfids->cfid_list_lock);
511 kref_put(&cfid->refcount, smb2_close_cached_fid);
512 }
513 /* Drop the extra reference opened above*/
514 kref_put(&cfid->refcount, smb2_close_cached_fid);
515 }
516 }
517
518 static void
519 smb2_cached_lease_break(struct work_struct *work)
520 {
521 struct cached_fid *cfid = container_of(work,
522 struct cached_fid, lease_break);
523
524 spin_lock(&cfid->cfids->cfid_list_lock);
525 cfid->has_lease = false;
526 spin_unlock(&cfid->cfids->cfid_list_lock);
527 kref_put(&cfid->refcount, smb2_close_cached_fid);
528 }
529
530 int cached_dir_lease_break(struct cifs_tcon *tcon, __u8 lease_key[16])
531 {
532 struct cached_fids *cfids = tcon->cfids;
533 struct cached_fid *cfid;
534
535 if (cfids == NULL)
536 return false;
537
538 spin_lock(&cfids->cfid_list_lock);
539 list_for_each_entry(cfid, &cfids->entries, entry) {
540 if (cfid->has_lease &&
541 !memcmp(lease_key,
542 cfid->fid.lease_key,
543 SMB2_LEASE_KEY_SIZE)) {
544 cfid->time = 0;
545 /*
546 * We found a lease remove it from the list
547 * so no threads can access it.
548 */
549 list_del(&cfid->entry);
550 cfid->on_list = false;
551 cfids->num_entries--;
552
553 queue_work(cifsiod_wq,
554 &cfid->lease_break);
555 spin_unlock(&cfids->cfid_list_lock);
556 return true;
557 }
558 }
559 spin_unlock(&cfids->cfid_list_lock);
560 return false;
561 }
562
563 static struct cached_fid *init_cached_dir(const char *path)
564 {
565 struct cached_fid *cfid;
566
567 cfid = kzalloc(sizeof(*cfid), GFP_ATOMIC);
568 if (!cfid)
569 return NULL;
570 cfid->path = kstrdup(path, GFP_ATOMIC);
571 if (!cfid->path) {
572 kfree(cfid);
573 return NULL;
574 }
575
576 INIT_WORK(&cfid->lease_break, smb2_cached_lease_break);
577 INIT_LIST_HEAD(&cfid->entry);
578 INIT_LIST_HEAD(&cfid->dirents.entries);
579 mutex_init(&cfid->dirents.de_mutex);
580 spin_lock_init(&cfid->fid_lock);
581 kref_init(&cfid->refcount);
582 return cfid;
583 }
584
585 static void free_cached_dir(struct cached_fid *cfid)
586 {
587 struct cached_dirent *dirent, *q;
588
589 dput(cfid->dentry);
590 cfid->dentry = NULL;
591
592 /*
593 * Delete all cached dirent names
594 */
595 list_for_each_entry_safe(dirent, q, &cfid->dirents.entries, entry) {
596 list_del(&dirent->entry);
597 kfree(dirent->name);
598 kfree(dirent);
599 }
600
601 kfree(cfid->path);
602 cfid->path = NULL;
603 kfree(cfid);
604 }
605
606 static void cfids_laundromat_worker(struct work_struct *work)
607 {
608 struct cached_fids *cfids;
609 struct cached_fid *cfid, *q;
610 LIST_HEAD(entry);
611
612 cfids = container_of(work, struct cached_fids, laundromat_work.work);
613
614 spin_lock(&cfids->cfid_list_lock);
615 list_for_each_entry_safe(cfid, q, &cfids->entries, entry) {
616 if (cfid->time &&
617 time_after(jiffies, cfid->time + HZ * dir_cache_timeout)) {
618 cfid->on_list = false;
619 list_move(&cfid->entry, &entry);
620 cfids->num_entries--;
621 /* To prevent race with smb2_cached_lease_break() */
622 kref_get(&cfid->refcount);
623 }
624 }
625 spin_unlock(&cfids->cfid_list_lock);
626
627 list_for_each_entry_safe(cfid, q, &entry, entry) {
628 list_del(&cfid->entry);
629 /*
630 * Cancel and wait for the work to finish in case we are racing
631 * with it.
632 */
633 cancel_work_sync(&cfid->lease_break);
634 if (cfid->has_lease) {
635 /*
636 * Our lease has not yet been cancelled from the server
637 * so we need to drop the reference.
638 */
639 spin_lock(&cfids->cfid_list_lock);
640 cfid->has_lease = false;
641 spin_unlock(&cfids->cfid_list_lock);
642 kref_put(&cfid->refcount, smb2_close_cached_fid);
643 }
644 /* Drop the extra reference opened above */
645 kref_put(&cfid->refcount, smb2_close_cached_fid);
646 }
647 queue_delayed_work(cifsiod_wq, &cfids->laundromat_work,
648 dir_cache_timeout * HZ);
649 }
650
651 struct cached_fids *init_cached_dirs(void)
652 {
653 struct cached_fids *cfids;
654
655 cfids = kzalloc(sizeof(*cfids), GFP_KERNEL);
656 if (!cfids)
657 return NULL;
658 spin_lock_init(&cfids->cfid_list_lock);
659 INIT_LIST_HEAD(&cfids->entries);
660
661 INIT_DELAYED_WORK(&cfids->laundromat_work, cfids_laundromat_worker);
662 queue_delayed_work(cifsiod_wq, &cfids->laundromat_work,
663 dir_cache_timeout * HZ);
664
665 return cfids;
666 }
667
668 /*
669 * Called from tconInfoFree when we are tearing down the tcon.
670 * There are no active users or open files/directories at this point.
671 */
672 void free_cached_dirs(struct cached_fids *cfids)
673 {
674 struct cached_fid *cfid, *q;
675 LIST_HEAD(entry);
676
677 if (cfids == NULL)
678 return;
679
680 cancel_delayed_work_sync(&cfids->laundromat_work);
681
682 spin_lock(&cfids->cfid_list_lock);
683 list_for_each_entry_safe(cfid, q, &cfids->entries, entry) {
684 cfid->on_list = false;
685 cfid->is_open = false;
686 list_move(&cfid->entry, &entry);
687 }
688 spin_unlock(&cfids->cfid_list_lock);
689
690 list_for_each_entry_safe(cfid, q, &entry, entry) {
691 list_del(&cfid->entry);
692 free_cached_dir(cfid);
693 }
694
695 kfree(cfids);
696 }