clnt.c 38 KB

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