clnt.c 28 KB

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