nfs2xdr.c 26 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160
  1. /*
  2. * linux/fs/nfs/nfs2xdr.c
  3. *
  4. * XDR functions to encode/decode NFS RPC arguments and results.
  5. *
  6. * Copyright (C) 1992, 1993, 1994 Rick Sladkey
  7. * Copyright (C) 1996 Olaf Kirch
  8. * 04 Aug 1998 Ion Badulescu <ionut@cs.columbia.edu>
  9. * FIFO's need special handling in NFSv2
  10. */
  11. #include <linux/param.h>
  12. #include <linux/time.h>
  13. #include <linux/mm.h>
  14. #include <linux/errno.h>
  15. #include <linux/string.h>
  16. #include <linux/in.h>
  17. #include <linux/pagemap.h>
  18. #include <linux/proc_fs.h>
  19. #include <linux/sunrpc/clnt.h>
  20. #include <linux/nfs.h>
  21. #include <linux/nfs2.h>
  22. #include <linux/nfs_fs.h>
  23. #include "internal.h"
  24. #define NFSDBG_FACILITY NFSDBG_XDR
  25. /* Mapping from NFS error code to "errno" error code. */
  26. #define errno_NFSERR_IO EIO
  27. /*
  28. * Declare the space requirements for NFS arguments and replies as
  29. * number of 32bit-words
  30. */
  31. #define NFS_fhandle_sz (8)
  32. #define NFS_sattr_sz (8)
  33. #define NFS_filename_sz (1+(NFS2_MAXNAMLEN>>2))
  34. #define NFS_path_sz (1+(NFS2_MAXPATHLEN>>2))
  35. #define NFS_fattr_sz (17)
  36. #define NFS_info_sz (5)
  37. #define NFS_entry_sz (NFS_filename_sz+3)
  38. #define NFS_diropargs_sz (NFS_fhandle_sz+NFS_filename_sz)
  39. #define NFS_removeargs_sz (NFS_fhandle_sz+NFS_filename_sz)
  40. #define NFS_sattrargs_sz (NFS_fhandle_sz+NFS_sattr_sz)
  41. #define NFS_readlinkargs_sz (NFS_fhandle_sz)
  42. #define NFS_readargs_sz (NFS_fhandle_sz+3)
  43. #define NFS_writeargs_sz (NFS_fhandle_sz+4)
  44. #define NFS_createargs_sz (NFS_diropargs_sz+NFS_sattr_sz)
  45. #define NFS_renameargs_sz (NFS_diropargs_sz+NFS_diropargs_sz)
  46. #define NFS_linkargs_sz (NFS_fhandle_sz+NFS_diropargs_sz)
  47. #define NFS_symlinkargs_sz (NFS_diropargs_sz+1+NFS_sattr_sz)
  48. #define NFS_readdirargs_sz (NFS_fhandle_sz+2)
  49. #define NFS_attrstat_sz (1+NFS_fattr_sz)
  50. #define NFS_diropres_sz (1+NFS_fhandle_sz+NFS_fattr_sz)
  51. #define NFS_readlinkres_sz (2)
  52. #define NFS_readres_sz (1+NFS_fattr_sz+1)
  53. #define NFS_writeres_sz (NFS_attrstat_sz)
  54. #define NFS_stat_sz (1)
  55. #define NFS_readdirres_sz (1)
  56. #define NFS_statfsres_sz (1+NFS_info_sz)
  57. static int nfs_stat_to_errno(enum nfs_stat);
  58. /*
  59. * While encoding arguments, set up the reply buffer in advance to
  60. * receive reply data directly into the page cache.
  61. */
  62. static void prepare_reply_buffer(struct rpc_rqst *req, struct page **pages,
  63. unsigned int base, unsigned int len,
  64. unsigned int bufsize)
  65. {
  66. struct rpc_auth *auth = req->rq_cred->cr_auth;
  67. unsigned int replen;
  68. replen = RPC_REPHDRSIZE + auth->au_rslack + bufsize;
  69. xdr_inline_pages(&req->rq_rcv_buf, replen << 2, pages, base, len);
  70. }
  71. /*
  72. * Handle decode buffer overflows out-of-line.
  73. */
  74. static void print_overflow_msg(const char *func, const struct xdr_stream *xdr)
  75. {
  76. dprintk("NFS: %s prematurely hit the end of our receive buffer. "
  77. "Remaining buffer length is %tu words.\n",
  78. func, xdr->end - xdr->p);
  79. }
  80. /*
  81. * Encode/decode NFSv2 basic data types
  82. *
  83. * Basic NFSv2 data types are defined in section 2.3 of RFC 1094:
  84. * "NFS: Network File System Protocol Specification".
  85. *
  86. * Not all basic data types have their own encoding and decoding
  87. * functions. For run-time efficiency, some data types are encoded
  88. * or decoded inline.
  89. */
  90. /*
  91. * typedef opaque nfsdata<>;
  92. */
  93. static int decode_nfsdata(struct xdr_stream *xdr, struct nfs_readres *result)
  94. {
  95. u32 recvd, count;
  96. size_t hdrlen;
  97. __be32 *p;
  98. p = xdr_inline_decode(xdr, 4);
  99. if (unlikely(p == NULL))
  100. goto out_overflow;
  101. count = be32_to_cpup(p);
  102. hdrlen = (u8 *)xdr->p - (u8 *)xdr->iov->iov_base;
  103. recvd = xdr->buf->len - hdrlen;
  104. if (unlikely(count > recvd))
  105. goto out_cheating;
  106. out:
  107. xdr_read_pages(xdr, count);
  108. result->eof = 0; /* NFSv2 does not pass EOF flag on the wire. */
  109. result->count = count;
  110. return count;
  111. out_cheating:
  112. dprintk("NFS: server cheating in read result: "
  113. "count %u > recvd %u\n", count, recvd);
  114. count = recvd;
  115. goto out;
  116. out_overflow:
  117. print_overflow_msg(__func__, xdr);
  118. return -EIO;
  119. }
  120. /*
  121. * enum stat {
  122. * NFS_OK = 0,
  123. * NFSERR_PERM = 1,
  124. * NFSERR_NOENT = 2,
  125. * NFSERR_IO = 5,
  126. * NFSERR_NXIO = 6,
  127. * NFSERR_ACCES = 13,
  128. * NFSERR_EXIST = 17,
  129. * NFSERR_NODEV = 19,
  130. * NFSERR_NOTDIR = 20,
  131. * NFSERR_ISDIR = 21,
  132. * NFSERR_FBIG = 27,
  133. * NFSERR_NOSPC = 28,
  134. * NFSERR_ROFS = 30,
  135. * NFSERR_NAMETOOLONG = 63,
  136. * NFSERR_NOTEMPTY = 66,
  137. * NFSERR_DQUOT = 69,
  138. * NFSERR_STALE = 70,
  139. * NFSERR_WFLUSH = 99
  140. * };
  141. */
  142. static int decode_stat(struct xdr_stream *xdr, enum nfs_stat *status)
  143. {
  144. __be32 *p;
  145. p = xdr_inline_decode(xdr, 4);
  146. if (unlikely(p == NULL))
  147. goto out_overflow;
  148. *status = be32_to_cpup(p);
  149. return 0;
  150. out_overflow:
  151. print_overflow_msg(__func__, xdr);
  152. return -EIO;
  153. }
  154. /*
  155. * 2.3.2. ftype
  156. *
  157. * enum ftype {
  158. * NFNON = 0,
  159. * NFREG = 1,
  160. * NFDIR = 2,
  161. * NFBLK = 3,
  162. * NFCHR = 4,
  163. * NFLNK = 5
  164. * };
  165. *
  166. */
  167. static __be32 *xdr_decode_ftype(__be32 *p, u32 *type)
  168. {
  169. *type = be32_to_cpup(p++);
  170. if (unlikely(*type > NF2FIFO))
  171. *type = NFBAD;
  172. return p;
  173. }
  174. /*
  175. * 2.3.3. fhandle
  176. *
  177. * typedef opaque fhandle[FHSIZE];
  178. */
  179. static void encode_fhandle(struct xdr_stream *xdr, const struct nfs_fh *fh)
  180. {
  181. __be32 *p;
  182. BUG_ON(fh->size != NFS2_FHSIZE);
  183. p = xdr_reserve_space(xdr, NFS2_FHSIZE);
  184. memcpy(p, fh->data, NFS2_FHSIZE);
  185. }
  186. static int decode_fhandle(struct xdr_stream *xdr, struct nfs_fh *fh)
  187. {
  188. __be32 *p;
  189. p = xdr_inline_decode(xdr, NFS2_FHSIZE);
  190. if (unlikely(p == NULL))
  191. goto out_overflow;
  192. fh->size = NFS2_FHSIZE;
  193. memcpy(fh->data, p, NFS2_FHSIZE);
  194. return 0;
  195. out_overflow:
  196. print_overflow_msg(__func__, xdr);
  197. return -EIO;
  198. }
  199. /*
  200. * 2.3.4. timeval
  201. *
  202. * struct timeval {
  203. * unsigned int seconds;
  204. * unsigned int useconds;
  205. * };
  206. */
  207. static __be32 *xdr_encode_time(__be32 *p, const struct timespec *timep)
  208. {
  209. *p++ = cpu_to_be32(timep->tv_sec);
  210. if (timep->tv_nsec != 0)
  211. *p++ = cpu_to_be32(timep->tv_nsec / NSEC_PER_USEC);
  212. else
  213. *p++ = cpu_to_be32(0);
  214. return p;
  215. }
  216. /*
  217. * Passing the invalid value useconds=1000000 is a Sun convention for
  218. * "set to current server time". It's needed to make permissions checks
  219. * for the "touch" program across v2 mounts to Solaris and Irix servers
  220. * work correctly. See description of sattr in section 6.1 of "NFS
  221. * Illustrated" by Brent Callaghan, Addison-Wesley, ISBN 0-201-32750-5.
  222. */
  223. static __be32 *xdr_encode_current_server_time(__be32 *p,
  224. const struct timespec *timep)
  225. {
  226. *p++ = cpu_to_be32(timep->tv_sec);
  227. *p++ = cpu_to_be32(1000000);
  228. return p;
  229. }
  230. static __be32 *xdr_decode_time(__be32 *p, struct timespec *timep)
  231. {
  232. timep->tv_sec = be32_to_cpup(p++);
  233. timep->tv_nsec = be32_to_cpup(p++) * NSEC_PER_USEC;
  234. return p;
  235. }
  236. /*
  237. * 2.3.5. fattr
  238. *
  239. * struct fattr {
  240. * ftype type;
  241. * unsigned int mode;
  242. * unsigned int nlink;
  243. * unsigned int uid;
  244. * unsigned int gid;
  245. * unsigned int size;
  246. * unsigned int blocksize;
  247. * unsigned int rdev;
  248. * unsigned int blocks;
  249. * unsigned int fsid;
  250. * unsigned int fileid;
  251. * timeval atime;
  252. * timeval mtime;
  253. * timeval ctime;
  254. * };
  255. *
  256. */
  257. static int decode_fattr(struct xdr_stream *xdr, struct nfs_fattr *fattr)
  258. {
  259. u32 rdev, type;
  260. __be32 *p;
  261. p = xdr_inline_decode(xdr, NFS_fattr_sz << 2);
  262. if (unlikely(p == NULL))
  263. goto out_overflow;
  264. fattr->valid |= NFS_ATTR_FATTR_V2;
  265. p = xdr_decode_ftype(p, &type);
  266. fattr->mode = be32_to_cpup(p++);
  267. fattr->nlink = be32_to_cpup(p++);
  268. fattr->uid = be32_to_cpup(p++);
  269. fattr->gid = be32_to_cpup(p++);
  270. fattr->size = be32_to_cpup(p++);
  271. fattr->du.nfs2.blocksize = be32_to_cpup(p++);
  272. rdev = be32_to_cpup(p++);
  273. fattr->rdev = new_decode_dev(rdev);
  274. if (type == (u32)NFCHR && rdev == (u32)NFS2_FIFO_DEV) {
  275. fattr->mode = (fattr->mode & ~S_IFMT) | S_IFIFO;
  276. fattr->rdev = 0;
  277. }
  278. fattr->du.nfs2.blocks = be32_to_cpup(p++);
  279. fattr->fsid.major = be32_to_cpup(p++);
  280. fattr->fsid.minor = 0;
  281. fattr->fileid = be32_to_cpup(p++);
  282. p = xdr_decode_time(p, &fattr->atime);
  283. p = xdr_decode_time(p, &fattr->mtime);
  284. xdr_decode_time(p, &fattr->ctime);
  285. fattr->change_attr = nfs_timespec_to_change_attr(&fattr->ctime);
  286. return 0;
  287. out_overflow:
  288. print_overflow_msg(__func__, xdr);
  289. return -EIO;
  290. }
  291. /*
  292. * 2.3.6. sattr
  293. *
  294. * struct sattr {
  295. * unsigned int mode;
  296. * unsigned int uid;
  297. * unsigned int gid;
  298. * unsigned int size;
  299. * timeval atime;
  300. * timeval mtime;
  301. * };
  302. */
  303. #define NFS2_SATTR_NOT_SET (0xffffffff)
  304. static __be32 *xdr_time_not_set(__be32 *p)
  305. {
  306. *p++ = cpu_to_be32(NFS2_SATTR_NOT_SET);
  307. *p++ = cpu_to_be32(NFS2_SATTR_NOT_SET);
  308. return p;
  309. }
  310. static void encode_sattr(struct xdr_stream *xdr, const struct iattr *attr)
  311. {
  312. __be32 *p;
  313. p = xdr_reserve_space(xdr, NFS_sattr_sz << 2);
  314. if (attr->ia_valid & ATTR_MODE)
  315. *p++ = cpu_to_be32(attr->ia_mode);
  316. else
  317. *p++ = cpu_to_be32(NFS2_SATTR_NOT_SET);
  318. if (attr->ia_valid & ATTR_UID)
  319. *p++ = cpu_to_be32(attr->ia_uid);
  320. else
  321. *p++ = cpu_to_be32(NFS2_SATTR_NOT_SET);
  322. if (attr->ia_valid & ATTR_GID)
  323. *p++ = cpu_to_be32(attr->ia_gid);
  324. else
  325. *p++ = cpu_to_be32(NFS2_SATTR_NOT_SET);
  326. if (attr->ia_valid & ATTR_SIZE)
  327. *p++ = cpu_to_be32((u32)attr->ia_size);
  328. else
  329. *p++ = cpu_to_be32(NFS2_SATTR_NOT_SET);
  330. if (attr->ia_valid & ATTR_ATIME_SET)
  331. p = xdr_encode_time(p, &attr->ia_atime);
  332. else if (attr->ia_valid & ATTR_ATIME)
  333. p = xdr_encode_current_server_time(p, &attr->ia_atime);
  334. else
  335. p = xdr_time_not_set(p);
  336. if (attr->ia_valid & ATTR_MTIME_SET)
  337. xdr_encode_time(p, &attr->ia_mtime);
  338. else if (attr->ia_valid & ATTR_MTIME)
  339. xdr_encode_current_server_time(p, &attr->ia_mtime);
  340. else
  341. xdr_time_not_set(p);
  342. }
  343. /*
  344. * 2.3.7. filename
  345. *
  346. * typedef string filename<MAXNAMLEN>;
  347. */
  348. static void encode_filename(struct xdr_stream *xdr,
  349. const char *name, u32 length)
  350. {
  351. __be32 *p;
  352. BUG_ON(length > NFS2_MAXNAMLEN);
  353. p = xdr_reserve_space(xdr, 4 + length);
  354. xdr_encode_opaque(p, name, length);
  355. }
  356. static int decode_filename_inline(struct xdr_stream *xdr,
  357. const char **name, u32 *length)
  358. {
  359. __be32 *p;
  360. u32 count;
  361. p = xdr_inline_decode(xdr, 4);
  362. if (unlikely(p == NULL))
  363. goto out_overflow;
  364. count = be32_to_cpup(p);
  365. if (count > NFS3_MAXNAMLEN)
  366. goto out_nametoolong;
  367. p = xdr_inline_decode(xdr, count);
  368. if (unlikely(p == NULL))
  369. goto out_overflow;
  370. *name = (const char *)p;
  371. *length = count;
  372. return 0;
  373. out_nametoolong:
  374. dprintk("NFS: returned filename too long: %u\n", count);
  375. return -ENAMETOOLONG;
  376. out_overflow:
  377. print_overflow_msg(__func__, xdr);
  378. return -EIO;
  379. }
  380. /*
  381. * 2.3.8. path
  382. *
  383. * typedef string path<MAXPATHLEN>;
  384. */
  385. static void encode_path(struct xdr_stream *xdr, struct page **pages, u32 length)
  386. {
  387. __be32 *p;
  388. BUG_ON(length > NFS2_MAXPATHLEN);
  389. p = xdr_reserve_space(xdr, 4);
  390. *p = cpu_to_be32(length);
  391. xdr_write_pages(xdr, pages, 0, length);
  392. }
  393. static int decode_path(struct xdr_stream *xdr)
  394. {
  395. u32 length, recvd;
  396. size_t hdrlen;
  397. __be32 *p;
  398. p = xdr_inline_decode(xdr, 4);
  399. if (unlikely(p == NULL))
  400. goto out_overflow;
  401. length = be32_to_cpup(p);
  402. if (unlikely(length >= xdr->buf->page_len || length > NFS_MAXPATHLEN))
  403. goto out_size;
  404. hdrlen = (u8 *)xdr->p - (u8 *)xdr->iov->iov_base;
  405. recvd = xdr->buf->len - hdrlen;
  406. if (unlikely(length > recvd))
  407. goto out_cheating;
  408. xdr_read_pages(xdr, length);
  409. xdr_terminate_string(xdr->buf, length);
  410. return 0;
  411. out_size:
  412. dprintk("NFS: returned pathname too long: %u\n", length);
  413. return -ENAMETOOLONG;
  414. out_cheating:
  415. dprintk("NFS: server cheating in pathname result: "
  416. "length %u > received %u\n", length, recvd);
  417. return -EIO;
  418. out_overflow:
  419. print_overflow_msg(__func__, xdr);
  420. return -EIO;
  421. }
  422. /*
  423. * 2.3.9. attrstat
  424. *
  425. * union attrstat switch (stat status) {
  426. * case NFS_OK:
  427. * fattr attributes;
  428. * default:
  429. * void;
  430. * };
  431. */
  432. static int decode_attrstat(struct xdr_stream *xdr, struct nfs_fattr *result)
  433. {
  434. enum nfs_stat status;
  435. int error;
  436. error = decode_stat(xdr, &status);
  437. if (unlikely(error))
  438. goto out;
  439. if (status != NFS_OK)
  440. goto out_default;
  441. error = decode_fattr(xdr, result);
  442. out:
  443. return error;
  444. out_default:
  445. return nfs_stat_to_errno(status);
  446. }
  447. /*
  448. * 2.3.10. diropargs
  449. *
  450. * struct diropargs {
  451. * fhandle dir;
  452. * filename name;
  453. * };
  454. */
  455. static void encode_diropargs(struct xdr_stream *xdr, const struct nfs_fh *fh,
  456. const char *name, u32 length)
  457. {
  458. encode_fhandle(xdr, fh);
  459. encode_filename(xdr, name, length);
  460. }
  461. /*
  462. * 2.3.11. diropres
  463. *
  464. * union diropres switch (stat status) {
  465. * case NFS_OK:
  466. * struct {
  467. * fhandle file;
  468. * fattr attributes;
  469. * } diropok;
  470. * default:
  471. * void;
  472. * };
  473. */
  474. static int decode_diropok(struct xdr_stream *xdr, struct nfs_diropok *result)
  475. {
  476. int error;
  477. error = decode_fhandle(xdr, result->fh);
  478. if (unlikely(error))
  479. goto out;
  480. error = decode_fattr(xdr, result->fattr);
  481. out:
  482. return error;
  483. }
  484. static int decode_diropres(struct xdr_stream *xdr, struct nfs_diropok *result)
  485. {
  486. enum nfs_stat status;
  487. int error;
  488. error = decode_stat(xdr, &status);
  489. if (unlikely(error))
  490. goto out;
  491. if (status != NFS_OK)
  492. goto out_default;
  493. error = decode_diropok(xdr, result);
  494. out:
  495. return error;
  496. out_default:
  497. return nfs_stat_to_errno(status);
  498. }
  499. /*
  500. * NFSv2 XDR encode functions
  501. *
  502. * NFSv2 argument types are defined in section 2.2 of RFC 1094:
  503. * "NFS: Network File System Protocol Specification".
  504. */
  505. static void nfs2_xdr_enc_fhandle(struct rpc_rqst *req,
  506. struct xdr_stream *xdr,
  507. const struct nfs_fh *fh)
  508. {
  509. encode_fhandle(xdr, fh);
  510. }
  511. /*
  512. * 2.2.3. sattrargs
  513. *
  514. * struct sattrargs {
  515. * fhandle file;
  516. * sattr attributes;
  517. * };
  518. */
  519. static void nfs2_xdr_enc_sattrargs(struct rpc_rqst *req,
  520. struct xdr_stream *xdr,
  521. const struct nfs_sattrargs *args)
  522. {
  523. encode_fhandle(xdr, args->fh);
  524. encode_sattr(xdr, args->sattr);
  525. }
  526. static void nfs2_xdr_enc_diropargs(struct rpc_rqst *req,
  527. struct xdr_stream *xdr,
  528. const struct nfs_diropargs *args)
  529. {
  530. encode_diropargs(xdr, args->fh, args->name, args->len);
  531. }
  532. static void nfs2_xdr_enc_readlinkargs(struct rpc_rqst *req,
  533. struct xdr_stream *xdr,
  534. const struct nfs_readlinkargs *args)
  535. {
  536. encode_fhandle(xdr, args->fh);
  537. prepare_reply_buffer(req, args->pages, args->pgbase,
  538. args->pglen, NFS_readlinkres_sz);
  539. }
  540. /*
  541. * 2.2.7. readargs
  542. *
  543. * struct readargs {
  544. * fhandle file;
  545. * unsigned offset;
  546. * unsigned count;
  547. * unsigned totalcount;
  548. * };
  549. */
  550. static void encode_readargs(struct xdr_stream *xdr,
  551. const struct nfs_readargs *args)
  552. {
  553. u32 offset = args->offset;
  554. u32 count = args->count;
  555. __be32 *p;
  556. encode_fhandle(xdr, args->fh);
  557. p = xdr_reserve_space(xdr, 4 + 4 + 4);
  558. *p++ = cpu_to_be32(offset);
  559. *p++ = cpu_to_be32(count);
  560. *p = cpu_to_be32(count);
  561. }
  562. static void nfs2_xdr_enc_readargs(struct rpc_rqst *req,
  563. struct xdr_stream *xdr,
  564. const struct nfs_readargs *args)
  565. {
  566. encode_readargs(xdr, args);
  567. prepare_reply_buffer(req, args->pages, args->pgbase,
  568. args->count, NFS_readres_sz);
  569. req->rq_rcv_buf.flags |= XDRBUF_READ;
  570. }
  571. /*
  572. * 2.2.9. writeargs
  573. *
  574. * struct writeargs {
  575. * fhandle file;
  576. * unsigned beginoffset;
  577. * unsigned offset;
  578. * unsigned totalcount;
  579. * nfsdata data;
  580. * };
  581. */
  582. static void encode_writeargs(struct xdr_stream *xdr,
  583. const struct nfs_writeargs *args)
  584. {
  585. u32 offset = args->offset;
  586. u32 count = args->count;
  587. __be32 *p;
  588. encode_fhandle(xdr, args->fh);
  589. p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4);
  590. *p++ = cpu_to_be32(offset);
  591. *p++ = cpu_to_be32(offset);
  592. *p++ = cpu_to_be32(count);
  593. /* nfsdata */
  594. *p = cpu_to_be32(count);
  595. xdr_write_pages(xdr, args->pages, args->pgbase, count);
  596. }
  597. static void nfs2_xdr_enc_writeargs(struct rpc_rqst *req,
  598. struct xdr_stream *xdr,
  599. const struct nfs_writeargs *args)
  600. {
  601. encode_writeargs(xdr, args);
  602. xdr->buf->flags |= XDRBUF_WRITE;
  603. }
  604. /*
  605. * 2.2.10. createargs
  606. *
  607. * struct createargs {
  608. * diropargs where;
  609. * sattr attributes;
  610. * };
  611. */
  612. static void nfs2_xdr_enc_createargs(struct rpc_rqst *req,
  613. struct xdr_stream *xdr,
  614. const struct nfs_createargs *args)
  615. {
  616. encode_diropargs(xdr, args->fh, args->name, args->len);
  617. encode_sattr(xdr, args->sattr);
  618. }
  619. static void nfs2_xdr_enc_removeargs(struct rpc_rqst *req,
  620. struct xdr_stream *xdr,
  621. const struct nfs_removeargs *args)
  622. {
  623. encode_diropargs(xdr, args->fh, args->name.name, args->name.len);
  624. }
  625. /*
  626. * 2.2.12. renameargs
  627. *
  628. * struct renameargs {
  629. * diropargs from;
  630. * diropargs to;
  631. * };
  632. */
  633. static void nfs2_xdr_enc_renameargs(struct rpc_rqst *req,
  634. struct xdr_stream *xdr,
  635. const struct nfs_renameargs *args)
  636. {
  637. const struct qstr *old = args->old_name;
  638. const struct qstr *new = args->new_name;
  639. encode_diropargs(xdr, args->old_dir, old->name, old->len);
  640. encode_diropargs(xdr, args->new_dir, new->name, new->len);
  641. }
  642. /*
  643. * 2.2.13. linkargs
  644. *
  645. * struct linkargs {
  646. * fhandle from;
  647. * diropargs to;
  648. * };
  649. */
  650. static void nfs2_xdr_enc_linkargs(struct rpc_rqst *req,
  651. struct xdr_stream *xdr,
  652. const struct nfs_linkargs *args)
  653. {
  654. encode_fhandle(xdr, args->fromfh);
  655. encode_diropargs(xdr, args->tofh, args->toname, args->tolen);
  656. }
  657. /*
  658. * 2.2.14. symlinkargs
  659. *
  660. * struct symlinkargs {
  661. * diropargs from;
  662. * path to;
  663. * sattr attributes;
  664. * };
  665. */
  666. static void nfs2_xdr_enc_symlinkargs(struct rpc_rqst *req,
  667. struct xdr_stream *xdr,
  668. const struct nfs_symlinkargs *args)
  669. {
  670. encode_diropargs(xdr, args->fromfh, args->fromname, args->fromlen);
  671. encode_path(xdr, args->pages, args->pathlen);
  672. encode_sattr(xdr, args->sattr);
  673. }
  674. /*
  675. * 2.2.17. readdirargs
  676. *
  677. * struct readdirargs {
  678. * fhandle dir;
  679. * nfscookie cookie;
  680. * unsigned count;
  681. * };
  682. */
  683. static void encode_readdirargs(struct xdr_stream *xdr,
  684. const struct nfs_readdirargs *args)
  685. {
  686. __be32 *p;
  687. encode_fhandle(xdr, args->fh);
  688. p = xdr_reserve_space(xdr, 4 + 4);
  689. *p++ = cpu_to_be32(args->cookie);
  690. *p = cpu_to_be32(args->count);
  691. }
  692. static void nfs2_xdr_enc_readdirargs(struct rpc_rqst *req,
  693. struct xdr_stream *xdr,
  694. const struct nfs_readdirargs *args)
  695. {
  696. encode_readdirargs(xdr, args);
  697. prepare_reply_buffer(req, args->pages, 0,
  698. args->count, NFS_readdirres_sz);
  699. }
  700. /*
  701. * NFSv2 XDR decode functions
  702. *
  703. * NFSv2 result types are defined in section 2.2 of RFC 1094:
  704. * "NFS: Network File System Protocol Specification".
  705. */
  706. static int nfs2_xdr_dec_stat(struct rpc_rqst *req, struct xdr_stream *xdr,
  707. void *__unused)
  708. {
  709. enum nfs_stat status;
  710. int error;
  711. error = decode_stat(xdr, &status);
  712. if (unlikely(error))
  713. goto out;
  714. if (status != NFS_OK)
  715. goto out_default;
  716. out:
  717. return error;
  718. out_default:
  719. return nfs_stat_to_errno(status);
  720. }
  721. static int nfs2_xdr_dec_attrstat(struct rpc_rqst *req, struct xdr_stream *xdr,
  722. struct nfs_fattr *result)
  723. {
  724. return decode_attrstat(xdr, result);
  725. }
  726. static int nfs2_xdr_dec_diropres(struct rpc_rqst *req, struct xdr_stream *xdr,
  727. struct nfs_diropok *result)
  728. {
  729. return decode_diropres(xdr, result);
  730. }
  731. /*
  732. * 2.2.6. readlinkres
  733. *
  734. * union readlinkres switch (stat status) {
  735. * case NFS_OK:
  736. * path data;
  737. * default:
  738. * void;
  739. * };
  740. */
  741. static int nfs2_xdr_dec_readlinkres(struct rpc_rqst *req,
  742. struct xdr_stream *xdr, void *__unused)
  743. {
  744. enum nfs_stat status;
  745. int error;
  746. error = decode_stat(xdr, &status);
  747. if (unlikely(error))
  748. goto out;
  749. if (status != NFS_OK)
  750. goto out_default;
  751. error = decode_path(xdr);
  752. out:
  753. return error;
  754. out_default:
  755. return nfs_stat_to_errno(status);
  756. }
  757. /*
  758. * 2.2.7. readres
  759. *
  760. * union readres switch (stat status) {
  761. * case NFS_OK:
  762. * fattr attributes;
  763. * nfsdata data;
  764. * default:
  765. * void;
  766. * };
  767. */
  768. static int nfs2_xdr_dec_readres(struct rpc_rqst *req, struct xdr_stream *xdr,
  769. struct nfs_readres *result)
  770. {
  771. enum nfs_stat status;
  772. int error;
  773. error = decode_stat(xdr, &status);
  774. if (unlikely(error))
  775. goto out;
  776. if (status != NFS_OK)
  777. goto out_default;
  778. error = decode_fattr(xdr, result->fattr);
  779. if (unlikely(error))
  780. goto out;
  781. error = decode_nfsdata(xdr, result);
  782. out:
  783. return error;
  784. out_default:
  785. return nfs_stat_to_errno(status);
  786. }
  787. static int nfs2_xdr_dec_writeres(struct rpc_rqst *req, struct xdr_stream *xdr,
  788. struct nfs_writeres *result)
  789. {
  790. /* All NFSv2 writes are "file sync" writes */
  791. result->verf->committed = NFS_FILE_SYNC;
  792. return decode_attrstat(xdr, result->fattr);
  793. }
  794. /**
  795. * nfs2_decode_dirent - Decode a single NFSv2 directory entry stored in
  796. * the local page cache.
  797. * @xdr: XDR stream where entry resides
  798. * @entry: buffer to fill in with entry data
  799. * @plus: boolean indicating whether this should be a readdirplus entry
  800. *
  801. * Returns zero if successful, otherwise a negative errno value is
  802. * returned.
  803. *
  804. * This function is not invoked during READDIR reply decoding, but
  805. * rather whenever an application invokes the getdents(2) system call
  806. * on a directory already in our cache.
  807. *
  808. * 2.2.17. entry
  809. *
  810. * struct entry {
  811. * unsigned fileid;
  812. * filename name;
  813. * nfscookie cookie;
  814. * entry *nextentry;
  815. * };
  816. */
  817. int nfs2_decode_dirent(struct xdr_stream *xdr, struct nfs_entry *entry,
  818. int plus)
  819. {
  820. __be32 *p;
  821. int error;
  822. p = xdr_inline_decode(xdr, 4);
  823. if (unlikely(p == NULL))
  824. goto out_overflow;
  825. if (*p++ == xdr_zero) {
  826. p = xdr_inline_decode(xdr, 4);
  827. if (unlikely(p == NULL))
  828. goto out_overflow;
  829. if (*p++ == xdr_zero)
  830. return -EAGAIN;
  831. entry->eof = 1;
  832. return -EBADCOOKIE;
  833. }
  834. p = xdr_inline_decode(xdr, 4);
  835. if (unlikely(p == NULL))
  836. goto out_overflow;
  837. entry->ino = be32_to_cpup(p);
  838. error = decode_filename_inline(xdr, &entry->name, &entry->len);
  839. if (unlikely(error))
  840. return error;
  841. /*
  842. * The type (size and byte order) of nfscookie isn't defined in
  843. * RFC 1094. This implementation assumes that it's an XDR uint32.
  844. */
  845. entry->prev_cookie = entry->cookie;
  846. p = xdr_inline_decode(xdr, 4);
  847. if (unlikely(p == NULL))
  848. goto out_overflow;
  849. entry->cookie = be32_to_cpup(p);
  850. entry->d_type = DT_UNKNOWN;
  851. return 0;
  852. out_overflow:
  853. print_overflow_msg(__func__, xdr);
  854. return -EAGAIN;
  855. }
  856. /*
  857. * 2.2.17. readdirres
  858. *
  859. * union readdirres switch (stat status) {
  860. * case NFS_OK:
  861. * struct {
  862. * entry *entries;
  863. * bool eof;
  864. * } readdirok;
  865. * default:
  866. * void;
  867. * };
  868. *
  869. * Read the directory contents into the page cache, but don't
  870. * touch them. The actual decoding is done by nfs2_decode_dirent()
  871. * during subsequent nfs_readdir() calls.
  872. */
  873. static int decode_readdirok(struct xdr_stream *xdr)
  874. {
  875. u32 recvd, pglen;
  876. size_t hdrlen;
  877. pglen = xdr->buf->page_len;
  878. hdrlen = (u8 *)xdr->p - (u8 *)xdr->iov->iov_base;
  879. recvd = xdr->buf->len - hdrlen;
  880. if (unlikely(pglen > recvd))
  881. goto out_cheating;
  882. out:
  883. xdr_read_pages(xdr, pglen);
  884. return pglen;
  885. out_cheating:
  886. dprintk("NFS: server cheating in readdir result: "
  887. "pglen %u > recvd %u\n", pglen, recvd);
  888. pglen = recvd;
  889. goto out;
  890. }
  891. static int nfs2_xdr_dec_readdirres(struct rpc_rqst *req,
  892. struct xdr_stream *xdr, void *__unused)
  893. {
  894. enum nfs_stat status;
  895. int error;
  896. error = decode_stat(xdr, &status);
  897. if (unlikely(error))
  898. goto out;
  899. if (status != NFS_OK)
  900. goto out_default;
  901. error = decode_readdirok(xdr);
  902. out:
  903. return error;
  904. out_default:
  905. return nfs_stat_to_errno(status);
  906. }
  907. /*
  908. * 2.2.18. statfsres
  909. *
  910. * union statfsres (stat status) {
  911. * case NFS_OK:
  912. * struct {
  913. * unsigned tsize;
  914. * unsigned bsize;
  915. * unsigned blocks;
  916. * unsigned bfree;
  917. * unsigned bavail;
  918. * } info;
  919. * default:
  920. * void;
  921. * };
  922. */
  923. static int decode_info(struct xdr_stream *xdr, struct nfs2_fsstat *result)
  924. {
  925. __be32 *p;
  926. p = xdr_inline_decode(xdr, NFS_info_sz << 2);
  927. if (unlikely(p == NULL))
  928. goto out_overflow;
  929. result->tsize = be32_to_cpup(p++);
  930. result->bsize = be32_to_cpup(p++);
  931. result->blocks = be32_to_cpup(p++);
  932. result->bfree = be32_to_cpup(p++);
  933. result->bavail = be32_to_cpup(p);
  934. return 0;
  935. out_overflow:
  936. print_overflow_msg(__func__, xdr);
  937. return -EIO;
  938. }
  939. static int nfs2_xdr_dec_statfsres(struct rpc_rqst *req, struct xdr_stream *xdr,
  940. struct nfs2_fsstat *result)
  941. {
  942. enum nfs_stat status;
  943. int error;
  944. error = decode_stat(xdr, &status);
  945. if (unlikely(error))
  946. goto out;
  947. if (status != NFS_OK)
  948. goto out_default;
  949. error = decode_info(xdr, result);
  950. out:
  951. return error;
  952. out_default:
  953. return nfs_stat_to_errno(status);
  954. }
  955. /*
  956. * We need to translate between nfs status return values and
  957. * the local errno values which may not be the same.
  958. */
  959. static const struct {
  960. int stat;
  961. int errno;
  962. } nfs_errtbl[] = {
  963. { NFS_OK, 0 },
  964. { NFSERR_PERM, -EPERM },
  965. { NFSERR_NOENT, -ENOENT },
  966. { NFSERR_IO, -errno_NFSERR_IO},
  967. { NFSERR_NXIO, -ENXIO },
  968. /* { NFSERR_EAGAIN, -EAGAIN }, */
  969. { NFSERR_ACCES, -EACCES },
  970. { NFSERR_EXIST, -EEXIST },
  971. { NFSERR_XDEV, -EXDEV },
  972. { NFSERR_NODEV, -ENODEV },
  973. { NFSERR_NOTDIR, -ENOTDIR },
  974. { NFSERR_ISDIR, -EISDIR },
  975. { NFSERR_INVAL, -EINVAL },
  976. { NFSERR_FBIG, -EFBIG },
  977. { NFSERR_NOSPC, -ENOSPC },
  978. { NFSERR_ROFS, -EROFS },
  979. { NFSERR_MLINK, -EMLINK },
  980. { NFSERR_NAMETOOLONG, -ENAMETOOLONG },
  981. { NFSERR_NOTEMPTY, -ENOTEMPTY },
  982. { NFSERR_DQUOT, -EDQUOT },
  983. { NFSERR_STALE, -ESTALE },
  984. { NFSERR_REMOTE, -EREMOTE },
  985. #ifdef EWFLUSH
  986. { NFSERR_WFLUSH, -EWFLUSH },
  987. #endif
  988. { NFSERR_BADHANDLE, -EBADHANDLE },
  989. { NFSERR_NOT_SYNC, -ENOTSYNC },
  990. { NFSERR_BAD_COOKIE, -EBADCOOKIE },
  991. { NFSERR_NOTSUPP, -ENOTSUPP },
  992. { NFSERR_TOOSMALL, -ETOOSMALL },
  993. { NFSERR_SERVERFAULT, -EREMOTEIO },
  994. { NFSERR_BADTYPE, -EBADTYPE },
  995. { NFSERR_JUKEBOX, -EJUKEBOX },
  996. { -1, -EIO }
  997. };
  998. /**
  999. * nfs_stat_to_errno - convert an NFS status code to a local errno
  1000. * @status: NFS status code to convert
  1001. *
  1002. * Returns a local errno value, or -EIO if the NFS status code is
  1003. * not recognized. This function is used jointly by NFSv2 and NFSv3.
  1004. */
  1005. static int nfs_stat_to_errno(enum nfs_stat status)
  1006. {
  1007. int i;
  1008. for (i = 0; nfs_errtbl[i].stat != -1; i++) {
  1009. if (nfs_errtbl[i].stat == (int)status)
  1010. return nfs_errtbl[i].errno;
  1011. }
  1012. dprintk("NFS: Unrecognized nfs status value: %u\n", status);
  1013. return nfs_errtbl[i].errno;
  1014. }
  1015. #define PROC(proc, argtype, restype, timer) \
  1016. [NFSPROC_##proc] = { \
  1017. .p_proc = NFSPROC_##proc, \
  1018. .p_encode = (kxdreproc_t)nfs2_xdr_enc_##argtype, \
  1019. .p_decode = (kxdrdproc_t)nfs2_xdr_dec_##restype, \
  1020. .p_arglen = NFS_##argtype##_sz, \
  1021. .p_replen = NFS_##restype##_sz, \
  1022. .p_timer = timer, \
  1023. .p_statidx = NFSPROC_##proc, \
  1024. .p_name = #proc, \
  1025. }
  1026. struct rpc_procinfo nfs_procedures[] = {
  1027. PROC(GETATTR, fhandle, attrstat, 1),
  1028. PROC(SETATTR, sattrargs, attrstat, 0),
  1029. PROC(LOOKUP, diropargs, diropres, 2),
  1030. PROC(READLINK, readlinkargs, readlinkres, 3),
  1031. PROC(READ, readargs, readres, 3),
  1032. PROC(WRITE, writeargs, writeres, 4),
  1033. PROC(CREATE, createargs, diropres, 0),
  1034. PROC(REMOVE, removeargs, stat, 0),
  1035. PROC(RENAME, renameargs, stat, 0),
  1036. PROC(LINK, linkargs, stat, 0),
  1037. PROC(SYMLINK, symlinkargs, stat, 0),
  1038. PROC(MKDIR, createargs, diropres, 0),
  1039. PROC(RMDIR, diropargs, stat, 0),
  1040. PROC(READDIR, readdirargs, readdirres, 3),
  1041. PROC(STATFS, fhandle, statfsres, 0),
  1042. };
  1043. const struct rpc_version nfs_version2 = {
  1044. .number = 2,
  1045. .nrprocs = ARRAY_SIZE(nfs_procedures),
  1046. .procs = nfs_procedures
  1047. };