xref: /linux/fs/erofs/zdata.c (revision 6c8c1406)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2018 HUAWEI, Inc.
4  *             https://www.huawei.com/
5  * Copyright (C) 2022 Alibaba Cloud
6  */
7 #include "zdata.h"
8 #include "compress.h"
9 #include <linux/prefetch.h>
10 #include <linux/psi.h>
11 
12 #include <trace/events/erofs.h>
13 
14 /*
15  * since pclustersize is variable for big pcluster feature, introduce slab
16  * pools implementation for different pcluster sizes.
17  */
18 struct z_erofs_pcluster_slab {
19 	struct kmem_cache *slab;
20 	unsigned int maxpages;
21 	char name[48];
22 };
23 
24 #define _PCLP(n) { .maxpages = n }
25 
26 static struct z_erofs_pcluster_slab pcluster_pool[] __read_mostly = {
27 	_PCLP(1), _PCLP(4), _PCLP(16), _PCLP(64), _PCLP(128),
28 	_PCLP(Z_EROFS_PCLUSTER_MAX_PAGES)
29 };
30 
31 struct z_erofs_bvec_iter {
32 	struct page *bvpage;
33 	struct z_erofs_bvset *bvset;
34 	unsigned int nr, cur;
35 };
36 
37 static struct page *z_erofs_bvec_iter_end(struct z_erofs_bvec_iter *iter)
38 {
39 	if (iter->bvpage)
40 		kunmap_local(iter->bvset);
41 	return iter->bvpage;
42 }
43 
44 static struct page *z_erofs_bvset_flip(struct z_erofs_bvec_iter *iter)
45 {
46 	unsigned long base = (unsigned long)((struct z_erofs_bvset *)0)->bvec;
47 	/* have to access nextpage in advance, otherwise it will be unmapped */
48 	struct page *nextpage = iter->bvset->nextpage;
49 	struct page *oldpage;
50 
51 	DBG_BUGON(!nextpage);
52 	oldpage = z_erofs_bvec_iter_end(iter);
53 	iter->bvpage = nextpage;
54 	iter->bvset = kmap_local_page(nextpage);
55 	iter->nr = (PAGE_SIZE - base) / sizeof(struct z_erofs_bvec);
56 	iter->cur = 0;
57 	return oldpage;
58 }
59 
60 static void z_erofs_bvec_iter_begin(struct z_erofs_bvec_iter *iter,
61 				    struct z_erofs_bvset_inline *bvset,
62 				    unsigned int bootstrap_nr,
63 				    unsigned int cur)
64 {
65 	*iter = (struct z_erofs_bvec_iter) {
66 		.nr = bootstrap_nr,
67 		.bvset = (struct z_erofs_bvset *)bvset,
68 	};
69 
70 	while (cur > iter->nr) {
71 		cur -= iter->nr;
72 		z_erofs_bvset_flip(iter);
73 	}
74 	iter->cur = cur;
75 }
76 
77 static int z_erofs_bvec_enqueue(struct z_erofs_bvec_iter *iter,
78 				struct z_erofs_bvec *bvec,
79 				struct page **candidate_bvpage)
80 {
81 	if (iter->cur == iter->nr) {
82 		if (!*candidate_bvpage)
83 			return -EAGAIN;
84 
85 		DBG_BUGON(iter->bvset->nextpage);
86 		iter->bvset->nextpage = *candidate_bvpage;
87 		z_erofs_bvset_flip(iter);
88 
89 		iter->bvset->nextpage = NULL;
90 		*candidate_bvpage = NULL;
91 	}
92 	iter->bvset->bvec[iter->cur++] = *bvec;
93 	return 0;
94 }
95 
96 static void z_erofs_bvec_dequeue(struct z_erofs_bvec_iter *iter,
97 				 struct z_erofs_bvec *bvec,
98 				 struct page **old_bvpage)
99 {
100 	if (iter->cur == iter->nr)
101 		*old_bvpage = z_erofs_bvset_flip(iter);
102 	else
103 		*old_bvpage = NULL;
104 	*bvec = iter->bvset->bvec[iter->cur++];
105 }
106 
107 static void z_erofs_destroy_pcluster_pool(void)
108 {
109 	int i;
110 
111 	for (i = 0; i < ARRAY_SIZE(pcluster_pool); ++i) {
112 		if (!pcluster_pool[i].slab)
113 			continue;
114 		kmem_cache_destroy(pcluster_pool[i].slab);
115 		pcluster_pool[i].slab = NULL;
116 	}
117 }
118 
119 static int z_erofs_create_pcluster_pool(void)
120 {
121 	struct z_erofs_pcluster_slab *pcs;
122 	struct z_erofs_pcluster *a;
123 	unsigned int size;
124 
125 	for (pcs = pcluster_pool;
126 	     pcs < pcluster_pool + ARRAY_SIZE(pcluster_pool); ++pcs) {
127 		size = struct_size(a, compressed_bvecs, pcs->maxpages);
128 
129 		sprintf(pcs->name, "erofs_pcluster-%u", pcs->maxpages);
130 		pcs->slab = kmem_cache_create(pcs->name, size, 0,
131 					      SLAB_RECLAIM_ACCOUNT, NULL);
132 		if (pcs->slab)
133 			continue;
134 
135 		z_erofs_destroy_pcluster_pool();
136 		return -ENOMEM;
137 	}
138 	return 0;
139 }
140 
141 static struct z_erofs_pcluster *z_erofs_alloc_pcluster(unsigned int nrpages)
142 {
143 	int i;
144 
145 	for (i = 0; i < ARRAY_SIZE(pcluster_pool); ++i) {
146 		struct z_erofs_pcluster_slab *pcs = pcluster_pool + i;
147 		struct z_erofs_pcluster *pcl;
148 
149 		if (nrpages > pcs->maxpages)
150 			continue;
151 
152 		pcl = kmem_cache_zalloc(pcs->slab, GFP_NOFS);
153 		if (!pcl)
154 			return ERR_PTR(-ENOMEM);
155 		pcl->pclusterpages = nrpages;
156 		return pcl;
157 	}
158 	return ERR_PTR(-EINVAL);
159 }
160 
161 static void z_erofs_free_pcluster(struct z_erofs_pcluster *pcl)
162 {
163 	unsigned int pclusterpages = z_erofs_pclusterpages(pcl);
164 	int i;
165 
166 	for (i = 0; i < ARRAY_SIZE(pcluster_pool); ++i) {
167 		struct z_erofs_pcluster_slab *pcs = pcluster_pool + i;
168 
169 		if (pclusterpages > pcs->maxpages)
170 			continue;
171 
172 		kmem_cache_free(pcs->slab, pcl);
173 		return;
174 	}
175 	DBG_BUGON(1);
176 }
177 
178 /* how to allocate cached pages for a pcluster */
179 enum z_erofs_cache_alloctype {
180 	DONTALLOC,	/* don't allocate any cached pages */
181 	/*
182 	 * try to use cached I/O if page allocation succeeds or fallback
183 	 * to in-place I/O instead to avoid any direct reclaim.
184 	 */
185 	TRYALLOC,
186 };
187 
188 /*
189  * tagged pointer with 1-bit tag for all compressed pages
190  * tag 0 - the page is just found with an extra page reference
191  */
192 typedef tagptr1_t compressed_page_t;
193 
194 #define tag_compressed_page_justfound(page) \
195 	tagptr_fold(compressed_page_t, page, 1)
196 
197 static struct workqueue_struct *z_erofs_workqueue __read_mostly;
198 
199 void z_erofs_exit_zip_subsystem(void)
200 {
201 	destroy_workqueue(z_erofs_workqueue);
202 	z_erofs_destroy_pcluster_pool();
203 }
204 
205 static inline int z_erofs_init_workqueue(void)
206 {
207 	const unsigned int onlinecpus = num_possible_cpus();
208 
209 	/*
210 	 * no need to spawn too many threads, limiting threads could minimum
211 	 * scheduling overhead, perhaps per-CPU threads should be better?
212 	 */
213 	z_erofs_workqueue = alloc_workqueue("erofs_unzipd",
214 					    WQ_UNBOUND | WQ_HIGHPRI,
215 					    onlinecpus + onlinecpus / 4);
216 	return z_erofs_workqueue ? 0 : -ENOMEM;
217 }
218 
219 int __init z_erofs_init_zip_subsystem(void)
220 {
221 	int err = z_erofs_create_pcluster_pool();
222 
223 	if (err)
224 		return err;
225 	err = z_erofs_init_workqueue();
226 	if (err)
227 		z_erofs_destroy_pcluster_pool();
228 	return err;
229 }
230 
231 enum z_erofs_pclustermode {
232 	Z_EROFS_PCLUSTER_INFLIGHT,
233 	/*
234 	 * The current pclusters was the tail of an exist chain, in addition
235 	 * that the previous processed chained pclusters are all decided to
236 	 * be hooked up to it.
237 	 * A new chain will be created for the remaining pclusters which are
238 	 * not processed yet, so different from Z_EROFS_PCLUSTER_FOLLOWED,
239 	 * the next pcluster cannot reuse the whole page safely for inplace I/O
240 	 * in the following scenario:
241 	 *  ________________________________________________________________
242 	 * |      tail (partial) page     |       head (partial) page       |
243 	 * |   (belongs to the next pcl)  |   (belongs to the current pcl)  |
244 	 * |_______PCLUSTER_FOLLOWED______|________PCLUSTER_HOOKED__________|
245 	 */
246 	Z_EROFS_PCLUSTER_HOOKED,
247 	/*
248 	 * a weak form of Z_EROFS_PCLUSTER_FOLLOWED, the difference is that it
249 	 * could be dispatched into bypass queue later due to uptodated managed
250 	 * pages. All related online pages cannot be reused for inplace I/O (or
251 	 * bvpage) since it can be directly decoded without I/O submission.
252 	 */
253 	Z_EROFS_PCLUSTER_FOLLOWED_NOINPLACE,
254 	/*
255 	 * The current collection has been linked with the owned chain, and
256 	 * could also be linked with the remaining collections, which means
257 	 * if the processing page is the tail page of the collection, thus
258 	 * the current collection can safely use the whole page (since
259 	 * the previous collection is under control) for in-place I/O, as
260 	 * illustrated below:
261 	 *  ________________________________________________________________
262 	 * |  tail (partial) page |          head (partial) page           |
263 	 * |  (of the current cl) |      (of the previous collection)      |
264 	 * | PCLUSTER_FOLLOWED or |                                        |
265 	 * |_____PCLUSTER_HOOKED__|___________PCLUSTER_FOLLOWED____________|
266 	 *
267 	 * [  (*) the above page can be used as inplace I/O.               ]
268 	 */
269 	Z_EROFS_PCLUSTER_FOLLOWED,
270 };
271 
272 struct z_erofs_decompress_frontend {
273 	struct inode *const inode;
274 	struct erofs_map_blocks map;
275 	struct z_erofs_bvec_iter biter;
276 
277 	struct page *candidate_bvpage;
278 	struct z_erofs_pcluster *pcl, *tailpcl;
279 	z_erofs_next_pcluster_t owned_head;
280 	enum z_erofs_pclustermode mode;
281 
282 	bool readahead;
283 	/* used for applying cache strategy on the fly */
284 	bool backmost;
285 	erofs_off_t headoffset;
286 
287 	/* a pointer used to pick up inplace I/O pages */
288 	unsigned int icur;
289 };
290 
291 #define DECOMPRESS_FRONTEND_INIT(__i) { \
292 	.inode = __i, .owned_head = Z_EROFS_PCLUSTER_TAIL, \
293 	.mode = Z_EROFS_PCLUSTER_FOLLOWED, .backmost = true }
294 
295 static void z_erofs_bind_cache(struct z_erofs_decompress_frontend *fe,
296 			       enum z_erofs_cache_alloctype type,
297 			       struct page **pagepool)
298 {
299 	struct address_space *mc = MNGD_MAPPING(EROFS_I_SB(fe->inode));
300 	struct z_erofs_pcluster *pcl = fe->pcl;
301 	bool standalone = true;
302 	/*
303 	 * optimistic allocation without direct reclaim since inplace I/O
304 	 * can be used if low memory otherwise.
305 	 */
306 	gfp_t gfp = (mapping_gfp_mask(mc) & ~__GFP_DIRECT_RECLAIM) |
307 			__GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;
308 	unsigned int i;
309 
310 	if (fe->mode < Z_EROFS_PCLUSTER_FOLLOWED)
311 		return;
312 
313 	for (i = 0; i < pcl->pclusterpages; ++i) {
314 		struct page *page;
315 		compressed_page_t t;
316 		struct page *newpage = NULL;
317 
318 		/* the compressed page was loaded before */
319 		if (READ_ONCE(pcl->compressed_bvecs[i].page))
320 			continue;
321 
322 		page = find_get_page(mc, pcl->obj.index + i);
323 
324 		if (page) {
325 			t = tag_compressed_page_justfound(page);
326 		} else {
327 			/* I/O is needed, no possible to decompress directly */
328 			standalone = false;
329 			switch (type) {
330 			case TRYALLOC:
331 				newpage = erofs_allocpage(pagepool, gfp);
332 				if (!newpage)
333 					continue;
334 				set_page_private(newpage,
335 						 Z_EROFS_PREALLOCATED_PAGE);
336 				t = tag_compressed_page_justfound(newpage);
337 				break;
338 			default:        /* DONTALLOC */
339 				continue;
340 			}
341 		}
342 
343 		if (!cmpxchg_relaxed(&pcl->compressed_bvecs[i].page, NULL,
344 				     tagptr_cast_ptr(t)))
345 			continue;
346 
347 		if (page)
348 			put_page(page);
349 		else if (newpage)
350 			erofs_pagepool_add(pagepool, newpage);
351 	}
352 
353 	/*
354 	 * don't do inplace I/O if all compressed pages are available in
355 	 * managed cache since it can be moved to the bypass queue instead.
356 	 */
357 	if (standalone)
358 		fe->mode = Z_EROFS_PCLUSTER_FOLLOWED_NOINPLACE;
359 }
360 
361 /* called by erofs_shrinker to get rid of all compressed_pages */
362 int erofs_try_to_free_all_cached_pages(struct erofs_sb_info *sbi,
363 				       struct erofs_workgroup *grp)
364 {
365 	struct z_erofs_pcluster *const pcl =
366 		container_of(grp, struct z_erofs_pcluster, obj);
367 	int i;
368 
369 	DBG_BUGON(z_erofs_is_inline_pcluster(pcl));
370 	/*
371 	 * refcount of workgroup is now freezed as 1,
372 	 * therefore no need to worry about available decompression users.
373 	 */
374 	for (i = 0; i < pcl->pclusterpages; ++i) {
375 		struct page *page = pcl->compressed_bvecs[i].page;
376 
377 		if (!page)
378 			continue;
379 
380 		/* block other users from reclaiming or migrating the page */
381 		if (!trylock_page(page))
382 			return -EBUSY;
383 
384 		if (!erofs_page_is_managed(sbi, page))
385 			continue;
386 
387 		/* barrier is implied in the following 'unlock_page' */
388 		WRITE_ONCE(pcl->compressed_bvecs[i].page, NULL);
389 		detach_page_private(page);
390 		unlock_page(page);
391 	}
392 	return 0;
393 }
394 
395 int erofs_try_to_free_cached_page(struct page *page)
396 {
397 	struct z_erofs_pcluster *const pcl = (void *)page_private(page);
398 	int ret, i;
399 
400 	if (!erofs_workgroup_try_to_freeze(&pcl->obj, 1))
401 		return 0;
402 
403 	ret = 0;
404 	DBG_BUGON(z_erofs_is_inline_pcluster(pcl));
405 	for (i = 0; i < pcl->pclusterpages; ++i) {
406 		if (pcl->compressed_bvecs[i].page == page) {
407 			WRITE_ONCE(pcl->compressed_bvecs[i].page, NULL);
408 			ret = 1;
409 			break;
410 		}
411 	}
412 	erofs_workgroup_unfreeze(&pcl->obj, 1);
413 	if (ret)
414 		detach_page_private(page);
415 	return ret;
416 }
417 
418 static bool z_erofs_try_inplace_io(struct z_erofs_decompress_frontend *fe,
419 				   struct z_erofs_bvec *bvec)
420 {
421 	struct z_erofs_pcluster *const pcl = fe->pcl;
422 
423 	while (fe->icur > 0) {
424 		if (!cmpxchg(&pcl->compressed_bvecs[--fe->icur].page,
425 			     NULL, bvec->page)) {
426 			pcl->compressed_bvecs[fe->icur] = *bvec;
427 			return true;
428 		}
429 	}
430 	return false;
431 }
432 
433 /* callers must be with pcluster lock held */
434 static int z_erofs_attach_page(struct z_erofs_decompress_frontend *fe,
435 			       struct z_erofs_bvec *bvec, bool exclusive)
436 {
437 	int ret;
438 
439 	if (exclusive) {
440 		/* give priority for inplaceio to use file pages first */
441 		if (z_erofs_try_inplace_io(fe, bvec))
442 			return 0;
443 		/* otherwise, check if it can be used as a bvpage */
444 		if (fe->mode >= Z_EROFS_PCLUSTER_FOLLOWED &&
445 		    !fe->candidate_bvpage)
446 			fe->candidate_bvpage = bvec->page;
447 	}
448 	ret = z_erofs_bvec_enqueue(&fe->biter, bvec, &fe->candidate_bvpage);
449 	fe->pcl->vcnt += (ret >= 0);
450 	return ret;
451 }
452 
453 static void z_erofs_try_to_claim_pcluster(struct z_erofs_decompress_frontend *f)
454 {
455 	struct z_erofs_pcluster *pcl = f->pcl;
456 	z_erofs_next_pcluster_t *owned_head = &f->owned_head;
457 
458 	/* type 1, nil pcluster (this pcluster doesn't belong to any chain.) */
459 	if (cmpxchg(&pcl->next, Z_EROFS_PCLUSTER_NIL,
460 		    *owned_head) == Z_EROFS_PCLUSTER_NIL) {
461 		*owned_head = &pcl->next;
462 		/* so we can attach this pcluster to our submission chain. */
463 		f->mode = Z_EROFS_PCLUSTER_FOLLOWED;
464 		return;
465 	}
466 
467 	/*
468 	 * type 2, link to the end of an existing open chain, be careful
469 	 * that its submission is controlled by the original attached chain.
470 	 */
471 	if (*owned_head != &pcl->next && pcl != f->tailpcl &&
472 	    cmpxchg(&pcl->next, Z_EROFS_PCLUSTER_TAIL,
473 		    *owned_head) == Z_EROFS_PCLUSTER_TAIL) {
474 		*owned_head = Z_EROFS_PCLUSTER_TAIL;
475 		f->mode = Z_EROFS_PCLUSTER_HOOKED;
476 		f->tailpcl = NULL;
477 		return;
478 	}
479 	/* type 3, it belongs to a chain, but it isn't the end of the chain */
480 	f->mode = Z_EROFS_PCLUSTER_INFLIGHT;
481 }
482 
483 static int z_erofs_register_pcluster(struct z_erofs_decompress_frontend *fe)
484 {
485 	struct erofs_map_blocks *map = &fe->map;
486 	bool ztailpacking = map->m_flags & EROFS_MAP_META;
487 	struct z_erofs_pcluster *pcl;
488 	struct erofs_workgroup *grp;
489 	int err;
490 
491 	if (!(map->m_flags & EROFS_MAP_ENCODED)) {
492 		DBG_BUGON(1);
493 		return -EFSCORRUPTED;
494 	}
495 
496 	/* no available pcluster, let's allocate one */
497 	pcl = z_erofs_alloc_pcluster(ztailpacking ? 1 :
498 				     map->m_plen >> PAGE_SHIFT);
499 	if (IS_ERR(pcl))
500 		return PTR_ERR(pcl);
501 
502 	atomic_set(&pcl->obj.refcount, 1);
503 	pcl->algorithmformat = map->m_algorithmformat;
504 	pcl->length = 0;
505 	pcl->partial = true;
506 
507 	/* new pclusters should be claimed as type 1, primary and followed */
508 	pcl->next = fe->owned_head;
509 	pcl->pageofs_out = map->m_la & ~PAGE_MASK;
510 	fe->mode = Z_EROFS_PCLUSTER_FOLLOWED;
511 
512 	/*
513 	 * lock all primary followed works before visible to others
514 	 * and mutex_trylock *never* fails for a new pcluster.
515 	 */
516 	mutex_init(&pcl->lock);
517 	DBG_BUGON(!mutex_trylock(&pcl->lock));
518 
519 	if (ztailpacking) {
520 		pcl->obj.index = 0;	/* which indicates ztailpacking */
521 		pcl->pageofs_in = erofs_blkoff(map->m_pa);
522 		pcl->tailpacking_size = map->m_plen;
523 	} else {
524 		pcl->obj.index = map->m_pa >> PAGE_SHIFT;
525 
526 		grp = erofs_insert_workgroup(fe->inode->i_sb, &pcl->obj);
527 		if (IS_ERR(grp)) {
528 			err = PTR_ERR(grp);
529 			goto err_out;
530 		}
531 
532 		if (grp != &pcl->obj) {
533 			fe->pcl = container_of(grp,
534 					struct z_erofs_pcluster, obj);
535 			err = -EEXIST;
536 			goto err_out;
537 		}
538 	}
539 	/* used to check tail merging loop due to corrupted images */
540 	if (fe->owned_head == Z_EROFS_PCLUSTER_TAIL)
541 		fe->tailpcl = pcl;
542 	fe->owned_head = &pcl->next;
543 	fe->pcl = pcl;
544 	return 0;
545 
546 err_out:
547 	mutex_unlock(&pcl->lock);
548 	z_erofs_free_pcluster(pcl);
549 	return err;
550 }
551 
552 static int z_erofs_collector_begin(struct z_erofs_decompress_frontend *fe)
553 {
554 	struct erofs_map_blocks *map = &fe->map;
555 	struct erofs_workgroup *grp = NULL;
556 	int ret;
557 
558 	DBG_BUGON(fe->pcl);
559 
560 	/* must be Z_EROFS_PCLUSTER_TAIL or pointed to previous pcluster */
561 	DBG_BUGON(fe->owned_head == Z_EROFS_PCLUSTER_NIL);
562 	DBG_BUGON(fe->owned_head == Z_EROFS_PCLUSTER_TAIL_CLOSED);
563 
564 	if (!(map->m_flags & EROFS_MAP_META)) {
565 		grp = erofs_find_workgroup(fe->inode->i_sb,
566 					   map->m_pa >> PAGE_SHIFT);
567 	} else if ((map->m_pa & ~PAGE_MASK) + map->m_plen > PAGE_SIZE) {
568 		DBG_BUGON(1);
569 		return -EFSCORRUPTED;
570 	}
571 
572 	if (grp) {
573 		fe->pcl = container_of(grp, struct z_erofs_pcluster, obj);
574 		ret = -EEXIST;
575 	} else {
576 		ret = z_erofs_register_pcluster(fe);
577 	}
578 
579 	if (ret == -EEXIST) {
580 		mutex_lock(&fe->pcl->lock);
581 		/* used to check tail merging loop due to corrupted images */
582 		if (fe->owned_head == Z_EROFS_PCLUSTER_TAIL)
583 			fe->tailpcl = fe->pcl;
584 
585 		z_erofs_try_to_claim_pcluster(fe);
586 	} else if (ret) {
587 		return ret;
588 	}
589 	z_erofs_bvec_iter_begin(&fe->biter, &fe->pcl->bvset,
590 				Z_EROFS_INLINE_BVECS, fe->pcl->vcnt);
591 	/* since file-backed online pages are traversed in reverse order */
592 	fe->icur = z_erofs_pclusterpages(fe->pcl);
593 	return 0;
594 }
595 
596 /*
597  * keep in mind that no referenced pclusters will be freed
598  * only after a RCU grace period.
599  */
600 static void z_erofs_rcu_callback(struct rcu_head *head)
601 {
602 	z_erofs_free_pcluster(container_of(head,
603 			struct z_erofs_pcluster, rcu));
604 }
605 
606 void erofs_workgroup_free_rcu(struct erofs_workgroup *grp)
607 {
608 	struct z_erofs_pcluster *const pcl =
609 		container_of(grp, struct z_erofs_pcluster, obj);
610 
611 	call_rcu(&pcl->rcu, z_erofs_rcu_callback);
612 }
613 
614 static bool z_erofs_collector_end(struct z_erofs_decompress_frontend *fe)
615 {
616 	struct z_erofs_pcluster *pcl = fe->pcl;
617 
618 	if (!pcl)
619 		return false;
620 
621 	z_erofs_bvec_iter_end(&fe->biter);
622 	mutex_unlock(&pcl->lock);
623 
624 	if (fe->candidate_bvpage) {
625 		DBG_BUGON(z_erofs_is_shortlived_page(fe->candidate_bvpage));
626 		fe->candidate_bvpage = NULL;
627 	}
628 
629 	/*
630 	 * if all pending pages are added, don't hold its reference
631 	 * any longer if the pcluster isn't hosted by ourselves.
632 	 */
633 	if (fe->mode < Z_EROFS_PCLUSTER_FOLLOWED_NOINPLACE)
634 		erofs_workgroup_put(&pcl->obj);
635 
636 	fe->pcl = NULL;
637 	return true;
638 }
639 
640 static bool should_alloc_managed_pages(struct z_erofs_decompress_frontend *fe,
641 				       unsigned int cachestrategy,
642 				       erofs_off_t la)
643 {
644 	if (cachestrategy <= EROFS_ZIP_CACHE_DISABLED)
645 		return false;
646 
647 	if (fe->backmost)
648 		return true;
649 
650 	return cachestrategy >= EROFS_ZIP_CACHE_READAROUND &&
651 		la < fe->headoffset;
652 }
653 
654 static int z_erofs_read_fragment(struct inode *inode, erofs_off_t pos,
655 				 struct page *page, unsigned int pageofs,
656 				 unsigned int len)
657 {
658 	struct inode *packed_inode = EROFS_I_SB(inode)->packed_inode;
659 	struct erofs_buf buf = __EROFS_BUF_INITIALIZER;
660 	u8 *src, *dst;
661 	unsigned int i, cnt;
662 
663 	pos += EROFS_I(inode)->z_fragmentoff;
664 	for (i = 0; i < len; i += cnt) {
665 		cnt = min_t(unsigned int, len - i,
666 			    EROFS_BLKSIZ - erofs_blkoff(pos));
667 		src = erofs_bread(&buf, packed_inode,
668 				  erofs_blknr(pos), EROFS_KMAP);
669 		if (IS_ERR(src)) {
670 			erofs_put_metabuf(&buf);
671 			return PTR_ERR(src);
672 		}
673 
674 		dst = kmap_local_page(page);
675 		memcpy(dst + pageofs + i, src + erofs_blkoff(pos), cnt);
676 		kunmap_local(dst);
677 		pos += cnt;
678 	}
679 	erofs_put_metabuf(&buf);
680 	return 0;
681 }
682 
683 static int z_erofs_do_read_page(struct z_erofs_decompress_frontend *fe,
684 				struct page *page, struct page **pagepool)
685 {
686 	struct inode *const inode = fe->inode;
687 	struct erofs_sb_info *const sbi = EROFS_I_SB(inode);
688 	struct erofs_map_blocks *const map = &fe->map;
689 	const loff_t offset = page_offset(page);
690 	bool tight = true, exclusive;
691 
692 	enum z_erofs_cache_alloctype cache_strategy;
693 	unsigned int cur, end, spiltted;
694 	int err = 0;
695 
696 	/* register locked file pages as online pages in pack */
697 	z_erofs_onlinepage_init(page);
698 
699 	spiltted = 0;
700 	end = PAGE_SIZE;
701 repeat:
702 	cur = end - 1;
703 
704 	if (offset + cur < map->m_la ||
705 	    offset + cur >= map->m_la + map->m_llen) {
706 		erofs_dbg("out-of-range map @ pos %llu", offset + cur);
707 
708 		if (z_erofs_collector_end(fe))
709 			fe->backmost = false;
710 		map->m_la = offset + cur;
711 		map->m_llen = 0;
712 		err = z_erofs_map_blocks_iter(inode, map, 0);
713 		if (err)
714 			goto out;
715 	} else {
716 		if (fe->pcl)
717 			goto hitted;
718 		/* didn't get a valid pcluster previously (very rare) */
719 	}
720 
721 	if (!(map->m_flags & EROFS_MAP_MAPPED) ||
722 	    map->m_flags & EROFS_MAP_FRAGMENT)
723 		goto hitted;
724 
725 	err = z_erofs_collector_begin(fe);
726 	if (err)
727 		goto out;
728 
729 	if (z_erofs_is_inline_pcluster(fe->pcl)) {
730 		void *mp;
731 
732 		mp = erofs_read_metabuf(&fe->map.buf, inode->i_sb,
733 					erofs_blknr(map->m_pa), EROFS_NO_KMAP);
734 		if (IS_ERR(mp)) {
735 			err = PTR_ERR(mp);
736 			erofs_err(inode->i_sb,
737 				  "failed to get inline page, err %d", err);
738 			goto out;
739 		}
740 		get_page(fe->map.buf.page);
741 		WRITE_ONCE(fe->pcl->compressed_bvecs[0].page,
742 			   fe->map.buf.page);
743 		fe->mode = Z_EROFS_PCLUSTER_FOLLOWED_NOINPLACE;
744 	} else {
745 		/* bind cache first when cached decompression is preferred */
746 		if (should_alloc_managed_pages(fe, sbi->opt.cache_strategy,
747 					       map->m_la))
748 			cache_strategy = TRYALLOC;
749 		else
750 			cache_strategy = DONTALLOC;
751 
752 		z_erofs_bind_cache(fe, cache_strategy, pagepool);
753 	}
754 hitted:
755 	/*
756 	 * Ensure the current partial page belongs to this submit chain rather
757 	 * than other concurrent submit chains or the noio(bypass) chain since
758 	 * those chains are handled asynchronously thus the page cannot be used
759 	 * for inplace I/O or bvpage (should be processed in a strict order.)
760 	 */
761 	tight &= (fe->mode >= Z_EROFS_PCLUSTER_HOOKED &&
762 		  fe->mode != Z_EROFS_PCLUSTER_FOLLOWED_NOINPLACE);
763 
764 	cur = end - min_t(unsigned int, offset + end - map->m_la, end);
765 	if (!(map->m_flags & EROFS_MAP_MAPPED)) {
766 		zero_user_segment(page, cur, end);
767 		goto next_part;
768 	}
769 	if (map->m_flags & EROFS_MAP_FRAGMENT) {
770 		unsigned int pageofs, skip, len;
771 
772 		if (offset > map->m_la) {
773 			pageofs = 0;
774 			skip = offset - map->m_la;
775 		} else {
776 			pageofs = map->m_la & ~PAGE_MASK;
777 			skip = 0;
778 		}
779 		len = min_t(unsigned int, map->m_llen - skip, end - cur);
780 		err = z_erofs_read_fragment(inode, skip, page, pageofs, len);
781 		if (err)
782 			goto out;
783 		++spiltted;
784 		tight = false;
785 		goto next_part;
786 	}
787 
788 	exclusive = (!cur && (!spiltted || tight));
789 	if (cur)
790 		tight &= (fe->mode >= Z_EROFS_PCLUSTER_FOLLOWED);
791 
792 retry:
793 	err = z_erofs_attach_page(fe, &((struct z_erofs_bvec) {
794 					.page = page,
795 					.offset = offset - map->m_la,
796 					.end = end,
797 				  }), exclusive);
798 	/* should allocate an additional short-lived page for bvset */
799 	if (err == -EAGAIN && !fe->candidate_bvpage) {
800 		fe->candidate_bvpage = alloc_page(GFP_NOFS | __GFP_NOFAIL);
801 		set_page_private(fe->candidate_bvpage,
802 				 Z_EROFS_SHORTLIVED_PAGE);
803 		goto retry;
804 	}
805 
806 	if (err) {
807 		DBG_BUGON(err == -EAGAIN && fe->candidate_bvpage);
808 		goto out;
809 	}
810 
811 	z_erofs_onlinepage_split(page);
812 	/* bump up the number of spiltted parts of a page */
813 	++spiltted;
814 	if (fe->pcl->pageofs_out != (map->m_la & ~PAGE_MASK))
815 		fe->pcl->multibases = true;
816 	if (fe->pcl->length < offset + end - map->m_la) {
817 		fe->pcl->length = offset + end - map->m_la;
818 		fe->pcl->pageofs_out = map->m_la & ~PAGE_MASK;
819 	}
820 	if ((map->m_flags & EROFS_MAP_FULL_MAPPED) &&
821 	    !(map->m_flags & EROFS_MAP_PARTIAL_REF) &&
822 	    fe->pcl->length == map->m_llen)
823 		fe->pcl->partial = false;
824 next_part:
825 	/* shorten the remaining extent to update progress */
826 	map->m_llen = offset + cur - map->m_la;
827 	map->m_flags &= ~EROFS_MAP_FULL_MAPPED;
828 
829 	end = cur;
830 	if (end > 0)
831 		goto repeat;
832 
833 out:
834 	if (err)
835 		z_erofs_page_mark_eio(page);
836 	z_erofs_onlinepage_endio(page);
837 
838 	erofs_dbg("%s, finish page: %pK spiltted: %u map->m_llen %llu",
839 		  __func__, page, spiltted, map->m_llen);
840 	return err;
841 }
842 
843 static bool z_erofs_get_sync_decompress_policy(struct erofs_sb_info *sbi,
844 				       unsigned int readahead_pages)
845 {
846 	/* auto: enable for read_folio, disable for readahead */
847 	if ((sbi->opt.sync_decompress == EROFS_SYNC_DECOMPRESS_AUTO) &&
848 	    !readahead_pages)
849 		return true;
850 
851 	if ((sbi->opt.sync_decompress == EROFS_SYNC_DECOMPRESS_FORCE_ON) &&
852 	    (readahead_pages <= sbi->opt.max_sync_decompress_pages))
853 		return true;
854 
855 	return false;
856 }
857 
858 static bool z_erofs_page_is_invalidated(struct page *page)
859 {
860 	return !page->mapping && !z_erofs_is_shortlived_page(page);
861 }
862 
863 struct z_erofs_decompress_backend {
864 	struct page *onstack_pages[Z_EROFS_ONSTACK_PAGES];
865 	struct super_block *sb;
866 	struct z_erofs_pcluster *pcl;
867 
868 	/* pages with the longest decompressed length for deduplication */
869 	struct page **decompressed_pages;
870 	/* pages to keep the compressed data */
871 	struct page **compressed_pages;
872 
873 	struct list_head decompressed_secondary_bvecs;
874 	struct page **pagepool;
875 	unsigned int onstack_used, nr_pages;
876 };
877 
878 struct z_erofs_bvec_item {
879 	struct z_erofs_bvec bvec;
880 	struct list_head list;
881 };
882 
883 static void z_erofs_do_decompressed_bvec(struct z_erofs_decompress_backend *be,
884 					 struct z_erofs_bvec *bvec)
885 {
886 	struct z_erofs_bvec_item *item;
887 
888 	if (!((bvec->offset + be->pcl->pageofs_out) & ~PAGE_MASK)) {
889 		unsigned int pgnr;
890 
891 		pgnr = (bvec->offset + be->pcl->pageofs_out) >> PAGE_SHIFT;
892 		DBG_BUGON(pgnr >= be->nr_pages);
893 		if (!be->decompressed_pages[pgnr]) {
894 			be->decompressed_pages[pgnr] = bvec->page;
895 			return;
896 		}
897 	}
898 
899 	/* (cold path) one pcluster is requested multiple times */
900 	item = kmalloc(sizeof(*item), GFP_KERNEL | __GFP_NOFAIL);
901 	item->bvec = *bvec;
902 	list_add(&item->list, &be->decompressed_secondary_bvecs);
903 }
904 
905 static void z_erofs_fill_other_copies(struct z_erofs_decompress_backend *be,
906 				      int err)
907 {
908 	unsigned int off0 = be->pcl->pageofs_out;
909 	struct list_head *p, *n;
910 
911 	list_for_each_safe(p, n, &be->decompressed_secondary_bvecs) {
912 		struct z_erofs_bvec_item *bvi;
913 		unsigned int end, cur;
914 		void *dst, *src;
915 
916 		bvi = container_of(p, struct z_erofs_bvec_item, list);
917 		cur = bvi->bvec.offset < 0 ? -bvi->bvec.offset : 0;
918 		end = min_t(unsigned int, be->pcl->length - bvi->bvec.offset,
919 			    bvi->bvec.end);
920 		dst = kmap_local_page(bvi->bvec.page);
921 		while (cur < end) {
922 			unsigned int pgnr, scur, len;
923 
924 			pgnr = (bvi->bvec.offset + cur + off0) >> PAGE_SHIFT;
925 			DBG_BUGON(pgnr >= be->nr_pages);
926 
927 			scur = bvi->bvec.offset + cur -
928 					((pgnr << PAGE_SHIFT) - off0);
929 			len = min_t(unsigned int, end - cur, PAGE_SIZE - scur);
930 			if (!be->decompressed_pages[pgnr]) {
931 				err = -EFSCORRUPTED;
932 				cur += len;
933 				continue;
934 			}
935 			src = kmap_local_page(be->decompressed_pages[pgnr]);
936 			memcpy(dst + cur, src + scur, len);
937 			kunmap_local(src);
938 			cur += len;
939 		}
940 		kunmap_local(dst);
941 		if (err)
942 			z_erofs_page_mark_eio(bvi->bvec.page);
943 		z_erofs_onlinepage_endio(bvi->bvec.page);
944 		list_del(p);
945 		kfree(bvi);
946 	}
947 }
948 
949 static void z_erofs_parse_out_bvecs(struct z_erofs_decompress_backend *be)
950 {
951 	struct z_erofs_pcluster *pcl = be->pcl;
952 	struct z_erofs_bvec_iter biter;
953 	struct page *old_bvpage;
954 	int i;
955 
956 	z_erofs_bvec_iter_begin(&biter, &pcl->bvset, Z_EROFS_INLINE_BVECS, 0);
957 	for (i = 0; i < pcl->vcnt; ++i) {
958 		struct z_erofs_bvec bvec;
959 
960 		z_erofs_bvec_dequeue(&biter, &bvec, &old_bvpage);
961 
962 		if (old_bvpage)
963 			z_erofs_put_shortlivedpage(be->pagepool, old_bvpage);
964 
965 		DBG_BUGON(z_erofs_page_is_invalidated(bvec.page));
966 		z_erofs_do_decompressed_bvec(be, &bvec);
967 	}
968 
969 	old_bvpage = z_erofs_bvec_iter_end(&biter);
970 	if (old_bvpage)
971 		z_erofs_put_shortlivedpage(be->pagepool, old_bvpage);
972 }
973 
974 static int z_erofs_parse_in_bvecs(struct z_erofs_decompress_backend *be,
975 				  bool *overlapped)
976 {
977 	struct z_erofs_pcluster *pcl = be->pcl;
978 	unsigned int pclusterpages = z_erofs_pclusterpages(pcl);
979 	int i, err = 0;
980 
981 	*overlapped = false;
982 	for (i = 0; i < pclusterpages; ++i) {
983 		struct z_erofs_bvec *bvec = &pcl->compressed_bvecs[i];
984 		struct page *page = bvec->page;
985 
986 		/* compressed pages ought to be present before decompressing */
987 		if (!page) {
988 			DBG_BUGON(1);
989 			continue;
990 		}
991 		be->compressed_pages[i] = page;
992 
993 		if (z_erofs_is_inline_pcluster(pcl)) {
994 			if (!PageUptodate(page))
995 				err = -EIO;
996 			continue;
997 		}
998 
999 		DBG_BUGON(z_erofs_page_is_invalidated(page));
1000 		if (!z_erofs_is_shortlived_page(page)) {
1001 			if (erofs_page_is_managed(EROFS_SB(be->sb), page)) {
1002 				if (!PageUptodate(page))
1003 					err = -EIO;
1004 				continue;
1005 			}
1006 			z_erofs_do_decompressed_bvec(be, bvec);
1007 			*overlapped = true;
1008 		}
1009 	}
1010 
1011 	if (err)
1012 		return err;
1013 	return 0;
1014 }
1015 
1016 static int z_erofs_decompress_pcluster(struct z_erofs_decompress_backend *be,
1017 				       int err)
1018 {
1019 	struct erofs_sb_info *const sbi = EROFS_SB(be->sb);
1020 	struct z_erofs_pcluster *pcl = be->pcl;
1021 	unsigned int pclusterpages = z_erofs_pclusterpages(pcl);
1022 	unsigned int i, inputsize;
1023 	int err2;
1024 	struct page *page;
1025 	bool overlapped;
1026 
1027 	mutex_lock(&pcl->lock);
1028 	be->nr_pages = PAGE_ALIGN(pcl->length + pcl->pageofs_out) >> PAGE_SHIFT;
1029 
1030 	/* allocate (de)compressed page arrays if cannot be kept on stack */
1031 	be->decompressed_pages = NULL;
1032 	be->compressed_pages = NULL;
1033 	be->onstack_used = 0;
1034 	if (be->nr_pages <= Z_EROFS_ONSTACK_PAGES) {
1035 		be->decompressed_pages = be->onstack_pages;
1036 		be->onstack_used = be->nr_pages;
1037 		memset(be->decompressed_pages, 0,
1038 		       sizeof(struct page *) * be->nr_pages);
1039 	}
1040 
1041 	if (pclusterpages + be->onstack_used <= Z_EROFS_ONSTACK_PAGES)
1042 		be->compressed_pages = be->onstack_pages + be->onstack_used;
1043 
1044 	if (!be->decompressed_pages)
1045 		be->decompressed_pages =
1046 			kvcalloc(be->nr_pages, sizeof(struct page *),
1047 				 GFP_KERNEL | __GFP_NOFAIL);
1048 	if (!be->compressed_pages)
1049 		be->compressed_pages =
1050 			kvcalloc(pclusterpages, sizeof(struct page *),
1051 				 GFP_KERNEL | __GFP_NOFAIL);
1052 
1053 	z_erofs_parse_out_bvecs(be);
1054 	err2 = z_erofs_parse_in_bvecs(be, &overlapped);
1055 	if (err2)
1056 		err = err2;
1057 	if (err)
1058 		goto out;
1059 
1060 	if (z_erofs_is_inline_pcluster(pcl))
1061 		inputsize = pcl->tailpacking_size;
1062 	else
1063 		inputsize = pclusterpages * PAGE_SIZE;
1064 
1065 	err = z_erofs_decompress(&(struct z_erofs_decompress_req) {
1066 					.sb = be->sb,
1067 					.in = be->compressed_pages,
1068 					.out = be->decompressed_pages,
1069 					.pageofs_in = pcl->pageofs_in,
1070 					.pageofs_out = pcl->pageofs_out,
1071 					.inputsize = inputsize,
1072 					.outputsize = pcl->length,
1073 					.alg = pcl->algorithmformat,
1074 					.inplace_io = overlapped,
1075 					.partial_decoding = pcl->partial,
1076 					.fillgaps = pcl->multibases,
1077 				 }, be->pagepool);
1078 
1079 out:
1080 	/* must handle all compressed pages before actual file pages */
1081 	if (z_erofs_is_inline_pcluster(pcl)) {
1082 		page = pcl->compressed_bvecs[0].page;
1083 		WRITE_ONCE(pcl->compressed_bvecs[0].page, NULL);
1084 		put_page(page);
1085 	} else {
1086 		for (i = 0; i < pclusterpages; ++i) {
1087 			page = pcl->compressed_bvecs[i].page;
1088 
1089 			if (erofs_page_is_managed(sbi, page))
1090 				continue;
1091 
1092 			/* recycle all individual short-lived pages */
1093 			(void)z_erofs_put_shortlivedpage(be->pagepool, page);
1094 			WRITE_ONCE(pcl->compressed_bvecs[i].page, NULL);
1095 		}
1096 	}
1097 	if (be->compressed_pages < be->onstack_pages ||
1098 	    be->compressed_pages >= be->onstack_pages + Z_EROFS_ONSTACK_PAGES)
1099 		kvfree(be->compressed_pages);
1100 	z_erofs_fill_other_copies(be, err);
1101 
1102 	for (i = 0; i < be->nr_pages; ++i) {
1103 		page = be->decompressed_pages[i];
1104 		if (!page)
1105 			continue;
1106 
1107 		DBG_BUGON(z_erofs_page_is_invalidated(page));
1108 
1109 		/* recycle all individual short-lived pages */
1110 		if (z_erofs_put_shortlivedpage(be->pagepool, page))
1111 			continue;
1112 		if (err)
1113 			z_erofs_page_mark_eio(page);
1114 		z_erofs_onlinepage_endio(page);
1115 	}
1116 
1117 	if (be->decompressed_pages != be->onstack_pages)
1118 		kvfree(be->decompressed_pages);
1119 
1120 	pcl->length = 0;
1121 	pcl->partial = true;
1122 	pcl->multibases = false;
1123 	pcl->bvset.nextpage = NULL;
1124 	pcl->vcnt = 0;
1125 
1126 	/* pcluster lock MUST be taken before the following line */
1127 	WRITE_ONCE(pcl->next, Z_EROFS_PCLUSTER_NIL);
1128 	mutex_unlock(&pcl->lock);
1129 	return err;
1130 }
1131 
1132 static void z_erofs_decompress_queue(const struct z_erofs_decompressqueue *io,
1133 				     struct page **pagepool)
1134 {
1135 	struct z_erofs_decompress_backend be = {
1136 		.sb = io->sb,
1137 		.pagepool = pagepool,
1138 		.decompressed_secondary_bvecs =
1139 			LIST_HEAD_INIT(be.decompressed_secondary_bvecs),
1140 	};
1141 	z_erofs_next_pcluster_t owned = io->head;
1142 
1143 	while (owned != Z_EROFS_PCLUSTER_TAIL_CLOSED) {
1144 		/* impossible that 'owned' equals Z_EROFS_WORK_TPTR_TAIL */
1145 		DBG_BUGON(owned == Z_EROFS_PCLUSTER_TAIL);
1146 		/* impossible that 'owned' equals Z_EROFS_PCLUSTER_NIL */
1147 		DBG_BUGON(owned == Z_EROFS_PCLUSTER_NIL);
1148 
1149 		be.pcl = container_of(owned, struct z_erofs_pcluster, next);
1150 		owned = READ_ONCE(be.pcl->next);
1151 
1152 		z_erofs_decompress_pcluster(&be, io->eio ? -EIO : 0);
1153 		erofs_workgroup_put(&be.pcl->obj);
1154 	}
1155 }
1156 
1157 static void z_erofs_decompressqueue_work(struct work_struct *work)
1158 {
1159 	struct z_erofs_decompressqueue *bgq =
1160 		container_of(work, struct z_erofs_decompressqueue, u.work);
1161 	struct page *pagepool = NULL;
1162 
1163 	DBG_BUGON(bgq->head == Z_EROFS_PCLUSTER_TAIL_CLOSED);
1164 	z_erofs_decompress_queue(bgq, &pagepool);
1165 
1166 	erofs_release_pages(&pagepool);
1167 	kvfree(bgq);
1168 }
1169 
1170 static void z_erofs_decompress_kickoff(struct z_erofs_decompressqueue *io,
1171 				       bool sync, int bios)
1172 {
1173 	struct erofs_sb_info *const sbi = EROFS_SB(io->sb);
1174 
1175 	/* wake up the caller thread for sync decompression */
1176 	if (sync) {
1177 		if (!atomic_add_return(bios, &io->pending_bios))
1178 			complete(&io->u.done);
1179 		return;
1180 	}
1181 
1182 	if (atomic_add_return(bios, &io->pending_bios))
1183 		return;
1184 	/* Use workqueue and sync decompression for atomic contexts only */
1185 	if (in_atomic() || irqs_disabled()) {
1186 		queue_work(z_erofs_workqueue, &io->u.work);
1187 		/* enable sync decompression for readahead */
1188 		if (sbi->opt.sync_decompress == EROFS_SYNC_DECOMPRESS_AUTO)
1189 			sbi->opt.sync_decompress = EROFS_SYNC_DECOMPRESS_FORCE_ON;
1190 		return;
1191 	}
1192 	z_erofs_decompressqueue_work(&io->u.work);
1193 }
1194 
1195 static struct page *pickup_page_for_submission(struct z_erofs_pcluster *pcl,
1196 					       unsigned int nr,
1197 					       struct page **pagepool,
1198 					       struct address_space *mc)
1199 {
1200 	const pgoff_t index = pcl->obj.index;
1201 	gfp_t gfp = mapping_gfp_mask(mc);
1202 	bool tocache = false;
1203 
1204 	struct address_space *mapping;
1205 	struct page *oldpage, *page;
1206 
1207 	compressed_page_t t;
1208 	int justfound;
1209 
1210 repeat:
1211 	page = READ_ONCE(pcl->compressed_bvecs[nr].page);
1212 	oldpage = page;
1213 
1214 	if (!page)
1215 		goto out_allocpage;
1216 
1217 	/* process the target tagged pointer */
1218 	t = tagptr_init(compressed_page_t, page);
1219 	justfound = tagptr_unfold_tags(t);
1220 	page = tagptr_unfold_ptr(t);
1221 
1222 	/*
1223 	 * preallocated cached pages, which is used to avoid direct reclaim
1224 	 * otherwise, it will go inplace I/O path instead.
1225 	 */
1226 	if (page->private == Z_EROFS_PREALLOCATED_PAGE) {
1227 		WRITE_ONCE(pcl->compressed_bvecs[nr].page, page);
1228 		set_page_private(page, 0);
1229 		tocache = true;
1230 		goto out_tocache;
1231 	}
1232 	mapping = READ_ONCE(page->mapping);
1233 
1234 	/*
1235 	 * file-backed online pages in plcuster are all locked steady,
1236 	 * therefore it is impossible for `mapping' to be NULL.
1237 	 */
1238 	if (mapping && mapping != mc)
1239 		/* ought to be unmanaged pages */
1240 		goto out;
1241 
1242 	/* directly return for shortlived page as well */
1243 	if (z_erofs_is_shortlived_page(page))
1244 		goto out;
1245 
1246 	lock_page(page);
1247 
1248 	/* only true if page reclaim goes wrong, should never happen */
1249 	DBG_BUGON(justfound && PagePrivate(page));
1250 
1251 	/* the page is still in manage cache */
1252 	if (page->mapping == mc) {
1253 		WRITE_ONCE(pcl->compressed_bvecs[nr].page, page);
1254 
1255 		if (!PagePrivate(page)) {
1256 			/*
1257 			 * impossible to be !PagePrivate(page) for
1258 			 * the current restriction as well if
1259 			 * the page is already in compressed_bvecs[].
1260 			 */
1261 			DBG_BUGON(!justfound);
1262 
1263 			justfound = 0;
1264 			set_page_private(page, (unsigned long)pcl);
1265 			SetPagePrivate(page);
1266 		}
1267 
1268 		/* no need to submit io if it is already up-to-date */
1269 		if (PageUptodate(page)) {
1270 			unlock_page(page);
1271 			page = NULL;
1272 		}
1273 		goto out;
1274 	}
1275 
1276 	/*
1277 	 * the managed page has been truncated, it's unsafe to
1278 	 * reuse this one, let's allocate a new cache-managed page.
1279 	 */
1280 	DBG_BUGON(page->mapping);
1281 	DBG_BUGON(!justfound);
1282 
1283 	tocache = true;
1284 	unlock_page(page);
1285 	put_page(page);
1286 out_allocpage:
1287 	page = erofs_allocpage(pagepool, gfp | __GFP_NOFAIL);
1288 	if (oldpage != cmpxchg(&pcl->compressed_bvecs[nr].page,
1289 			       oldpage, page)) {
1290 		erofs_pagepool_add(pagepool, page);
1291 		cond_resched();
1292 		goto repeat;
1293 	}
1294 out_tocache:
1295 	if (!tocache || add_to_page_cache_lru(page, mc, index + nr, gfp)) {
1296 		/* turn into temporary page if fails (1 ref) */
1297 		set_page_private(page, Z_EROFS_SHORTLIVED_PAGE);
1298 		goto out;
1299 	}
1300 	attach_page_private(page, pcl);
1301 	/* drop a refcount added by allocpage (then we have 2 refs here) */
1302 	put_page(page);
1303 
1304 out:	/* the only exit (for tracing and debugging) */
1305 	return page;
1306 }
1307 
1308 static struct z_erofs_decompressqueue *
1309 jobqueue_init(struct super_block *sb,
1310 	      struct z_erofs_decompressqueue *fgq, bool *fg)
1311 {
1312 	struct z_erofs_decompressqueue *q;
1313 
1314 	if (fg && !*fg) {
1315 		q = kvzalloc(sizeof(*q), GFP_KERNEL | __GFP_NOWARN);
1316 		if (!q) {
1317 			*fg = true;
1318 			goto fg_out;
1319 		}
1320 		INIT_WORK(&q->u.work, z_erofs_decompressqueue_work);
1321 	} else {
1322 fg_out:
1323 		q = fgq;
1324 		init_completion(&fgq->u.done);
1325 		atomic_set(&fgq->pending_bios, 0);
1326 		q->eio = false;
1327 	}
1328 	q->sb = sb;
1329 	q->head = Z_EROFS_PCLUSTER_TAIL_CLOSED;
1330 	return q;
1331 }
1332 
1333 /* define decompression jobqueue types */
1334 enum {
1335 	JQ_BYPASS,
1336 	JQ_SUBMIT,
1337 	NR_JOBQUEUES,
1338 };
1339 
1340 static void *jobqueueset_init(struct super_block *sb,
1341 			      struct z_erofs_decompressqueue *q[],
1342 			      struct z_erofs_decompressqueue *fgq, bool *fg)
1343 {
1344 	/*
1345 	 * if managed cache is enabled, bypass jobqueue is needed,
1346 	 * no need to read from device for all pclusters in this queue.
1347 	 */
1348 	q[JQ_BYPASS] = jobqueue_init(sb, fgq + JQ_BYPASS, NULL);
1349 	q[JQ_SUBMIT] = jobqueue_init(sb, fgq + JQ_SUBMIT, fg);
1350 
1351 	return tagptr_cast_ptr(tagptr_fold(tagptr1_t, q[JQ_SUBMIT], *fg));
1352 }
1353 
1354 static void move_to_bypass_jobqueue(struct z_erofs_pcluster *pcl,
1355 				    z_erofs_next_pcluster_t qtail[],
1356 				    z_erofs_next_pcluster_t owned_head)
1357 {
1358 	z_erofs_next_pcluster_t *const submit_qtail = qtail[JQ_SUBMIT];
1359 	z_erofs_next_pcluster_t *const bypass_qtail = qtail[JQ_BYPASS];
1360 
1361 	DBG_BUGON(owned_head == Z_EROFS_PCLUSTER_TAIL_CLOSED);
1362 	if (owned_head == Z_EROFS_PCLUSTER_TAIL)
1363 		owned_head = Z_EROFS_PCLUSTER_TAIL_CLOSED;
1364 
1365 	WRITE_ONCE(pcl->next, Z_EROFS_PCLUSTER_TAIL_CLOSED);
1366 
1367 	WRITE_ONCE(*submit_qtail, owned_head);
1368 	WRITE_ONCE(*bypass_qtail, &pcl->next);
1369 
1370 	qtail[JQ_BYPASS] = &pcl->next;
1371 }
1372 
1373 static void z_erofs_decompressqueue_endio(struct bio *bio)
1374 {
1375 	tagptr1_t t = tagptr_init(tagptr1_t, bio->bi_private);
1376 	struct z_erofs_decompressqueue *q = tagptr_unfold_ptr(t);
1377 	blk_status_t err = bio->bi_status;
1378 	struct bio_vec *bvec;
1379 	struct bvec_iter_all iter_all;
1380 
1381 	bio_for_each_segment_all(bvec, bio, iter_all) {
1382 		struct page *page = bvec->bv_page;
1383 
1384 		DBG_BUGON(PageUptodate(page));
1385 		DBG_BUGON(z_erofs_page_is_invalidated(page));
1386 
1387 		if (erofs_page_is_managed(EROFS_SB(q->sb), page)) {
1388 			if (!err)
1389 				SetPageUptodate(page);
1390 			unlock_page(page);
1391 		}
1392 	}
1393 	if (err)
1394 		q->eio = true;
1395 	z_erofs_decompress_kickoff(q, tagptr_unfold_tags(t), -1);
1396 	bio_put(bio);
1397 }
1398 
1399 static void z_erofs_submit_queue(struct z_erofs_decompress_frontend *f,
1400 				 struct page **pagepool,
1401 				 struct z_erofs_decompressqueue *fgq,
1402 				 bool *force_fg)
1403 {
1404 	struct super_block *sb = f->inode->i_sb;
1405 	struct address_space *mc = MNGD_MAPPING(EROFS_SB(sb));
1406 	z_erofs_next_pcluster_t qtail[NR_JOBQUEUES];
1407 	struct z_erofs_decompressqueue *q[NR_JOBQUEUES];
1408 	void *bi_private;
1409 	z_erofs_next_pcluster_t owned_head = f->owned_head;
1410 	/* bio is NULL initially, so no need to initialize last_{index,bdev} */
1411 	pgoff_t last_index;
1412 	struct block_device *last_bdev;
1413 	unsigned int nr_bios = 0;
1414 	struct bio *bio = NULL;
1415 	unsigned long pflags;
1416 	int memstall = 0;
1417 
1418 	bi_private = jobqueueset_init(sb, q, fgq, force_fg);
1419 	qtail[JQ_BYPASS] = &q[JQ_BYPASS]->head;
1420 	qtail[JQ_SUBMIT] = &q[JQ_SUBMIT]->head;
1421 
1422 	/* by default, all need io submission */
1423 	q[JQ_SUBMIT]->head = owned_head;
1424 
1425 	do {
1426 		struct erofs_map_dev mdev;
1427 		struct z_erofs_pcluster *pcl;
1428 		pgoff_t cur, end;
1429 		unsigned int i = 0;
1430 		bool bypass = true;
1431 
1432 		/* no possible 'owned_head' equals the following */
1433 		DBG_BUGON(owned_head == Z_EROFS_PCLUSTER_TAIL_CLOSED);
1434 		DBG_BUGON(owned_head == Z_EROFS_PCLUSTER_NIL);
1435 
1436 		pcl = container_of(owned_head, struct z_erofs_pcluster, next);
1437 
1438 		/* close the main owned chain at first */
1439 		owned_head = cmpxchg(&pcl->next, Z_EROFS_PCLUSTER_TAIL,
1440 				     Z_EROFS_PCLUSTER_TAIL_CLOSED);
1441 		if (z_erofs_is_inline_pcluster(pcl)) {
1442 			move_to_bypass_jobqueue(pcl, qtail, owned_head);
1443 			continue;
1444 		}
1445 
1446 		/* no device id here, thus it will always succeed */
1447 		mdev = (struct erofs_map_dev) {
1448 			.m_pa = blknr_to_addr(pcl->obj.index),
1449 		};
1450 		(void)erofs_map_dev(sb, &mdev);
1451 
1452 		cur = erofs_blknr(mdev.m_pa);
1453 		end = cur + pcl->pclusterpages;
1454 
1455 		do {
1456 			struct page *page;
1457 
1458 			page = pickup_page_for_submission(pcl, i++, pagepool,
1459 							  mc);
1460 			if (!page)
1461 				continue;
1462 
1463 			if (bio && (cur != last_index + 1 ||
1464 				    last_bdev != mdev.m_bdev)) {
1465 submit_bio_retry:
1466 				submit_bio(bio);
1467 				if (memstall) {
1468 					psi_memstall_leave(&pflags);
1469 					memstall = 0;
1470 				}
1471 				bio = NULL;
1472 			}
1473 
1474 			if (unlikely(PageWorkingset(page)) && !memstall) {
1475 				psi_memstall_enter(&pflags);
1476 				memstall = 1;
1477 			}
1478 
1479 			if (!bio) {
1480 				bio = bio_alloc(mdev.m_bdev, BIO_MAX_VECS,
1481 						REQ_OP_READ, GFP_NOIO);
1482 				bio->bi_end_io = z_erofs_decompressqueue_endio;
1483 
1484 				last_bdev = mdev.m_bdev;
1485 				bio->bi_iter.bi_sector = (sector_t)cur <<
1486 					LOG_SECTORS_PER_BLOCK;
1487 				bio->bi_private = bi_private;
1488 				if (f->readahead)
1489 					bio->bi_opf |= REQ_RAHEAD;
1490 				++nr_bios;
1491 			}
1492 
1493 			if (bio_add_page(bio, page, PAGE_SIZE, 0) < PAGE_SIZE)
1494 				goto submit_bio_retry;
1495 
1496 			last_index = cur;
1497 			bypass = false;
1498 		} while (++cur < end);
1499 
1500 		if (!bypass)
1501 			qtail[JQ_SUBMIT] = &pcl->next;
1502 		else
1503 			move_to_bypass_jobqueue(pcl, qtail, owned_head);
1504 	} while (owned_head != Z_EROFS_PCLUSTER_TAIL);
1505 
1506 	if (bio) {
1507 		submit_bio(bio);
1508 		if (memstall)
1509 			psi_memstall_leave(&pflags);
1510 	}
1511 
1512 	/*
1513 	 * although background is preferred, no one is pending for submission.
1514 	 * don't issue workqueue for decompression but drop it directly instead.
1515 	 */
1516 	if (!*force_fg && !nr_bios) {
1517 		kvfree(q[JQ_SUBMIT]);
1518 		return;
1519 	}
1520 	z_erofs_decompress_kickoff(q[JQ_SUBMIT], *force_fg, nr_bios);
1521 }
1522 
1523 static void z_erofs_runqueue(struct z_erofs_decompress_frontend *f,
1524 			     struct page **pagepool, bool force_fg)
1525 {
1526 	struct z_erofs_decompressqueue io[NR_JOBQUEUES];
1527 
1528 	if (f->owned_head == Z_EROFS_PCLUSTER_TAIL)
1529 		return;
1530 	z_erofs_submit_queue(f, pagepool, io, &force_fg);
1531 
1532 	/* handle bypass queue (no i/o pclusters) immediately */
1533 	z_erofs_decompress_queue(&io[JQ_BYPASS], pagepool);
1534 
1535 	if (!force_fg)
1536 		return;
1537 
1538 	/* wait until all bios are completed */
1539 	wait_for_completion_io(&io[JQ_SUBMIT].u.done);
1540 
1541 	/* handle synchronous decompress queue in the caller context */
1542 	z_erofs_decompress_queue(&io[JQ_SUBMIT], pagepool);
1543 }
1544 
1545 /*
1546  * Since partial uptodate is still unimplemented for now, we have to use
1547  * approximate readmore strategies as a start.
1548  */
1549 static void z_erofs_pcluster_readmore(struct z_erofs_decompress_frontend *f,
1550 				      struct readahead_control *rac,
1551 				      erofs_off_t end,
1552 				      struct page **pagepool,
1553 				      bool backmost)
1554 {
1555 	struct inode *inode = f->inode;
1556 	struct erofs_map_blocks *map = &f->map;
1557 	erofs_off_t cur;
1558 	int err;
1559 
1560 	if (backmost) {
1561 		map->m_la = end;
1562 		err = z_erofs_map_blocks_iter(inode, map,
1563 					      EROFS_GET_BLOCKS_READMORE);
1564 		if (err)
1565 			return;
1566 
1567 		/* expend ra for the trailing edge if readahead */
1568 		if (rac) {
1569 			loff_t newstart = readahead_pos(rac);
1570 
1571 			cur = round_up(map->m_la + map->m_llen, PAGE_SIZE);
1572 			readahead_expand(rac, newstart, cur - newstart);
1573 			return;
1574 		}
1575 		end = round_up(end, PAGE_SIZE);
1576 	} else {
1577 		end = round_up(map->m_la, PAGE_SIZE);
1578 
1579 		if (!map->m_llen)
1580 			return;
1581 	}
1582 
1583 	cur = map->m_la + map->m_llen - 1;
1584 	while (cur >= end) {
1585 		pgoff_t index = cur >> PAGE_SHIFT;
1586 		struct page *page;
1587 
1588 		page = erofs_grab_cache_page_nowait(inode->i_mapping, index);
1589 		if (page) {
1590 			if (PageUptodate(page)) {
1591 				unlock_page(page);
1592 			} else {
1593 				err = z_erofs_do_read_page(f, page, pagepool);
1594 				if (err)
1595 					erofs_err(inode->i_sb,
1596 						  "readmore error at page %lu @ nid %llu",
1597 						  index, EROFS_I(inode)->nid);
1598 			}
1599 			put_page(page);
1600 		}
1601 
1602 		if (cur < PAGE_SIZE)
1603 			break;
1604 		cur = (index << PAGE_SHIFT) - 1;
1605 	}
1606 }
1607 
1608 static int z_erofs_read_folio(struct file *file, struct folio *folio)
1609 {
1610 	struct page *page = &folio->page;
1611 	struct inode *const inode = page->mapping->host;
1612 	struct erofs_sb_info *const sbi = EROFS_I_SB(inode);
1613 	struct z_erofs_decompress_frontend f = DECOMPRESS_FRONTEND_INIT(inode);
1614 	struct page *pagepool = NULL;
1615 	int err;
1616 
1617 	trace_erofs_readpage(page, false);
1618 	f.headoffset = (erofs_off_t)page->index << PAGE_SHIFT;
1619 
1620 	z_erofs_pcluster_readmore(&f, NULL, f.headoffset + PAGE_SIZE - 1,
1621 				  &pagepool, true);
1622 	err = z_erofs_do_read_page(&f, page, &pagepool);
1623 	z_erofs_pcluster_readmore(&f, NULL, 0, &pagepool, false);
1624 
1625 	(void)z_erofs_collector_end(&f);
1626 
1627 	/* if some compressed cluster ready, need submit them anyway */
1628 	z_erofs_runqueue(&f, &pagepool,
1629 			 z_erofs_get_sync_decompress_policy(sbi, 0));
1630 
1631 	if (err)
1632 		erofs_err(inode->i_sb, "failed to read, err [%d]", err);
1633 
1634 	erofs_put_metabuf(&f.map.buf);
1635 	erofs_release_pages(&pagepool);
1636 	return err;
1637 }
1638 
1639 static void z_erofs_readahead(struct readahead_control *rac)
1640 {
1641 	struct inode *const inode = rac->mapping->host;
1642 	struct erofs_sb_info *const sbi = EROFS_I_SB(inode);
1643 	struct z_erofs_decompress_frontend f = DECOMPRESS_FRONTEND_INIT(inode);
1644 	struct page *pagepool = NULL, *head = NULL, *page;
1645 	unsigned int nr_pages;
1646 
1647 	f.readahead = true;
1648 	f.headoffset = readahead_pos(rac);
1649 
1650 	z_erofs_pcluster_readmore(&f, rac, f.headoffset +
1651 				  readahead_length(rac) - 1, &pagepool, true);
1652 	nr_pages = readahead_count(rac);
1653 	trace_erofs_readpages(inode, readahead_index(rac), nr_pages, false);
1654 
1655 	while ((page = readahead_page(rac))) {
1656 		set_page_private(page, (unsigned long)head);
1657 		head = page;
1658 	}
1659 
1660 	while (head) {
1661 		struct page *page = head;
1662 		int err;
1663 
1664 		/* traversal in reverse order */
1665 		head = (void *)page_private(page);
1666 
1667 		err = z_erofs_do_read_page(&f, page, &pagepool);
1668 		if (err)
1669 			erofs_err(inode->i_sb,
1670 				  "readahead error at page %lu @ nid %llu",
1671 				  page->index, EROFS_I(inode)->nid);
1672 		put_page(page);
1673 	}
1674 	z_erofs_pcluster_readmore(&f, rac, 0, &pagepool, false);
1675 	(void)z_erofs_collector_end(&f);
1676 
1677 	z_erofs_runqueue(&f, &pagepool,
1678 			 z_erofs_get_sync_decompress_policy(sbi, nr_pages));
1679 	erofs_put_metabuf(&f.map.buf);
1680 	erofs_release_pages(&pagepool);
1681 }
1682 
1683 const struct address_space_operations z_erofs_aops = {
1684 	.read_folio = z_erofs_read_folio,
1685 	.readahead = z_erofs_readahead,
1686 };
1687