clnt.c 38 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609
  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/kallsyms.h>
  27. #include <linux/mm.h>
  28. #include <linux/slab.h>
  29. #include <linux/smp_lock.h>
  30. #include <linux/utsname.h>
  31. #include <linux/workqueue.h>
  32. #include <linux/in6.h>
  33. #include <linux/sunrpc/clnt.h>
  34. #include <linux/sunrpc/rpc_pipe_fs.h>
  35. #include <linux/sunrpc/metrics.h>
  36. #ifdef RPC_DEBUG
  37. # define RPCDBG_FACILITY RPCDBG_CALL
  38. #endif
  39. #define dprint_status(t) \
  40. dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
  41. __func__, t->tk_status)
  42. /*
  43. * All RPC clients are linked into this list
  44. */
  45. static LIST_HEAD(all_clients);
  46. static DEFINE_SPINLOCK(rpc_client_lock);
  47. static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
  48. static void call_start(struct rpc_task *task);
  49. static void call_reserve(struct rpc_task *task);
  50. static void call_reserveresult(struct rpc_task *task);
  51. static void call_allocate(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 *rpc_encode_header(struct rpc_task *task);
  64. static __be32 *rpc_verify_header(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 = args->prognumber ? : 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. clnt->cl_principal = NULL;
  173. if (args->client_name) {
  174. clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
  175. if (!clnt->cl_principal)
  176. goto out_no_principal;
  177. }
  178. kref_init(&clnt->cl_kref);
  179. err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
  180. if (err < 0)
  181. goto out_no_path;
  182. auth = rpcauth_create(args->authflavor, clnt);
  183. if (IS_ERR(auth)) {
  184. printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
  185. args->authflavor);
  186. err = PTR_ERR(auth);
  187. goto out_no_auth;
  188. }
  189. /* save the nodename */
  190. clnt->cl_nodelen = strlen(init_utsname()->nodename);
  191. if (clnt->cl_nodelen > UNX_MAXNODENAME)
  192. clnt->cl_nodelen = UNX_MAXNODENAME;
  193. memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
  194. rpc_register_client(clnt);
  195. return clnt;
  196. out_no_auth:
  197. if (!IS_ERR(clnt->cl_dentry)) {
  198. rpc_rmdir(clnt->cl_dentry);
  199. rpc_put_mount();
  200. }
  201. out_no_path:
  202. kfree(clnt->cl_principal);
  203. out_no_principal:
  204. rpc_free_iostats(clnt->cl_metrics);
  205. out_no_stats:
  206. if (clnt->cl_server != clnt->cl_inline_name)
  207. kfree(clnt->cl_server);
  208. kfree(clnt);
  209. out_err:
  210. xprt_put(xprt);
  211. out_no_xprt:
  212. rpciod_down();
  213. out_no_rpciod:
  214. return ERR_PTR(err);
  215. }
  216. /*
  217. * rpc_create - create an RPC client and transport with one call
  218. * @args: rpc_clnt create argument structure
  219. *
  220. * Creates and initializes an RPC transport and an RPC client.
  221. *
  222. * It can ping the server in order to determine if it is up, and to see if
  223. * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
  224. * this behavior so asynchronous tasks can also use rpc_create.
  225. */
  226. struct rpc_clnt *rpc_create(struct rpc_create_args *args)
  227. {
  228. struct rpc_xprt *xprt;
  229. struct rpc_clnt *clnt;
  230. struct xprt_create xprtargs = {
  231. .ident = args->protocol,
  232. .srcaddr = args->saddress,
  233. .dstaddr = args->address,
  234. .addrlen = args->addrsize,
  235. };
  236. char servername[48];
  237. /*
  238. * If the caller chooses not to specify a hostname, whip
  239. * up a string representation of the passed-in address.
  240. */
  241. if (args->servername == NULL) {
  242. servername[0] = '\0';
  243. switch (args->address->sa_family) {
  244. case AF_INET: {
  245. struct sockaddr_in *sin =
  246. (struct sockaddr_in *)args->address;
  247. snprintf(servername, sizeof(servername), "%pI4",
  248. &sin->sin_addr.s_addr);
  249. break;
  250. }
  251. case AF_INET6: {
  252. struct sockaddr_in6 *sin =
  253. (struct sockaddr_in6 *)args->address;
  254. snprintf(servername, sizeof(servername), "%pI6",
  255. &sin->sin6_addr);
  256. break;
  257. }
  258. default:
  259. /* caller wants default server name, but
  260. * address family isn't recognized. */
  261. return ERR_PTR(-EINVAL);
  262. }
  263. args->servername = servername;
  264. }
  265. xprt = xprt_create_transport(&xprtargs);
  266. if (IS_ERR(xprt))
  267. return (struct rpc_clnt *)xprt;
  268. /*
  269. * By default, kernel RPC client connects from a reserved port.
  270. * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
  271. * but it is always enabled for rpciod, which handles the connect
  272. * operation.
  273. */
  274. xprt->resvport = 1;
  275. if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
  276. xprt->resvport = 0;
  277. clnt = rpc_new_client(args, xprt);
  278. if (IS_ERR(clnt))
  279. return clnt;
  280. if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
  281. int err = rpc_ping(clnt, RPC_TASK_SOFT);
  282. if (err != 0) {
  283. rpc_shutdown_client(clnt);
  284. return ERR_PTR(err);
  285. }
  286. }
  287. clnt->cl_softrtry = 1;
  288. if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
  289. clnt->cl_softrtry = 0;
  290. if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
  291. clnt->cl_autobind = 1;
  292. if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
  293. clnt->cl_discrtry = 1;
  294. if (!(args->flags & RPC_CLNT_CREATE_QUIET))
  295. clnt->cl_chatty = 1;
  296. return clnt;
  297. }
  298. EXPORT_SYMBOL_GPL(rpc_create);
  299. /*
  300. * This function clones the RPC client structure. It allows us to share the
  301. * same transport while varying parameters such as the authentication
  302. * flavour.
  303. */
  304. struct rpc_clnt *
  305. rpc_clone_client(struct rpc_clnt *clnt)
  306. {
  307. struct rpc_clnt *new;
  308. int err = -ENOMEM;
  309. new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
  310. if (!new)
  311. goto out_no_clnt;
  312. new->cl_parent = clnt;
  313. /* Turn off autobind on clones */
  314. new->cl_autobind = 0;
  315. INIT_LIST_HEAD(&new->cl_tasks);
  316. spin_lock_init(&new->cl_lock);
  317. rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
  318. new->cl_metrics = rpc_alloc_iostats(clnt);
  319. if (new->cl_metrics == NULL)
  320. goto out_no_stats;
  321. if (clnt->cl_principal) {
  322. new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
  323. if (new->cl_principal == NULL)
  324. goto out_no_principal;
  325. }
  326. kref_init(&new->cl_kref);
  327. err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
  328. if (err != 0)
  329. goto out_no_path;
  330. if (new->cl_auth)
  331. atomic_inc(&new->cl_auth->au_count);
  332. xprt_get(clnt->cl_xprt);
  333. kref_get(&clnt->cl_kref);
  334. rpc_register_client(new);
  335. rpciod_up();
  336. return new;
  337. out_no_path:
  338. kfree(new->cl_principal);
  339. out_no_principal:
  340. rpc_free_iostats(new->cl_metrics);
  341. out_no_stats:
  342. kfree(new);
  343. out_no_clnt:
  344. dprintk("RPC: %s: returned error %d\n", __func__, err);
  345. return ERR_PTR(err);
  346. }
  347. EXPORT_SYMBOL_GPL(rpc_clone_client);
  348. /*
  349. * Properly shut down an RPC client, terminating all outstanding
  350. * requests.
  351. */
  352. void rpc_shutdown_client(struct rpc_clnt *clnt)
  353. {
  354. dprintk("RPC: shutting down %s client for %s\n",
  355. clnt->cl_protname, clnt->cl_server);
  356. while (!list_empty(&clnt->cl_tasks)) {
  357. rpc_killall_tasks(clnt);
  358. wait_event_timeout(destroy_wait,
  359. list_empty(&clnt->cl_tasks), 1*HZ);
  360. }
  361. rpc_release_client(clnt);
  362. }
  363. EXPORT_SYMBOL_GPL(rpc_shutdown_client);
  364. /*
  365. * Free an RPC client
  366. */
  367. static void
  368. rpc_free_client(struct kref *kref)
  369. {
  370. struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
  371. dprintk("RPC: destroying %s client for %s\n",
  372. clnt->cl_protname, clnt->cl_server);
  373. if (!IS_ERR(clnt->cl_dentry)) {
  374. rpc_rmdir(clnt->cl_dentry);
  375. rpc_put_mount();
  376. }
  377. if (clnt->cl_parent != clnt) {
  378. rpc_release_client(clnt->cl_parent);
  379. goto out_free;
  380. }
  381. if (clnt->cl_server != clnt->cl_inline_name)
  382. kfree(clnt->cl_server);
  383. out_free:
  384. rpc_unregister_client(clnt);
  385. rpc_free_iostats(clnt->cl_metrics);
  386. kfree(clnt->cl_principal);
  387. clnt->cl_metrics = NULL;
  388. xprt_put(clnt->cl_xprt);
  389. rpciod_down();
  390. kfree(clnt);
  391. }
  392. /*
  393. * Free an RPC client
  394. */
  395. static void
  396. rpc_free_auth(struct kref *kref)
  397. {
  398. struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
  399. if (clnt->cl_auth == NULL) {
  400. rpc_free_client(kref);
  401. return;
  402. }
  403. /*
  404. * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
  405. * release remaining GSS contexts. This mechanism ensures
  406. * that it can do so safely.
  407. */
  408. kref_init(kref);
  409. rpcauth_release(clnt->cl_auth);
  410. clnt->cl_auth = NULL;
  411. kref_put(kref, rpc_free_client);
  412. }
  413. /*
  414. * Release reference to the RPC client
  415. */
  416. void
  417. rpc_release_client(struct rpc_clnt *clnt)
  418. {
  419. dprintk("RPC: rpc_release_client(%p)\n", clnt);
  420. if (list_empty(&clnt->cl_tasks))
  421. wake_up(&destroy_wait);
  422. kref_put(&clnt->cl_kref, rpc_free_auth);
  423. }
  424. /**
  425. * rpc_bind_new_program - bind a new RPC program to an existing client
  426. * @old: old rpc_client
  427. * @program: rpc program to set
  428. * @vers: rpc program version
  429. *
  430. * Clones the rpc client and sets up a new RPC program. This is mainly
  431. * of use for enabling different RPC programs to share the same transport.
  432. * The Sun NFSv2/v3 ACL protocol can do this.
  433. */
  434. struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
  435. struct rpc_program *program,
  436. u32 vers)
  437. {
  438. struct rpc_clnt *clnt;
  439. struct rpc_version *version;
  440. int err;
  441. BUG_ON(vers >= program->nrvers || !program->version[vers]);
  442. version = program->version[vers];
  443. clnt = rpc_clone_client(old);
  444. if (IS_ERR(clnt))
  445. goto out;
  446. clnt->cl_procinfo = version->procs;
  447. clnt->cl_maxproc = version->nrprocs;
  448. clnt->cl_protname = program->name;
  449. clnt->cl_prog = program->number;
  450. clnt->cl_vers = version->number;
  451. clnt->cl_stats = program->stats;
  452. err = rpc_ping(clnt, RPC_TASK_SOFT);
  453. if (err != 0) {
  454. rpc_shutdown_client(clnt);
  455. clnt = ERR_PTR(err);
  456. }
  457. out:
  458. return clnt;
  459. }
  460. EXPORT_SYMBOL_GPL(rpc_bind_new_program);
  461. /*
  462. * Default callback for async RPC calls
  463. */
  464. static void
  465. rpc_default_callback(struct rpc_task *task, void *data)
  466. {
  467. }
  468. static const struct rpc_call_ops rpc_default_ops = {
  469. .rpc_call_done = rpc_default_callback,
  470. };
  471. /**
  472. * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
  473. * @task_setup_data: pointer to task initialisation data
  474. */
  475. struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
  476. {
  477. struct rpc_task *task, *ret;
  478. task = rpc_new_task(task_setup_data);
  479. if (task == NULL) {
  480. rpc_release_calldata(task_setup_data->callback_ops,
  481. task_setup_data->callback_data);
  482. ret = ERR_PTR(-ENOMEM);
  483. goto out;
  484. }
  485. if (task->tk_status != 0) {
  486. ret = ERR_PTR(task->tk_status);
  487. rpc_put_task(task);
  488. goto out;
  489. }
  490. atomic_inc(&task->tk_count);
  491. rpc_execute(task);
  492. ret = task;
  493. out:
  494. return ret;
  495. }
  496. EXPORT_SYMBOL_GPL(rpc_run_task);
  497. /**
  498. * rpc_call_sync - Perform a synchronous RPC call
  499. * @clnt: pointer to RPC client
  500. * @msg: RPC call parameters
  501. * @flags: RPC call flags
  502. */
  503. int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
  504. {
  505. struct rpc_task *task;
  506. struct rpc_task_setup task_setup_data = {
  507. .rpc_client = clnt,
  508. .rpc_message = msg,
  509. .callback_ops = &rpc_default_ops,
  510. .flags = flags,
  511. };
  512. int status;
  513. BUG_ON(flags & RPC_TASK_ASYNC);
  514. task = rpc_run_task(&task_setup_data);
  515. if (IS_ERR(task))
  516. return PTR_ERR(task);
  517. status = task->tk_status;
  518. rpc_put_task(task);
  519. return status;
  520. }
  521. EXPORT_SYMBOL_GPL(rpc_call_sync);
  522. /**
  523. * rpc_call_async - Perform an asynchronous RPC call
  524. * @clnt: pointer to RPC client
  525. * @msg: RPC call parameters
  526. * @flags: RPC call flags
  527. * @tk_ops: RPC call ops
  528. * @data: user call data
  529. */
  530. int
  531. rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
  532. const struct rpc_call_ops *tk_ops, void *data)
  533. {
  534. struct rpc_task *task;
  535. struct rpc_task_setup task_setup_data = {
  536. .rpc_client = clnt,
  537. .rpc_message = msg,
  538. .callback_ops = tk_ops,
  539. .callback_data = data,
  540. .flags = flags|RPC_TASK_ASYNC,
  541. };
  542. task = rpc_run_task(&task_setup_data);
  543. if (IS_ERR(task))
  544. return PTR_ERR(task);
  545. rpc_put_task(task);
  546. return 0;
  547. }
  548. EXPORT_SYMBOL_GPL(rpc_call_async);
  549. void
  550. rpc_call_start(struct rpc_task *task)
  551. {
  552. task->tk_action = call_start;
  553. }
  554. EXPORT_SYMBOL_GPL(rpc_call_start);
  555. /**
  556. * rpc_peeraddr - extract remote peer address from clnt's xprt
  557. * @clnt: RPC client structure
  558. * @buf: target buffer
  559. * @bufsize: length of target buffer
  560. *
  561. * Returns the number of bytes that are actually in the stored address.
  562. */
  563. size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
  564. {
  565. size_t bytes;
  566. struct rpc_xprt *xprt = clnt->cl_xprt;
  567. bytes = sizeof(xprt->addr);
  568. if (bytes > bufsize)
  569. bytes = bufsize;
  570. memcpy(buf, &clnt->cl_xprt->addr, bytes);
  571. return xprt->addrlen;
  572. }
  573. EXPORT_SYMBOL_GPL(rpc_peeraddr);
  574. /**
  575. * rpc_peeraddr2str - return remote peer address in printable format
  576. * @clnt: RPC client structure
  577. * @format: address format
  578. *
  579. */
  580. const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
  581. enum rpc_display_format_t format)
  582. {
  583. struct rpc_xprt *xprt = clnt->cl_xprt;
  584. if (xprt->address_strings[format] != NULL)
  585. return xprt->address_strings[format];
  586. else
  587. return "unprintable";
  588. }
  589. EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
  590. void
  591. rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
  592. {
  593. struct rpc_xprt *xprt = clnt->cl_xprt;
  594. if (xprt->ops->set_buffer_size)
  595. xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
  596. }
  597. EXPORT_SYMBOL_GPL(rpc_setbufsize);
  598. /*
  599. * Return size of largest payload RPC client can support, in bytes
  600. *
  601. * For stream transports, this is one RPC record fragment (see RFC
  602. * 1831), as we don't support multi-record requests yet. For datagram
  603. * transports, this is the size of an IP packet minus the IP, UDP, and
  604. * RPC header sizes.
  605. */
  606. size_t rpc_max_payload(struct rpc_clnt *clnt)
  607. {
  608. return clnt->cl_xprt->max_payload;
  609. }
  610. EXPORT_SYMBOL_GPL(rpc_max_payload);
  611. /**
  612. * rpc_force_rebind - force transport to check that remote port is unchanged
  613. * @clnt: client to rebind
  614. *
  615. */
  616. void rpc_force_rebind(struct rpc_clnt *clnt)
  617. {
  618. if (clnt->cl_autobind)
  619. xprt_clear_bound(clnt->cl_xprt);
  620. }
  621. EXPORT_SYMBOL_GPL(rpc_force_rebind);
  622. /*
  623. * Restart an (async) RPC call. Usually called from within the
  624. * exit handler.
  625. */
  626. void
  627. rpc_restart_call(struct rpc_task *task)
  628. {
  629. if (RPC_ASSASSINATED(task))
  630. return;
  631. task->tk_action = call_start;
  632. }
  633. EXPORT_SYMBOL_GPL(rpc_restart_call);
  634. #ifdef RPC_DEBUG
  635. static const char *rpc_proc_name(const struct rpc_task *task)
  636. {
  637. const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
  638. if (proc) {
  639. if (proc->p_name)
  640. return proc->p_name;
  641. else
  642. return "NULL";
  643. } else
  644. return "no proc";
  645. }
  646. #endif
  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 %s (%s)\n", task->tk_pid,
  658. clnt->cl_protname, clnt->cl_vers,
  659. rpc_proc_name(task),
  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. __func__, 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. __func__, 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. __func__, 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. rpc_xdr_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. p = rpc_encode_header(task);
  806. if (p == NULL) {
  807. printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
  808. rpc_exit(task, -EIO);
  809. return;
  810. }
  811. encode = task->tk_msg.rpc_proc->p_encode;
  812. if (encode == NULL)
  813. return;
  814. task->tk_status = rpcauth_wrap_req(task, encode, req, p,
  815. task->tk_msg.rpc_argp);
  816. }
  817. /*
  818. * 4. Get the server port number if not yet set
  819. */
  820. static void
  821. call_bind(struct rpc_task *task)
  822. {
  823. struct rpc_xprt *xprt = task->tk_xprt;
  824. dprint_status(task);
  825. task->tk_action = call_connect;
  826. if (!xprt_bound(xprt)) {
  827. task->tk_action = call_bind_status;
  828. task->tk_timeout = xprt->bind_timeout;
  829. xprt->ops->rpcbind(task);
  830. }
  831. }
  832. /*
  833. * 4a. Sort out bind result
  834. */
  835. static void
  836. call_bind_status(struct rpc_task *task)
  837. {
  838. int status = -EIO;
  839. if (task->tk_status >= 0) {
  840. dprint_status(task);
  841. task->tk_status = 0;
  842. task->tk_action = call_connect;
  843. return;
  844. }
  845. switch (task->tk_status) {
  846. case -ENOMEM:
  847. dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
  848. rpc_delay(task, HZ >> 2);
  849. goto retry_timeout;
  850. case -EACCES:
  851. dprintk("RPC: %5u remote rpcbind: RPC program/version "
  852. "unavailable\n", task->tk_pid);
  853. /* fail immediately if this is an RPC ping */
  854. if (task->tk_msg.rpc_proc->p_proc == 0) {
  855. status = -EOPNOTSUPP;
  856. break;
  857. }
  858. rpc_delay(task, 3*HZ);
  859. goto retry_timeout;
  860. case -ETIMEDOUT:
  861. dprintk("RPC: %5u rpcbind request timed out\n",
  862. task->tk_pid);
  863. goto retry_timeout;
  864. case -EPFNOSUPPORT:
  865. /* server doesn't support any rpcbind version we know of */
  866. dprintk("RPC: %5u remote rpcbind service unavailable\n",
  867. task->tk_pid);
  868. break;
  869. case -EPROTONOSUPPORT:
  870. dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
  871. task->tk_pid);
  872. task->tk_status = 0;
  873. task->tk_action = call_bind;
  874. return;
  875. default:
  876. dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
  877. task->tk_pid, -task->tk_status);
  878. }
  879. rpc_exit(task, status);
  880. return;
  881. retry_timeout:
  882. task->tk_action = call_timeout;
  883. }
  884. /*
  885. * 4b. Connect to the RPC server
  886. */
  887. static void
  888. call_connect(struct rpc_task *task)
  889. {
  890. struct rpc_xprt *xprt = task->tk_xprt;
  891. dprintk("RPC: %5u call_connect xprt %p %s connected\n",
  892. task->tk_pid, xprt,
  893. (xprt_connected(xprt) ? "is" : "is not"));
  894. task->tk_action = call_transmit;
  895. if (!xprt_connected(xprt)) {
  896. task->tk_action = call_connect_status;
  897. if (task->tk_status < 0)
  898. return;
  899. xprt_connect(task);
  900. }
  901. }
  902. /*
  903. * 4c. Sort out connect result
  904. */
  905. static void
  906. call_connect_status(struct rpc_task *task)
  907. {
  908. struct rpc_clnt *clnt = task->tk_client;
  909. int status = task->tk_status;
  910. dprint_status(task);
  911. task->tk_status = 0;
  912. if (status >= 0) {
  913. clnt->cl_stats->netreconn++;
  914. task->tk_action = call_transmit;
  915. return;
  916. }
  917. /* Something failed: remote service port may have changed */
  918. rpc_force_rebind(clnt);
  919. switch (status) {
  920. case -ENOTCONN:
  921. case -EAGAIN:
  922. task->tk_action = call_bind;
  923. if (!RPC_IS_SOFT(task))
  924. return;
  925. /* if soft mounted, test if we've timed out */
  926. case -ETIMEDOUT:
  927. task->tk_action = call_timeout;
  928. return;
  929. }
  930. rpc_exit(task, -EIO);
  931. }
  932. /*
  933. * 5. Transmit the RPC request, and wait for reply
  934. */
  935. static void
  936. call_transmit(struct rpc_task *task)
  937. {
  938. dprint_status(task);
  939. task->tk_action = call_status;
  940. if (task->tk_status < 0)
  941. return;
  942. task->tk_status = xprt_prepare_transmit(task);
  943. if (task->tk_status != 0)
  944. return;
  945. task->tk_action = call_transmit_status;
  946. /* Encode here so that rpcsec_gss can use correct sequence number. */
  947. if (rpc_task_need_encode(task)) {
  948. BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
  949. rpc_xdr_encode(task);
  950. /* Did the encode result in an error condition? */
  951. if (task->tk_status != 0) {
  952. /* Was the error nonfatal? */
  953. if (task->tk_status == -EAGAIN)
  954. rpc_delay(task, HZ >> 4);
  955. else
  956. rpc_exit(task, task->tk_status);
  957. return;
  958. }
  959. }
  960. xprt_transmit(task);
  961. if (task->tk_status < 0)
  962. return;
  963. /*
  964. * On success, ensure that we call xprt_end_transmit() before sleeping
  965. * in order to allow access to the socket to other RPC requests.
  966. */
  967. call_transmit_status(task);
  968. if (task->tk_msg.rpc_proc->p_decode != NULL)
  969. return;
  970. task->tk_action = rpc_exit_task;
  971. rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
  972. }
  973. /*
  974. * 5a. Handle cleanup after a transmission
  975. */
  976. static void
  977. call_transmit_status(struct rpc_task *task)
  978. {
  979. task->tk_action = call_status;
  980. switch (task->tk_status) {
  981. case -EAGAIN:
  982. break;
  983. default:
  984. xprt_end_transmit(task);
  985. /*
  986. * Special cases: if we've been waiting on the
  987. * socket's write_space() callback, or if the
  988. * socket just returned a connection error,
  989. * then hold onto the transport lock.
  990. */
  991. case -ECONNREFUSED:
  992. case -ENOTCONN:
  993. case -EHOSTDOWN:
  994. case -EHOSTUNREACH:
  995. case -ENETUNREACH:
  996. rpc_task_force_reencode(task);
  997. }
  998. }
  999. /*
  1000. * 6. Sort out the RPC call status
  1001. */
  1002. static void
  1003. call_status(struct rpc_task *task)
  1004. {
  1005. struct rpc_clnt *clnt = task->tk_client;
  1006. struct rpc_rqst *req = task->tk_rqstp;
  1007. int status;
  1008. if (req->rq_received > 0 && !req->rq_bytes_sent)
  1009. task->tk_status = req->rq_received;
  1010. dprint_status(task);
  1011. status = task->tk_status;
  1012. if (status >= 0) {
  1013. task->tk_action = call_decode;
  1014. return;
  1015. }
  1016. task->tk_status = 0;
  1017. switch(status) {
  1018. case -EHOSTDOWN:
  1019. case -EHOSTUNREACH:
  1020. case -ENETUNREACH:
  1021. /*
  1022. * Delay any retries for 3 seconds, then handle as if it
  1023. * were a timeout.
  1024. */
  1025. rpc_delay(task, 3*HZ);
  1026. case -ETIMEDOUT:
  1027. task->tk_action = call_timeout;
  1028. if (task->tk_client->cl_discrtry)
  1029. xprt_conditional_disconnect(task->tk_xprt,
  1030. req->rq_connect_cookie);
  1031. break;
  1032. case -ECONNREFUSED:
  1033. case -ENOTCONN:
  1034. rpc_force_rebind(clnt);
  1035. task->tk_action = call_bind;
  1036. break;
  1037. case -EAGAIN:
  1038. task->tk_action = call_transmit;
  1039. break;
  1040. case -EIO:
  1041. /* shutdown or soft timeout */
  1042. rpc_exit(task, status);
  1043. break;
  1044. default:
  1045. if (clnt->cl_chatty)
  1046. printk("%s: RPC call returned error %d\n",
  1047. clnt->cl_protname, -status);
  1048. rpc_exit(task, status);
  1049. }
  1050. }
  1051. /*
  1052. * 6a. Handle RPC timeout
  1053. * We do not release the request slot, so we keep using the
  1054. * same XID for all retransmits.
  1055. */
  1056. static void
  1057. call_timeout(struct rpc_task *task)
  1058. {
  1059. struct rpc_clnt *clnt = task->tk_client;
  1060. if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
  1061. dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
  1062. goto retry;
  1063. }
  1064. dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
  1065. task->tk_timeouts++;
  1066. if (RPC_IS_SOFT(task)) {
  1067. if (clnt->cl_chatty)
  1068. printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
  1069. clnt->cl_protname, clnt->cl_server);
  1070. rpc_exit(task, -EIO);
  1071. return;
  1072. }
  1073. if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
  1074. task->tk_flags |= RPC_CALL_MAJORSEEN;
  1075. if (clnt->cl_chatty)
  1076. printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
  1077. clnt->cl_protname, clnt->cl_server);
  1078. }
  1079. rpc_force_rebind(clnt);
  1080. /*
  1081. * Did our request time out due to an RPCSEC_GSS out-of-sequence
  1082. * event? RFC2203 requires the server to drop all such requests.
  1083. */
  1084. rpcauth_invalcred(task);
  1085. retry:
  1086. clnt->cl_stats->rpcretrans++;
  1087. task->tk_action = call_bind;
  1088. task->tk_status = 0;
  1089. }
  1090. /*
  1091. * 7. Decode the RPC reply
  1092. */
  1093. static void
  1094. call_decode(struct rpc_task *task)
  1095. {
  1096. struct rpc_clnt *clnt = task->tk_client;
  1097. struct rpc_rqst *req = task->tk_rqstp;
  1098. kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
  1099. __be32 *p;
  1100. dprintk("RPC: %5u call_decode (status %d)\n",
  1101. task->tk_pid, task->tk_status);
  1102. if (task->tk_flags & RPC_CALL_MAJORSEEN) {
  1103. if (clnt->cl_chatty)
  1104. printk(KERN_NOTICE "%s: server %s OK\n",
  1105. clnt->cl_protname, clnt->cl_server);
  1106. task->tk_flags &= ~RPC_CALL_MAJORSEEN;
  1107. }
  1108. /*
  1109. * Ensure that we see all writes made by xprt_complete_rqst()
  1110. * before it changed req->rq_received.
  1111. */
  1112. smp_rmb();
  1113. req->rq_rcv_buf.len = req->rq_private_buf.len;
  1114. /* Check that the softirq receive buffer is valid */
  1115. WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
  1116. sizeof(req->rq_rcv_buf)) != 0);
  1117. if (req->rq_rcv_buf.len < 12) {
  1118. if (!RPC_IS_SOFT(task)) {
  1119. task->tk_action = call_bind;
  1120. clnt->cl_stats->rpcretrans++;
  1121. goto out_retry;
  1122. }
  1123. dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
  1124. clnt->cl_protname, task->tk_status);
  1125. task->tk_action = call_timeout;
  1126. goto out_retry;
  1127. }
  1128. p = rpc_verify_header(task);
  1129. if (IS_ERR(p)) {
  1130. if (p == ERR_PTR(-EAGAIN))
  1131. goto out_retry;
  1132. return;
  1133. }
  1134. task->tk_action = rpc_exit_task;
  1135. if (decode) {
  1136. task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
  1137. task->tk_msg.rpc_resp);
  1138. }
  1139. dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
  1140. task->tk_status);
  1141. return;
  1142. out_retry:
  1143. task->tk_status = 0;
  1144. /* Note: rpc_verify_header() may have freed the RPC slot */
  1145. if (task->tk_rqstp == req) {
  1146. req->rq_received = req->rq_rcv_buf.len = 0;
  1147. if (task->tk_client->cl_discrtry)
  1148. xprt_conditional_disconnect(task->tk_xprt,
  1149. req->rq_connect_cookie);
  1150. }
  1151. }
  1152. /*
  1153. * 8. Refresh the credentials if rejected by the server
  1154. */
  1155. static void
  1156. call_refresh(struct rpc_task *task)
  1157. {
  1158. dprint_status(task);
  1159. task->tk_action = call_refreshresult;
  1160. task->tk_status = 0;
  1161. task->tk_client->cl_stats->rpcauthrefresh++;
  1162. rpcauth_refreshcred(task);
  1163. }
  1164. /*
  1165. * 8a. Process the results of a credential refresh
  1166. */
  1167. static void
  1168. call_refreshresult(struct rpc_task *task)
  1169. {
  1170. int status = task->tk_status;
  1171. dprint_status(task);
  1172. task->tk_status = 0;
  1173. task->tk_action = call_reserve;
  1174. if (status >= 0 && rpcauth_uptodatecred(task))
  1175. return;
  1176. if (status == -EACCES) {
  1177. rpc_exit(task, -EACCES);
  1178. return;
  1179. }
  1180. task->tk_action = call_refresh;
  1181. if (status != -ETIMEDOUT)
  1182. rpc_delay(task, 3*HZ);
  1183. return;
  1184. }
  1185. static __be32 *
  1186. rpc_encode_header(struct rpc_task *task)
  1187. {
  1188. struct rpc_clnt *clnt = task->tk_client;
  1189. struct rpc_rqst *req = task->tk_rqstp;
  1190. __be32 *p = req->rq_svec[0].iov_base;
  1191. /* FIXME: check buffer size? */
  1192. p = xprt_skip_transport_header(task->tk_xprt, p);
  1193. *p++ = req->rq_xid; /* XID */
  1194. *p++ = htonl(RPC_CALL); /* CALL */
  1195. *p++ = htonl(RPC_VERSION); /* RPC version */
  1196. *p++ = htonl(clnt->cl_prog); /* program number */
  1197. *p++ = htonl(clnt->cl_vers); /* program version */
  1198. *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
  1199. p = rpcauth_marshcred(task, p);
  1200. req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
  1201. return p;
  1202. }
  1203. static __be32 *
  1204. rpc_verify_header(struct rpc_task *task)
  1205. {
  1206. struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
  1207. int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
  1208. __be32 *p = iov->iov_base;
  1209. u32 n;
  1210. int error = -EACCES;
  1211. if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
  1212. /* RFC-1014 says that the representation of XDR data must be a
  1213. * multiple of four bytes
  1214. * - if it isn't pointer subtraction in the NFS client may give
  1215. * undefined results
  1216. */
  1217. dprintk("RPC: %5u %s: XDR representation not a multiple of"
  1218. " 4 bytes: 0x%x\n", task->tk_pid, __func__,
  1219. task->tk_rqstp->rq_rcv_buf.len);
  1220. goto out_eio;
  1221. }
  1222. if ((len -= 3) < 0)
  1223. goto out_overflow;
  1224. p += 1; /* skip XID */
  1225. if ((n = ntohl(*p++)) != RPC_REPLY) {
  1226. dprintk("RPC: %5u %s: not an RPC reply: %x\n",
  1227. task->tk_pid, __func__, n);
  1228. goto out_garbage;
  1229. }
  1230. if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
  1231. if (--len < 0)
  1232. goto out_overflow;
  1233. switch ((n = ntohl(*p++))) {
  1234. case RPC_AUTH_ERROR:
  1235. break;
  1236. case RPC_MISMATCH:
  1237. dprintk("RPC: %5u %s: RPC call version "
  1238. "mismatch!\n",
  1239. task->tk_pid, __func__);
  1240. error = -EPROTONOSUPPORT;
  1241. goto out_err;
  1242. default:
  1243. dprintk("RPC: %5u %s: RPC call rejected, "
  1244. "unknown error: %x\n",
  1245. task->tk_pid, __func__, n);
  1246. goto out_eio;
  1247. }
  1248. if (--len < 0)
  1249. goto out_overflow;
  1250. switch ((n = ntohl(*p++))) {
  1251. case RPC_AUTH_REJECTEDCRED:
  1252. case RPC_AUTH_REJECTEDVERF:
  1253. case RPCSEC_GSS_CREDPROBLEM:
  1254. case RPCSEC_GSS_CTXPROBLEM:
  1255. if (!task->tk_cred_retry)
  1256. break;
  1257. task->tk_cred_retry--;
  1258. dprintk("RPC: %5u %s: retry stale creds\n",
  1259. task->tk_pid, __func__);
  1260. rpcauth_invalcred(task);
  1261. /* Ensure we obtain a new XID! */
  1262. xprt_release(task);
  1263. task->tk_action = call_refresh;
  1264. goto out_retry;
  1265. case RPC_AUTH_BADCRED:
  1266. case RPC_AUTH_BADVERF:
  1267. /* possibly garbled cred/verf? */
  1268. if (!task->tk_garb_retry)
  1269. break;
  1270. task->tk_garb_retry--;
  1271. dprintk("RPC: %5u %s: retry garbled creds\n",
  1272. task->tk_pid, __func__);
  1273. task->tk_action = call_bind;
  1274. goto out_retry;
  1275. case RPC_AUTH_TOOWEAK:
  1276. printk(KERN_NOTICE "RPC: server %s requires stronger "
  1277. "authentication.\n", task->tk_client->cl_server);
  1278. break;
  1279. default:
  1280. dprintk("RPC: %5u %s: unknown auth error: %x\n",
  1281. task->tk_pid, __func__, n);
  1282. error = -EIO;
  1283. }
  1284. dprintk("RPC: %5u %s: call rejected %d\n",
  1285. task->tk_pid, __func__, n);
  1286. goto out_err;
  1287. }
  1288. if (!(p = rpcauth_checkverf(task, p))) {
  1289. dprintk("RPC: %5u %s: auth check failed\n",
  1290. task->tk_pid, __func__);
  1291. goto out_garbage; /* bad verifier, retry */
  1292. }
  1293. len = p - (__be32 *)iov->iov_base - 1;
  1294. if (len < 0)
  1295. goto out_overflow;
  1296. switch ((n = ntohl(*p++))) {
  1297. case RPC_SUCCESS:
  1298. return p;
  1299. case RPC_PROG_UNAVAIL:
  1300. dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
  1301. task->tk_pid, __func__,
  1302. (unsigned int)task->tk_client->cl_prog,
  1303. task->tk_client->cl_server);
  1304. error = -EPFNOSUPPORT;
  1305. goto out_err;
  1306. case RPC_PROG_MISMATCH:
  1307. dprintk("RPC: %5u %s: program %u, version %u unsupported by "
  1308. "server %s\n", task->tk_pid, __func__,
  1309. (unsigned int)task->tk_client->cl_prog,
  1310. (unsigned int)task->tk_client->cl_vers,
  1311. task->tk_client->cl_server);
  1312. error = -EPROTONOSUPPORT;
  1313. goto out_err;
  1314. case RPC_PROC_UNAVAIL:
  1315. dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
  1316. "version %u on server %s\n",
  1317. task->tk_pid, __func__,
  1318. rpc_proc_name(task),
  1319. task->tk_client->cl_prog,
  1320. task->tk_client->cl_vers,
  1321. task->tk_client->cl_server);
  1322. error = -EOPNOTSUPP;
  1323. goto out_err;
  1324. case RPC_GARBAGE_ARGS:
  1325. dprintk("RPC: %5u %s: server saw garbage\n",
  1326. task->tk_pid, __func__);
  1327. break; /* retry */
  1328. default:
  1329. dprintk("RPC: %5u %s: server accept status: %x\n",
  1330. task->tk_pid, __func__, n);
  1331. /* Also retry */
  1332. }
  1333. out_garbage:
  1334. task->tk_client->cl_stats->rpcgarbage++;
  1335. if (task->tk_garb_retry) {
  1336. task->tk_garb_retry--;
  1337. dprintk("RPC: %5u %s: retrying\n",
  1338. task->tk_pid, __func__);
  1339. task->tk_action = call_bind;
  1340. out_retry:
  1341. return ERR_PTR(-EAGAIN);
  1342. }
  1343. out_eio:
  1344. error = -EIO;
  1345. out_err:
  1346. rpc_exit(task, error);
  1347. dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
  1348. __func__, error);
  1349. return ERR_PTR(error);
  1350. out_overflow:
  1351. dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
  1352. __func__);
  1353. goto out_garbage;
  1354. }
  1355. static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
  1356. {
  1357. return 0;
  1358. }
  1359. static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
  1360. {
  1361. return 0;
  1362. }
  1363. static struct rpc_procinfo rpcproc_null = {
  1364. .p_encode = rpcproc_encode_null,
  1365. .p_decode = rpcproc_decode_null,
  1366. };
  1367. static int rpc_ping(struct rpc_clnt *clnt, int flags)
  1368. {
  1369. struct rpc_message msg = {
  1370. .rpc_proc = &rpcproc_null,
  1371. };
  1372. int err;
  1373. msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
  1374. err = rpc_call_sync(clnt, &msg, flags);
  1375. put_rpccred(msg.rpc_cred);
  1376. return err;
  1377. }
  1378. struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
  1379. {
  1380. struct rpc_message msg = {
  1381. .rpc_proc = &rpcproc_null,
  1382. .rpc_cred = cred,
  1383. };
  1384. struct rpc_task_setup task_setup_data = {
  1385. .rpc_client = clnt,
  1386. .rpc_message = &msg,
  1387. .callback_ops = &rpc_default_ops,
  1388. .flags = flags,
  1389. };
  1390. return rpc_run_task(&task_setup_data);
  1391. }
  1392. EXPORT_SYMBOL_GPL(rpc_call_null);
  1393. #ifdef RPC_DEBUG
  1394. static void rpc_show_header(void)
  1395. {
  1396. printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
  1397. "-timeout ---ops--\n");
  1398. }
  1399. static void rpc_show_task(const struct rpc_clnt *clnt,
  1400. const struct rpc_task *task)
  1401. {
  1402. const char *rpc_waitq = "none";
  1403. char *p, action[KSYM_SYMBOL_LEN];
  1404. if (RPC_IS_QUEUED(task))
  1405. rpc_waitq = rpc_qname(task->tk_waitqueue);
  1406. /* map tk_action pointer to a function name; then trim off
  1407. * the "+0x0 [sunrpc]" */
  1408. sprint_symbol(action, (unsigned long)task->tk_action);
  1409. p = strchr(action, '+');
  1410. if (p)
  1411. *p = '\0';
  1412. printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
  1413. task->tk_pid, task->tk_flags, task->tk_status,
  1414. clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
  1415. clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
  1416. action, rpc_waitq);
  1417. }
  1418. void rpc_show_tasks(void)
  1419. {
  1420. struct rpc_clnt *clnt;
  1421. struct rpc_task *task;
  1422. int header = 0;
  1423. spin_lock(&rpc_client_lock);
  1424. list_for_each_entry(clnt, &all_clients, cl_clients) {
  1425. spin_lock(&clnt->cl_lock);
  1426. list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
  1427. if (!header) {
  1428. rpc_show_header();
  1429. header++;
  1430. }
  1431. rpc_show_task(clnt, task);
  1432. }
  1433. spin_unlock(&clnt->cl_lock);
  1434. }
  1435. spin_unlock(&rpc_client_lock);
  1436. }
  1437. #endif