1 /* $NetBSD: nfs.c,v 1.2 1998/01/24 12:43:09 drochner Exp $ */
4 * Copyright (c) 1993 John Brezak
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
27 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
36 #include <sys/socket.h>
41 #include <netinet/in.h>
42 #include <netinet/in_systm.h>
54 #define NFSREAD_MIN_SIZE 1024
55 #define NFSREAD_MAX_SIZE 16384
57 /* NFSv3 definitions */
58 #define NFS_V3MAXFHSIZE 64
61 #define NFSPROCV3_LOOKUP 3
62 #define NFSPROCV3_READLINK 5
63 #define NFSPROCV3_READ 6
64 #define NFSPROCV3_READDIR 16
86 struct nfsv3_time fa_atime;
87 struct nfsv3_time fa_mtime;
88 struct nfsv3_time fa_ctime;
92 * For NFSv3, the file handle is variable in size, so most fixed sized
93 * structures for arguments won't work. For most cases, a structure
94 * that starts with any fixed size section is followed by an array
95 * that covers the maximum size required.
97 struct nfsv3_readdir_repl {
100 struct nfsv3_fattrs fa;
105 struct nfsv3_readdir_entry {
110 uint32_t nameplus[0];
114 struct iodesc *iodesc;
117 u_char fh[NFS_V3MAXFHSIZE];
118 struct nfsv3_fattrs fa; /* all in network order */
123 * XXX interactions with tftp? See nfswrapper.c for a confusing
126 int nfs_open(const char *path, struct open_file *f);
127 static int nfs_close(struct open_file *f);
128 static int nfs_read(struct open_file *f, void *buf, size_t size, size_t *resid);
129 static int nfs_write(struct open_file *f, void *buf, size_t size, size_t *resid);
130 static off_t nfs_seek(struct open_file *f, off_t offset, int where);
131 static int nfs_stat(struct open_file *f, struct stat *sb);
132 static int nfs_readdir(struct open_file *f, struct dirent *d);
134 struct nfs_iodesc nfs_root_node;
136 struct fs_ops nfs_fsops = {
147 static int nfs_read_size = NFSREAD_MIN_SIZE;
150 * Improve boot performance over NFS
153 set_nfs_read_size(void)
158 if ((env = getenv("nfs.read_size")) != NULL) {
160 nfs_read_size = (int)strtol(env, &end, 0);
161 if (errno != 0 || *env == '\0' || *end != '\0') {
162 printf("%s: bad value: \"%s\", defaulting to %d\n",
163 "nfs.read_size", env, NFSREAD_MIN_SIZE);
164 nfs_read_size = NFSREAD_MIN_SIZE;
167 if (nfs_read_size < NFSREAD_MIN_SIZE) {
168 printf("%s: bad value: \"%d\", defaulting to %d\n",
169 "nfs.read_size", nfs_read_size, NFSREAD_MIN_SIZE);
170 nfs_read_size = NFSREAD_MIN_SIZE;
172 if (nfs_read_size > NFSREAD_MAX_SIZE) {
173 printf("%s: bad value: \"%d\", defaulting to %d\n",
174 "nfs.read_size", nfs_read_size, NFSREAD_MIN_SIZE);
175 nfs_read_size = NFSREAD_MAX_SIZE;
177 snprintf(buf, sizeof (buf), "%d", nfs_read_size);
178 setenv("nfs.read_size", buf, 1);
182 * Fetch the root file handle (call mount daemon)
183 * Return zero or error number.
186 nfs_getrootfh(struct iodesc *d, char *path, uint32_t *fhlenp, u_char *fhp)
192 char path[FNAME_SIZE];
197 u_char fh[NFS_V3MAXFHSIZE];
202 uint32_t h[RPC_HEADER_WORDS];
209 printf("nfs_getrootfh: %s\n", path);
214 bzero(args, sizeof(*args));
216 if (len > sizeof(args->path))
217 len = sizeof(args->path);
218 args->len = htonl(len);
219 bcopy(path, args->path, len);
220 len = sizeof(uint32_t) + roundup(len, sizeof(uint32_t));
222 cc = rpc_call(d, RPCPROG_MNT, RPCMNT_VER3, RPCMNT_MOUNT,
223 args, len, (void **)&repl, &pkt);
226 /* errno was set by rpc_call */
229 if (cc < 2 * sizeof (uint32_t)) {
233 if (repl->errno != 0) {
235 return (ntohl(repl->errno));
237 *fhlenp = ntohl(repl->fhsize);
238 bcopy(repl->fh, fhp, *fhlenp);
246 * Lookup a file. Store handle and attributes.
247 * Return zero or error number.
250 nfs_lookupfh(struct nfs_iodesc *d, const char *name, struct nfs_iodesc *newfd)
256 uint32_t fhplusname[1 +
257 (NFS_V3MAXFHSIZE + FNAME_SIZE) / sizeof(uint32_t)];
262 uint32_t fhplusattr[(NFS_V3MAXFHSIZE +
263 2 * (sizeof(uint32_t) +
264 sizeof(struct nfsv3_fattrs))) / sizeof(uint32_t)];
267 uint32_t h[RPC_HEADER_WORDS];
274 printf("lookupfh: called\n");
279 bzero(args, sizeof(*args));
280 args->fhsize = htonl(d->fhsize);
281 bcopy(d->fh, args->fhplusname, d->fhsize);
283 if (len > FNAME_SIZE)
285 pos = roundup(d->fhsize, sizeof(uint32_t)) / sizeof(uint32_t);
286 args->fhplusname[pos++] = htonl(len);
287 bcopy(name, &args->fhplusname[pos], len);
288 len = sizeof(uint32_t) + pos * sizeof(uint32_t) +
289 roundup(len, sizeof(uint32_t));
291 cc = rpc_call(d->iodesc, NFS_PROG, NFS_VER3, NFSPROCV3_LOOKUP,
292 args, len, (void **)&repl, &pkt);
295 return (errno); /* XXX - from rpc_call */
297 if (cc < 2 * sizeof(uint32_t)) {
301 if (repl->errno != 0) {
303 /* saerrno.h now matches NFS error numbers. */
304 return (ntohl(repl->errno));
306 newfd->fhsize = ntohl(repl->fhsize);
307 bcopy(repl->fhplusattr, &newfd->fh, newfd->fhsize);
308 pos = roundup(newfd->fhsize, sizeof(uint32_t)) / sizeof(uint32_t);
309 if (repl->fhplusattr[pos++] == 0) {
313 bcopy(&repl->fhplusattr[pos], &newfd->fa, sizeof(newfd->fa));
318 #ifndef NFS_NOSYMLINK
320 * Get the destination of a symbolic link.
323 nfs_readlink(struct nfs_iodesc *d, char *buf)
328 u_char fh[NFS_V3MAXFHSIZE];
333 struct nfsv3_fattrs fa;
335 u_char path[NFS_MAXPATHLEN];
338 uint32_t h[RPC_HEADER_WORDS];
346 printf("readlink: called\n");
351 bzero(args, sizeof(*args));
352 args->fhsize = htonl(d->fhsize);
353 bcopy(d->fh, args->fh, d->fhsize);
354 cc = rpc_call(d->iodesc, NFS_PROG, NFS_VER3, NFSPROCV3_READLINK,
355 args, sizeof(uint32_t) + roundup(d->fhsize, sizeof(uint32_t)),
356 (void **)&repl, &pkt);
360 if (cc < 2 * sizeof(uint32_t)) {
365 if (repl->errno != 0) {
366 rc = ntohl(repl->errno);
375 repl->len = ntohl(repl->len);
376 if (repl->len > NFS_MAXPATHLEN) {
381 bcopy(repl->path, buf, repl->len);
390 * Read data from a file.
391 * Return transfer count or -1 (and set errno)
394 nfs_readdata(struct nfs_iodesc *d, off_t off, void *addr, size_t len)
399 uint32_t fhoffcnt[NFS_V3MAXFHSIZE / sizeof(uint32_t) + 3];
404 struct nfsv3_fattrs fa;
408 u_char data[NFSREAD_MAX_SIZE];
411 uint32_t h[RPC_HEADER_WORDS];
420 bzero(args, sizeof(*args));
421 args->fhsize = htonl(d->fhsize);
422 bcopy(d->fh, args->fhoffcnt, d->fhsize);
423 pos = roundup(d->fhsize, sizeof(uint32_t)) / sizeof(uint32_t);
424 args->fhoffcnt[pos++] = 0;
425 args->fhoffcnt[pos++] = htonl((uint32_t)off);
426 if (len > nfs_read_size)
428 args->fhoffcnt[pos] = htonl((uint32_t)len);
429 hlen = offsetof(struct repl, data[0]);
431 cc = rpc_call(d->iodesc, NFS_PROG, NFS_VER3, NFSPROCV3_READ,
432 args, 4 * sizeof(uint32_t) + roundup(d->fhsize, sizeof(uint32_t)),
433 (void **)&repl, &pkt);
435 /* errno was already set by rpc_call */
443 if (repl->errno != 0) {
444 errno = ntohl(repl->errno);
449 x = ntohl(repl->count);
451 printf("nfsread: short packet, %d < %ld\n", rlen, x);
456 bcopy(repl->data, addr, x);
463 * return zero or error number
466 nfs_open(const char *upath, struct open_file *f)
469 struct nfs_iodesc *currfd;
470 char buf[2 * NFS_V3MAXFHSIZE + 3];
474 #ifndef NFS_NOSYMLINK
475 struct nfs_iodesc *newfd;
476 struct nfsv3_fattrs *fa;
479 char namebuf[NFS_MAXPATHLEN + 1];
480 char linkbuf[NFS_MAXPATHLEN + 1];
486 if (netproto != NET_NFS)
491 printf("nfs_open: %s (rootpath=%s)\n", upath, rootpath);
494 printf("no rootpath, no nfs\n");
498 if (f->f_dev->dv_type != DEVT_NET)
501 if (!(desc = socktodesc(*(int *)(f->f_devdata))))
504 /* Bind to a reserved port. */
505 desc->myport = htons(--rpc_port);
506 desc->destip = rootip;
507 if ((error = nfs_getrootfh(desc, rootpath, &nfs_root_node.fhsize,
510 nfs_root_node.fa.fa_type = htonl(NFDIR);
511 nfs_root_node.fa.fa_mode = htonl(0755);
512 nfs_root_node.fa.fa_nlink = htonl(2);
513 nfs_root_node.iodesc = desc;
515 fh = &nfs_root_node.fh[0];
518 for (i = 0; i < nfs_root_node.fhsize; i++, cp += 2)
519 sprintf(cp, "%02x", fh[i]);
521 setenv("boot.nfsroot.server", inet_ntoa(rootip), 1);
522 setenv("boot.nfsroot.path", rootpath, 1);
523 setenv("boot.nfsroot.nfshandle", buf, 1);
524 sprintf(buf, "%d", nfs_root_node.fhsize);
525 setenv("boot.nfsroot.nfshandlelen", buf, 1);
527 /* Allocate file system specific data structure */
528 currfd = malloc(sizeof(*newfd));
529 if (currfd == NULL) {
533 #ifndef NFS_NOSYMLINK
534 bcopy(&nfs_root_node, currfd, sizeof(*currfd));
537 cp = path = strdup(upath);
544 * Remove extra separators
552 * Check that current node is a directory.
554 if (currfd->fa.fa_type != htonl(NFDIR)) {
559 /* allocate file system specific data structure */
560 newfd = malloc(sizeof(*newfd));
565 newfd->iodesc = currfd->iodesc;
568 * Get next component of path name.
574 while ((c = *cp) != '\0' && c != '/') {
575 if (++len > NFS_MAXNAMLEN) {
584 /* lookup a file handle */
585 error = nfs_lookupfh(currfd, ncp, newfd);
591 * Check for symbolic link
593 if (newfd->fa.fa_type == htonl(NFLNK)) {
596 error = nfs_readlink(newfd, linkbuf);
600 link_len = strlen(linkbuf);
603 if (link_len + len > MAXPATHLEN
604 || ++nlinks > MAXSYMLINKS) {
609 bcopy(cp, &namebuf[link_len], len + 1);
610 bcopy(linkbuf, namebuf, link_len);
613 * If absolute pathname, restart at root.
614 * If relative pathname, restart at parent directory.
618 bcopy(&nfs_root_node, currfd, sizeof(*currfd));
637 currfd->iodesc = desc;
639 error = nfs_lookupfh(&nfs_root_node, upath, currfd);
644 f->f_fsdata = (void *)currfd;
650 printf("nfs_open: %s lookupfh failed: %s\n",
651 path, strerror(error));
659 nfs_close(struct open_file *f)
661 struct nfs_iodesc *fp = (struct nfs_iodesc *)f->f_fsdata;
665 printf("nfs_close: fp=0x%lx\n", (u_long)fp);
675 * read a portion of a file
678 nfs_read(struct open_file *f, void *buf, size_t size, size_t *resid)
680 struct nfs_iodesc *fp = (struct nfs_iodesc *)f->f_fsdata;
686 printf("nfs_read: size=%lu off=%d\n", (u_long)size,
689 while ((int)size > 0) {
691 cc = nfs_readdata(fp, fp->off, (void *)addr, size);
692 /* XXX maybe should retry on certain errors */
696 printf("nfs_read: read: %s", strerror(errno));
698 return (errno); /* XXX - from nfs_readdata */
703 printf("nfs_read: hit EOF unexpectantly");
722 nfs_write(struct open_file *f, void *buf, size_t size, size_t *resid)
728 nfs_seek(struct open_file *f, off_t offset, int where)
730 struct nfs_iodesc *d = (struct nfs_iodesc *)f->f_fsdata;
731 uint32_t size = ntohl(d->fa.fa_size.val[1]);
741 d->off = size - offset;
751 /* NFNON=0, NFREG=1, NFDIR=2, NFBLK=3, NFCHR=4, NFLNK=5, NFSOCK=6, NFFIFO=7 */
752 int nfs_stat_types[9] = {
753 0, S_IFREG, S_IFDIR, S_IFBLK, S_IFCHR, S_IFLNK, S_IFSOCK, S_IFIFO, 0 };
756 nfs_stat(struct open_file *f, struct stat *sb)
758 struct nfs_iodesc *fp = (struct nfs_iodesc *)f->f_fsdata;
759 uint32_t ftype, mode;
761 ftype = ntohl(fp->fa.fa_type);
762 mode = ntohl(fp->fa.fa_mode);
763 mode |= nfs_stat_types[ftype & 7];
766 sb->st_nlink = ntohl(fp->fa.fa_nlink);
767 sb->st_uid = ntohl(fp->fa.fa_uid);
768 sb->st_gid = ntohl(fp->fa.fa_gid);
769 sb->st_size = ntohl(fp->fa.fa_size.val[1]);
775 nfs_readdir(struct open_file *f, struct dirent *d)
777 struct nfs_iodesc *fp = (struct nfs_iodesc *)f->f_fsdata;
778 struct nfsv3_readdir_repl *repl;
779 struct nfsv3_readdir_entry *rent;
780 static void *pkt = NULL;
782 static struct nfs_iodesc *pfp = NULL;
783 static uint64_t cookie = 0;
789 uint32_t fhpluscookie[5 + NFS_V3MAXFHSIZE];
792 uint32_t h[RPC_HEADER_WORDS];
796 if (fp != pfp || fp->off != cookie) {
802 bzero(args, sizeof(*args));
804 args->fhsize = htonl(fp->fhsize);
805 bcopy(fp->fh, args->fhpluscookie, fp->fhsize);
806 pos = roundup(fp->fhsize, sizeof(uint32_t)) / sizeof(uint32_t);
807 args->fhpluscookie[pos++] = htonl(fp->off >> 32);
808 args->fhpluscookie[pos++] = htonl(fp->off);
809 args->fhpluscookie[pos++] = htonl(fp->cookie >> 32);
810 args->fhpluscookie[pos++] = htonl(fp->cookie);
811 args->fhpluscookie[pos] = htonl(NFS_READDIRSIZE);
813 cc = rpc_call(fp->iodesc, NFS_PROG, NFS_VER3, NFSPROCV3_READDIR,
814 args, 6 * sizeof(uint32_t) +
815 roundup(fp->fhsize, sizeof(uint32_t)),
816 (void **)&buf, &pkt);
821 repl = (struct nfsv3_readdir_repl *)buf;
822 if (repl->errno != 0) {
823 rc = ntohl(repl->errno);
828 fp->cookie = ((uint64_t)ntohl(repl->cookiev0) << 32) |
829 ntohl(repl->cookiev1);
830 buf += sizeof (struct nfsv3_readdir_repl);
832 rent = (struct nfsv3_readdir_entry *)buf;
834 if (rent->follows == 0) {
835 /* fid0 is actually eof */
836 if (rent->fid0 != 0) {
843 d->d_namlen = ntohl(rent->len);
844 bcopy(rent->nameplus, d->d_name, d->d_namlen);
845 d->d_name[d->d_namlen] = '\0';
847 pos = roundup(d->d_namlen, sizeof(uint32_t)) / sizeof(uint32_t);
848 fp->off = cookie = ((uint64_t)ntohl(rent->nameplus[pos]) << 32) |
849 ntohl(rent->nameplus[pos + 1]);
851 buf = (u_char *)&rent->nameplus[pos];