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. */
33 #define HASHES_PER_LINE 65 /* Number of "loading" hashes per line */
34 #define NFS_RETRY_COUNT 30
35 #ifndef CONFIG_NFS_TIMEOUT
36 # define NFS_TIMEOUT 2000UL
38 # define NFS_TIMEOUT CONFIG_NFS_TIMEOUT
42 #define NFS_RPC_DROP 124
44 static int fs_mounted;
45 static unsigned long rpc_id;
46 static int nfs_offset = -1;
48 static ulong nfs_timeout = NFS_TIMEOUT;
50 static char dirfh[NFS_FHSIZE]; /* file handle of directory */
51 static char filefh[NFS_FHSIZE]; /* file handle of kernel image */
53 static enum net_loop_state nfs_download_state;
54 static struct in_addr nfs_server_ip;
55 static int nfs_server_mount_port;
56 static int nfs_server_port;
57 static int nfs_our_port;
58 static int nfs_timeout_count;
60 #define STATE_PRCLOOKUP_PROG_MOUNT_REQ 1
61 #define STATE_PRCLOOKUP_PROG_NFS_REQ 2
62 #define STATE_MOUNT_REQ 3
63 #define STATE_UMOUNT_REQ 4
64 #define STATE_LOOKUP_REQ 5
65 #define STATE_READ_REQ 6
66 #define STATE_READLINK_REQ 7
68 static char *nfs_filename;
69 static char *nfs_path;
70 static char nfs_path_buff[2048];
72 static inline int store_block(uchar *src, unsigned offset, unsigned len)
74 ulong newsize = offset + len;
75 #ifdef CONFIG_SYS_DIRECT_FLASH_NFS
78 for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
79 /* start address in flash? */
80 if (load_addr + offset >= flash_info[i].start[0]) {
86 if (rc) { /* Flash is destination for this packet */
87 rc = flash_write((uchar *)src, (ulong)(load_addr+offset), len);
93 #endif /* CONFIG_SYS_DIRECT_FLASH_NFS */
95 void *ptr = map_sysmem(load_addr + offset, len);
97 memcpy(ptr, src, len);
101 if (net_boot_file_size < (offset + len))
102 net_boot_file_size = newsize;
106 static char *basename(char *path)
110 fname = path + strlen(path) - 1;
111 while (fname >= path) {
121 static char *dirname(char *path)
125 fname = basename(path);
131 /**************************************************************************
132 RPC_ADD_CREDENTIALS - Add RPC authentication/verifier entries
133 **************************************************************************/
134 static uint32_t *rpc_add_credentials(uint32_t *p)
140 strcpy(hostname, "");
141 hostnamelen = strlen(hostname);
143 /* Here's the executive summary on authentication requirements of the
144 * various NFS server implementations: Linux accepts both AUTH_NONE
145 * and AUTH_UNIX authentication (also accepts an empty hostname field
146 * in the AUTH_UNIX scheme). *BSD refuses AUTH_NONE, but accepts
147 * AUTH_UNIX (also accepts an empty hostname field in the AUTH_UNIX
148 * scheme). To be safe, use AUTH_UNIX and pass the hostname if we have
149 * it (if the BOOTP/DHCP reply didn't give one, just use an empty
152 hl = (hostnamelen + 3) & ~3;
154 /* Provide an AUTH_UNIX credential. */
155 *p++ = htonl(1); /* AUTH_UNIX */
156 *p++ = htonl(hl+20); /* auth length */
157 *p++ = htonl(0); /* stamp */
158 *p++ = htonl(hostnamelen); /* hostname string */
160 *(p + hostnamelen / 4) = 0; /* add zero padding */
161 memcpy(p, hostname, hostnamelen);
165 *p++ = 0; /* auxiliary gid list */
167 /* Provide an AUTH_NONE verifier. */
168 *p++ = 0; /* AUTH_NONE */
169 *p++ = 0; /* auth length */
174 /**************************************************************************
175 RPC_LOOKUP - Lookup RPC Port numbers
176 **************************************************************************/
177 static void rpc_req(int rpc_prog, int rpc_proc, uint32_t *data, int datalen)
186 pkt.u.call.id = htonl(id);
187 pkt.u.call.type = htonl(MSG_CALL);
188 pkt.u.call.rpcvers = htonl(2); /* use RPC version 2 */
189 pkt.u.call.prog = htonl(rpc_prog);
190 pkt.u.call.vers = htonl(2); /* portmapper is version 2 */
191 pkt.u.call.proc = htonl(rpc_proc);
192 p = (uint32_t *)&(pkt.u.call.data);
195 memcpy((char *)p, (char *)data, datalen*sizeof(uint32_t));
197 pktlen = (char *)p + datalen*sizeof(uint32_t) - (char *)&pkt;
199 memcpy((char *)net_tx_packet + net_eth_hdr_size() + IP_UDP_HDR_SIZE,
200 (char *)&pkt, pktlen);
202 if (rpc_prog == PROG_PORTMAP)
204 else if (rpc_prog == PROG_MOUNT)
205 sport = nfs_server_mount_port;
207 sport = nfs_server_port;
209 net_send_udp_packet(net_server_ethaddr, nfs_server_ip, sport,
210 nfs_our_port, pktlen);
213 /**************************************************************************
214 RPC_LOOKUP - Lookup RPC Port numbers
215 **************************************************************************/
216 static void rpc_lookup_req(int prog, int ver)
220 data[0] = 0; data[1] = 0; /* auth credential */
221 data[2] = 0; data[3] = 0; /* auth verifier */
222 data[4] = htonl(prog);
223 data[5] = htonl(ver);
224 data[6] = htonl(17); /* IP_UDP */
227 rpc_req(PROG_PORTMAP, PORTMAP_GETPORT, data, 8);
230 /**************************************************************************
231 NFS_MOUNT - Mount an NFS Filesystem
232 **************************************************************************/
233 static void nfs_mount_req(char *path)
240 pathlen = strlen(path);
243 p = rpc_add_credentials(p);
245 *p++ = htonl(pathlen);
247 *(p + pathlen / 4) = 0;
248 memcpy(p, path, pathlen);
249 p += (pathlen + 3) / 4;
251 len = (uint32_t *)p - (uint32_t *)&(data[0]);
253 rpc_req(PROG_MOUNT, MOUNT_ADDENTRY, data, len);
256 /**************************************************************************
257 NFS_UMOUNTALL - Unmount all our NFS Filesystems on the Server
258 **************************************************************************/
259 static void nfs_umountall_req(void)
265 if ((nfs_server_mount_port == -1) || (!fs_mounted))
266 /* Nothing mounted, nothing to umount */
270 p = rpc_add_credentials(p);
272 len = (uint32_t *)p - (uint32_t *)&(data[0]);
274 rpc_req(PROG_MOUNT, MOUNT_UMOUNTALL, data, len);
277 /***************************************************************************
278 * NFS_READLINK (AH 2003-07-14)
279 * This procedure is called when read of the first block fails -
280 * this probably happens when it's a directory or a symlink
281 * In case of successful readlink(), the dirname is manipulated,
282 * so that inside the nfs() function a recursion can be done.
283 **************************************************************************/
284 static void nfs_readlink_req(void)
291 p = rpc_add_credentials(p);
293 memcpy(p, filefh, NFS_FHSIZE);
294 p += (NFS_FHSIZE / 4);
296 len = (uint32_t *)p - (uint32_t *)&(data[0]);
298 rpc_req(PROG_NFS, NFS_READLINK, data, len);
301 /**************************************************************************
302 NFS_LOOKUP - Lookup Pathname
303 **************************************************************************/
304 static void nfs_lookup_req(char *fname)
311 fnamelen = strlen(fname);
314 p = rpc_add_credentials(p);
316 memcpy(p, dirfh, NFS_FHSIZE);
317 p += (NFS_FHSIZE / 4);
318 *p++ = htonl(fnamelen);
320 *(p + fnamelen / 4) = 0;
321 memcpy(p, fname, fnamelen);
322 p += (fnamelen + 3) / 4;
324 len = (uint32_t *)p - (uint32_t *)&(data[0]);
326 rpc_req(PROG_NFS, NFS_LOOKUP, data, len);
329 /**************************************************************************
330 NFS_READ - Read File on NFS Server
331 **************************************************************************/
332 static void nfs_read_req(int offset, int readlen)
339 p = rpc_add_credentials(p);
341 memcpy(p, filefh, NFS_FHSIZE);
342 p += (NFS_FHSIZE / 4);
343 *p++ = htonl(offset);
344 *p++ = htonl(readlen);
347 len = (uint32_t *)p - (uint32_t *)&(data[0]);
349 rpc_req(PROG_NFS, NFS_READ, data, len);
352 /**************************************************************************
353 RPC request dispatcher
354 **************************************************************************/
355 static void nfs_send(void)
357 debug("%s\n", __func__);
360 case STATE_PRCLOOKUP_PROG_MOUNT_REQ:
361 rpc_lookup_req(PROG_MOUNT, 1);
363 case STATE_PRCLOOKUP_PROG_NFS_REQ:
364 rpc_lookup_req(PROG_NFS, 2);
366 case STATE_MOUNT_REQ:
367 nfs_mount_req(nfs_path);
369 case STATE_UMOUNT_REQ:
372 case STATE_LOOKUP_REQ:
373 nfs_lookup_req(nfs_filename);
376 nfs_read_req(nfs_offset, nfs_len);
378 case STATE_READLINK_REQ:
384 /**************************************************************************
385 Handlers for the reply from server
386 **************************************************************************/
388 static int rpc_lookup_reply(int prog, uchar *pkt, unsigned len)
390 struct rpc_t rpc_pkt;
392 memcpy((unsigned char *)&rpc_pkt, pkt, len);
394 debug("%s\n", __func__);
396 if (ntohl(rpc_pkt.u.reply.id) > rpc_id)
398 else if (ntohl(rpc_pkt.u.reply.id) < rpc_id)
399 return -NFS_RPC_DROP;
401 if (rpc_pkt.u.reply.rstatus ||
402 rpc_pkt.u.reply.verifier ||
403 rpc_pkt.u.reply.astatus)
408 nfs_server_mount_port = ntohl(rpc_pkt.u.reply.data[0]);
411 nfs_server_port = ntohl(rpc_pkt.u.reply.data[0]);
418 static int nfs_mount_reply(uchar *pkt, unsigned len)
420 struct rpc_t rpc_pkt;
422 debug("%s\n", __func__);
424 memcpy((unsigned char *)&rpc_pkt, pkt, len);
426 if (ntohl(rpc_pkt.u.reply.id) > rpc_id)
428 else if (ntohl(rpc_pkt.u.reply.id) < rpc_id)
429 return -NFS_RPC_DROP;
431 if (rpc_pkt.u.reply.rstatus ||
432 rpc_pkt.u.reply.verifier ||
433 rpc_pkt.u.reply.astatus ||
434 rpc_pkt.u.reply.data[0])
438 memcpy(dirfh, rpc_pkt.u.reply.data + 1, NFS_FHSIZE);
443 static int 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)
453 else if (ntohl(rpc_pkt.u.reply.id) < rpc_id)
454 return -NFS_RPC_DROP;
456 if (rpc_pkt.u.reply.rstatus ||
457 rpc_pkt.u.reply.verifier ||
458 rpc_pkt.u.reply.astatus)
462 memset(dirfh, 0, sizeof(dirfh));
467 static int nfs_lookup_reply(uchar *pkt, unsigned len)
469 struct rpc_t rpc_pkt;
471 debug("%s\n", __func__);
473 memcpy((unsigned char *)&rpc_pkt, pkt, len);
475 if (ntohl(rpc_pkt.u.reply.id) > rpc_id)
477 else if (ntohl(rpc_pkt.u.reply.id) < rpc_id)
478 return -NFS_RPC_DROP;
480 if (rpc_pkt.u.reply.rstatus ||
481 rpc_pkt.u.reply.verifier ||
482 rpc_pkt.u.reply.astatus ||
483 rpc_pkt.u.reply.data[0]) {
484 switch (ntohl(rpc_pkt.u.reply.astatus)) {
485 case 0: /* Not an error */
487 case 2: /* Remote can't support NFS version */
488 printf("*** ERROR: NFS version not supported: Requested: V%d, accepted: min V%d - max V%d\n",
490 ntohl(rpc_pkt.u.reply.data[0]),
491 ntohl(rpc_pkt.u.reply.data[1]));
493 default: /* Unknown error on 'accept state' flag */
494 printf("*** ERROR: accept state error (%d)\n",
495 ntohl(rpc_pkt.u.reply.astatus));
501 memcpy(filefh, rpc_pkt.u.reply.data + 1, NFS_FHSIZE);
506 static int nfs_readlink_reply(uchar *pkt, unsigned len)
508 struct rpc_t rpc_pkt;
511 debug("%s\n", __func__);
513 memcpy((unsigned char *)&rpc_pkt, pkt, len);
515 if (ntohl(rpc_pkt.u.reply.id) > rpc_id)
517 else if (ntohl(rpc_pkt.u.reply.id) < rpc_id)
518 return -NFS_RPC_DROP;
520 if (rpc_pkt.u.reply.rstatus ||
521 rpc_pkt.u.reply.verifier ||
522 rpc_pkt.u.reply.astatus ||
523 rpc_pkt.u.reply.data[0])
526 rlen = ntohl(rpc_pkt.u.reply.data[1]); /* new path length */
528 if (*((char *)&(rpc_pkt.u.reply.data[2])) != '/') {
530 strcat(nfs_path, "/");
531 pathlen = strlen(nfs_path);
532 memcpy(nfs_path + pathlen, (uchar *)&(rpc_pkt.u.reply.data[2]),
534 nfs_path[pathlen + rlen] = 0;
536 memcpy(nfs_path, (uchar *)&(rpc_pkt.u.reply.data[2]), rlen);
542 static int nfs_read_reply(uchar *pkt, unsigned len)
544 struct rpc_t rpc_pkt;
547 debug("%s\n", __func__);
549 memcpy((uchar *)&rpc_pkt, pkt, sizeof(rpc_pkt.u.reply));
551 if (ntohl(rpc_pkt.u.reply.id) > rpc_id)
553 else if (ntohl(rpc_pkt.u.reply.id) < rpc_id)
554 return -NFS_RPC_DROP;
556 if (rpc_pkt.u.reply.rstatus ||
557 rpc_pkt.u.reply.verifier ||
558 rpc_pkt.u.reply.astatus ||
559 rpc_pkt.u.reply.data[0]) {
560 if (rpc_pkt.u.reply.rstatus)
562 if (rpc_pkt.u.reply.astatus)
564 return -ntohl(rpc_pkt.u.reply.data[0]);
567 if ((nfs_offset != 0) && !((nfs_offset) %
568 (NFS_READ_SIZE / 2 * 10 * HASHES_PER_LINE)))
570 if (!(nfs_offset % ((NFS_READ_SIZE / 2) * 10)))
573 rlen = ntohl(rpc_pkt.u.reply.data[18]);
574 if (store_block((uchar *)pkt + sizeof(rpc_pkt.u.reply),
581 /**************************************************************************
583 **************************************************************************/
584 static void nfs_timeout_handler(void)
586 if (++nfs_timeout_count > NFS_RETRY_COUNT) {
587 puts("\nRetry count exceeded; starting again\n");
591 net_set_timeout_handler(nfs_timeout +
592 NFS_TIMEOUT * nfs_timeout_count,
593 nfs_timeout_handler);
598 static void nfs_handler(uchar *pkt, unsigned dest, struct in_addr sip,
599 unsigned src, unsigned len)
604 debug("%s\n", __func__);
606 if (dest != nfs_our_port)
610 case STATE_PRCLOOKUP_PROG_MOUNT_REQ:
611 if (rpc_lookup_reply(PROG_MOUNT, pkt, len) == -NFS_RPC_DROP)
613 nfs_state = STATE_PRCLOOKUP_PROG_NFS_REQ;
617 case STATE_PRCLOOKUP_PROG_NFS_REQ:
618 if (rpc_lookup_reply(PROG_NFS, pkt, len) == -NFS_RPC_DROP)
620 nfs_state = STATE_MOUNT_REQ;
624 case STATE_MOUNT_REQ:
625 reply = nfs_mount_reply(pkt, len);
626 if (reply == -NFS_RPC_DROP) {
628 } else if (reply == -NFS_RPC_ERR) {
629 puts("*** ERROR: Cannot mount\n");
630 /* just to be sure... */
631 nfs_state = STATE_UMOUNT_REQ;
634 nfs_state = STATE_LOOKUP_REQ;
639 case STATE_UMOUNT_REQ:
640 reply = nfs_umountall_reply(pkt, len);
641 if (reply == -NFS_RPC_DROP) {
643 } else if (reply == -NFS_RPC_ERR) {
644 puts("*** ERROR: Cannot umount\n");
645 net_set_state(NETLOOP_FAIL);
648 net_set_state(nfs_download_state);
652 case STATE_LOOKUP_REQ:
653 reply = nfs_lookup_reply(pkt, len);
654 if (reply == -NFS_RPC_DROP) {
656 } else if (reply == -NFS_RPC_ERR) {
657 puts("*** ERROR: File lookup fail\n");
658 nfs_state = STATE_UMOUNT_REQ;
661 nfs_state = STATE_READ_REQ;
663 nfs_len = NFS_READ_SIZE;
668 case STATE_READLINK_REQ:
669 reply = nfs_readlink_reply(pkt, len);
670 if (reply == -NFS_RPC_DROP) {
672 } else if (reply == -NFS_RPC_ERR) {
673 puts("*** ERROR: Symlink fail\n");
674 nfs_state = STATE_UMOUNT_REQ;
677 debug("Symlink --> %s\n", nfs_path);
678 nfs_filename = basename(nfs_path);
679 nfs_path = dirname(nfs_path);
681 nfs_state = STATE_MOUNT_REQ;
687 rlen = nfs_read_reply(pkt, len);
688 net_set_timeout_handler(nfs_timeout, nfs_timeout_handler);
692 } else if ((rlen == -NFSERR_ISDIR) || (rlen == -NFSERR_INVAL)) {
694 nfs_state = STATE_READLINK_REQ;
698 nfs_download_state = NETLOOP_SUCCESS;
699 nfs_state = STATE_UMOUNT_REQ;
709 debug("%s\n", __func__);
710 nfs_download_state = NETLOOP_FAIL;
712 nfs_server_ip = net_server_ip;
713 nfs_path = (char *)nfs_path_buff;
715 if (nfs_path == NULL) {
716 net_set_state(NETLOOP_FAIL);
717 puts("*** ERROR: Fail allocate memory\n");
721 if (net_boot_file_name[0] == '\0') {
722 sprintf(nfs_path, "/nfsroot/%02X%02X%02X%02X.img",
723 net_ip.s_addr & 0xFF,
724 (net_ip.s_addr >> 8) & 0xFF,
725 (net_ip.s_addr >> 16) & 0xFF,
726 (net_ip.s_addr >> 24) & 0xFF);
728 printf("*** Warning: no boot file name; using '%s'\n",
731 char *p = net_boot_file_name;
736 nfs_server_ip = string_to_ip(net_boot_file_name);
740 strcpy(nfs_path, net_boot_file_name);
744 nfs_filename = basename(nfs_path);
745 nfs_path = dirname(nfs_path);
747 printf("Using %s device\n", eth_get_name());
749 printf("File transfer via NFS from server %pI4; our IP address is %pI4",
750 &nfs_server_ip, &net_ip);
752 /* Check if we need to send across this subnet */
753 if (net_gateway.s_addr && net_netmask.s_addr) {
754 struct in_addr our_net;
755 struct in_addr server_net;
757 our_net.s_addr = net_ip.s_addr & net_netmask.s_addr;
758 server_net.s_addr = net_server_ip.s_addr & net_netmask.s_addr;
759 if (our_net.s_addr != server_net.s_addr)
760 printf("; sending through gateway %pI4",
763 printf("\nFilename '%s/%s'.", nfs_path, nfs_filename);
765 if (net_boot_file_expected_size_in_blocks) {
766 printf(" Size is 0x%x Bytes = ",
767 net_boot_file_expected_size_in_blocks << 9);
768 print_size(net_boot_file_expected_size_in_blocks << 9, "");
770 printf("\nLoad address: 0x%lx\n"
771 "Loading: *\b", load_addr);
773 net_set_timeout_handler(nfs_timeout, nfs_timeout_handler);
774 net_set_udp_handler(nfs_handler);
776 nfs_timeout_count = 0;
777 nfs_state = STATE_PRCLOOKUP_PROG_MOUNT_REQ;
779 /*nfs_our_port = 4096 + (get_ticks() % 3072);*/
783 /* zero out server ether in case the server ip has changed */
784 memset(net_server_ethaddr, 0, 6);