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 defined(CONFIG_CMD_NET) && defined(CONFIG_CMD_NFS)
36 #define HASHES_PER_LINE 65 /* Number of "loading" hashes per line */
37 #define NFS_TIMEOUT 60UL
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 int NfsDownloadState
;
48 static IPaddr_t NfsServerIP
;
49 static int NfsSrvMountPort
;
50 static int NfsSrvNfsPort
;
51 static int NfsOurPort
;
52 static int NfsTimeoutCount
;
54 #define STATE_PRCLOOKUP_PROG_MOUNT_REQ 1
55 #define STATE_PRCLOOKUP_PROG_NFS_REQ 2
56 #define STATE_MOUNT_REQ 3
57 #define STATE_UMOUNT_REQ 4
58 #define STATE_LOOKUP_REQ 5
59 #define STATE_READ_REQ 6
60 #define STATE_READLINK_REQ 7
62 static char default_filename
[64];
63 static char *nfs_filename
;
64 static char *nfs_path
;
65 static char nfs_path_buff
[2048];
68 store_block (uchar
* src
, unsigned offset
, unsigned len
)
70 ulong newsize
= offset
+ len
;
71 #ifdef CFG_DIRECT_FLASH_NFS
74 for (i
=0; i
<CFG_MAX_FLASH_BANKS
; i
++) {
75 /* start address in flash? */
76 if (load_addr
+ offset
>= flash_info
[i
].start
[0]) {
82 if (rc
) { /* Flash is destination for this packet */
83 rc
= flash_write ((uchar
*)src
, (ulong
)(load_addr
+offset
), len
);
89 #endif /* CFG_DIRECT_FLASH_NFS */
91 (void)memcpy ((void *)(load_addr
+ offset
), src
, len
);
94 if (NetBootFileXferSize
< (offset
+len
))
95 NetBootFileXferSize
= newsize
;
100 basename (char *path
)
104 fname
= path
+ strlen(path
) - 1;
105 while (fname
>= path
) {
120 fname
= basename (path
);
126 /**************************************************************************
127 RPC_ADD_CREDENTIALS - Add RPC authentication/verifier entries
128 **************************************************************************/
129 static long *rpc_add_credentials (long *p
)
135 strcpy (hostname
, "");
136 hostnamelen
=strlen (hostname
);
138 /* Here's the executive summary on authentication requirements of the
139 * various NFS server implementations: Linux accepts both AUTH_NONE
140 * and AUTH_UNIX authentication (also accepts an empty hostname field
141 * in the AUTH_UNIX scheme). *BSD refuses AUTH_NONE, but accepts
142 * AUTH_UNIX (also accepts an empty hostname field in the AUTH_UNIX
143 * scheme). To be safe, use AUTH_UNIX and pass the hostname if we have
144 * it (if the BOOTP/DHCP reply didn't give one, just use an empty
147 hl
= (hostnamelen
+ 3) & ~3;
149 /* Provide an AUTH_UNIX credential. */
150 *p
++ = htonl(1); /* AUTH_UNIX */
151 *p
++ = htonl(hl
+20); /* auth length */
152 *p
++ = htonl(0); /* stamp */
153 *p
++ = htonl(hostnamelen
); /* hostname string */
154 if (hostnamelen
& 3) {
155 *(p
+ hostnamelen
/ 4) = 0; /* add zero padding */
157 memcpy (p
, hostname
, hostnamelen
);
161 *p
++ = 0; /* auxiliary gid list */
163 /* Provide an AUTH_NONE verifier. */
164 *p
++ = 0; /* AUTH_NONE */
165 *p
++ = 0; /* auth length */
170 /**************************************************************************
171 RPC_LOOKUP - Lookup RPC Port numbers
172 **************************************************************************/
174 rpc_req (int rpc_prog
, int rpc_proc
, uint32_t *data
, int datalen
)
183 pkt
.u
.call
.id
= htonl(id
);
184 pkt
.u
.call
.type
= htonl(MSG_CALL
);
185 pkt
.u
.call
.rpcvers
= htonl(2); /* use RPC version 2 */
186 pkt
.u
.call
.prog
= htonl(rpc_prog
);
187 pkt
.u
.call
.vers
= htonl(2); /* portmapper is version 2 */
188 pkt
.u
.call
.proc
= htonl(rpc_proc
);
189 p
= (uint32_t *)&(pkt
.u
.call
.data
);
192 memcpy ((char *)p
, (char *)data
, datalen
*sizeof(uint32_t));
194 pktlen
= (char *)p
+ datalen
*sizeof(uint32_t) - (char *)&pkt
;
196 memcpy ((char *)NetTxPacket
+ NetEthHdrSize() + IP_HDR_SIZE
, (char *)&pkt
, pktlen
);
198 if (rpc_prog
== PROG_PORTMAP
)
200 else if (rpc_prog
== PROG_MOUNT
)
201 sport
= NfsSrvMountPort
;
203 sport
= NfsSrvNfsPort
;
205 NetSendUDPPacket (NetServerEther
, NfsServerIP
, sport
, NfsOurPort
, pktlen
);
208 /**************************************************************************
209 RPC_LOOKUP - Lookup RPC Port numbers
210 **************************************************************************/
212 rpc_lookup_req (int prog
, int ver
)
216 data
[0] = 0; data
[1] = 0; /* auth credential */
217 data
[2] = 0; data
[3] = 0; /* auth verifier */
218 data
[4] = htonl(prog
);
219 data
[5] = htonl(ver
);
220 data
[6] = htonl(17); /* IP_UDP */
223 rpc_req (PROG_PORTMAP
, PORTMAP_GETPORT
, data
, 8);
226 /**************************************************************************
227 NFS_MOUNT - Mount an NFS Filesystem
228 **************************************************************************/
230 nfs_mount_req (char *path
)
237 pathlen
= strlen (path
);
240 p
= (uint32_t *)rpc_add_credentials((long *)p
);
242 *p
++ = htonl(pathlen
);
243 if (pathlen
& 3) *(p
+ pathlen
/ 4) = 0;
244 memcpy (p
, path
, pathlen
);
245 p
+= (pathlen
+ 3) / 4;
247 len
= (uint32_t *)p
- (uint32_t *)&(data
[0]);
249 rpc_req (PROG_MOUNT
, MOUNT_ADDENTRY
, data
, len
);
252 /**************************************************************************
253 NFS_UMOUNTALL - Unmount all our NFS Filesystems on the Server
254 **************************************************************************/
256 nfs_umountall_req (void)
262 if ((NfsSrvMountPort
== -1) || (!fs_mounted
)) {
263 /* Nothing mounted, nothing to umount */
268 p
= (uint32_t *)rpc_add_credentials ((long *)p
);
270 len
= (uint32_t *)p
- (uint32_t *)&(data
[0]);
272 rpc_req (PROG_MOUNT
, MOUNT_UMOUNTALL
, data
, len
);
275 /***************************************************************************
276 * NFS_READLINK (AH 2003-07-14)
277 * This procedure is called when read of the first block fails -
278 * this probably happens when it's a directory or a symlink
279 * In case of successful readlink(), the dirname is manipulated,
280 * so that inside the nfs() function a recursion can be done.
281 **************************************************************************/
283 nfs_readlink_req (void)
290 p
= (uint32_t *)rpc_add_credentials ((long *)p
);
292 memcpy (p
, filefh
, NFS_FHSIZE
);
293 p
+= (NFS_FHSIZE
/ 4);
295 len
= (uint32_t *)p
- (uint32_t *)&(data
[0]);
297 rpc_req (PROG_NFS
, NFS_READLINK
, data
, len
);
300 /**************************************************************************
301 NFS_LOOKUP - Lookup Pathname
302 **************************************************************************/
304 nfs_lookup_req (char *fname
)
311 fnamelen
= strlen (fname
);
314 p
= (uint32_t *)rpc_add_credentials ((long *)p
);
316 memcpy (p
, dirfh
, NFS_FHSIZE
);
317 p
+= (NFS_FHSIZE
/ 4);
318 *p
++ = htonl(fnamelen
);
319 if (fnamelen
& 3) *(p
+ fnamelen
/ 4) = 0;
320 memcpy (p
, fname
, fnamelen
);
321 p
+= (fnamelen
+ 3) / 4;
323 len
= (uint32_t *)p
- (uint32_t *)&(data
[0]);
325 rpc_req (PROG_NFS
, NFS_LOOKUP
, data
, len
);
328 /**************************************************************************
329 NFS_READ - Read File on NFS Server
330 **************************************************************************/
332 nfs_read_req (int offset
, int readlen
)
339 p
= (uint32_t *)rpc_add_credentials ((long *)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 **************************************************************************/
360 printf ("%s\n", __FUNCTION__
);
364 case STATE_PRCLOOKUP_PROG_MOUNT_REQ
:
365 rpc_lookup_req (PROG_MOUNT
, 1);
367 case STATE_PRCLOOKUP_PROG_NFS_REQ
:
368 rpc_lookup_req (PROG_NFS
, 2);
370 case STATE_MOUNT_REQ
:
371 nfs_mount_req (nfs_path
);
373 case STATE_UMOUNT_REQ
:
374 nfs_umountall_req ();
376 case STATE_LOOKUP_REQ
:
377 nfs_lookup_req (nfs_filename
);
380 nfs_read_req (nfs_offset
, nfs_len
);
382 case STATE_READLINK_REQ
:
388 /**************************************************************************
389 Handlers for the reply from server
390 **************************************************************************/
393 rpc_lookup_reply (int prog
, uchar
*pkt
, unsigned len
)
395 struct rpc_t rpc_pkt
;
397 memcpy ((unsigned char *)&rpc_pkt
, pkt
, len
);
400 printf ("%s\n", __FUNCTION__
);
403 if (ntohl(rpc_pkt
.u
.reply
.id
) != rpc_id
)
406 if (rpc_pkt
.u
.reply
.rstatus
||
407 rpc_pkt
.u
.reply
.verifier
||
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 if ( store_block ((uchar
*)pkt
+sizeof(rpc_pkt
.u
.reply
), nfs_offset
, rlen
) )
582 /**************************************************************************
584 **************************************************************************/
590 NetState
= NETLOOP_FAIL
;
595 NfsHandler (uchar
*pkt
, unsigned dest
, unsigned src
, unsigned len
)
600 printf ("%s\n", __FUNCTION__
);
603 if (dest
!= NfsOurPort
) return;
606 case STATE_PRCLOOKUP_PROG_MOUNT_REQ
:
607 rpc_lookup_reply (PROG_MOUNT
, pkt
, len
);
608 NfsState
= STATE_PRCLOOKUP_PROG_NFS_REQ
;
612 case STATE_PRCLOOKUP_PROG_NFS_REQ
:
613 rpc_lookup_reply (PROG_NFS
, pkt
, len
);
614 NfsState
= STATE_MOUNT_REQ
;
618 case STATE_MOUNT_REQ
:
619 if (nfs_mount_reply(pkt
, len
)) {
620 puts ("*** ERROR: Cannot mount\n");
621 /* just to be sure... */
622 NfsState
= STATE_UMOUNT_REQ
;
625 NfsState
= STATE_LOOKUP_REQ
;
630 case STATE_UMOUNT_REQ
:
631 if (nfs_umountall_reply(pkt
, len
)) {
632 puts ("*** ERROR: Cannot umount\n");
633 NetState
= NETLOOP_FAIL
;
636 NetState
= NfsDownloadState
;
640 case STATE_LOOKUP_REQ
:
641 if (nfs_lookup_reply(pkt
, len
)) {
642 puts ("*** ERROR: File lookup fail\n");
643 NfsState
= STATE_UMOUNT_REQ
;
646 NfsState
= STATE_READ_REQ
;
648 nfs_len
= NFS_READ_SIZE
;
653 case STATE_READLINK_REQ
:
654 if (nfs_readlink_reply(pkt
, len
)) {
655 puts ("*** ERROR: Symlink fail\n");
656 NfsState
= STATE_UMOUNT_REQ
;
660 printf ("Symlink --> %s\n", nfs_path
);
662 nfs_filename
= basename (nfs_path
);
663 nfs_path
= dirname (nfs_path
);
665 NfsState
= STATE_MOUNT_REQ
;
671 rlen
= nfs_read_reply (pkt
, len
);
672 NetSetTimeout (NFS_TIMEOUT
* CFG_HZ
, NfsTimeout
);
677 else if ((rlen
== -NFSERR_ISDIR
)||(rlen
== -NFSERR_INVAL
)) {
679 NfsState
= STATE_READLINK_REQ
;
682 if ( ! rlen
) NfsDownloadState
= NETLOOP_SUCCESS
;
683 NfsState
= STATE_UMOUNT_REQ
;
695 printf ("%s\n", __FUNCTION__
);
697 NfsDownloadState
= NETLOOP_FAIL
;
699 NfsServerIP
= NetServerIP
;
700 nfs_path
= (char *)nfs_path_buff
;
702 if (nfs_path
== NULL
) {
703 NetState
= NETLOOP_FAIL
;
704 puts ("*** ERROR: Fail allocate memory\n");
708 if (BootFile
[0] == '\0') {
709 sprintf (default_filename
, "/nfsroot/%02lX%02lX%02lX%02lX.img",
711 (NetOurIP
>> 8) & 0xFF,
712 (NetOurIP
>> 16) & 0xFF,
713 (NetOurIP
>> 24) & 0xFF );
714 strcpy (nfs_path
, default_filename
);
716 printf ("*** Warning: no boot file name; using '%s'\n",
724 NfsServerIP
= string_to_ip (BootFile
);
726 strcpy (nfs_path
, p
);
728 strcpy (nfs_path
, BootFile
);
732 nfs_filename
= basename (nfs_path
);
733 nfs_path
= dirname (nfs_path
);
735 #if defined(CONFIG_NET_MULTI)
736 printf ("Using %s device\n", eth_get_name());
739 puts ("File transfer via NFS from server "); print_IPaddr (NfsServerIP
);
740 puts ("; our IP address is "); print_IPaddr (NetOurIP
);
742 /* Check if we need to send across this subnet */
743 if (NetOurGatewayIP
&& NetOurSubnetMask
) {
744 IPaddr_t OurNet
= NetOurIP
& NetOurSubnetMask
;
745 IPaddr_t ServerNet
= NetServerIP
& NetOurSubnetMask
;
747 if (OurNet
!= ServerNet
) {
748 puts ("; sending through gateway ");
749 print_IPaddr (NetOurGatewayIP
) ;
752 printf ("\nFilename '%s/%s'.", nfs_path
, nfs_filename
);
754 if (NetBootFileSize
) {
755 printf (" Size is 0x%x Bytes = ", NetBootFileSize
<<9);
756 print_size (NetBootFileSize
<<9, "");
758 printf ("\nLoad address: 0x%lx\n"
759 "Loading: *\b", load_addr
);
761 NetSetTimeout (NFS_TIMEOUT
* CFG_HZ
, NfsTimeout
);
762 NetSetHandler (NfsHandler
);
765 NfsState
= STATE_PRCLOOKUP_PROG_MOUNT_REQ
;
767 /*NfsOurPort = 4096 + (get_ticks() % 3072);*/
771 /* zero out server ether in case the server ip has changed */
772 memset (NetServerEther
, 0, 6);