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
|
/* SPDX-License-Identifier: GPL-2.0+ OR Apache-2.0 */
#ifndef __EROFS_DIR_H
#define __EROFS_DIR_H
#ifdef __cplusplus
extern "C"
{
#endif
#include "internal.h"
#define EROFS_READDIR_VALID_PNID 0x0001
#define EROFS_READDIR_DOTDOT_FOUND 0x0002
#define EROFS_READDIR_DOT_FOUND 0x0004
#define EROFS_READDIR_ALL_SPECIAL_FOUND \
(EROFS_READDIR_DOTDOT_FOUND | EROFS_READDIR_DOT_FOUND)
struct erofs_dir_context;
/* callback function for iterating over inodes of EROFS */
typedef int (*erofs_readdir_cb)(struct erofs_dir_context *);
/*
* Callers could use a wrapper to contain extra information.
*
* Note that callback can reuse `struct erofs_dir_context' with care
* to avoid stack overflow due to deep recursion:
* - if fsck is true, |pnid|, |flags|, (optional)|cb| SHOULD be saved
* to ensure the original state;
* - if fsck is false, EROFS_READDIR_VALID_PNID SHOULD NOT be
* set if |pnid| is inaccurate.
*
* Another way is to allocate a `struct erofs_dir_context' wraper
* with `struct inode' on heap, and chain them together for
* multi-level traversal to completely avoid recursion.
*
* |dname| may be WITHOUT the trailing '\0' and it's ONLY valid in
* the callback context. |de_namelen| is the exact dirent name length.
*/
struct erofs_dir_context {
/*
* During execution of |erofs_iterate_dir|, the function needs to
* read the values inside |erofs_inode* dir|. So it is important
* that the callback function does not modify struct pointed by
* |dir|. It is OK to repoint |dir| to other objects.
* Unfortunately, it's not possible to enforce this restriction
* with const keyword, as |erofs_iterate_dir| needs to modify
* struct pointed by |dir|.
*/
struct erofs_inode *dir;
erofs_readdir_cb cb;
erofs_nid_t pnid; /* optional */
/* [OUT] the dirent which is under processing */
const char *dname; /* please see the comment above */
erofs_nid_t de_nid;
u8 de_namelen, de_ftype, flags;
bool dot_dotdot;
};
/* Iterate over inodes that are in directory */
int erofs_iterate_dir(struct erofs_dir_context *ctx, bool fsck);
/* Get a full pathname of the inode NID */
int erofs_get_pathname(struct erofs_sb_info *sbi, erofs_nid_t nid,
char *buf, size_t size);
#ifdef __cplusplus
}
#endif
#endif
|
