1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate * CDDL HEADER START
3*0Sstevel@tonic-gate *
4*0Sstevel@tonic-gate * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate * (the "License"). You may not use this file except in compliance
7*0Sstevel@tonic-gate * with the License.
8*0Sstevel@tonic-gate *
9*0Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate * and limitations under the License.
13*0Sstevel@tonic-gate *
14*0Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate *
20*0Sstevel@tonic-gate * CDDL HEADER END
21*0Sstevel@tonic-gate */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate * Copyright 2005 Sun Microsystems, Inc. All rights reserved.
24*0Sstevel@tonic-gate * Use is subject to license terms.
25*0Sstevel@tonic-gate *
26*0Sstevel@tonic-gate * Stuff relating to NFSv4 directory reading ...
27*0Sstevel@tonic-gate */
28*0Sstevel@tonic-gate
29*0Sstevel@tonic-gate #pragma ident "%Z%%M% %I% %E% SMI"
30*0Sstevel@tonic-gate
31*0Sstevel@tonic-gate #include <rpc/types.h>
32*0Sstevel@tonic-gate #include <rpc/auth.h>
33*0Sstevel@tonic-gate #include <rpc/xdr.h>
34*0Sstevel@tonic-gate #include "clnt.h"
35*0Sstevel@tonic-gate #include <rpc/rpc_msg.h>
36*0Sstevel@tonic-gate #include <sys/t_lock.h>
37*0Sstevel@tonic-gate #include "nfs_inet.h"
38*0Sstevel@tonic-gate #include <rpc/rpc.h>
39*0Sstevel@tonic-gate #include "brpc.h"
40*0Sstevel@tonic-gate #include <rpcsvc/nfs_prot.h>
41*0Sstevel@tonic-gate #include <sys/types.h>
42*0Sstevel@tonic-gate #include <sys/stat.h>
43*0Sstevel@tonic-gate #include <sys/bootvfs.h>
44*0Sstevel@tonic-gate #include <sys/sysmacros.h>
45*0Sstevel@tonic-gate #include "socket_inet.h"
46*0Sstevel@tonic-gate #include <sys/salib.h>
47*0Sstevel@tonic-gate #include <sys/bootdebug.h>
48*0Sstevel@tonic-gate
49*0Sstevel@tonic-gate #define MAXDENTS 16
50*0Sstevel@tonic-gate #define MINSIZ 20
51*0Sstevel@tonic-gate
52*0Sstevel@tonic-gate /*
53*0Sstevel@tonic-gate * Boot needs to be cleaned up to use either dirent32 or dirent64,
54*0Sstevel@tonic-gate * in the meantime use dirent_t and always round to 8 bytes
55*0Sstevel@tonic-gate */
56*0Sstevel@tonic-gate #define BDIRENT_RECLEN(namelen) \
57*0Sstevel@tonic-gate ((offsetof(dirent_t, d_name[0]) + 1 + (namelen) + 7) & ~ 7)
58*0Sstevel@tonic-gate
59*0Sstevel@tonic-gate #define dprintf if (boothowto & RB_DEBUG) printf
60*0Sstevel@tonic-gate
61*0Sstevel@tonic-gate /*
62*0Sstevel@tonic-gate * Get directory entries:
63*0Sstevel@tonic-gate *
64*0Sstevel@tonic-gate * Uses the nfs "READDIR" operation to read directory entries
65*0Sstevel@tonic-gate * into a local buffer. These are then translated into file
66*0Sstevel@tonic-gate * system independent "dirent" structs and returned in the
67*0Sstevel@tonic-gate * caller's buffer. Returns the number of entries converted
68*0Sstevel@tonic-gate * (-1 if there's an error).
69*0Sstevel@tonic-gate *
70*0Sstevel@tonic-gate * Although the xdr functions can allocate memory, we have
71*0Sstevel@tonic-gate * a limited heap so we allocate our own space,
72*0Sstevel@tonic-gate * assuming the worst case of 256 byte names.
73*0Sstevel@tonic-gate * This is a space hog in our local buffer, so we want
74*0Sstevel@tonic-gate * the number of buffers to be small. To make sure we don't
75*0Sstevel@tonic-gate * get more names than we can handle, we tell the rpc
76*0Sstevel@tonic-gate * routine that we only have space for MAXDENT names if
77*0Sstevel@tonic-gate * they are all the minimum size. This keeps the return
78*0Sstevel@tonic-gate * packet unfragmented, but may result in lots of reads
79*0Sstevel@tonic-gate * to process a large directory. Since this is standalone
80*0Sstevel@tonic-gate * we don't worry about speed. With MAXDENTs at 16, the
81*0Sstevel@tonic-gate * local buffer is 4k.
82*0Sstevel@tonic-gate */
83*0Sstevel@tonic-gate
84*0Sstevel@tonic-gate int
nfs4getdents(struct nfs_file * nfp,struct dirent * dep,unsigned size)85*0Sstevel@tonic-gate nfs4getdents(struct nfs_file *nfp, struct dirent *dep, unsigned size)
86*0Sstevel@tonic-gate {
87*0Sstevel@tonic-gate int cnt = 0;
88*0Sstevel@tonic-gate b_entry4_t *ep;
89*0Sstevel@tonic-gate readdir4arg_t readdir_args;
90*0Sstevel@tonic-gate readdir4res_t readdir_res;
91*0Sstevel@tonic-gate attr4_bitmap1_t bitmap1;
92*0Sstevel@tonic-gate enum clnt_stat status;
93*0Sstevel@tonic-gate struct {
94*0Sstevel@tonic-gate b_entry4_t etlist[MAXDENTS];
95*0Sstevel@tonic-gate char names[MAXDENTS][NFS_MAXNAMLEN+1];
96*0Sstevel@tonic-gate } rdbuf;
97*0Sstevel@tonic-gate int j;
98*0Sstevel@tonic-gate struct timeval zero_timeout = {0, 0}; /* default */
99*0Sstevel@tonic-gate utf8string str;
100*0Sstevel@tonic-gate char tagname[] = "inetboot readdir";
101*0Sstevel@tonic-gate
102*0Sstevel@tonic-gate bzero((caddr_t)&readdir_res, sizeof (readdir4res_t));
103*0Sstevel@tonic-gate bzero((caddr_t)&readdir_args, sizeof (readdir4arg_t));
104*0Sstevel@tonic-gate bzero((caddr_t)rdbuf.etlist, sizeof (rdbuf.etlist));
105*0Sstevel@tonic-gate
106*0Sstevel@tonic-gate str.utf8string_len = sizeof (tagname) - 1;
107*0Sstevel@tonic-gate str.utf8string_val = tagname;
108*0Sstevel@tonic-gate
109*0Sstevel@tonic-gate if (nfp->fh.fh4.len > 0)
110*0Sstevel@tonic-gate compound_init(&readdir_args.rd_arg, &str, 0, 2, &nfp->fh.fh4);
111*0Sstevel@tonic-gate else
112*0Sstevel@tonic-gate compound_init(&readdir_args.rd_arg, &str, 0, 2, NULL);
113*0Sstevel@tonic-gate
114*0Sstevel@tonic-gate readdir_args.rd_opreaddir = OP_READDIR;
115*0Sstevel@tonic-gate readdir_args.rd_cookie = nfp->cookie.cookie4;
116*0Sstevel@tonic-gate
117*0Sstevel@tonic-gate while (!readdir_res.rd_eof) {
118*0Sstevel@tonic-gate /*
119*0Sstevel@tonic-gate * Keep issuing nfs calls until EOF is reached on
120*0Sstevel@tonic-gate * the directory or the user buffer is filled.
121*0Sstevel@tonic-gate */
122*0Sstevel@tonic-gate for (j = 0; j < MAXDENTS; j++) {
123*0Sstevel@tonic-gate /*
124*0Sstevel@tonic-gate * Link our buffers together for the benefit of
125*0Sstevel@tonic-gate * XDR. We do this each time we issue the rpc call
126*0Sstevel@tonic-gate * JIC the xdr decode
127*0Sstevel@tonic-gate * routines screw up the linkage!
128*0Sstevel@tonic-gate */
129*0Sstevel@tonic-gate rdbuf.etlist[j].b_name.utf8string_len = NFS_MAXNAMLEN;
130*0Sstevel@tonic-gate rdbuf.etlist[j].b_name.utf8string_val =
131*0Sstevel@tonic-gate rdbuf.names[(MAXDENTS-1) - j];
132*0Sstevel@tonic-gate rdbuf.etlist[j].b_nextentry =
133*0Sstevel@tonic-gate (j < (MAXDENTS-1)) ? &rdbuf.etlist[j+1] : 0;
134*0Sstevel@tonic-gate }
135*0Sstevel@tonic-gate
136*0Sstevel@tonic-gate readdir_res.rd_entries = rdbuf.etlist;
137*0Sstevel@tonic-gate /*
138*0Sstevel@tonic-gate * Cannot give the whole buffer unless every name is
139*0Sstevel@tonic-gate * 256 bytes! Assume the worst case of all 1 byte names.
140*0Sstevel@tonic-gate * This results in MINSIZ bytes/name in the xdr stream.
141*0Sstevel@tonic-gate */
142*0Sstevel@tonic-gate readdir_args.rd_dircount = MAXDENTS * MINSIZ;
143*0Sstevel@tonic-gate readdir_args.rd_maxcount = sizeof (readdir4res_t) +
144*0Sstevel@tonic-gate (MAXDENTS * MINSIZ);
145*0Sstevel@tonic-gate bzero((caddr_t)rdbuf.names, sizeof (rdbuf.names));
146*0Sstevel@tonic-gate
147*0Sstevel@tonic-gate /*
148*0Sstevel@tonic-gate * Set the attr bitmap, so we get the fileid back.
149*0Sstevel@tonic-gate */
150*0Sstevel@tonic-gate bitmap1.word = 0;
151*0Sstevel@tonic-gate bitmap1.bm_fattr4_fileid = 1;
152*0Sstevel@tonic-gate readdir_args.rd_attr_req.b_bitmap_len = 1;
153*0Sstevel@tonic-gate readdir_args.rd_attr_req.b_bitmap_val[0] = bitmap1.word;
154*0Sstevel@tonic-gate
155*0Sstevel@tonic-gate status = CLNT_CALL(root_CLIENT, NFSPROC4_COMPOUND,
156*0Sstevel@tonic-gate xdr_readdir4_args, (caddr_t)&readdir_args,
157*0Sstevel@tonic-gate xdr_readdir4_res, (caddr_t)&readdir_res, zero_timeout);
158*0Sstevel@tonic-gate
159*0Sstevel@tonic-gate if (status != RPC_SUCCESS) {
160*0Sstevel@tonic-gate dprintf("nfs4_getdents: RPC error\n");
161*0Sstevel@tonic-gate return (-1);
162*0Sstevel@tonic-gate }
163*0Sstevel@tonic-gate if (readdir_res.rd_status != NFS4_OK) {
164*0Sstevel@tonic-gate /*
165*0Sstevel@tonic-gate * The most common failure here would be trying to
166*0Sstevel@tonic-gate * issue a getdents call on a non-directory!
167*0Sstevel@tonic-gate */
168*0Sstevel@tonic-gate
169*0Sstevel@tonic-gate nfs4_error(readdir_res.rd_status);
170*0Sstevel@tonic-gate return (-1);
171*0Sstevel@tonic-gate }
172*0Sstevel@tonic-gate
173*0Sstevel@tonic-gate /*
174*0Sstevel@tonic-gate * If we are reading from the beginning of the
175*0Sstevel@tonic-gate * directory we will need to create the "." and ".."
176*0Sstevel@tonic-gate * since we won't be getting them from the server. To obtain
177*0Sstevel@tonic-gate * the fileid's just issue a couple otw lookups to get the
178*0Sstevel@tonic-gate * info we need.
179*0Sstevel@tonic-gate */
180*0Sstevel@tonic-gate if (readdir_args.rd_cookie == 0 &&
181*0Sstevel@tonic-gate rdbuf.etlist[0].b_cookie > 2) {
182*0Sstevel@tonic-gate int n;
183*0Sstevel@tonic-gate int error;
184*0Sstevel@tonic-gate uint64_t fileid;
185*0Sstevel@tonic-gate struct vattr va;
186*0Sstevel@tonic-gate
187*0Sstevel@tonic-gate /*
188*0Sstevel@tonic-gate * Do a getattr for the '.'
189*0Sstevel@tonic-gate */
190*0Sstevel@tonic-gate error = nfs4getattr(nfp, &va);
191*0Sstevel@tonic-gate if (error)
192*0Sstevel@tonic-gate return (-1);
193*0Sstevel@tonic-gate
194*0Sstevel@tonic-gate dep->d_name[0] = '.';
195*0Sstevel@tonic-gate dep->d_name[1] = '\0';
196*0Sstevel@tonic-gate dep->d_ino = va.va_nodeid;
197*0Sstevel@tonic-gate dep->d_off = 1;
198*0Sstevel@tonic-gate n = BDIRENT_RECLEN(1);
199*0Sstevel@tonic-gate dep->d_reclen = n;
200*0Sstevel@tonic-gate dep = (struct dirent *)((char *)dep + n);
201*0Sstevel@tonic-gate
202*0Sstevel@tonic-gate /*
203*0Sstevel@tonic-gate * Do a lookupp for the '..'
204*0Sstevel@tonic-gate */
205*0Sstevel@tonic-gate (void) nfs4lookupp(nfp, &error, &fileid);
206*0Sstevel@tonic-gate if (error)
207*0Sstevel@tonic-gate return (-1);
208*0Sstevel@tonic-gate
209*0Sstevel@tonic-gate dep->d_name[0] = '.';
210*0Sstevel@tonic-gate dep->d_name[1] = '.';
211*0Sstevel@tonic-gate dep->d_name[2] = '\0';
212*0Sstevel@tonic-gate dep->d_ino = fileid;
213*0Sstevel@tonic-gate dep->d_off = 2;
214*0Sstevel@tonic-gate n = BDIRENT_RECLEN(2);
215*0Sstevel@tonic-gate dep->d_reclen = n;
216*0Sstevel@tonic-gate dep = (struct dirent *)((char *)dep + n);
217*0Sstevel@tonic-gate }
218*0Sstevel@tonic-gate
219*0Sstevel@tonic-gate for (ep = rdbuf.etlist; ep; ep = ep->b_nextentry) {
220*0Sstevel@tonic-gate /*
221*0Sstevel@tonic-gate * Step thru all entries returned by NFS, converting
222*0Sstevel@tonic-gate * to the cannonical form and copying out to the
223*0Sstevel@tonic-gate * user's buffer.
224*0Sstevel@tonic-gate */
225*0Sstevel@tonic-gate int n;
226*0Sstevel@tonic-gate int namlen;
227*0Sstevel@tonic-gate
228*0Sstevel@tonic-gate /*
229*0Sstevel@tonic-gate * catch the case user called at EOF
230*0Sstevel@tonic-gate */
231*0Sstevel@tonic-gate if ((namlen = ep->b_name.utf8string_len) == 0)
232*0Sstevel@tonic-gate return (cnt);
233*0Sstevel@tonic-gate
234*0Sstevel@tonic-gate n = BDIRENT_RECLEN(namlen);
235*0Sstevel@tonic-gate
236*0Sstevel@tonic-gate if (n > size)
237*0Sstevel@tonic-gate return (cnt);
238*0Sstevel@tonic-gate size -= n;
239*0Sstevel@tonic-gate
240*0Sstevel@tonic-gate bcopy(ep->b_name.utf8string_val, dep->d_name, namlen);
241*0Sstevel@tonic-gate dep->d_name[namlen] = '\0';
242*0Sstevel@tonic-gate dep->d_ino = ep->b_fileid;
243*0Sstevel@tonic-gate dep->d_off = (off_t)ep->b_cookie;
244*0Sstevel@tonic-gate dep->d_reclen = (ushort_t)n;
245*0Sstevel@tonic-gate
246*0Sstevel@tonic-gate dep = (struct dirent *)((char *)dep + n);
247*0Sstevel@tonic-gate readdir_args.rd_cookie = ep->b_cookie;
248*0Sstevel@tonic-gate nfp->cookie.cookie4 = ep->b_cookie;
249*0Sstevel@tonic-gate cnt++;
250*0Sstevel@tonic-gate }
251*0Sstevel@tonic-gate }
252*0Sstevel@tonic-gate
253*0Sstevel@tonic-gate return (cnt);
254*0Sstevel@tonic-gate }
255