2 * NFS support driver - based on etherboot and U-BOOT's tftp.c
4 * Masami Komiya <mkomiya@sonare.it> 2004
8 /* NOTE: the NFS code is heavily inspired by the NetBSD netboot code (read:
9 * large portions are copied verbatim) as distributed in OSKit 0.97. A few
10 * changes were necessary to adapt the code to Etherboot and to fix several
11 * inconsistencies. Also the RPC message preparation is done "by hand" to
12 * avoid adding netsprintf() which I find hard to understand and use. */
14 /* NOTE 2: Etherboot does not care about things beyond the kernel image, so
15 * it loads the kernel image off the boot server (ARP_SERVER) and does not
16 * access the client root disk (root-path in dhcpd.conf), which would use
17 * ARP_ROOTSERVER. The root disk is something the operating system we are
18 * about to load needs to use. This is different from the OSKit 0.97 logic. */
20 /* NOTE 3: Symlink handling introduced by Anselm M Hoffmeister, 2003-July-14
21 * If a symlink is encountered, it is followed as far as possible (recursion
22 * possible, maximum 16 steps). There is no clearing of ".."'s inside the
23 * path, so please DON'T DO THAT. thx. */
32 #define HASHES_PER_LINE 65 /* Number of "loading" hashes per line */
33 #define NFS_RETRY_COUNT 30
34 #define NFS_TIMEOUT 2000UL
36 static int fs_mounted;
37 static unsigned long rpc_id;
38 static int nfs_offset = -1;
41 static char dirfh[NFS_FHSIZE]; /* file handle of directory */
42 static char filefh[NFS_FHSIZE]; /* file handle of kernel image */
44 static int NfsDownloadState;
45 static IPaddr_t NfsServerIP;
46 static int NfsSrvMountPort;
47 static int NfsSrvNfsPort;
48 static int NfsOurPort;
49 static int NfsTimeoutCount;
51 #define STATE_PRCLOOKUP_PROG_MOUNT_REQ 1
52 #define STATE_PRCLOOKUP_PROG_NFS_REQ 2
53 #define STATE_MOUNT_REQ 3
54 #define STATE_UMOUNT_REQ 4
55 #define STATE_LOOKUP_REQ 5
56 #define STATE_READ_REQ 6
57 #define STATE_READLINK_REQ 7
59 static char default_filename[64];
60 static char *nfs_filename;
61 static char *nfs_path;
62 static char nfs_path_buff[2048];
65 store_block(uchar *src, unsigned offset, unsigned len)
67 ulong newsize = offset + len;
68 #ifdef CONFIG_SYS_DIRECT_FLASH_NFS
71 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
72 /* start address in flash? */
73 if (load_addr + offset >= flash_info[i].start[0]) {
79 if (rc) { /* Flash is destination for this packet */
80 rc = flash_write((uchar *)src, (ulong)(load_addr+offset), len);
86 #endif /* CONFIG_SYS_DIRECT_FLASH_NFS */
88 (void)memcpy((void *)(load_addr + offset), src, len);
91 if (NetBootFileXferSize < (offset+len))
92 NetBootFileXferSize = newsize;
101 fname = path + strlen(path) - 1;
102 while (fname >= path) {
117 fname = basename(path);
123 /**************************************************************************
124 RPC_ADD_CREDENTIALS - Add RPC authentication/verifier entries
125 **************************************************************************/
126 static long *rpc_add_credentials(long *p)
132 strcpy(hostname, "");
133 hostnamelen = strlen(hostname);
135 /* Here's the executive summary on authentication requirements of the
136 * various NFS server implementations: Linux accepts both AUTH_NONE
137 * and AUTH_UNIX authentication (also accepts an empty hostname field
138 * in the AUTH_UNIX scheme). *BSD refuses AUTH_NONE, but accepts
139 * AUTH_UNIX (also accepts an empty hostname field in the AUTH_UNIX
140 * scheme). To be safe, use AUTH_UNIX and pass the hostname if we have
141 * it (if the BOOTP/DHCP reply didn't give one, just use an empty
144 hl = (hostnamelen + 3) & ~3;
146 /* Provide an AUTH_UNIX credential. */
147 *p++ = htonl(1); /* AUTH_UNIX */
148 *p++ = htonl(hl+20); /* auth length */
149 *p++ = htonl(0); /* stamp */
150 *p++ = htonl(hostnamelen); /* hostname string */
152 *(p + hostnamelen / 4) = 0; /* add zero padding */
153 memcpy(p, hostname, hostnamelen);
157 *p++ = 0; /* auxiliary gid list */
159 /* Provide an AUTH_NONE verifier. */
160 *p++ = 0; /* AUTH_NONE */
161 *p++ = 0; /* auth length */
166 /**************************************************************************
167 RPC_LOOKUP - Lookup RPC Port numbers
168 **************************************************************************/
170 rpc_req(int rpc_prog, int rpc_proc, uint32_t *data, int datalen)
179 pkt.u.call.id = htonl(id);
180 pkt.u.call.type = htonl(MSG_CALL);
181 pkt.u.call.rpcvers = htonl(2); /* use RPC version 2 */
182 pkt.u.call.prog = htonl(rpc_prog);
183 pkt.u.call.vers = htonl(2); /* portmapper is version 2 */
184 pkt.u.call.proc = htonl(rpc_proc);
185 p = (uint32_t *)&(pkt.u.call.data);
188 memcpy((char *)p, (char *)data, datalen*sizeof(uint32_t));
190 pktlen = (char *)p + datalen*sizeof(uint32_t) - (char *)&pkt;
192 memcpy((char *)NetTxPacket + NetEthHdrSize() + IP_HDR_SIZE,
193 (char *)&pkt, pktlen);
195 if (rpc_prog == PROG_PORTMAP)
197 else if (rpc_prog == PROG_MOUNT)
198 sport = NfsSrvMountPort;
200 sport = NfsSrvNfsPort;
202 NetSendUDPPacket(NetServerEther, NfsServerIP, sport, NfsOurPort,
206 /**************************************************************************
207 RPC_LOOKUP - Lookup RPC Port numbers
208 **************************************************************************/
210 rpc_lookup_req(int prog, int ver)
214 data[0] = 0; data[1] = 0; /* auth credential */
215 data[2] = 0; data[3] = 0; /* auth verifier */
216 data[4] = htonl(prog);
217 data[5] = htonl(ver);
218 data[6] = htonl(17); /* IP_UDP */
221 rpc_req(PROG_PORTMAP, PORTMAP_GETPORT, data, 8);
224 /**************************************************************************
225 NFS_MOUNT - Mount an NFS Filesystem
226 **************************************************************************/
228 nfs_mount_req(char *path)
235 pathlen = strlen(path);
238 p = (uint32_t *)rpc_add_credentials((long *)p);
240 *p++ = htonl(pathlen);
242 *(p + pathlen / 4) = 0;
243 memcpy(p, path, pathlen);
244 p += (pathlen + 3) / 4;
246 len = (uint32_t *)p - (uint32_t *)&(data[0]);
248 rpc_req(PROG_MOUNT, MOUNT_ADDENTRY, data, len);
251 /**************************************************************************
252 NFS_UMOUNTALL - Unmount all our NFS Filesystems on the Server
253 **************************************************************************/
255 nfs_umountall_req(void)
261 if ((NfsSrvMountPort == -1) || (!fs_mounted))
262 /* Nothing mounted, nothing to umount */
266 p = (uint32_t *)rpc_add_credentials((long *)p);
268 len = (uint32_t *)p - (uint32_t *)&(data[0]);
270 rpc_req(PROG_MOUNT, MOUNT_UMOUNTALL, data, len);
273 /***************************************************************************
274 * NFS_READLINK (AH 2003-07-14)
275 * This procedure is called when read of the first block fails -
276 * this probably happens when it's a directory or a symlink
277 * In case of successful readlink(), the dirname is manipulated,
278 * so that inside the nfs() function a recursion can be done.
279 **************************************************************************/
281 nfs_readlink_req(void)
288 p = (uint32_t *)rpc_add_credentials((long *)p);
290 memcpy(p, filefh, NFS_FHSIZE);
291 p += (NFS_FHSIZE / 4);
293 len = (uint32_t *)p - (uint32_t *)&(data[0]);
295 rpc_req(PROG_NFS, NFS_READLINK, data, len);
298 /**************************************************************************
299 NFS_LOOKUP - Lookup Pathname
300 **************************************************************************/
302 nfs_lookup_req(char *fname)
309 fnamelen = strlen(fname);
312 p = (uint32_t *)rpc_add_credentials((long *)p);
314 memcpy(p, dirfh, NFS_FHSIZE);
315 p += (NFS_FHSIZE / 4);
316 *p++ = htonl(fnamelen);
318 *(p + fnamelen / 4) = 0;
319 memcpy(p, fname, fnamelen);
320 p += (fnamelen + 3) / 4;
322 len = (uint32_t *)p - (uint32_t *)&(data[0]);
324 rpc_req(PROG_NFS, NFS_LOOKUP, data, len);
327 /**************************************************************************
328 NFS_READ - Read File on NFS Server
329 **************************************************************************/
331 nfs_read_req(int offset, int readlen)
338 p = (uint32_t *)rpc_add_credentials((long *)p);
340 memcpy(p, filefh, NFS_FHSIZE);
341 p += (NFS_FHSIZE / 4);
342 *p++ = htonl(offset);
343 *p++ = htonl(readlen);
346 len = (uint32_t *)p - (uint32_t *)&(data[0]);
348 rpc_req(PROG_NFS, NFS_READ, data, len);
351 /**************************************************************************
352 RPC request dispatcher
353 **************************************************************************/
358 debug("%s\n", __func__);
361 case STATE_PRCLOOKUP_PROG_MOUNT_REQ:
362 rpc_lookup_req(PROG_MOUNT, 1);
364 case STATE_PRCLOOKUP_PROG_NFS_REQ:
365 rpc_lookup_req(PROG_NFS, 2);
367 case STATE_MOUNT_REQ:
368 nfs_mount_req(nfs_path);
370 case STATE_UMOUNT_REQ:
373 case STATE_LOOKUP_REQ:
374 nfs_lookup_req(nfs_filename);
377 nfs_read_req(nfs_offset, nfs_len);
379 case STATE_READLINK_REQ:
385 /**************************************************************************
386 Handlers for the reply from server
387 **************************************************************************/
390 rpc_lookup_reply(int prog, uchar *pkt, unsigned len)
392 struct rpc_t rpc_pkt;
394 memcpy((unsigned char *)&rpc_pkt, pkt, len);
396 debug("%s\n", __func__);
398 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
401 if (rpc_pkt.u.reply.rstatus ||
402 rpc_pkt.u.reply.verifier ||
403 rpc_pkt.u.reply.astatus)
408 NfsSrvMountPort = ntohl(rpc_pkt.u.reply.data[0]);
411 NfsSrvNfsPort = ntohl(rpc_pkt.u.reply.data[0]);
419 nfs_mount_reply(uchar *pkt, unsigned len)
421 struct rpc_t rpc_pkt;
423 debug("%s\n", __func__);
425 memcpy((unsigned char *)&rpc_pkt, pkt, len);
427 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
430 if (rpc_pkt.u.reply.rstatus ||
431 rpc_pkt.u.reply.verifier ||
432 rpc_pkt.u.reply.astatus ||
433 rpc_pkt.u.reply.data[0])
437 memcpy(dirfh, rpc_pkt.u.reply.data + 1, NFS_FHSIZE);
443 nfs_umountall_reply(uchar *pkt, unsigned len)
445 struct rpc_t rpc_pkt;
447 debug("%s\n", __func__);
449 memcpy((unsigned char *)&rpc_pkt, pkt, len);
451 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
454 if (rpc_pkt.u.reply.rstatus ||
455 rpc_pkt.u.reply.verifier ||
456 rpc_pkt.u.reply.astatus)
460 memset(dirfh, 0, sizeof(dirfh));
466 nfs_lookup_reply(uchar *pkt, unsigned len)
468 struct rpc_t rpc_pkt;
470 debug("%s\n", __func__);
472 memcpy((unsigned char *)&rpc_pkt, pkt, len);
474 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
477 if (rpc_pkt.u.reply.rstatus ||
478 rpc_pkt.u.reply.verifier ||
479 rpc_pkt.u.reply.astatus ||
480 rpc_pkt.u.reply.data[0])
483 memcpy(filefh, rpc_pkt.u.reply.data + 1, NFS_FHSIZE);
489 nfs_readlink_reply(uchar *pkt, unsigned len)
491 struct rpc_t rpc_pkt;
494 debug("%s\n", __func__);
496 memcpy((unsigned char *)&rpc_pkt, pkt, len);
498 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
501 if (rpc_pkt.u.reply.rstatus ||
502 rpc_pkt.u.reply.verifier ||
503 rpc_pkt.u.reply.astatus ||
504 rpc_pkt.u.reply.data[0])
507 rlen = ntohl(rpc_pkt.u.reply.data[1]); /* new path length */
509 if (*((char *)&(rpc_pkt.u.reply.data[2])) != '/') {
511 strcat(nfs_path, "/");
512 pathlen = strlen(nfs_path);
513 memcpy(nfs_path + pathlen, (uchar *)&(rpc_pkt.u.reply.data[2]),
515 nfs_path[pathlen + rlen] = 0;
517 memcpy(nfs_path, (uchar *)&(rpc_pkt.u.reply.data[2]), rlen);
524 nfs_read_reply(uchar *pkt, unsigned len)
526 struct rpc_t rpc_pkt;
529 debug("%s\n", __func__);
531 memcpy((uchar *)&rpc_pkt, pkt, sizeof(rpc_pkt.u.reply));
533 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
536 if (rpc_pkt.u.reply.rstatus ||
537 rpc_pkt.u.reply.verifier ||
538 rpc_pkt.u.reply.astatus ||
539 rpc_pkt.u.reply.data[0]) {
540 if (rpc_pkt.u.reply.rstatus)
542 if (rpc_pkt.u.reply.astatus)
544 return -ntohl(rpc_pkt.u.reply.data[0]);
547 if ((nfs_offset != 0) && !((nfs_offset) %
548 (NFS_READ_SIZE / 2 * 10 * HASHES_PER_LINE)))
550 if (!(nfs_offset % ((NFS_READ_SIZE / 2) * 10)))
553 rlen = ntohl(rpc_pkt.u.reply.data[18]);
554 if (store_block((uchar *)pkt + sizeof(rpc_pkt.u.reply),
561 /**************************************************************************
563 **************************************************************************/
568 if (++NfsTimeoutCount > NFS_RETRY_COUNT) {
569 puts("\nRetry count exceeded; starting again\n");
573 NetSetTimeout(NFS_TIMEOUT, NfsTimeout);
579 NfsHandler(uchar *pkt, unsigned dest, IPaddr_t sip, unsigned src, unsigned len)
583 debug("%s\n", __func__);
585 if (dest != NfsOurPort)
589 case STATE_PRCLOOKUP_PROG_MOUNT_REQ:
590 rpc_lookup_reply(PROG_MOUNT, pkt, len);
591 NfsState = STATE_PRCLOOKUP_PROG_NFS_REQ;
595 case STATE_PRCLOOKUP_PROG_NFS_REQ:
596 rpc_lookup_reply(PROG_NFS, pkt, len);
597 NfsState = STATE_MOUNT_REQ;
601 case STATE_MOUNT_REQ:
602 if (nfs_mount_reply(pkt, len)) {
603 puts("*** ERROR: Cannot mount\n");
604 /* just to be sure... */
605 NfsState = STATE_UMOUNT_REQ;
608 NfsState = STATE_LOOKUP_REQ;
613 case STATE_UMOUNT_REQ:
614 if (nfs_umountall_reply(pkt, len)) {
615 puts("*** ERROR: Cannot umount\n");
616 NetState = NETLOOP_FAIL;
619 NetState = NfsDownloadState;
623 case STATE_LOOKUP_REQ:
624 if (nfs_lookup_reply(pkt, len)) {
625 puts("*** ERROR: File lookup fail\n");
626 NfsState = STATE_UMOUNT_REQ;
629 NfsState = STATE_READ_REQ;
631 nfs_len = NFS_READ_SIZE;
636 case STATE_READLINK_REQ:
637 if (nfs_readlink_reply(pkt, len)) {
638 puts("*** ERROR: Symlink fail\n");
639 NfsState = STATE_UMOUNT_REQ;
642 debug("Symlink --> %s\n", nfs_path);
643 nfs_filename = basename(nfs_path);
644 nfs_path = dirname(nfs_path);
646 NfsState = STATE_MOUNT_REQ;
652 rlen = nfs_read_reply(pkt, len);
653 NetSetTimeout(NFS_TIMEOUT, NfsTimeout);
657 } else if ((rlen == -NFSERR_ISDIR) || (rlen == -NFSERR_INVAL)) {
659 NfsState = STATE_READLINK_REQ;
663 NfsDownloadState = NETLOOP_SUCCESS;
664 NfsState = STATE_UMOUNT_REQ;
675 debug("%s\n", __func__);
676 NfsDownloadState = NETLOOP_FAIL;
678 NfsServerIP = NetServerIP;
679 nfs_path = (char *)nfs_path_buff;
681 if (nfs_path == NULL) {
682 NetState = NETLOOP_FAIL;
683 puts("*** ERROR: Fail allocate memory\n");
687 if (BootFile[0] == '\0') {
688 sprintf(default_filename, "/nfsroot/%02X%02X%02X%02X.img",
690 (NetOurIP >> 8) & 0xFF,
691 (NetOurIP >> 16) & 0xFF,
692 (NetOurIP >> 24) & 0xFF);
693 strcpy(nfs_path, default_filename);
695 printf("*** Warning: no boot file name; using '%s'\n",
703 NfsServerIP = string_to_ip(BootFile);
707 strcpy(nfs_path, BootFile);
711 nfs_filename = basename(nfs_path);
712 nfs_path = dirname(nfs_path);
714 printf("Using %s device\n", eth_get_name());
716 printf("File transfer via NFS from server %pI4"
717 "; our IP address is %pI4", &NfsServerIP, &NetOurIP);
719 /* Check if we need to send across this subnet */
720 if (NetOurGatewayIP && NetOurSubnetMask) {
721 IPaddr_t OurNet = NetOurIP & NetOurSubnetMask;
722 IPaddr_t ServerNet = NetServerIP & NetOurSubnetMask;
724 if (OurNet != ServerNet)
725 printf("; sending through gateway %pI4",
728 printf("\nFilename '%s/%s'.", nfs_path, nfs_filename);
730 if (NetBootFileSize) {
731 printf(" Size is 0x%x Bytes = ", NetBootFileSize<<9);
732 print_size(NetBootFileSize<<9, "");
734 printf("\nLoad address: 0x%lx\n"
735 "Loading: *\b", load_addr);
737 NetSetTimeout(NFS_TIMEOUT, NfsTimeout);
738 NetSetHandler(NfsHandler);
741 NfsState = STATE_PRCLOOKUP_PROG_MOUNT_REQ;
743 /*NfsOurPort = 4096 + (get_ticks() % 3072);*/
747 /* zero out server ether in case the server ip has changed */
748 memset(NetServerEther, 0, 6);