clnt.c 38 KB

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