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. */
34 #if ((CONFIG_COMMANDS & CFG_CMD_NET) && (CONFIG_COMMANDS & CFG_CMD_NFS))
36 #define HASHES_PER_LINE 65 /* Number of "loading" hashes per line */
37 #define NFS_TIMEOUT 60
39 static int fs_mounted = 0;
40 static unsigned long rpc_id = 0;
41 static int nfs_offset = -1;
44 static char dirfh[NFS_FHSIZE]; /* file handle of directory */
45 static char filefh[NFS_FHSIZE]; /* file handle of kernel image */
47 static IPaddr_t NfsServerIP;
48 static int NfsSrvMountPort;
49 static int NfsSrvNfsPort;
50 static int NfsOurPort;
51 static int NfsTimeoutCount;
53 #define STATE_PRCLOOKUP_PROG_MOUNT_REQ 1
54 #define STATE_PRCLOOKUP_PROG_NFS_REQ 2
55 #define STATE_MOUNT_REQ 3
56 #define STATE_UMOUNT_REQ 4
57 #define STATE_LOOKUP_REQ 5
58 #define STATE_READ_REQ 6
59 #define STATE_READLINK_REQ 7
61 static char default_filename[64];
62 static char *nfs_filename;
63 static char *nfs_path;
64 static char nfs_path_buff[2048];
66 static __inline__ void
67 store_block (uchar * src, unsigned offset, unsigned len)
69 ulong newsize = offset + len;
70 #ifdef CFG_DIRECT_FLASH_NFS
73 for (i=0; i<CFG_MAX_FLASH_BANKS; i++) {
74 /* start address in flash? */
75 if (load_addr + offset >= flash_info[i].start[0]) {
81 if (rc) { /* Flash is destination for this packet */
82 rc = flash_write ((uchar *)src, (ulong)(load_addr+offset), len);
85 NetState = NETLOOP_FAIL;
89 #endif /* CFG_DIRECT_FLASH_NFS */
91 (void)memcpy ((void *)(load_addr + offset), src, len);
94 if (NetBootFileXferSize < (offset+len))
95 NetBootFileXferSize = newsize;
103 fname = path + strlen(path) - 1;
104 while (fname >= path) {
119 fname = basename (path);
125 /**************************************************************************
126 RPC_ADD_CREDENTIALS - Add RPC authentication/verifier entries
127 **************************************************************************/
128 static long *rpc_add_credentials (long *p)
134 strcpy (hostname, "");
135 hostnamelen=strlen (hostname);
137 /* Here's the executive summary on authentication requirements of the
138 * various NFS server implementations: Linux accepts both AUTH_NONE
139 * and AUTH_UNIX authentication (also accepts an empty hostname field
140 * in the AUTH_UNIX scheme). *BSD refuses AUTH_NONE, but accepts
141 * AUTH_UNIX (also accepts an empty hostname field in the AUTH_UNIX
142 * scheme). To be safe, use AUTH_UNIX and pass the hostname if we have
143 * it (if the BOOTP/DHCP reply didn't give one, just use an empty
146 hl = (hostnamelen + 3) & ~3;
148 /* Provide an AUTH_UNIX credential. */
149 *p++ = htonl(1); /* AUTH_UNIX */
150 *p++ = htonl(hl+20); /* auth length */
151 *p++ = htonl(0); /* stamp */
152 *p++ = htonl(hostnamelen); /* hostname string */
153 if (hostnamelen & 3) {
154 *(p + hostnamelen / 4) = 0; /* add zero padding */
156 memcpy (p, hostname, hostnamelen);
160 *p++ = 0; /* auxiliary gid list */
162 /* Provide an AUTH_NONE verifier. */
163 *p++ = 0; /* AUTH_NONE */
164 *p++ = 0; /* auth length */
169 /**************************************************************************
170 RPC_LOOKUP - Lookup RPC Port numbers
171 **************************************************************************/
173 rpc_req (int rpc_prog, int rpc_proc, uint32_t *data, int datalen)
182 pkt.u.call.id = htonl(id);
183 pkt.u.call.type = htonl(MSG_CALL);
184 pkt.u.call.rpcvers = htonl(2); /* use RPC version 2 */
185 pkt.u.call.prog = htonl(rpc_prog);
186 pkt.u.call.vers = htonl(2); /* portmapper is version 2 */
187 pkt.u.call.proc = htonl(rpc_proc);
188 p = (uint32_t *)&(pkt.u.call.data);
191 memcpy ((char *)p, (char *)data, datalen*sizeof(uint32_t));
193 pktlen = (char *)p + datalen*sizeof(uint32_t) - (char *)&pkt;
195 memcpy ((char *)NetTxPacket + NetEthHdrSize() + IP_HDR_SIZE, (char *)&pkt, pktlen);
197 if (rpc_prog == PROG_PORTMAP)
199 else if (rpc_prog == PROG_MOUNT)
200 sport = NfsSrvMountPort;
202 sport = NfsSrvNfsPort;
204 NetSendUDPPacket (NetServerEther, NfsServerIP, sport, NfsOurPort, pktlen);
207 /**************************************************************************
208 RPC_LOOKUP - Lookup RPC Port numbers
209 **************************************************************************/
211 rpc_lookup_req (int prog, int ver)
215 data[0] = 0; data[1] = 0; /* auth credential */
216 data[2] = 0; data[3] = 0; /* auth verifier */
217 data[4] = htonl(prog);
218 data[5] = htonl(ver);
219 data[6] = htonl(17); /* IP_UDP */
222 rpc_req (PROG_PORTMAP, PORTMAP_GETPORT, data, 8);
225 /**************************************************************************
226 NFS_MOUNT - Mount an NFS Filesystem
227 **************************************************************************/
229 nfs_mount_req (char *path)
236 pathlen = strlen (path);
239 p = (uint32_t *)rpc_add_credentials((long *)p);
241 *p++ = htonl(pathlen);
242 if (pathlen & 3) *(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 */
267 p = (uint32_t *)rpc_add_credentials ((long *)p);
269 len = (uint32_t *)p - (uint32_t *)&(data[0]);
271 rpc_req (PROG_MOUNT, MOUNT_UMOUNTALL, data, len);
274 /***************************************************************************
275 * NFS_READLINK (AH 2003-07-14)
276 * This procedure is called when read of the first block fails -
277 * this probably happens when it's a directory or a symlink
278 * In case of successful readlink(), the dirname is manipulated,
279 * so that inside the nfs() function a recursion can be done.
280 **************************************************************************/
282 nfs_readlink_req (void)
289 p = (uint32_t *)rpc_add_credentials ((long *)p);
291 memcpy (p, filefh, NFS_FHSIZE);
292 p += (NFS_FHSIZE / 4);
294 len = (uint32_t *)p - (uint32_t *)&(data[0]);
296 rpc_req (PROG_NFS, NFS_READLINK, data, len);
299 /**************************************************************************
300 NFS_LOOKUP - Lookup Pathname
301 **************************************************************************/
303 nfs_lookup_req (char *fname)
310 fnamelen = strlen (fname);
313 p = (uint32_t *)rpc_add_credentials ((long *)p);
315 memcpy (p, dirfh, NFS_FHSIZE);
316 p += (NFS_FHSIZE / 4);
317 *p++ = htonl(fnamelen);
318 if (fnamelen & 3) *(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 **************************************************************************/
359 printf ("%s\n", __FUNCTION__);
363 case STATE_PRCLOOKUP_PROG_MOUNT_REQ:
364 rpc_lookup_req (PROG_MOUNT, 1);
366 case STATE_PRCLOOKUP_PROG_NFS_REQ:
367 rpc_lookup_req (PROG_NFS, 2);
369 case STATE_MOUNT_REQ:
370 nfs_mount_req (nfs_path);
372 case STATE_UMOUNT_REQ:
373 nfs_umountall_req ();
375 case STATE_LOOKUP_REQ:
376 nfs_lookup_req (nfs_filename);
379 nfs_read_req (nfs_offset, nfs_len);
381 case STATE_READLINK_REQ:
387 /**************************************************************************
388 Handlers for the reply from server
389 **************************************************************************/
392 rpc_lookup_reply (int prog, uchar *pkt, unsigned len)
394 struct rpc_t rpc_pkt;
396 memcpy ((unsigned char *)&rpc_pkt, pkt, len);
399 printf ("%s\n", __FUNCTION__);
402 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
405 if (rpc_pkt.u.reply.rstatus ||
406 rpc_pkt.u.reply.verifier ||
407 rpc_pkt.u.reply.astatus ||
408 rpc_pkt.u.reply.astatus) {
414 NfsSrvMountPort = ntohl(rpc_pkt.u.reply.data[0]);
417 NfsSrvNfsPort = ntohl(rpc_pkt.u.reply.data[0]);
425 nfs_mount_reply (uchar *pkt, unsigned len)
427 struct rpc_t rpc_pkt;
430 printf ("%s\n", __FUNCTION__);
433 memcpy ((unsigned char *)&rpc_pkt, pkt, len);
435 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
438 if (rpc_pkt.u.reply.rstatus ||
439 rpc_pkt.u.reply.verifier ||
440 rpc_pkt.u.reply.astatus ||
441 rpc_pkt.u.reply.data[0]) {
446 memcpy (dirfh, rpc_pkt.u.reply.data + 1, NFS_FHSIZE);
452 nfs_umountall_reply (uchar *pkt, unsigned len)
454 struct rpc_t rpc_pkt;
457 printf ("%s\n", __FUNCTION__);
460 memcpy ((unsigned char *)&rpc_pkt, pkt, len);
462 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
465 if (rpc_pkt.u.reply.rstatus ||
466 rpc_pkt.u.reply.verifier ||
467 rpc_pkt.u.reply.astatus) {
472 memset (dirfh, 0, sizeof(dirfh));
478 nfs_lookup_reply (uchar *pkt, unsigned len)
480 struct rpc_t rpc_pkt;
483 printf ("%s\n", __FUNCTION__);
486 memcpy ((unsigned char *)&rpc_pkt, pkt, len);
488 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
491 if (rpc_pkt.u.reply.rstatus ||
492 rpc_pkt.u.reply.verifier ||
493 rpc_pkt.u.reply.astatus ||
494 rpc_pkt.u.reply.data[0]) {
498 memcpy (filefh, rpc_pkt.u.reply.data + 1, NFS_FHSIZE);
504 nfs_readlink_reply (uchar *pkt, unsigned len)
506 struct rpc_t rpc_pkt;
510 printf ("%s\n", __FUNCTION__);
513 memcpy ((unsigned char *)&rpc_pkt, pkt, len);
515 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
518 if (rpc_pkt.u.reply.rstatus ||
519 rpc_pkt.u.reply.verifier ||
520 rpc_pkt.u.reply.astatus ||
521 rpc_pkt.u.reply.data[0]) {
525 rlen = ntohl (rpc_pkt.u.reply.data[1]); /* new path length */
527 if (*((char *)&(rpc_pkt.u.reply.data[2])) != '/') {
529 strcat (nfs_path, "/");
530 pathlen = strlen(nfs_path);
531 memcpy (nfs_path+pathlen, (uchar *)&(rpc_pkt.u.reply.data[2]), rlen);
532 nfs_path[pathlen+rlen+1] = 0;
534 memcpy (nfs_path, (uchar *)&(rpc_pkt.u.reply.data[2]), rlen);
541 nfs_read_reply (uchar *pkt, unsigned len)
543 struct rpc_t rpc_pkt;
547 printf ("%s\n", __FUNCTION__);
550 memcpy ((uchar *)&rpc_pkt, pkt, sizeof(rpc_pkt.u.reply));
552 if (ntohl(rpc_pkt.u.reply.id) != rpc_id)
555 if (rpc_pkt.u.reply.rstatus ||
556 rpc_pkt.u.reply.verifier ||
557 rpc_pkt.u.reply.astatus ||
558 rpc_pkt.u.reply.data[0]) {
559 if (rpc_pkt.u.reply.rstatus) {
562 if (rpc_pkt.u.reply.astatus) {
565 return -ntohl(rpc_pkt.u.reply.data[0]);;
568 if ((nfs_offset!=0) && !((nfs_offset) % (NFS_READ_SIZE/2*10*HASHES_PER_LINE))) {
571 if (!(nfs_offset % ((NFS_READ_SIZE/2)*10))) {
575 rlen = ntohl(rpc_pkt.u.reply.data[18]);
576 store_block ((uchar *)pkt+sizeof(rpc_pkt.u.reply), nfs_offset, rlen);
581 /**************************************************************************
583 **************************************************************************/
586 NfsHandler (uchar *pkt, unsigned dest, unsigned src, unsigned len)
591 printf ("%s\n", __FUNCTION__);
594 if (dest != NfsOurPort) return;
597 case STATE_PRCLOOKUP_PROG_MOUNT_REQ:
598 rpc_lookup_reply (PROG_MOUNT, pkt, len);
599 NfsState = STATE_PRCLOOKUP_PROG_NFS_REQ;
603 case STATE_PRCLOOKUP_PROG_NFS_REQ:
604 rpc_lookup_reply (PROG_NFS, pkt, len);
605 NfsState = STATE_MOUNT_REQ;
609 case STATE_MOUNT_REQ:
610 if (nfs_mount_reply(pkt, len)) {
611 puts ("*** ERROR: Cannot mount\n");
612 /* just to be sure... */
613 NfsState = STATE_UMOUNT_REQ;
616 NfsState = STATE_LOOKUP_REQ;
621 case STATE_UMOUNT_REQ:
622 if (nfs_umountall_reply(pkt, len)) {
623 puts ("*** ERROR: Cannot umount\n");
624 NetState = NETLOOP_FAIL;
627 NetState = NETLOOP_SUCCESS;
631 case STATE_LOOKUP_REQ:
632 if (nfs_lookup_reply(pkt, len)) {
633 puts ("*** ERROR: File lookup fail\n");
634 NfsState = STATE_UMOUNT_REQ;
637 NfsState = STATE_READ_REQ;
639 nfs_len = NFS_READ_SIZE;
644 case STATE_READLINK_REQ:
645 if (nfs_readlink_reply(pkt, len)) {
646 puts ("*** ERROR: Symlink fail\n");
647 NfsState = STATE_UMOUNT_REQ;
651 printf ("Symlink --> %s\n", nfs_path);
653 nfs_filename = basename (nfs_path);
654 nfs_path = dirname (nfs_path);
656 NfsState = STATE_MOUNT_REQ;
662 rlen = nfs_read_reply (pkt, len);
667 else if ((rlen == -NFSERR_ISDIR)||(rlen == -NFSERR_INVAL)) {
669 NfsState = STATE_READLINK_REQ;
672 NfsState = STATE_UMOUNT_REQ;
683 NetState = NETLOOP_FAIL;
691 printf ("%s\n", __FUNCTION__);
694 NfsServerIP = NetServerIP;
695 nfs_path = (char *)nfs_path_buff;
697 if (nfs_path == NULL) {
698 NetState = NETLOOP_FAIL;
699 puts ("*** ERROR: Fail allocate memory\n");
703 if (BootFile[0] == '\0') {
704 IPaddr_t OurIP = ntohl (NetOurIP);
706 sprintf (default_filename, "/nfsroot/%02lX%02lX%02lX%02lX.img",
709 (OurIP >> 16) & 0xFF,
710 (OurIP >> 24) & 0xFF );
711 strcpy (nfs_path, default_filename);
713 printf ("*** Warning: no boot file name; using '%s'\n",
721 NfsServerIP = string_to_ip (BootFile);
723 strcpy (nfs_path, p);
725 strcpy (nfs_path, BootFile);
729 nfs_filename = basename (nfs_path);
730 nfs_path = dirname (nfs_path);
732 #if defined(CONFIG_NET_MULTI)
733 printf ("Using %s device\n", eth_get_name());
736 puts ("File transfer via NFS from server "); print_IPaddr (NfsServerIP);
737 puts ("; our IP address is "); print_IPaddr (NetOurIP);
739 /* Check if we need to send across this subnet */
740 if (NetOurGatewayIP && NetOurSubnetMask) {
741 IPaddr_t OurNet = NetOurIP & NetOurSubnetMask;
742 IPaddr_t ServerNet = NetServerIP & NetOurSubnetMask;
744 if (OurNet != ServerNet) {
745 puts ("; sending through gateway ");
746 print_IPaddr (NetOurGatewayIP) ;
749 printf ("\nFilename '%s/%s'.", nfs_path, nfs_filename);
751 if (NetBootFileSize) {
752 printf (" Size is 0x%x Bytes = ", NetBootFileSize<<9);
753 print_size (NetBootFileSize<<9, "");
755 printf ("\nLoad address: 0x%lx\n"
756 "Loading: *\b", load_addr);
758 NetSetTimeout (NFS_TIMEOUT * CFG_HZ, NfsTimeout);
759 NetSetHandler (NfsHandler);
762 NfsState = STATE_PRCLOOKUP_PROG_MOUNT_REQ;
764 /*NfsOurPort = 4096 + (get_ticks() % 3072);*/
768 /* zero out server ether in case the server ip has changed */
769 memset (NetServerEther, 0, 6);
774 #endif /* CONFIG_COMMANDS & CFG_CMD_NFS */