clnt.c 26 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085
  1. /*
  2. * linux/net/sunrpc/rpcclnt.c
  3. *
  4. * This file contains the high-level RPC interface.
  5. * It is modeled as a finite state machine to support both synchronous
  6. * and asynchronous requests.
  7. *
  8. * - RPC header generation and argument serialization.
  9. * - Credential refresh.
  10. * - TCP connect handling.
  11. * - Retry of operation when it is suspected the operation failed because
  12. * of uid squashing on the server, or when the credentials were stale
  13. * and need to be refreshed, or when a packet was damaged in transit.
  14. * This may be have to be moved to the VFS layer.
  15. *
  16. * NB: BSD uses a more intelligent approach to guessing when a request
  17. * or reply has been lost by keeping the RTO estimate for each procedure.
  18. * We currently make do with a constant timeout value.
  19. *
  20. * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
  21. * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
  22. */
  23. #include <asm/system.h>
  24. #include <linux/module.h>
  25. #include <linux/types.h>
  26. #include <linux/mm.h>
  27. #include <linux/slab.h>
  28. #include <linux/in.h>
  29. #include <linux/utsname.h>
  30. #include <linux/sunrpc/clnt.h>
  31. #include <linux/workqueue.h>
  32. #include <linux/sunrpc/rpc_pipe_fs.h>
  33. #include <linux/nfs.h>
  34. #define RPC_SLACK_SPACE (1024) /* total overkill */
  35. #ifdef RPC_DEBUG
  36. # define RPCDBG_FACILITY RPCDBG_CALL
  37. #endif
  38. static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
  39. static void call_start(struct rpc_task *task);
  40. static void call_reserve(struct rpc_task *task);
  41. static void call_reserveresult(struct rpc_task *task);
  42. static void call_allocate(struct rpc_task *task);
  43. static void call_encode(struct rpc_task *task);
  44. static void call_decode(struct rpc_task *task);
  45. static void call_bind(struct rpc_task *task);
  46. static void call_transmit(struct rpc_task *task);
  47. static void call_status(struct rpc_task *task);
  48. static void call_refresh(struct rpc_task *task);
  49. static void call_refreshresult(struct rpc_task *task);
  50. static void call_timeout(struct rpc_task *task);
  51. static void call_connect(struct rpc_task *task);
  52. static void call_connect_status(struct rpc_task *task);
  53. static u32 * call_header(struct rpc_task *task);
  54. static u32 * call_verify(struct rpc_task *task);
  55. static int
  56. rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
  57. {
  58. static uint32_t clntid;
  59. int error;
  60. if (dir_name == NULL)
  61. return 0;
  62. for (;;) {
  63. snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
  64. "%s/clnt%x", dir_name,
  65. (unsigned int)clntid++);
  66. clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
  67. clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
  68. if (!IS_ERR(clnt->cl_dentry))
  69. return 0;
  70. error = PTR_ERR(clnt->cl_dentry);
  71. if (error != -EEXIST) {
  72. printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
  73. clnt->cl_pathname, error);
  74. return error;
  75. }
  76. }
  77. }
  78. /*
  79. * Create an RPC client
  80. * FIXME: This should also take a flags argument (as in task->tk_flags).
  81. * It's called (among others) from pmap_create_client, which may in
  82. * turn be called by an async task. In this case, rpciod should not be
  83. * made to sleep too long.
  84. */
  85. struct rpc_clnt *
  86. rpc_create_client(struct rpc_xprt *xprt, char *servname,
  87. struct rpc_program *program, u32 vers,
  88. rpc_authflavor_t flavor)
  89. {
  90. struct rpc_version *version;
  91. struct rpc_clnt *clnt = NULL;
  92. int err;
  93. int len;
  94. dprintk("RPC: creating %s client for %s (xprt %p)\n",
  95. program->name, servname, xprt);
  96. err = -EINVAL;
  97. if (!xprt)
  98. goto out_err;
  99. if (vers >= program->nrvers || !(version = program->version[vers]))
  100. goto out_err;
  101. err = -ENOMEM;
  102. clnt = (struct rpc_clnt *) kmalloc(sizeof(*clnt), GFP_KERNEL);
  103. if (!clnt)
  104. goto out_err;
  105. memset(clnt, 0, sizeof(*clnt));
  106. atomic_set(&clnt->cl_users, 0);
  107. atomic_set(&clnt->cl_count, 1);
  108. clnt->cl_parent = clnt;
  109. clnt->cl_server = clnt->cl_inline_name;
  110. len = strlen(servname) + 1;
  111. if (len > sizeof(clnt->cl_inline_name)) {
  112. char *buf = kmalloc(len, GFP_KERNEL);
  113. if (buf != 0)
  114. clnt->cl_server = buf;
  115. else
  116. len = sizeof(clnt->cl_inline_name);
  117. }
  118. strlcpy(clnt->cl_server, servname, len);
  119. clnt->cl_xprt = xprt;
  120. clnt->cl_procinfo = version->procs;
  121. clnt->cl_maxproc = version->nrprocs;
  122. clnt->cl_protname = program->name;
  123. clnt->cl_pmap = &clnt->cl_pmap_default;
  124. clnt->cl_port = xprt->addr.sin_port;
  125. clnt->cl_prog = program->number;
  126. clnt->cl_vers = version->number;
  127. clnt->cl_prot = xprt->prot;
  128. clnt->cl_stats = program->stats;
  129. rpc_init_wait_queue(&clnt->cl_pmap_default.pm_bindwait, "bindwait");
  130. if (!clnt->cl_port)
  131. clnt->cl_autobind = 1;
  132. clnt->cl_rtt = &clnt->cl_rtt_default;
  133. rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
  134. err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
  135. if (err < 0)
  136. goto out_no_path;
  137. err = -ENOMEM;
  138. if (!rpcauth_create(flavor, clnt)) {
  139. printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
  140. flavor);
  141. goto out_no_auth;
  142. }
  143. /* save the nodename */
  144. clnt->cl_nodelen = strlen(system_utsname.nodename);
  145. if (clnt->cl_nodelen > UNX_MAXNODENAME)
  146. clnt->cl_nodelen = UNX_MAXNODENAME;
  147. memcpy(clnt->cl_nodename, system_utsname.nodename, clnt->cl_nodelen);
  148. return clnt;
  149. out_no_auth:
  150. rpc_rmdir(clnt->cl_pathname);
  151. out_no_path:
  152. if (clnt->cl_server != clnt->cl_inline_name)
  153. kfree(clnt->cl_server);
  154. kfree(clnt);
  155. out_err:
  156. return ERR_PTR(err);
  157. }
  158. /*
  159. * This function clones the RPC client structure. It allows us to share the
  160. * same transport while varying parameters such as the authentication
  161. * flavour.
  162. */
  163. struct rpc_clnt *
  164. rpc_clone_client(struct rpc_clnt *clnt)
  165. {
  166. struct rpc_clnt *new;
  167. new = (struct rpc_clnt *)kmalloc(sizeof(*new), GFP_KERNEL);
  168. if (!new)
  169. goto out_no_clnt;
  170. memcpy(new, clnt, sizeof(*new));
  171. atomic_set(&new->cl_count, 1);
  172. atomic_set(&new->cl_users, 0);
  173. new->cl_parent = clnt;
  174. atomic_inc(&clnt->cl_count);
  175. /* Duplicate portmapper */
  176. rpc_init_wait_queue(&new->cl_pmap_default.pm_bindwait, "bindwait");
  177. /* Turn off autobind on clones */
  178. new->cl_autobind = 0;
  179. new->cl_oneshot = 0;
  180. new->cl_dead = 0;
  181. rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
  182. if (new->cl_auth)
  183. atomic_inc(&new->cl_auth->au_count);
  184. return new;
  185. out_no_clnt:
  186. printk(KERN_INFO "RPC: out of memory in %s\n", __FUNCTION__);
  187. return ERR_PTR(-ENOMEM);
  188. }
  189. /*
  190. * Properly shut down an RPC client, terminating all outstanding
  191. * requests. Note that we must be certain that cl_oneshot and
  192. * cl_dead are cleared, or else the client would be destroyed
  193. * when the last task releases it.
  194. */
  195. int
  196. rpc_shutdown_client(struct rpc_clnt *clnt)
  197. {
  198. dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
  199. clnt->cl_protname, clnt->cl_server,
  200. atomic_read(&clnt->cl_users));
  201. while (atomic_read(&clnt->cl_users) > 0) {
  202. /* Don't let rpc_release_client destroy us */
  203. clnt->cl_oneshot = 0;
  204. clnt->cl_dead = 0;
  205. rpc_killall_tasks(clnt);
  206. sleep_on_timeout(&destroy_wait, 1*HZ);
  207. }
  208. if (atomic_read(&clnt->cl_users) < 0) {
  209. printk(KERN_ERR "RPC: rpc_shutdown_client clnt %p tasks=%d\n",
  210. clnt, atomic_read(&clnt->cl_users));
  211. #ifdef RPC_DEBUG
  212. rpc_show_tasks();
  213. #endif
  214. BUG();
  215. }
  216. return rpc_destroy_client(clnt);
  217. }
  218. /*
  219. * Delete an RPC client
  220. */
  221. int
  222. rpc_destroy_client(struct rpc_clnt *clnt)
  223. {
  224. if (!atomic_dec_and_test(&clnt->cl_count))
  225. return 1;
  226. BUG_ON(atomic_read(&clnt->cl_users) != 0);
  227. dprintk("RPC: destroying %s client for %s\n",
  228. clnt->cl_protname, clnt->cl_server);
  229. if (clnt->cl_auth) {
  230. rpcauth_destroy(clnt->cl_auth);
  231. clnt->cl_auth = NULL;
  232. }
  233. if (clnt->cl_parent != clnt) {
  234. rpc_destroy_client(clnt->cl_parent);
  235. goto out_free;
  236. }
  237. if (clnt->cl_pathname[0])
  238. rpc_rmdir(clnt->cl_pathname);
  239. if (clnt->cl_xprt) {
  240. xprt_destroy(clnt->cl_xprt);
  241. clnt->cl_xprt = NULL;
  242. }
  243. if (clnt->cl_server != clnt->cl_inline_name)
  244. kfree(clnt->cl_server);
  245. out_free:
  246. kfree(clnt);
  247. return 0;
  248. }
  249. /*
  250. * Release an RPC client
  251. */
  252. void
  253. rpc_release_client(struct rpc_clnt *clnt)
  254. {
  255. dprintk("RPC: rpc_release_client(%p, %d)\n",
  256. clnt, atomic_read(&clnt->cl_users));
  257. if (!atomic_dec_and_test(&clnt->cl_users))
  258. return;
  259. wake_up(&destroy_wait);
  260. if (clnt->cl_oneshot || clnt->cl_dead)
  261. rpc_destroy_client(clnt);
  262. }
  263. /*
  264. * Default callback for async RPC calls
  265. */
  266. static void
  267. rpc_default_callback(struct rpc_task *task)
  268. {
  269. }
  270. /*
  271. * Export the signal mask handling for aysnchronous code that
  272. * sleeps on RPC calls
  273. */
  274. void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
  275. {
  276. unsigned long sigallow = sigmask(SIGKILL);
  277. unsigned long irqflags;
  278. /* Turn off various signals */
  279. if (clnt->cl_intr) {
  280. struct k_sigaction *action = current->sighand->action;
  281. if (action[SIGINT-1].sa.sa_handler == SIG_DFL)
  282. sigallow |= sigmask(SIGINT);
  283. if (action[SIGQUIT-1].sa.sa_handler == SIG_DFL)
  284. sigallow |= sigmask(SIGQUIT);
  285. }
  286. spin_lock_irqsave(&current->sighand->siglock, irqflags);
  287. *oldset = current->blocked;
  288. siginitsetinv(&current->blocked, sigallow & ~oldset->sig[0]);
  289. recalc_sigpending();
  290. spin_unlock_irqrestore(&current->sighand->siglock, irqflags);
  291. }
  292. void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
  293. {
  294. unsigned long irqflags;
  295. spin_lock_irqsave(&current->sighand->siglock, irqflags);
  296. current->blocked = *oldset;
  297. recalc_sigpending();
  298. spin_unlock_irqrestore(&current->sighand->siglock, irqflags);
  299. }
  300. /*
  301. * New rpc_call implementation
  302. */
  303. int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
  304. {
  305. struct rpc_task *task;
  306. sigset_t oldset;
  307. int status;
  308. /* If this client is slain all further I/O fails */
  309. if (clnt->cl_dead)
  310. return -EIO;
  311. BUG_ON(flags & RPC_TASK_ASYNC);
  312. rpc_clnt_sigmask(clnt, &oldset);
  313. status = -ENOMEM;
  314. task = rpc_new_task(clnt, NULL, flags);
  315. if (task == NULL)
  316. goto out;
  317. rpc_call_setup(task, msg, 0);
  318. /* Set up the call info struct and execute the task */
  319. if (task->tk_status == 0)
  320. status = rpc_execute(task);
  321. else {
  322. status = task->tk_status;
  323. rpc_release_task(task);
  324. }
  325. out:
  326. rpc_clnt_sigunmask(clnt, &oldset);
  327. return status;
  328. }
  329. /*
  330. * New rpc_call implementation
  331. */
  332. int
  333. rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
  334. rpc_action callback, void *data)
  335. {
  336. struct rpc_task *task;
  337. sigset_t oldset;
  338. int status;
  339. /* If this client is slain all further I/O fails */
  340. if (clnt->cl_dead)
  341. return -EIO;
  342. flags |= RPC_TASK_ASYNC;
  343. rpc_clnt_sigmask(clnt, &oldset);
  344. /* Create/initialize a new RPC task */
  345. if (!callback)
  346. callback = rpc_default_callback;
  347. status = -ENOMEM;
  348. if (!(task = rpc_new_task(clnt, callback, flags)))
  349. goto out;
  350. task->tk_calldata = data;
  351. rpc_call_setup(task, msg, 0);
  352. /* Set up the call info struct and execute the task */
  353. status = task->tk_status;
  354. if (status == 0)
  355. rpc_execute(task);
  356. else
  357. rpc_release_task(task);
  358. out:
  359. rpc_clnt_sigunmask(clnt, &oldset);
  360. return status;
  361. }
  362. void
  363. rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
  364. {
  365. task->tk_msg = *msg;
  366. task->tk_flags |= flags;
  367. /* Bind the user cred */
  368. if (task->tk_msg.rpc_cred != NULL)
  369. rpcauth_holdcred(task);
  370. else
  371. rpcauth_bindcred(task);
  372. if (task->tk_status == 0)
  373. task->tk_action = call_start;
  374. else
  375. task->tk_action = NULL;
  376. }
  377. void
  378. rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
  379. {
  380. struct rpc_xprt *xprt = clnt->cl_xprt;
  381. xprt->sndsize = 0;
  382. if (sndsize)
  383. xprt->sndsize = sndsize + RPC_SLACK_SPACE;
  384. xprt->rcvsize = 0;
  385. if (rcvsize)
  386. xprt->rcvsize = rcvsize + RPC_SLACK_SPACE;
  387. if (xprt_connected(xprt))
  388. xprt_sock_setbufsize(xprt);
  389. }
  390. /*
  391. * Return size of largest payload RPC client can support, in bytes
  392. *
  393. * For stream transports, this is one RPC record fragment (see RFC
  394. * 1831), as we don't support multi-record requests yet. For datagram
  395. * transports, this is the size of an IP packet minus the IP, UDP, and
  396. * RPC header sizes.
  397. */
  398. size_t rpc_max_payload(struct rpc_clnt *clnt)
  399. {
  400. return clnt->cl_xprt->max_payload;
  401. }
  402. EXPORT_SYMBOL(rpc_max_payload);
  403. /*
  404. * Restart an (async) RPC call. Usually called from within the
  405. * exit handler.
  406. */
  407. void
  408. rpc_restart_call(struct rpc_task *task)
  409. {
  410. if (RPC_ASSASSINATED(task))
  411. return;
  412. task->tk_action = call_start;
  413. }
  414. /*
  415. * 0. Initial state
  416. *
  417. * Other FSM states can be visited zero or more times, but
  418. * this state is visited exactly once for each RPC.
  419. */
  420. static void
  421. call_start(struct rpc_task *task)
  422. {
  423. struct rpc_clnt *clnt = task->tk_client;
  424. dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task->tk_pid,
  425. clnt->cl_protname, clnt->cl_vers, task->tk_msg.rpc_proc->p_proc,
  426. (RPC_IS_ASYNC(task) ? "async" : "sync"));
  427. /* Increment call count */
  428. task->tk_msg.rpc_proc->p_count++;
  429. clnt->cl_stats->rpccnt++;
  430. task->tk_action = call_reserve;
  431. }
  432. /*
  433. * 1. Reserve an RPC call slot
  434. */
  435. static void
  436. call_reserve(struct rpc_task *task)
  437. {
  438. dprintk("RPC: %4d call_reserve\n", task->tk_pid);
  439. if (!rpcauth_uptodatecred(task)) {
  440. task->tk_action = call_refresh;
  441. return;
  442. }
  443. task->tk_status = 0;
  444. task->tk_action = call_reserveresult;
  445. xprt_reserve(task);
  446. }
  447. /*
  448. * 1b. Grok the result of xprt_reserve()
  449. */
  450. static void
  451. call_reserveresult(struct rpc_task *task)
  452. {
  453. int status = task->tk_status;
  454. dprintk("RPC: %4d call_reserveresult (status %d)\n",
  455. task->tk_pid, task->tk_status);
  456. /*
  457. * After a call to xprt_reserve(), we must have either
  458. * a request slot or else an error status.
  459. */
  460. task->tk_status = 0;
  461. if (status >= 0) {
  462. if (task->tk_rqstp) {
  463. task->tk_action = call_allocate;
  464. return;
  465. }
  466. printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
  467. __FUNCTION__, status);
  468. rpc_exit(task, -EIO);
  469. return;
  470. }
  471. /*
  472. * Even though there was an error, we may have acquired
  473. * a request slot somehow. Make sure not to leak it.
  474. */
  475. if (task->tk_rqstp) {
  476. printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
  477. __FUNCTION__, status);
  478. xprt_release(task);
  479. }
  480. switch (status) {
  481. case -EAGAIN: /* woken up; retry */
  482. task->tk_action = call_reserve;
  483. return;
  484. case -EIO: /* probably a shutdown */
  485. break;
  486. default:
  487. printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
  488. __FUNCTION__, status);
  489. break;
  490. }
  491. rpc_exit(task, status);
  492. }
  493. /*
  494. * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
  495. * (Note: buffer memory is freed in rpc_task_release).
  496. */
  497. static void
  498. call_allocate(struct rpc_task *task)
  499. {
  500. unsigned int bufsiz;
  501. dprintk("RPC: %4d call_allocate (status %d)\n",
  502. task->tk_pid, task->tk_status);
  503. task->tk_action = call_bind;
  504. if (task->tk_buffer)
  505. return;
  506. /* FIXME: compute buffer requirements more exactly using
  507. * auth->au_wslack */
  508. bufsiz = task->tk_msg.rpc_proc->p_bufsiz + RPC_SLACK_SPACE;
  509. if (rpc_malloc(task, bufsiz << 1) != NULL)
  510. return;
  511. printk(KERN_INFO "RPC: buffer allocation failed for task %p\n", task);
  512. if (RPC_IS_ASYNC(task) || !(task->tk_client->cl_intr && signalled())) {
  513. xprt_release(task);
  514. task->tk_action = call_reserve;
  515. rpc_delay(task, HZ>>4);
  516. return;
  517. }
  518. rpc_exit(task, -ERESTARTSYS);
  519. }
  520. /*
  521. * 3. Encode arguments of an RPC call
  522. */
  523. static void
  524. call_encode(struct rpc_task *task)
  525. {
  526. struct rpc_clnt *clnt = task->tk_client;
  527. struct rpc_rqst *req = task->tk_rqstp;
  528. struct xdr_buf *sndbuf = &req->rq_snd_buf;
  529. struct xdr_buf *rcvbuf = &req->rq_rcv_buf;
  530. unsigned int bufsiz;
  531. kxdrproc_t encode;
  532. int status;
  533. u32 *p;
  534. dprintk("RPC: %4d call_encode (status %d)\n",
  535. task->tk_pid, task->tk_status);
  536. /* Default buffer setup */
  537. bufsiz = task->tk_bufsize >> 1;
  538. sndbuf->head[0].iov_base = (void *)task->tk_buffer;
  539. sndbuf->head[0].iov_len = bufsiz;
  540. sndbuf->tail[0].iov_len = 0;
  541. sndbuf->page_len = 0;
  542. sndbuf->len = 0;
  543. sndbuf->buflen = bufsiz;
  544. rcvbuf->head[0].iov_base = (void *)((char *)task->tk_buffer + bufsiz);
  545. rcvbuf->head[0].iov_len = bufsiz;
  546. rcvbuf->tail[0].iov_len = 0;
  547. rcvbuf->page_len = 0;
  548. rcvbuf->len = 0;
  549. rcvbuf->buflen = bufsiz;
  550. /* Encode header and provided arguments */
  551. encode = task->tk_msg.rpc_proc->p_encode;
  552. if (!(p = call_header(task))) {
  553. printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
  554. rpc_exit(task, -EIO);
  555. return;
  556. }
  557. if (encode && (status = rpcauth_wrap_req(task, encode, req, p,
  558. task->tk_msg.rpc_argp)) < 0) {
  559. printk(KERN_WARNING "%s: can't encode arguments: %d\n",
  560. clnt->cl_protname, -status);
  561. rpc_exit(task, status);
  562. }
  563. }
  564. /*
  565. * 4. Get the server port number if not yet set
  566. */
  567. static void
  568. call_bind(struct rpc_task *task)
  569. {
  570. struct rpc_clnt *clnt = task->tk_client;
  571. struct rpc_xprt *xprt = clnt->cl_xprt;
  572. dprintk("RPC: %4d call_bind xprt %p %s connected\n", task->tk_pid,
  573. xprt, (xprt_connected(xprt) ? "is" : "is not"));
  574. task->tk_action = (xprt_connected(xprt)) ? call_transmit : call_connect;
  575. if (!clnt->cl_port) {
  576. task->tk_action = call_connect;
  577. task->tk_timeout = RPC_CONNECT_TIMEOUT;
  578. rpc_getport(task, clnt);
  579. }
  580. }
  581. /*
  582. * 4a. Connect to the RPC server (TCP case)
  583. */
  584. static void
  585. call_connect(struct rpc_task *task)
  586. {
  587. struct rpc_clnt *clnt = task->tk_client;
  588. dprintk("RPC: %4d call_connect status %d\n",
  589. task->tk_pid, task->tk_status);
  590. if (xprt_connected(clnt->cl_xprt)) {
  591. task->tk_action = call_transmit;
  592. return;
  593. }
  594. task->tk_action = call_connect_status;
  595. if (task->tk_status < 0)
  596. return;
  597. xprt_connect(task);
  598. }
  599. /*
  600. * 4b. Sort out connect result
  601. */
  602. static void
  603. call_connect_status(struct rpc_task *task)
  604. {
  605. struct rpc_clnt *clnt = task->tk_client;
  606. int status = task->tk_status;
  607. task->tk_status = 0;
  608. if (status >= 0) {
  609. clnt->cl_stats->netreconn++;
  610. task->tk_action = call_transmit;
  611. return;
  612. }
  613. /* Something failed: we may have to rebind */
  614. if (clnt->cl_autobind)
  615. clnt->cl_port = 0;
  616. switch (status) {
  617. case -ENOTCONN:
  618. case -ETIMEDOUT:
  619. case -EAGAIN:
  620. task->tk_action = (clnt->cl_port == 0) ? call_bind : call_connect;
  621. break;
  622. default:
  623. rpc_exit(task, -EIO);
  624. }
  625. }
  626. /*
  627. * 5. Transmit the RPC request, and wait for reply
  628. */
  629. static void
  630. call_transmit(struct rpc_task *task)
  631. {
  632. dprintk("RPC: %4d call_transmit (status %d)\n",
  633. task->tk_pid, task->tk_status);
  634. task->tk_action = call_status;
  635. if (task->tk_status < 0)
  636. return;
  637. task->tk_status = xprt_prepare_transmit(task);
  638. if (task->tk_status != 0)
  639. return;
  640. /* Encode here so that rpcsec_gss can use correct sequence number. */
  641. if (!task->tk_rqstp->rq_bytes_sent)
  642. call_encode(task);
  643. if (task->tk_status < 0)
  644. return;
  645. xprt_transmit(task);
  646. if (task->tk_status < 0)
  647. return;
  648. if (!task->tk_msg.rpc_proc->p_decode) {
  649. task->tk_action = NULL;
  650. rpc_wake_up_task(task);
  651. }
  652. }
  653. /*
  654. * 6. Sort out the RPC call status
  655. */
  656. static void
  657. call_status(struct rpc_task *task)
  658. {
  659. struct rpc_clnt *clnt = task->tk_client;
  660. struct rpc_rqst *req = task->tk_rqstp;
  661. int status;
  662. if (req->rq_received > 0 && !req->rq_bytes_sent)
  663. task->tk_status = req->rq_received;
  664. dprintk("RPC: %4d call_status (status %d)\n",
  665. task->tk_pid, task->tk_status);
  666. status = task->tk_status;
  667. if (status >= 0) {
  668. task->tk_action = call_decode;
  669. return;
  670. }
  671. task->tk_status = 0;
  672. switch(status) {
  673. case -ETIMEDOUT:
  674. task->tk_action = call_timeout;
  675. break;
  676. case -ECONNREFUSED:
  677. case -ENOTCONN:
  678. req->rq_bytes_sent = 0;
  679. if (clnt->cl_autobind)
  680. clnt->cl_port = 0;
  681. task->tk_action = call_bind;
  682. break;
  683. case -EAGAIN:
  684. task->tk_action = call_transmit;
  685. break;
  686. case -EIO:
  687. /* shutdown or soft timeout */
  688. rpc_exit(task, status);
  689. break;
  690. default:
  691. if (clnt->cl_chatty)
  692. printk("%s: RPC call returned error %d\n",
  693. clnt->cl_protname, -status);
  694. rpc_exit(task, status);
  695. break;
  696. }
  697. }
  698. /*
  699. * 6a. Handle RPC timeout
  700. * We do not release the request slot, so we keep using the
  701. * same XID for all retransmits.
  702. */
  703. static void
  704. call_timeout(struct rpc_task *task)
  705. {
  706. struct rpc_clnt *clnt = task->tk_client;
  707. if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
  708. dprintk("RPC: %4d call_timeout (minor)\n", task->tk_pid);
  709. goto retry;
  710. }
  711. dprintk("RPC: %4d call_timeout (major)\n", task->tk_pid);
  712. if (RPC_IS_SOFT(task)) {
  713. if (clnt->cl_chatty)
  714. printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
  715. clnt->cl_protname, clnt->cl_server);
  716. rpc_exit(task, -EIO);
  717. return;
  718. }
  719. if (clnt->cl_chatty && !(task->tk_flags & RPC_CALL_MAJORSEEN)) {
  720. task->tk_flags |= RPC_CALL_MAJORSEEN;
  721. printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
  722. clnt->cl_protname, clnt->cl_server);
  723. }
  724. if (clnt->cl_autobind)
  725. clnt->cl_port = 0;
  726. retry:
  727. clnt->cl_stats->rpcretrans++;
  728. task->tk_action = call_bind;
  729. task->tk_status = 0;
  730. }
  731. /*
  732. * 7. Decode the RPC reply
  733. */
  734. static void
  735. call_decode(struct rpc_task *task)
  736. {
  737. struct rpc_clnt *clnt = task->tk_client;
  738. struct rpc_rqst *req = task->tk_rqstp;
  739. kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
  740. u32 *p;
  741. dprintk("RPC: %4d call_decode (status %d)\n",
  742. task->tk_pid, task->tk_status);
  743. if (clnt->cl_chatty && (task->tk_flags & RPC_CALL_MAJORSEEN)) {
  744. printk(KERN_NOTICE "%s: server %s OK\n",
  745. clnt->cl_protname, clnt->cl_server);
  746. task->tk_flags &= ~RPC_CALL_MAJORSEEN;
  747. }
  748. if (task->tk_status < 12) {
  749. if (!RPC_IS_SOFT(task)) {
  750. task->tk_action = call_bind;
  751. clnt->cl_stats->rpcretrans++;
  752. goto out_retry;
  753. }
  754. printk(KERN_WARNING "%s: too small RPC reply size (%d bytes)\n",
  755. clnt->cl_protname, task->tk_status);
  756. rpc_exit(task, -EIO);
  757. return;
  758. }
  759. req->rq_rcv_buf.len = req->rq_private_buf.len;
  760. /* Check that the softirq receive buffer is valid */
  761. WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
  762. sizeof(req->rq_rcv_buf)) != 0);
  763. /* Verify the RPC header */
  764. if (!(p = call_verify(task))) {
  765. if (task->tk_action == NULL)
  766. return;
  767. goto out_retry;
  768. }
  769. task->tk_action = NULL;
  770. if (decode)
  771. task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
  772. task->tk_msg.rpc_resp);
  773. dprintk("RPC: %4d call_decode result %d\n", task->tk_pid,
  774. task->tk_status);
  775. return;
  776. out_retry:
  777. req->rq_received = req->rq_private_buf.len = 0;
  778. task->tk_status = 0;
  779. }
  780. /*
  781. * 8. Refresh the credentials if rejected by the server
  782. */
  783. static void
  784. call_refresh(struct rpc_task *task)
  785. {
  786. dprintk("RPC: %4d call_refresh\n", task->tk_pid);
  787. xprt_release(task); /* Must do to obtain new XID */
  788. task->tk_action = call_refreshresult;
  789. task->tk_status = 0;
  790. task->tk_client->cl_stats->rpcauthrefresh++;
  791. rpcauth_refreshcred(task);
  792. }
  793. /*
  794. * 8a. Process the results of a credential refresh
  795. */
  796. static void
  797. call_refreshresult(struct rpc_task *task)
  798. {
  799. int status = task->tk_status;
  800. dprintk("RPC: %4d call_refreshresult (status %d)\n",
  801. task->tk_pid, task->tk_status);
  802. task->tk_status = 0;
  803. task->tk_action = call_reserve;
  804. if (status >= 0 && rpcauth_uptodatecred(task))
  805. return;
  806. if (status == -EACCES) {
  807. rpc_exit(task, -EACCES);
  808. return;
  809. }
  810. task->tk_action = call_refresh;
  811. if (status != -ETIMEDOUT)
  812. rpc_delay(task, 3*HZ);
  813. return;
  814. }
  815. /*
  816. * Call header serialization
  817. */
  818. static u32 *
  819. call_header(struct rpc_task *task)
  820. {
  821. struct rpc_clnt *clnt = task->tk_client;
  822. struct rpc_xprt *xprt = clnt->cl_xprt;
  823. struct rpc_rqst *req = task->tk_rqstp;
  824. u32 *p = req->rq_svec[0].iov_base;
  825. /* FIXME: check buffer size? */
  826. if (xprt->stream)
  827. *p++ = 0; /* fill in later */
  828. *p++ = req->rq_xid; /* XID */
  829. *p++ = htonl(RPC_CALL); /* CALL */
  830. *p++ = htonl(RPC_VERSION); /* RPC version */
  831. *p++ = htonl(clnt->cl_prog); /* program number */
  832. *p++ = htonl(clnt->cl_vers); /* program version */
  833. *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
  834. return rpcauth_marshcred(task, p);
  835. }
  836. /*
  837. * Reply header verification
  838. */
  839. static u32 *
  840. call_verify(struct rpc_task *task)
  841. {
  842. struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
  843. int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
  844. u32 *p = iov->iov_base, n;
  845. int error = -EACCES;
  846. if ((len -= 3) < 0)
  847. goto out_overflow;
  848. p += 1; /* skip XID */
  849. if ((n = ntohl(*p++)) != RPC_REPLY) {
  850. printk(KERN_WARNING "call_verify: not an RPC reply: %x\n", n);
  851. goto out_retry;
  852. }
  853. if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
  854. if (--len < 0)
  855. goto out_overflow;
  856. switch ((n = ntohl(*p++))) {
  857. case RPC_AUTH_ERROR:
  858. break;
  859. case RPC_MISMATCH:
  860. printk(KERN_WARNING "%s: RPC call version mismatch!\n", __FUNCTION__);
  861. goto out_eio;
  862. default:
  863. printk(KERN_WARNING "%s: RPC call rejected, unknown error: %x\n", __FUNCTION__, n);
  864. goto out_eio;
  865. }
  866. if (--len < 0)
  867. goto out_overflow;
  868. switch ((n = ntohl(*p++))) {
  869. case RPC_AUTH_REJECTEDCRED:
  870. case RPC_AUTH_REJECTEDVERF:
  871. case RPCSEC_GSS_CREDPROBLEM:
  872. case RPCSEC_GSS_CTXPROBLEM:
  873. if (!task->tk_cred_retry)
  874. break;
  875. task->tk_cred_retry--;
  876. dprintk("RPC: %4d call_verify: retry stale creds\n",
  877. task->tk_pid);
  878. rpcauth_invalcred(task);
  879. task->tk_action = call_refresh;
  880. return NULL;
  881. case RPC_AUTH_BADCRED:
  882. case RPC_AUTH_BADVERF:
  883. /* possibly garbled cred/verf? */
  884. if (!task->tk_garb_retry)
  885. break;
  886. task->tk_garb_retry--;
  887. dprintk("RPC: %4d call_verify: retry garbled creds\n",
  888. task->tk_pid);
  889. task->tk_action = call_bind;
  890. return NULL;
  891. case RPC_AUTH_TOOWEAK:
  892. printk(KERN_NOTICE "call_verify: server requires stronger "
  893. "authentication.\n");
  894. break;
  895. default:
  896. printk(KERN_WARNING "call_verify: unknown auth error: %x\n", n);
  897. error = -EIO;
  898. }
  899. dprintk("RPC: %4d call_verify: call rejected %d\n",
  900. task->tk_pid, n);
  901. goto out_err;
  902. }
  903. if (!(p = rpcauth_checkverf(task, p))) {
  904. printk(KERN_WARNING "call_verify: auth check failed\n");
  905. goto out_retry; /* bad verifier, retry */
  906. }
  907. len = p - (u32 *)iov->iov_base - 1;
  908. if (len < 0)
  909. goto out_overflow;
  910. switch ((n = ntohl(*p++))) {
  911. case RPC_SUCCESS:
  912. return p;
  913. case RPC_PROG_UNAVAIL:
  914. printk(KERN_WARNING "RPC: call_verify: program %u is unsupported by server %s\n",
  915. (unsigned int)task->tk_client->cl_prog,
  916. task->tk_client->cl_server);
  917. goto out_eio;
  918. case RPC_PROG_MISMATCH:
  919. printk(KERN_WARNING "RPC: call_verify: program %u, version %u unsupported by server %s\n",
  920. (unsigned int)task->tk_client->cl_prog,
  921. (unsigned int)task->tk_client->cl_vers,
  922. task->tk_client->cl_server);
  923. goto out_eio;
  924. case RPC_PROC_UNAVAIL:
  925. printk(KERN_WARNING "RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
  926. task->tk_msg.rpc_proc,
  927. task->tk_client->cl_prog,
  928. task->tk_client->cl_vers,
  929. task->tk_client->cl_server);
  930. goto out_eio;
  931. case RPC_GARBAGE_ARGS:
  932. dprintk("RPC: %4d %s: server saw garbage\n", task->tk_pid, __FUNCTION__);
  933. break; /* retry */
  934. default:
  935. printk(KERN_WARNING "call_verify: server accept status: %x\n", n);
  936. /* Also retry */
  937. }
  938. out_retry:
  939. task->tk_client->cl_stats->rpcgarbage++;
  940. if (task->tk_garb_retry) {
  941. task->tk_garb_retry--;
  942. dprintk(KERN_WARNING "RPC %s: retrying %4d\n", __FUNCTION__, task->tk_pid);
  943. task->tk_action = call_bind;
  944. return NULL;
  945. }
  946. printk(KERN_WARNING "RPC %s: retry failed, exit EIO\n", __FUNCTION__);
  947. out_eio:
  948. error = -EIO;
  949. out_err:
  950. rpc_exit(task, error);
  951. return NULL;
  952. out_overflow:
  953. printk(KERN_WARNING "RPC %s: server reply was truncated.\n", __FUNCTION__);
  954. goto out_retry;
  955. }