clnt.c 38 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588
  1. /*
  2. * linux/net/sunrpc/clnt.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/smp_lock.h>
  29. #include <linux/utsname.h>
  30. #include <linux/workqueue.h>
  31. #include <linux/sunrpc/clnt.h>
  32. #include <linux/sunrpc/rpc_pipe_fs.h>
  33. #include <linux/sunrpc/metrics.h>
  34. #ifdef RPC_DEBUG
  35. # define RPCDBG_FACILITY RPCDBG_CALL
  36. #endif
  37. #define dprint_status(t) \
  38. dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
  39. __FUNCTION__, t->tk_status)
  40. /*
  41. * All RPC clients are linked into this list
  42. */
  43. static LIST_HEAD(all_clients);
  44. static DEFINE_SPINLOCK(rpc_client_lock);
  45. static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
  46. static void call_start(struct rpc_task *task);
  47. static void call_reserve(struct rpc_task *task);
  48. static void call_reserveresult(struct rpc_task *task);
  49. static void call_allocate(struct rpc_task *task);
  50. static void call_encode(struct rpc_task *task);
  51. static void call_decode(struct rpc_task *task);
  52. static void call_bind(struct rpc_task *task);
  53. static void call_bind_status(struct rpc_task *task);
  54. static void call_transmit(struct rpc_task *task);
  55. static void call_status(struct rpc_task *task);
  56. static void call_transmit_status(struct rpc_task *task);
  57. static void call_refresh(struct rpc_task *task);
  58. static void call_refreshresult(struct rpc_task *task);
  59. static void call_timeout(struct rpc_task *task);
  60. static void call_connect(struct rpc_task *task);
  61. static void call_connect_status(struct rpc_task *task);
  62. static __be32 * call_header(struct rpc_task *task);
  63. static __be32 * call_verify(struct rpc_task *task);
  64. static int rpc_ping(struct rpc_clnt *clnt, int flags);
  65. static void rpc_register_client(struct rpc_clnt *clnt)
  66. {
  67. spin_lock(&rpc_client_lock);
  68. list_add(&clnt->cl_clients, &all_clients);
  69. spin_unlock(&rpc_client_lock);
  70. }
  71. static void rpc_unregister_client(struct rpc_clnt *clnt)
  72. {
  73. spin_lock(&rpc_client_lock);
  74. list_del(&clnt->cl_clients);
  75. spin_unlock(&rpc_client_lock);
  76. }
  77. static int
  78. rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
  79. {
  80. static uint32_t clntid;
  81. int error;
  82. clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
  83. clnt->cl_dentry = ERR_PTR(-ENOENT);
  84. if (dir_name == NULL)
  85. return 0;
  86. clnt->cl_vfsmnt = rpc_get_mount();
  87. if (IS_ERR(clnt->cl_vfsmnt))
  88. return PTR_ERR(clnt->cl_vfsmnt);
  89. for (;;) {
  90. snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
  91. "%s/clnt%x", dir_name,
  92. (unsigned int)clntid++);
  93. clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
  94. clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
  95. if (!IS_ERR(clnt->cl_dentry))
  96. return 0;
  97. error = PTR_ERR(clnt->cl_dentry);
  98. if (error != -EEXIST) {
  99. printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
  100. clnt->cl_pathname, error);
  101. rpc_put_mount();
  102. return error;
  103. }
  104. }
  105. }
  106. static struct rpc_clnt * rpc_new_client(struct rpc_xprt *xprt, char *servname, struct rpc_program *program, u32 vers, rpc_authflavor_t flavor)
  107. {
  108. struct rpc_version *version;
  109. struct rpc_clnt *clnt = NULL;
  110. struct rpc_auth *auth;
  111. int err;
  112. size_t len;
  113. /* sanity check the name before trying to print it */
  114. err = -EINVAL;
  115. len = strlen(servname);
  116. if (len > RPC_MAXNETNAMELEN)
  117. goto out_no_rpciod;
  118. len++;
  119. dprintk("RPC: creating %s client for %s (xprt %p)\n",
  120. program->name, servname, xprt);
  121. err = rpciod_up();
  122. if (err)
  123. goto out_no_rpciod;
  124. err = -EINVAL;
  125. if (!xprt)
  126. goto out_no_xprt;
  127. if (vers >= program->nrvers || !(version = program->version[vers]))
  128. goto out_err;
  129. err = -ENOMEM;
  130. clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
  131. if (!clnt)
  132. goto out_err;
  133. clnt->cl_parent = clnt;
  134. clnt->cl_server = clnt->cl_inline_name;
  135. if (len > sizeof(clnt->cl_inline_name)) {
  136. char *buf = kmalloc(len, GFP_KERNEL);
  137. if (buf != 0)
  138. clnt->cl_server = buf;
  139. else
  140. len = sizeof(clnt->cl_inline_name);
  141. }
  142. strlcpy(clnt->cl_server, servname, len);
  143. clnt->cl_xprt = xprt;
  144. clnt->cl_procinfo = version->procs;
  145. clnt->cl_maxproc = version->nrprocs;
  146. clnt->cl_protname = program->name;
  147. clnt->cl_prog = program->number;
  148. clnt->cl_vers = version->number;
  149. clnt->cl_stats = program->stats;
  150. clnt->cl_metrics = rpc_alloc_iostats(clnt);
  151. err = -ENOMEM;
  152. if (clnt->cl_metrics == NULL)
  153. goto out_no_stats;
  154. clnt->cl_program = program;
  155. INIT_LIST_HEAD(&clnt->cl_tasks);
  156. spin_lock_init(&clnt->cl_lock);
  157. if (!xprt_bound(clnt->cl_xprt))
  158. clnt->cl_autobind = 1;
  159. clnt->cl_rtt = &clnt->cl_rtt_default;
  160. rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
  161. kref_init(&clnt->cl_kref);
  162. err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
  163. if (err < 0)
  164. goto out_no_path;
  165. auth = rpcauth_create(flavor, clnt);
  166. if (IS_ERR(auth)) {
  167. printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
  168. flavor);
  169. err = PTR_ERR(auth);
  170. goto out_no_auth;
  171. }
  172. /* save the nodename */
  173. clnt->cl_nodelen = strlen(utsname()->nodename);
  174. if (clnt->cl_nodelen > UNX_MAXNODENAME)
  175. clnt->cl_nodelen = UNX_MAXNODENAME;
  176. memcpy(clnt->cl_nodename, utsname()->nodename, clnt->cl_nodelen);
  177. rpc_register_client(clnt);
  178. return clnt;
  179. out_no_auth:
  180. if (!IS_ERR(clnt->cl_dentry)) {
  181. rpc_rmdir(clnt->cl_dentry);
  182. rpc_put_mount();
  183. }
  184. out_no_path:
  185. rpc_free_iostats(clnt->cl_metrics);
  186. out_no_stats:
  187. if (clnt->cl_server != clnt->cl_inline_name)
  188. kfree(clnt->cl_server);
  189. kfree(clnt);
  190. out_err:
  191. xprt_put(xprt);
  192. out_no_xprt:
  193. rpciod_down();
  194. out_no_rpciod:
  195. return ERR_PTR(err);
  196. }
  197. /*
  198. * rpc_create - create an RPC client and transport with one call
  199. * @args: rpc_clnt create argument structure
  200. *
  201. * Creates and initializes an RPC transport and an RPC client.
  202. *
  203. * It can ping the server in order to determine if it is up, and to see if
  204. * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
  205. * this behavior so asynchronous tasks can also use rpc_create.
  206. */
  207. struct rpc_clnt *rpc_create(struct rpc_create_args *args)
  208. {
  209. struct rpc_xprt *xprt;
  210. struct rpc_clnt *clnt;
  211. struct xprt_create xprtargs = {
  212. .ident = args->protocol,
  213. .srcaddr = args->saddress,
  214. .dstaddr = args->address,
  215. .addrlen = args->addrsize,
  216. .timeout = args->timeout
  217. };
  218. char servername[20];
  219. xprt = xprt_create_transport(&xprtargs);
  220. if (IS_ERR(xprt))
  221. return (struct rpc_clnt *)xprt;
  222. /*
  223. * If the caller chooses not to specify a hostname, whip
  224. * up a string representation of the passed-in address.
  225. */
  226. if (args->servername == NULL) {
  227. struct sockaddr_in *addr =
  228. (struct sockaddr_in *) args->address;
  229. snprintf(servername, sizeof(servername), NIPQUAD_FMT,
  230. NIPQUAD(addr->sin_addr.s_addr));
  231. args->servername = servername;
  232. }
  233. /*
  234. * By default, kernel RPC client connects from a reserved port.
  235. * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
  236. * but it is always enabled for rpciod, which handles the connect
  237. * operation.
  238. */
  239. xprt->resvport = 1;
  240. if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
  241. xprt->resvport = 0;
  242. clnt = rpc_new_client(xprt, args->servername, args->program,
  243. args->version, args->authflavor);
  244. if (IS_ERR(clnt))
  245. return clnt;
  246. if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
  247. int err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
  248. if (err != 0) {
  249. rpc_shutdown_client(clnt);
  250. return ERR_PTR(err);
  251. }
  252. }
  253. clnt->cl_softrtry = 1;
  254. if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
  255. clnt->cl_softrtry = 0;
  256. if (args->flags & RPC_CLNT_CREATE_INTR)
  257. clnt->cl_intr = 1;
  258. if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
  259. clnt->cl_autobind = 1;
  260. if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
  261. clnt->cl_discrtry = 1;
  262. return clnt;
  263. }
  264. EXPORT_SYMBOL_GPL(rpc_create);
  265. /*
  266. * This function clones the RPC client structure. It allows us to share the
  267. * same transport while varying parameters such as the authentication
  268. * flavour.
  269. */
  270. struct rpc_clnt *
  271. rpc_clone_client(struct rpc_clnt *clnt)
  272. {
  273. struct rpc_clnt *new;
  274. int err = -ENOMEM;
  275. new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
  276. if (!new)
  277. goto out_no_clnt;
  278. new->cl_parent = clnt;
  279. /* Turn off autobind on clones */
  280. new->cl_autobind = 0;
  281. INIT_LIST_HEAD(&new->cl_tasks);
  282. spin_lock_init(&new->cl_lock);
  283. rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
  284. new->cl_metrics = rpc_alloc_iostats(clnt);
  285. if (new->cl_metrics == NULL)
  286. goto out_no_stats;
  287. kref_init(&new->cl_kref);
  288. err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
  289. if (err != 0)
  290. goto out_no_path;
  291. if (new->cl_auth)
  292. atomic_inc(&new->cl_auth->au_count);
  293. xprt_get(clnt->cl_xprt);
  294. kref_get(&clnt->cl_kref);
  295. rpc_register_client(new);
  296. rpciod_up();
  297. return new;
  298. out_no_path:
  299. rpc_free_iostats(new->cl_metrics);
  300. out_no_stats:
  301. kfree(new);
  302. out_no_clnt:
  303. dprintk("RPC: %s: returned error %d\n", __FUNCTION__, err);
  304. return ERR_PTR(err);
  305. }
  306. EXPORT_SYMBOL_GPL(rpc_clone_client);
  307. /*
  308. * Properly shut down an RPC client, terminating all outstanding
  309. * requests.
  310. */
  311. void rpc_shutdown_client(struct rpc_clnt *clnt)
  312. {
  313. dprintk("RPC: shutting down %s client for %s\n",
  314. clnt->cl_protname, clnt->cl_server);
  315. while (!list_empty(&clnt->cl_tasks)) {
  316. rpc_killall_tasks(clnt);
  317. wait_event_timeout(destroy_wait,
  318. list_empty(&clnt->cl_tasks), 1*HZ);
  319. }
  320. rpc_release_client(clnt);
  321. }
  322. EXPORT_SYMBOL_GPL(rpc_shutdown_client);
  323. /*
  324. * Free an RPC client
  325. */
  326. static void
  327. rpc_free_client(struct kref *kref)
  328. {
  329. struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
  330. dprintk("RPC: destroying %s client for %s\n",
  331. clnt->cl_protname, clnt->cl_server);
  332. if (!IS_ERR(clnt->cl_dentry)) {
  333. rpc_rmdir(clnt->cl_dentry);
  334. rpc_put_mount();
  335. }
  336. if (clnt->cl_parent != clnt) {
  337. rpc_release_client(clnt->cl_parent);
  338. goto out_free;
  339. }
  340. if (clnt->cl_server != clnt->cl_inline_name)
  341. kfree(clnt->cl_server);
  342. out_free:
  343. rpc_unregister_client(clnt);
  344. rpc_free_iostats(clnt->cl_metrics);
  345. clnt->cl_metrics = NULL;
  346. xprt_put(clnt->cl_xprt);
  347. rpciod_down();
  348. kfree(clnt);
  349. }
  350. /*
  351. * Free an RPC client
  352. */
  353. static void
  354. rpc_free_auth(struct kref *kref)
  355. {
  356. struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
  357. if (clnt->cl_auth == NULL) {
  358. rpc_free_client(kref);
  359. return;
  360. }
  361. /*
  362. * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
  363. * release remaining GSS contexts. This mechanism ensures
  364. * that it can do so safely.
  365. */
  366. kref_init(kref);
  367. rpcauth_release(clnt->cl_auth);
  368. clnt->cl_auth = NULL;
  369. kref_put(kref, rpc_free_client);
  370. }
  371. /*
  372. * Release reference to the RPC client
  373. */
  374. void
  375. rpc_release_client(struct rpc_clnt *clnt)
  376. {
  377. dprintk("RPC: rpc_release_client(%p)\n", clnt);
  378. if (list_empty(&clnt->cl_tasks))
  379. wake_up(&destroy_wait);
  380. kref_put(&clnt->cl_kref, rpc_free_auth);
  381. }
  382. /**
  383. * rpc_bind_new_program - bind a new RPC program to an existing client
  384. * @old - old rpc_client
  385. * @program - rpc program to set
  386. * @vers - rpc program version
  387. *
  388. * Clones the rpc client and sets up a new RPC program. This is mainly
  389. * of use for enabling different RPC programs to share the same transport.
  390. * The Sun NFSv2/v3 ACL protocol can do this.
  391. */
  392. struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
  393. struct rpc_program *program,
  394. u32 vers)
  395. {
  396. struct rpc_clnt *clnt;
  397. struct rpc_version *version;
  398. int err;
  399. BUG_ON(vers >= program->nrvers || !program->version[vers]);
  400. version = program->version[vers];
  401. clnt = rpc_clone_client(old);
  402. if (IS_ERR(clnt))
  403. goto out;
  404. clnt->cl_procinfo = version->procs;
  405. clnt->cl_maxproc = version->nrprocs;
  406. clnt->cl_protname = program->name;
  407. clnt->cl_prog = program->number;
  408. clnt->cl_vers = version->number;
  409. clnt->cl_stats = program->stats;
  410. err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
  411. if (err != 0) {
  412. rpc_shutdown_client(clnt);
  413. clnt = ERR_PTR(err);
  414. }
  415. out:
  416. return clnt;
  417. }
  418. EXPORT_SYMBOL_GPL(rpc_bind_new_program);
  419. /*
  420. * Default callback for async RPC calls
  421. */
  422. static void
  423. rpc_default_callback(struct rpc_task *task, void *data)
  424. {
  425. }
  426. static const struct rpc_call_ops rpc_default_ops = {
  427. .rpc_call_done = rpc_default_callback,
  428. };
  429. /*
  430. * Export the signal mask handling for synchronous code that
  431. * sleeps on RPC calls
  432. */
  433. #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
  434. static void rpc_save_sigmask(sigset_t *oldset, int intr)
  435. {
  436. unsigned long sigallow = sigmask(SIGKILL);
  437. sigset_t sigmask;
  438. /* Block all signals except those listed in sigallow */
  439. if (intr)
  440. sigallow |= RPC_INTR_SIGNALS;
  441. siginitsetinv(&sigmask, sigallow);
  442. sigprocmask(SIG_BLOCK, &sigmask, oldset);
  443. }
  444. static void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
  445. {
  446. rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
  447. }
  448. static void rpc_restore_sigmask(sigset_t *oldset)
  449. {
  450. sigprocmask(SIG_SETMASK, oldset, NULL);
  451. }
  452. void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
  453. {
  454. rpc_save_sigmask(oldset, clnt->cl_intr);
  455. }
  456. EXPORT_SYMBOL_GPL(rpc_clnt_sigmask);
  457. void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
  458. {
  459. rpc_restore_sigmask(oldset);
  460. }
  461. EXPORT_SYMBOL_GPL(rpc_clnt_sigunmask);
  462. /**
  463. * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
  464. * @task_setup_data: pointer to task initialisation data
  465. */
  466. struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
  467. {
  468. struct rpc_task *task, *ret;
  469. sigset_t oldset;
  470. task = rpc_new_task(task_setup_data);
  471. if (task == NULL) {
  472. rpc_release_calldata(task_setup_data->callback_ops,
  473. task_setup_data->callback_data);
  474. ret = ERR_PTR(-ENOMEM);
  475. goto out;
  476. }
  477. if (task_setup_data->rpc_message != NULL) {
  478. rpc_call_setup(task, task_setup_data->rpc_message, 0);
  479. if (task->tk_status != 0) {
  480. ret = ERR_PTR(task->tk_status);
  481. rpc_put_task(task);
  482. goto out;
  483. }
  484. }
  485. atomic_inc(&task->tk_count);
  486. /* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
  487. rpc_task_sigmask(task, &oldset);
  488. rpc_execute(task);
  489. rpc_restore_sigmask(&oldset);
  490. ret = task;
  491. out:
  492. return ret;
  493. }
  494. EXPORT_SYMBOL_GPL(rpc_run_task);
  495. /**
  496. * rpc_call_sync - Perform a synchronous RPC call
  497. * @clnt: pointer to RPC client
  498. * @msg: RPC call parameters
  499. * @flags: RPC call flags
  500. */
  501. int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
  502. {
  503. struct rpc_task *task;
  504. struct rpc_task_setup task_setup_data = {
  505. .rpc_client = clnt,
  506. .rpc_message = msg,
  507. .callback_ops = &rpc_default_ops,
  508. .flags = flags,
  509. };
  510. int status;
  511. BUG_ON(flags & RPC_TASK_ASYNC);
  512. task = rpc_run_task(&task_setup_data);
  513. if (IS_ERR(task))
  514. return PTR_ERR(task);
  515. status = task->tk_status;
  516. rpc_put_task(task);
  517. return status;
  518. }
  519. EXPORT_SYMBOL_GPL(rpc_call_sync);
  520. /**
  521. * rpc_call_async - Perform an asynchronous RPC call
  522. * @clnt: pointer to RPC client
  523. * @msg: RPC call parameters
  524. * @flags: RPC call flags
  525. * @ops: RPC call ops
  526. * @data: user call data
  527. */
  528. int
  529. rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
  530. const struct rpc_call_ops *tk_ops, void *data)
  531. {
  532. struct rpc_task *task;
  533. struct rpc_task_setup task_setup_data = {
  534. .rpc_client = clnt,
  535. .rpc_message = msg,
  536. .callback_ops = tk_ops,
  537. .callback_data = data,
  538. .flags = flags|RPC_TASK_ASYNC,
  539. };
  540. task = rpc_run_task(&task_setup_data);
  541. if (IS_ERR(task))
  542. return PTR_ERR(task);
  543. rpc_put_task(task);
  544. return 0;
  545. }
  546. EXPORT_SYMBOL_GPL(rpc_call_async);
  547. void
  548. rpc_call_setup(struct rpc_task *task, const struct rpc_message *msg, int flags)
  549. {
  550. task->tk_msg = *msg;
  551. task->tk_flags |= flags;
  552. /* Bind the user cred */
  553. if (task->tk_msg.rpc_cred != NULL)
  554. rpcauth_holdcred(task);
  555. else
  556. rpcauth_bindcred(task);
  557. if (task->tk_status == 0)
  558. task->tk_action = call_start;
  559. else
  560. task->tk_action = rpc_exit_task;
  561. }
  562. EXPORT_SYMBOL_GPL(rpc_call_setup);
  563. void
  564. rpc_call_start(struct rpc_task *task)
  565. {
  566. task->tk_action = call_start;
  567. }
  568. EXPORT_SYMBOL_GPL(rpc_call_start);
  569. /**
  570. * rpc_peeraddr - extract remote peer address from clnt's xprt
  571. * @clnt: RPC client structure
  572. * @buf: target buffer
  573. * @size: length of target buffer
  574. *
  575. * Returns the number of bytes that are actually in the stored address.
  576. */
  577. size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
  578. {
  579. size_t bytes;
  580. struct rpc_xprt *xprt = clnt->cl_xprt;
  581. bytes = sizeof(xprt->addr);
  582. if (bytes > bufsize)
  583. bytes = bufsize;
  584. memcpy(buf, &clnt->cl_xprt->addr, bytes);
  585. return xprt->addrlen;
  586. }
  587. EXPORT_SYMBOL_GPL(rpc_peeraddr);
  588. /**
  589. * rpc_peeraddr2str - return remote peer address in printable format
  590. * @clnt: RPC client structure
  591. * @format: address format
  592. *
  593. */
  594. char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
  595. {
  596. struct rpc_xprt *xprt = clnt->cl_xprt;
  597. if (xprt->address_strings[format] != NULL)
  598. return xprt->address_strings[format];
  599. else
  600. return "unprintable";
  601. }
  602. EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
  603. void
  604. rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
  605. {
  606. struct rpc_xprt *xprt = clnt->cl_xprt;
  607. if (xprt->ops->set_buffer_size)
  608. xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
  609. }
  610. EXPORT_SYMBOL_GPL(rpc_setbufsize);
  611. /*
  612. * Return size of largest payload RPC client can support, in bytes
  613. *
  614. * For stream transports, this is one RPC record fragment (see RFC
  615. * 1831), as we don't support multi-record requests yet. For datagram
  616. * transports, this is the size of an IP packet minus the IP, UDP, and
  617. * RPC header sizes.
  618. */
  619. size_t rpc_max_payload(struct rpc_clnt *clnt)
  620. {
  621. return clnt->cl_xprt->max_payload;
  622. }
  623. EXPORT_SYMBOL_GPL(rpc_max_payload);
  624. /**
  625. * rpc_force_rebind - force transport to check that remote port is unchanged
  626. * @clnt: client to rebind
  627. *
  628. */
  629. void rpc_force_rebind(struct rpc_clnt *clnt)
  630. {
  631. if (clnt->cl_autobind)
  632. xprt_clear_bound(clnt->cl_xprt);
  633. }
  634. EXPORT_SYMBOL_GPL(rpc_force_rebind);
  635. /*
  636. * Restart an (async) RPC call. Usually called from within the
  637. * exit handler.
  638. */
  639. void
  640. rpc_restart_call(struct rpc_task *task)
  641. {
  642. if (RPC_ASSASSINATED(task))
  643. return;
  644. task->tk_action = call_start;
  645. }
  646. EXPORT_SYMBOL_GPL(rpc_restart_call);
  647. /*
  648. * 0. Initial state
  649. *
  650. * Other FSM states can be visited zero or more times, but
  651. * this state is visited exactly once for each RPC.
  652. */
  653. static void
  654. call_start(struct rpc_task *task)
  655. {
  656. struct rpc_clnt *clnt = task->tk_client;
  657. dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
  658. clnt->cl_protname, clnt->cl_vers,
  659. task->tk_msg.rpc_proc->p_proc,
  660. (RPC_IS_ASYNC(task) ? "async" : "sync"));
  661. /* Increment call count */
  662. task->tk_msg.rpc_proc->p_count++;
  663. clnt->cl_stats->rpccnt++;
  664. task->tk_action = call_reserve;
  665. }
  666. /*
  667. * 1. Reserve an RPC call slot
  668. */
  669. static void
  670. call_reserve(struct rpc_task *task)
  671. {
  672. dprint_status(task);
  673. if (!rpcauth_uptodatecred(task)) {
  674. task->tk_action = call_refresh;
  675. return;
  676. }
  677. task->tk_status = 0;
  678. task->tk_action = call_reserveresult;
  679. xprt_reserve(task);
  680. }
  681. /*
  682. * 1b. Grok the result of xprt_reserve()
  683. */
  684. static void
  685. call_reserveresult(struct rpc_task *task)
  686. {
  687. int status = task->tk_status;
  688. dprint_status(task);
  689. /*
  690. * After a call to xprt_reserve(), we must have either
  691. * a request slot or else an error status.
  692. */
  693. task->tk_status = 0;
  694. if (status >= 0) {
  695. if (task->tk_rqstp) {
  696. task->tk_action = call_allocate;
  697. return;
  698. }
  699. printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
  700. __FUNCTION__, status);
  701. rpc_exit(task, -EIO);
  702. return;
  703. }
  704. /*
  705. * Even though there was an error, we may have acquired
  706. * a request slot somehow. Make sure not to leak it.
  707. */
  708. if (task->tk_rqstp) {
  709. printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
  710. __FUNCTION__, status);
  711. xprt_release(task);
  712. }
  713. switch (status) {
  714. case -EAGAIN: /* woken up; retry */
  715. task->tk_action = call_reserve;
  716. return;
  717. case -EIO: /* probably a shutdown */
  718. break;
  719. default:
  720. printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
  721. __FUNCTION__, status);
  722. break;
  723. }
  724. rpc_exit(task, status);
  725. }
  726. /*
  727. * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
  728. * (Note: buffer memory is freed in xprt_release).
  729. */
  730. static void
  731. call_allocate(struct rpc_task *task)
  732. {
  733. unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
  734. struct rpc_rqst *req = task->tk_rqstp;
  735. struct rpc_xprt *xprt = task->tk_xprt;
  736. struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
  737. dprint_status(task);
  738. task->tk_status = 0;
  739. task->tk_action = call_bind;
  740. if (req->rq_buffer)
  741. return;
  742. if (proc->p_proc != 0) {
  743. BUG_ON(proc->p_arglen == 0);
  744. if (proc->p_decode != NULL)
  745. BUG_ON(proc->p_replen == 0);
  746. }
  747. /*
  748. * Calculate the size (in quads) of the RPC call
  749. * and reply headers, and convert both values
  750. * to byte sizes.
  751. */
  752. req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
  753. req->rq_callsize <<= 2;
  754. req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
  755. req->rq_rcvsize <<= 2;
  756. req->rq_buffer = xprt->ops->buf_alloc(task,
  757. req->rq_callsize + req->rq_rcvsize);
  758. if (req->rq_buffer != NULL)
  759. return;
  760. dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
  761. if (RPC_IS_ASYNC(task) || !signalled()) {
  762. task->tk_action = call_allocate;
  763. rpc_delay(task, HZ>>4);
  764. return;
  765. }
  766. rpc_exit(task, -ERESTARTSYS);
  767. }
  768. static inline int
  769. rpc_task_need_encode(struct rpc_task *task)
  770. {
  771. return task->tk_rqstp->rq_snd_buf.len == 0;
  772. }
  773. static inline void
  774. rpc_task_force_reencode(struct rpc_task *task)
  775. {
  776. task->tk_rqstp->rq_snd_buf.len = 0;
  777. }
  778. static inline void
  779. rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
  780. {
  781. buf->head[0].iov_base = start;
  782. buf->head[0].iov_len = len;
  783. buf->tail[0].iov_len = 0;
  784. buf->page_len = 0;
  785. buf->flags = 0;
  786. buf->len = 0;
  787. buf->buflen = len;
  788. }
  789. /*
  790. * 3. Encode arguments of an RPC call
  791. */
  792. static void
  793. call_encode(struct rpc_task *task)
  794. {
  795. struct rpc_rqst *req = task->tk_rqstp;
  796. kxdrproc_t encode;
  797. __be32 *p;
  798. dprint_status(task);
  799. rpc_xdr_buf_init(&req->rq_snd_buf,
  800. req->rq_buffer,
  801. req->rq_callsize);
  802. rpc_xdr_buf_init(&req->rq_rcv_buf,
  803. (char *)req->rq_buffer + req->rq_callsize,
  804. req->rq_rcvsize);
  805. /* Encode header and provided arguments */
  806. encode = task->tk_msg.rpc_proc->p_encode;
  807. if (!(p = call_header(task))) {
  808. printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
  809. rpc_exit(task, -EIO);
  810. return;
  811. }
  812. if (encode == NULL)
  813. return;
  814. task->tk_status = rpcauth_wrap_req(task, encode, req, p,
  815. task->tk_msg.rpc_argp);
  816. if (task->tk_status == -ENOMEM) {
  817. /* XXX: Is this sane? */
  818. rpc_delay(task, 3*HZ);
  819. task->tk_status = -EAGAIN;
  820. }
  821. }
  822. /*
  823. * 4. Get the server port number if not yet set
  824. */
  825. static void
  826. call_bind(struct rpc_task *task)
  827. {
  828. struct rpc_xprt *xprt = task->tk_xprt;
  829. dprint_status(task);
  830. task->tk_action = call_connect;
  831. if (!xprt_bound(xprt)) {
  832. task->tk_action = call_bind_status;
  833. task->tk_timeout = xprt->bind_timeout;
  834. xprt->ops->rpcbind(task);
  835. }
  836. }
  837. /*
  838. * 4a. Sort out bind result
  839. */
  840. static void
  841. call_bind_status(struct rpc_task *task)
  842. {
  843. int status = -EIO;
  844. if (task->tk_status >= 0) {
  845. dprint_status(task);
  846. task->tk_status = 0;
  847. task->tk_action = call_connect;
  848. return;
  849. }
  850. switch (task->tk_status) {
  851. case -EAGAIN:
  852. dprintk("RPC: %5u rpcbind waiting for another request "
  853. "to finish\n", task->tk_pid);
  854. /* avoid busy-waiting here -- could be a network outage. */
  855. rpc_delay(task, 5*HZ);
  856. goto retry_timeout;
  857. case -EACCES:
  858. dprintk("RPC: %5u remote rpcbind: RPC program/version "
  859. "unavailable\n", task->tk_pid);
  860. /* fail immediately if this is an RPC ping */
  861. if (task->tk_msg.rpc_proc->p_proc == 0) {
  862. status = -EOPNOTSUPP;
  863. break;
  864. }
  865. rpc_delay(task, 3*HZ);
  866. goto retry_timeout;
  867. case -ETIMEDOUT:
  868. dprintk("RPC: %5u rpcbind request timed out\n",
  869. task->tk_pid);
  870. goto retry_timeout;
  871. case -EPFNOSUPPORT:
  872. /* server doesn't support any rpcbind version we know of */
  873. dprintk("RPC: %5u remote rpcbind service unavailable\n",
  874. task->tk_pid);
  875. break;
  876. case -EPROTONOSUPPORT:
  877. dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
  878. task->tk_pid);
  879. task->tk_status = 0;
  880. task->tk_action = call_bind;
  881. return;
  882. default:
  883. dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
  884. task->tk_pid, -task->tk_status);
  885. }
  886. rpc_exit(task, status);
  887. return;
  888. retry_timeout:
  889. task->tk_action = call_timeout;
  890. }
  891. /*
  892. * 4b. Connect to the RPC server
  893. */
  894. static void
  895. call_connect(struct rpc_task *task)
  896. {
  897. struct rpc_xprt *xprt = task->tk_xprt;
  898. dprintk("RPC: %5u call_connect xprt %p %s connected\n",
  899. task->tk_pid, xprt,
  900. (xprt_connected(xprt) ? "is" : "is not"));
  901. task->tk_action = call_transmit;
  902. if (!xprt_connected(xprt)) {
  903. task->tk_action = call_connect_status;
  904. if (task->tk_status < 0)
  905. return;
  906. xprt_connect(task);
  907. }
  908. }
  909. /*
  910. * 4c. Sort out connect result
  911. */
  912. static void
  913. call_connect_status(struct rpc_task *task)
  914. {
  915. struct rpc_clnt *clnt = task->tk_client;
  916. int status = task->tk_status;
  917. dprint_status(task);
  918. task->tk_status = 0;
  919. if (status >= 0) {
  920. clnt->cl_stats->netreconn++;
  921. task->tk_action = call_transmit;
  922. return;
  923. }
  924. /* Something failed: remote service port may have changed */
  925. rpc_force_rebind(clnt);
  926. switch (status) {
  927. case -ENOTCONN:
  928. case -EAGAIN:
  929. task->tk_action = call_bind;
  930. if (!RPC_IS_SOFT(task))
  931. return;
  932. /* if soft mounted, test if we've timed out */
  933. case -ETIMEDOUT:
  934. task->tk_action = call_timeout;
  935. return;
  936. }
  937. rpc_exit(task, -EIO);
  938. }
  939. /*
  940. * 5. Transmit the RPC request, and wait for reply
  941. */
  942. static void
  943. call_transmit(struct rpc_task *task)
  944. {
  945. dprint_status(task);
  946. task->tk_action = call_status;
  947. if (task->tk_status < 0)
  948. return;
  949. task->tk_status = xprt_prepare_transmit(task);
  950. if (task->tk_status != 0)
  951. return;
  952. task->tk_action = call_transmit_status;
  953. /* Encode here so that rpcsec_gss can use correct sequence number. */
  954. if (rpc_task_need_encode(task)) {
  955. BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
  956. call_encode(task);
  957. /* Did the encode result in an error condition? */
  958. if (task->tk_status != 0)
  959. return;
  960. }
  961. xprt_transmit(task);
  962. if (task->tk_status < 0)
  963. return;
  964. /*
  965. * On success, ensure that we call xprt_end_transmit() before sleeping
  966. * in order to allow access to the socket to other RPC requests.
  967. */
  968. call_transmit_status(task);
  969. if (task->tk_msg.rpc_proc->p_decode != NULL)
  970. return;
  971. task->tk_action = rpc_exit_task;
  972. rpc_wake_up_task(task);
  973. }
  974. /*
  975. * 5a. Handle cleanup after a transmission
  976. */
  977. static void
  978. call_transmit_status(struct rpc_task *task)
  979. {
  980. task->tk_action = call_status;
  981. /*
  982. * Special case: if we've been waiting on the socket's write_space()
  983. * callback, then don't call xprt_end_transmit().
  984. */
  985. if (task->tk_status == -EAGAIN)
  986. return;
  987. xprt_end_transmit(task);
  988. rpc_task_force_reencode(task);
  989. }
  990. /*
  991. * 6. Sort out the RPC call status
  992. */
  993. static void
  994. call_status(struct rpc_task *task)
  995. {
  996. struct rpc_clnt *clnt = task->tk_client;
  997. struct rpc_rqst *req = task->tk_rqstp;
  998. int status;
  999. if (req->rq_received > 0 && !req->rq_bytes_sent)
  1000. task->tk_status = req->rq_received;
  1001. dprint_status(task);
  1002. status = task->tk_status;
  1003. if (status >= 0) {
  1004. task->tk_action = call_decode;
  1005. return;
  1006. }
  1007. task->tk_status = 0;
  1008. switch(status) {
  1009. case -EHOSTDOWN:
  1010. case -EHOSTUNREACH:
  1011. case -ENETUNREACH:
  1012. /*
  1013. * Delay any retries for 3 seconds, then handle as if it
  1014. * were a timeout.
  1015. */
  1016. rpc_delay(task, 3*HZ);
  1017. case -ETIMEDOUT:
  1018. task->tk_action = call_timeout;
  1019. if (task->tk_client->cl_discrtry)
  1020. xprt_force_disconnect(task->tk_xprt);
  1021. break;
  1022. case -ECONNREFUSED:
  1023. case -ENOTCONN:
  1024. rpc_force_rebind(clnt);
  1025. task->tk_action = call_bind;
  1026. break;
  1027. case -EAGAIN:
  1028. task->tk_action = call_transmit;
  1029. break;
  1030. case -EIO:
  1031. /* shutdown or soft timeout */
  1032. rpc_exit(task, status);
  1033. break;
  1034. default:
  1035. printk("%s: RPC call returned error %d\n",
  1036. clnt->cl_protname, -status);
  1037. rpc_exit(task, status);
  1038. }
  1039. }
  1040. /*
  1041. * 6a. Handle RPC timeout
  1042. * We do not release the request slot, so we keep using the
  1043. * same XID for all retransmits.
  1044. */
  1045. static void
  1046. call_timeout(struct rpc_task *task)
  1047. {
  1048. struct rpc_clnt *clnt = task->tk_client;
  1049. if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
  1050. dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
  1051. goto retry;
  1052. }
  1053. dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
  1054. task->tk_timeouts++;
  1055. if (RPC_IS_SOFT(task)) {
  1056. printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
  1057. clnt->cl_protname, clnt->cl_server);
  1058. rpc_exit(task, -EIO);
  1059. return;
  1060. }
  1061. if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
  1062. task->tk_flags |= RPC_CALL_MAJORSEEN;
  1063. printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
  1064. clnt->cl_protname, clnt->cl_server);
  1065. }
  1066. rpc_force_rebind(clnt);
  1067. retry:
  1068. clnt->cl_stats->rpcretrans++;
  1069. task->tk_action = call_bind;
  1070. task->tk_status = 0;
  1071. }
  1072. /*
  1073. * 7. Decode the RPC reply
  1074. */
  1075. static void
  1076. call_decode(struct rpc_task *task)
  1077. {
  1078. struct rpc_clnt *clnt = task->tk_client;
  1079. struct rpc_rqst *req = task->tk_rqstp;
  1080. kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
  1081. __be32 *p;
  1082. dprintk("RPC: %5u call_decode (status %d)\n",
  1083. task->tk_pid, task->tk_status);
  1084. if (task->tk_flags & RPC_CALL_MAJORSEEN) {
  1085. printk(KERN_NOTICE "%s: server %s OK\n",
  1086. clnt->cl_protname, clnt->cl_server);
  1087. task->tk_flags &= ~RPC_CALL_MAJORSEEN;
  1088. }
  1089. if (task->tk_status < 12) {
  1090. if (!RPC_IS_SOFT(task)) {
  1091. task->tk_action = call_bind;
  1092. clnt->cl_stats->rpcretrans++;
  1093. goto out_retry;
  1094. }
  1095. dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
  1096. clnt->cl_protname, task->tk_status);
  1097. task->tk_action = call_timeout;
  1098. goto out_retry;
  1099. }
  1100. /*
  1101. * Ensure that we see all writes made by xprt_complete_rqst()
  1102. * before it changed req->rq_received.
  1103. */
  1104. smp_rmb();
  1105. req->rq_rcv_buf.len = req->rq_private_buf.len;
  1106. /* Check that the softirq receive buffer is valid */
  1107. WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
  1108. sizeof(req->rq_rcv_buf)) != 0);
  1109. /* Verify the RPC header */
  1110. p = call_verify(task);
  1111. if (IS_ERR(p)) {
  1112. if (p == ERR_PTR(-EAGAIN))
  1113. goto out_retry;
  1114. return;
  1115. }
  1116. task->tk_action = rpc_exit_task;
  1117. if (decode) {
  1118. task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
  1119. task->tk_msg.rpc_resp);
  1120. }
  1121. dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
  1122. task->tk_status);
  1123. return;
  1124. out_retry:
  1125. req->rq_received = req->rq_private_buf.len = 0;
  1126. task->tk_status = 0;
  1127. if (task->tk_client->cl_discrtry)
  1128. xprt_force_disconnect(task->tk_xprt);
  1129. }
  1130. /*
  1131. * 8. Refresh the credentials if rejected by the server
  1132. */
  1133. static void
  1134. call_refresh(struct rpc_task *task)
  1135. {
  1136. dprint_status(task);
  1137. task->tk_action = call_refreshresult;
  1138. task->tk_status = 0;
  1139. task->tk_client->cl_stats->rpcauthrefresh++;
  1140. rpcauth_refreshcred(task);
  1141. }
  1142. /*
  1143. * 8a. Process the results of a credential refresh
  1144. */
  1145. static void
  1146. call_refreshresult(struct rpc_task *task)
  1147. {
  1148. int status = task->tk_status;
  1149. dprint_status(task);
  1150. task->tk_status = 0;
  1151. task->tk_action = call_reserve;
  1152. if (status >= 0 && rpcauth_uptodatecred(task))
  1153. return;
  1154. if (status == -EACCES) {
  1155. rpc_exit(task, -EACCES);
  1156. return;
  1157. }
  1158. task->tk_action = call_refresh;
  1159. if (status != -ETIMEDOUT)
  1160. rpc_delay(task, 3*HZ);
  1161. return;
  1162. }
  1163. /*
  1164. * Call header serialization
  1165. */
  1166. static __be32 *
  1167. call_header(struct rpc_task *task)
  1168. {
  1169. struct rpc_clnt *clnt = task->tk_client;
  1170. struct rpc_rqst *req = task->tk_rqstp;
  1171. __be32 *p = req->rq_svec[0].iov_base;
  1172. /* FIXME: check buffer size? */
  1173. p = xprt_skip_transport_header(task->tk_xprt, p);
  1174. *p++ = req->rq_xid; /* XID */
  1175. *p++ = htonl(RPC_CALL); /* CALL */
  1176. *p++ = htonl(RPC_VERSION); /* RPC version */
  1177. *p++ = htonl(clnt->cl_prog); /* program number */
  1178. *p++ = htonl(clnt->cl_vers); /* program version */
  1179. *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
  1180. p = rpcauth_marshcred(task, p);
  1181. req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
  1182. return p;
  1183. }
  1184. /*
  1185. * Reply header verification
  1186. */
  1187. static __be32 *
  1188. call_verify(struct rpc_task *task)
  1189. {
  1190. struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
  1191. int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
  1192. __be32 *p = iov->iov_base;
  1193. u32 n;
  1194. int error = -EACCES;
  1195. if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
  1196. /* RFC-1014 says that the representation of XDR data must be a
  1197. * multiple of four bytes
  1198. * - if it isn't pointer subtraction in the NFS client may give
  1199. * undefined results
  1200. */
  1201. dprintk("RPC: %5u %s: XDR representation not a multiple of"
  1202. " 4 bytes: 0x%x\n", task->tk_pid, __FUNCTION__,
  1203. task->tk_rqstp->rq_rcv_buf.len);
  1204. goto out_eio;
  1205. }
  1206. if ((len -= 3) < 0)
  1207. goto out_overflow;
  1208. p += 1; /* skip XID */
  1209. if ((n = ntohl(*p++)) != RPC_REPLY) {
  1210. dprintk("RPC: %5u %s: not an RPC reply: %x\n",
  1211. task->tk_pid, __FUNCTION__, n);
  1212. goto out_garbage;
  1213. }
  1214. if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
  1215. if (--len < 0)
  1216. goto out_overflow;
  1217. switch ((n = ntohl(*p++))) {
  1218. case RPC_AUTH_ERROR:
  1219. break;
  1220. case RPC_MISMATCH:
  1221. dprintk("RPC: %5u %s: RPC call version "
  1222. "mismatch!\n",
  1223. task->tk_pid, __FUNCTION__);
  1224. error = -EPROTONOSUPPORT;
  1225. goto out_err;
  1226. default:
  1227. dprintk("RPC: %5u %s: RPC call rejected, "
  1228. "unknown error: %x\n",
  1229. task->tk_pid, __FUNCTION__, n);
  1230. goto out_eio;
  1231. }
  1232. if (--len < 0)
  1233. goto out_overflow;
  1234. switch ((n = ntohl(*p++))) {
  1235. case RPC_AUTH_REJECTEDCRED:
  1236. case RPC_AUTH_REJECTEDVERF:
  1237. case RPCSEC_GSS_CREDPROBLEM:
  1238. case RPCSEC_GSS_CTXPROBLEM:
  1239. if (!task->tk_cred_retry)
  1240. break;
  1241. task->tk_cred_retry--;
  1242. dprintk("RPC: %5u %s: retry stale creds\n",
  1243. task->tk_pid, __FUNCTION__);
  1244. rpcauth_invalcred(task);
  1245. /* Ensure we obtain a new XID! */
  1246. xprt_release(task);
  1247. task->tk_action = call_refresh;
  1248. goto out_retry;
  1249. case RPC_AUTH_BADCRED:
  1250. case RPC_AUTH_BADVERF:
  1251. /* possibly garbled cred/verf? */
  1252. if (!task->tk_garb_retry)
  1253. break;
  1254. task->tk_garb_retry--;
  1255. dprintk("RPC: %5u %s: retry garbled creds\n",
  1256. task->tk_pid, __FUNCTION__);
  1257. task->tk_action = call_bind;
  1258. goto out_retry;
  1259. case RPC_AUTH_TOOWEAK:
  1260. printk(KERN_NOTICE "call_verify: server %s requires stronger "
  1261. "authentication.\n", task->tk_client->cl_server);
  1262. break;
  1263. default:
  1264. dprintk("RPC: %5u %s: unknown auth error: %x\n",
  1265. task->tk_pid, __FUNCTION__, n);
  1266. error = -EIO;
  1267. }
  1268. dprintk("RPC: %5u %s: call rejected %d\n",
  1269. task->tk_pid, __FUNCTION__, n);
  1270. goto out_err;
  1271. }
  1272. if (!(p = rpcauth_checkverf(task, p))) {
  1273. dprintk("RPC: %5u %s: auth check failed\n",
  1274. task->tk_pid, __FUNCTION__);
  1275. goto out_garbage; /* bad verifier, retry */
  1276. }
  1277. len = p - (__be32 *)iov->iov_base - 1;
  1278. if (len < 0)
  1279. goto out_overflow;
  1280. switch ((n = ntohl(*p++))) {
  1281. case RPC_SUCCESS:
  1282. return p;
  1283. case RPC_PROG_UNAVAIL:
  1284. dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
  1285. task->tk_pid, __FUNCTION__,
  1286. (unsigned int)task->tk_client->cl_prog,
  1287. task->tk_client->cl_server);
  1288. error = -EPFNOSUPPORT;
  1289. goto out_err;
  1290. case RPC_PROG_MISMATCH:
  1291. dprintk("RPC: %5u %s: program %u, version %u unsupported by "
  1292. "server %s\n", task->tk_pid, __FUNCTION__,
  1293. (unsigned int)task->tk_client->cl_prog,
  1294. (unsigned int)task->tk_client->cl_vers,
  1295. task->tk_client->cl_server);
  1296. error = -EPROTONOSUPPORT;
  1297. goto out_err;
  1298. case RPC_PROC_UNAVAIL:
  1299. dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
  1300. "version %u on server %s\n",
  1301. task->tk_pid, __FUNCTION__,
  1302. task->tk_msg.rpc_proc,
  1303. task->tk_client->cl_prog,
  1304. task->tk_client->cl_vers,
  1305. task->tk_client->cl_server);
  1306. error = -EOPNOTSUPP;
  1307. goto out_err;
  1308. case RPC_GARBAGE_ARGS:
  1309. dprintk("RPC: %5u %s: server saw garbage\n",
  1310. task->tk_pid, __FUNCTION__);
  1311. break; /* retry */
  1312. default:
  1313. dprintk("RPC: %5u %s: server accept status: %x\n",
  1314. task->tk_pid, __FUNCTION__, n);
  1315. /* Also retry */
  1316. }
  1317. out_garbage:
  1318. task->tk_client->cl_stats->rpcgarbage++;
  1319. if (task->tk_garb_retry) {
  1320. task->tk_garb_retry--;
  1321. dprintk("RPC: %5u %s: retrying\n",
  1322. task->tk_pid, __FUNCTION__);
  1323. task->tk_action = call_bind;
  1324. out_retry:
  1325. return ERR_PTR(-EAGAIN);
  1326. }
  1327. out_eio:
  1328. error = -EIO;
  1329. out_err:
  1330. rpc_exit(task, error);
  1331. dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
  1332. __FUNCTION__, error);
  1333. return ERR_PTR(error);
  1334. out_overflow:
  1335. dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
  1336. __FUNCTION__);
  1337. goto out_garbage;
  1338. }
  1339. static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
  1340. {
  1341. return 0;
  1342. }
  1343. static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
  1344. {
  1345. return 0;
  1346. }
  1347. static struct rpc_procinfo rpcproc_null = {
  1348. .p_encode = rpcproc_encode_null,
  1349. .p_decode = rpcproc_decode_null,
  1350. };
  1351. static int rpc_ping(struct rpc_clnt *clnt, int flags)
  1352. {
  1353. struct rpc_message msg = {
  1354. .rpc_proc = &rpcproc_null,
  1355. };
  1356. int err;
  1357. msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
  1358. err = rpc_call_sync(clnt, &msg, flags);
  1359. put_rpccred(msg.rpc_cred);
  1360. return err;
  1361. }
  1362. struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
  1363. {
  1364. struct rpc_message msg = {
  1365. .rpc_proc = &rpcproc_null,
  1366. .rpc_cred = cred,
  1367. };
  1368. struct rpc_task_setup task_setup_data = {
  1369. .rpc_client = clnt,
  1370. .rpc_message = &msg,
  1371. .callback_ops = &rpc_default_ops,
  1372. .flags = flags,
  1373. };
  1374. return rpc_run_task(&task_setup_data);
  1375. }
  1376. EXPORT_SYMBOL_GPL(rpc_call_null);
  1377. #ifdef RPC_DEBUG
  1378. void rpc_show_tasks(void)
  1379. {
  1380. struct rpc_clnt *clnt;
  1381. struct rpc_task *t;
  1382. spin_lock(&rpc_client_lock);
  1383. if (list_empty(&all_clients))
  1384. goto out;
  1385. printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
  1386. "-rpcwait -action- ---ops--\n");
  1387. list_for_each_entry(clnt, &all_clients, cl_clients) {
  1388. if (list_empty(&clnt->cl_tasks))
  1389. continue;
  1390. spin_lock(&clnt->cl_lock);
  1391. list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
  1392. const char *rpc_waitq = "none";
  1393. int proc;
  1394. if (t->tk_msg.rpc_proc)
  1395. proc = t->tk_msg.rpc_proc->p_proc;
  1396. else
  1397. proc = -1;
  1398. if (RPC_IS_QUEUED(t))
  1399. rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
  1400. printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
  1401. t->tk_pid, proc,
  1402. t->tk_flags, t->tk_status,
  1403. t->tk_client,
  1404. (t->tk_client ? t->tk_client->cl_prog : 0),
  1405. t->tk_rqstp, t->tk_timeout,
  1406. rpc_waitq,
  1407. t->tk_action, t->tk_ops);
  1408. }
  1409. spin_unlock(&clnt->cl_lock);
  1410. }
  1411. out:
  1412. spin_unlock(&rpc_client_lock);
  1413. }
  1414. #endif