clnt.c 38 KB

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