xref: /OK3568_Linux_fs/kernel/fs/9p/vfs_dir.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * linux/fs/9p/vfs_dir.c
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * This file contains vfs directory ops for the 9P2000 protocol.
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  *  Copyright (C) 2004 by Eric Van Hensbergen <ericvh@gmail.com>
8*4882a593Smuzhiyun  *  Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <linux/module.h>
12*4882a593Smuzhiyun #include <linux/errno.h>
13*4882a593Smuzhiyun #include <linux/fs.h>
14*4882a593Smuzhiyun #include <linux/file.h>
15*4882a593Smuzhiyun #include <linux/stat.h>
16*4882a593Smuzhiyun #include <linux/string.h>
17*4882a593Smuzhiyun #include <linux/sched.h>
18*4882a593Smuzhiyun #include <linux/inet.h>
19*4882a593Smuzhiyun #include <linux/idr.h>
20*4882a593Smuzhiyun #include <linux/slab.h>
21*4882a593Smuzhiyun #include <linux/uio.h>
22*4882a593Smuzhiyun #include <net/9p/9p.h>
23*4882a593Smuzhiyun #include <net/9p/client.h>
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun #include "v9fs.h"
26*4882a593Smuzhiyun #include "v9fs_vfs.h"
27*4882a593Smuzhiyun #include "fid.h"
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun /**
30*4882a593Smuzhiyun  * struct p9_rdir - readdir accounting
31*4882a593Smuzhiyun  * @head: start offset of current dirread buffer
32*4882a593Smuzhiyun  * @tail: end offset of current dirread buffer
33*4882a593Smuzhiyun  * @buf: dirread buffer
34*4882a593Smuzhiyun  *
35*4882a593Smuzhiyun  * private structure for keeping track of readdir
36*4882a593Smuzhiyun  * allocated on demand
37*4882a593Smuzhiyun  */
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun struct p9_rdir {
40*4882a593Smuzhiyun 	int head;
41*4882a593Smuzhiyun 	int tail;
42*4882a593Smuzhiyun 	uint8_t buf[];
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun /**
46*4882a593Smuzhiyun  * dt_type - return file type
47*4882a593Smuzhiyun  * @mistat: mistat structure
48*4882a593Smuzhiyun  *
49*4882a593Smuzhiyun  */
50*4882a593Smuzhiyun 
dt_type(struct p9_wstat * mistat)51*4882a593Smuzhiyun static inline int dt_type(struct p9_wstat *mistat)
52*4882a593Smuzhiyun {
53*4882a593Smuzhiyun 	unsigned long perm = mistat->mode;
54*4882a593Smuzhiyun 	int rettype = DT_REG;
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun 	if (perm & P9_DMDIR)
57*4882a593Smuzhiyun 		rettype = DT_DIR;
58*4882a593Smuzhiyun 	if (perm & P9_DMSYMLINK)
59*4882a593Smuzhiyun 		rettype = DT_LNK;
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun 	return rettype;
62*4882a593Smuzhiyun }
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun /**
65*4882a593Smuzhiyun  * v9fs_alloc_rdir_buf - Allocate buffer used for read and readdir
66*4882a593Smuzhiyun  * @filp: opened file structure
67*4882a593Smuzhiyun  * @buflen: Length in bytes of buffer to allocate
68*4882a593Smuzhiyun  *
69*4882a593Smuzhiyun  */
70*4882a593Smuzhiyun 
v9fs_alloc_rdir_buf(struct file * filp,int buflen)71*4882a593Smuzhiyun static struct p9_rdir *v9fs_alloc_rdir_buf(struct file *filp, int buflen)
72*4882a593Smuzhiyun {
73*4882a593Smuzhiyun 	struct p9_fid *fid = filp->private_data;
74*4882a593Smuzhiyun 	if (!fid->rdir)
75*4882a593Smuzhiyun 		fid->rdir = kzalloc(sizeof(struct p9_rdir) + buflen, GFP_KERNEL);
76*4882a593Smuzhiyun 	return fid->rdir;
77*4882a593Smuzhiyun }
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun /**
80*4882a593Smuzhiyun  * v9fs_dir_readdir - iterate through a directory
81*4882a593Smuzhiyun  * @file: opened file structure
82*4882a593Smuzhiyun  * @ctx: actor we feed the entries to
83*4882a593Smuzhiyun  *
84*4882a593Smuzhiyun  */
85*4882a593Smuzhiyun 
v9fs_dir_readdir(struct file * file,struct dir_context * ctx)86*4882a593Smuzhiyun static int v9fs_dir_readdir(struct file *file, struct dir_context *ctx)
87*4882a593Smuzhiyun {
88*4882a593Smuzhiyun 	bool over;
89*4882a593Smuzhiyun 	struct p9_wstat st;
90*4882a593Smuzhiyun 	int err = 0;
91*4882a593Smuzhiyun 	struct p9_fid *fid;
92*4882a593Smuzhiyun 	int buflen;
93*4882a593Smuzhiyun 	struct p9_rdir *rdir;
94*4882a593Smuzhiyun 	struct kvec kvec;
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun 	p9_debug(P9_DEBUG_VFS, "name %pD\n", file);
97*4882a593Smuzhiyun 	fid = file->private_data;
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun 	buflen = fid->clnt->msize - P9_IOHDRSZ;
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun 	rdir = v9fs_alloc_rdir_buf(file, buflen);
102*4882a593Smuzhiyun 	if (!rdir)
103*4882a593Smuzhiyun 		return -ENOMEM;
104*4882a593Smuzhiyun 	kvec.iov_base = rdir->buf;
105*4882a593Smuzhiyun 	kvec.iov_len = buflen;
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 	while (1) {
108*4882a593Smuzhiyun 		if (rdir->tail == rdir->head) {
109*4882a593Smuzhiyun 			struct iov_iter to;
110*4882a593Smuzhiyun 			int n;
111*4882a593Smuzhiyun 			iov_iter_kvec(&to, READ, &kvec, 1, buflen);
112*4882a593Smuzhiyun 			n = p9_client_read(file->private_data, ctx->pos, &to,
113*4882a593Smuzhiyun 					   &err);
114*4882a593Smuzhiyun 			if (err)
115*4882a593Smuzhiyun 				return err;
116*4882a593Smuzhiyun 			if (n == 0)
117*4882a593Smuzhiyun 				return 0;
118*4882a593Smuzhiyun 
119*4882a593Smuzhiyun 			rdir->head = 0;
120*4882a593Smuzhiyun 			rdir->tail = n;
121*4882a593Smuzhiyun 		}
122*4882a593Smuzhiyun 		while (rdir->head < rdir->tail) {
123*4882a593Smuzhiyun 			err = p9stat_read(fid->clnt, rdir->buf + rdir->head,
124*4882a593Smuzhiyun 					  rdir->tail - rdir->head, &st);
125*4882a593Smuzhiyun 			if (err <= 0) {
126*4882a593Smuzhiyun 				p9_debug(P9_DEBUG_VFS, "returned %d\n", err);
127*4882a593Smuzhiyun 				return -EIO;
128*4882a593Smuzhiyun 			}
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 			over = !dir_emit(ctx, st.name, strlen(st.name),
131*4882a593Smuzhiyun 					 v9fs_qid2ino(&st.qid), dt_type(&st));
132*4882a593Smuzhiyun 			p9stat_free(&st);
133*4882a593Smuzhiyun 			if (over)
134*4882a593Smuzhiyun 				return 0;
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun 			rdir->head += err;
137*4882a593Smuzhiyun 			ctx->pos += err;
138*4882a593Smuzhiyun 		}
139*4882a593Smuzhiyun 	}
140*4882a593Smuzhiyun }
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun /**
143*4882a593Smuzhiyun  * v9fs_dir_readdir_dotl - iterate through a directory
144*4882a593Smuzhiyun  * @file: opened file structure
145*4882a593Smuzhiyun  * @ctx: actor we feed the entries to
146*4882a593Smuzhiyun  *
147*4882a593Smuzhiyun  */
v9fs_dir_readdir_dotl(struct file * file,struct dir_context * ctx)148*4882a593Smuzhiyun static int v9fs_dir_readdir_dotl(struct file *file, struct dir_context *ctx)
149*4882a593Smuzhiyun {
150*4882a593Smuzhiyun 	int err = 0;
151*4882a593Smuzhiyun 	struct p9_fid *fid;
152*4882a593Smuzhiyun 	int buflen;
153*4882a593Smuzhiyun 	struct p9_rdir *rdir;
154*4882a593Smuzhiyun 	struct p9_dirent curdirent;
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun 	p9_debug(P9_DEBUG_VFS, "name %pD\n", file);
157*4882a593Smuzhiyun 	fid = file->private_data;
158*4882a593Smuzhiyun 
159*4882a593Smuzhiyun 	buflen = fid->clnt->msize - P9_READDIRHDRSZ;
160*4882a593Smuzhiyun 
161*4882a593Smuzhiyun 	rdir = v9fs_alloc_rdir_buf(file, buflen);
162*4882a593Smuzhiyun 	if (!rdir)
163*4882a593Smuzhiyun 		return -ENOMEM;
164*4882a593Smuzhiyun 
165*4882a593Smuzhiyun 	while (1) {
166*4882a593Smuzhiyun 		if (rdir->tail == rdir->head) {
167*4882a593Smuzhiyun 			err = p9_client_readdir(fid, rdir->buf, buflen,
168*4882a593Smuzhiyun 						ctx->pos);
169*4882a593Smuzhiyun 			if (err <= 0)
170*4882a593Smuzhiyun 				return err;
171*4882a593Smuzhiyun 
172*4882a593Smuzhiyun 			rdir->head = 0;
173*4882a593Smuzhiyun 			rdir->tail = err;
174*4882a593Smuzhiyun 		}
175*4882a593Smuzhiyun 
176*4882a593Smuzhiyun 		while (rdir->head < rdir->tail) {
177*4882a593Smuzhiyun 
178*4882a593Smuzhiyun 			err = p9dirent_read(fid->clnt, rdir->buf + rdir->head,
179*4882a593Smuzhiyun 					    rdir->tail - rdir->head,
180*4882a593Smuzhiyun 					    &curdirent);
181*4882a593Smuzhiyun 			if (err < 0) {
182*4882a593Smuzhiyun 				p9_debug(P9_DEBUG_VFS, "returned %d\n", err);
183*4882a593Smuzhiyun 				return -EIO;
184*4882a593Smuzhiyun 			}
185*4882a593Smuzhiyun 
186*4882a593Smuzhiyun 			if (!dir_emit(ctx, curdirent.d_name,
187*4882a593Smuzhiyun 				      strlen(curdirent.d_name),
188*4882a593Smuzhiyun 				      v9fs_qid2ino(&curdirent.qid),
189*4882a593Smuzhiyun 				      curdirent.d_type))
190*4882a593Smuzhiyun 				return 0;
191*4882a593Smuzhiyun 
192*4882a593Smuzhiyun 			ctx->pos = curdirent.d_off;
193*4882a593Smuzhiyun 			rdir->head += err;
194*4882a593Smuzhiyun 		}
195*4882a593Smuzhiyun 	}
196*4882a593Smuzhiyun }
197*4882a593Smuzhiyun 
198*4882a593Smuzhiyun 
199*4882a593Smuzhiyun /**
200*4882a593Smuzhiyun  * v9fs_dir_release - close a directory
201*4882a593Smuzhiyun  * @inode: inode of the directory
202*4882a593Smuzhiyun  * @filp: file pointer to a directory
203*4882a593Smuzhiyun  *
204*4882a593Smuzhiyun  */
205*4882a593Smuzhiyun 
v9fs_dir_release(struct inode * inode,struct file * filp)206*4882a593Smuzhiyun int v9fs_dir_release(struct inode *inode, struct file *filp)
207*4882a593Smuzhiyun {
208*4882a593Smuzhiyun 	struct p9_fid *fid;
209*4882a593Smuzhiyun 
210*4882a593Smuzhiyun 	fid = filp->private_data;
211*4882a593Smuzhiyun 	p9_debug(P9_DEBUG_VFS, "inode: %p filp: %p fid: %d\n",
212*4882a593Smuzhiyun 		 inode, filp, fid ? fid->fid : -1);
213*4882a593Smuzhiyun 	if (fid)
214*4882a593Smuzhiyun 		p9_client_clunk(fid);
215*4882a593Smuzhiyun 	return 0;
216*4882a593Smuzhiyun }
217*4882a593Smuzhiyun 
218*4882a593Smuzhiyun const struct file_operations v9fs_dir_operations = {
219*4882a593Smuzhiyun 	.read = generic_read_dir,
220*4882a593Smuzhiyun 	.llseek = generic_file_llseek,
221*4882a593Smuzhiyun 	.iterate_shared = v9fs_dir_readdir,
222*4882a593Smuzhiyun 	.open = v9fs_file_open,
223*4882a593Smuzhiyun 	.release = v9fs_dir_release,
224*4882a593Smuzhiyun };
225*4882a593Smuzhiyun 
226*4882a593Smuzhiyun const struct file_operations v9fs_dir_operations_dotl = {
227*4882a593Smuzhiyun 	.read = generic_read_dir,
228*4882a593Smuzhiyun 	.llseek = generic_file_llseek,
229*4882a593Smuzhiyun 	.iterate_shared = v9fs_dir_readdir_dotl,
230*4882a593Smuzhiyun 	.open = v9fs_file_open,
231*4882a593Smuzhiyun 	.release = v9fs_dir_release,
232*4882a593Smuzhiyun         .fsync = v9fs_file_fsync_dotl,
233*4882a593Smuzhiyun };
234