clnt.c 30 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277
  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/utsname.h>
  29. #include <linux/sunrpc/clnt.h>
  30. #include <linux/workqueue.h>
  31. #include <linux/sunrpc/rpc_pipe_fs.h>
  32. #include <linux/nfs.h>
  33. #define RPC_SLACK_SPACE (1024) /* total overkill */
  34. #ifdef RPC_DEBUG
  35. # define RPCDBG_FACILITY RPCDBG_CALL
  36. #endif
  37. static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
  38. static void call_start(struct rpc_task *task);
  39. static void call_reserve(struct rpc_task *task);
  40. static void call_reserveresult(struct rpc_task *task);
  41. static void call_allocate(struct rpc_task *task);
  42. static void call_encode(struct rpc_task *task);
  43. static void call_decode(struct rpc_task *task);
  44. static void call_bind(struct rpc_task *task);
  45. static void call_bind_status(struct rpc_task *task);
  46. static void call_transmit(struct rpc_task *task);
  47. static void call_status(struct rpc_task *task);
  48. static void call_transmit_status(struct rpc_task *task);
  49. static void call_refresh(struct rpc_task *task);
  50. static void call_refreshresult(struct rpc_task *task);
  51. static void call_timeout(struct rpc_task *task);
  52. static void call_connect(struct rpc_task *task);
  53. static void call_connect_status(struct rpc_task *task);
  54. static u32 * call_header(struct rpc_task *task);
  55. static u32 * call_verify(struct rpc_task *task);
  56. static int
  57. rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
  58. {
  59. static uint32_t clntid;
  60. int error;
  61. if (dir_name == NULL)
  62. return 0;
  63. for (;;) {
  64. snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
  65. "%s/clnt%x", dir_name,
  66. (unsigned int)clntid++);
  67. clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
  68. clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
  69. if (!IS_ERR(clnt->cl_dentry))
  70. return 0;
  71. error = PTR_ERR(clnt->cl_dentry);
  72. if (error != -EEXIST) {
  73. printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
  74. clnt->cl_pathname, error);
  75. return error;
  76. }
  77. }
  78. }
  79. /*
  80. * Create an RPC client
  81. * FIXME: This should also take a flags argument (as in task->tk_flags).
  82. * It's called (among others) from pmap_create_client, which may in
  83. * turn be called by an async task. In this case, rpciod should not be
  84. * made to sleep too long.
  85. */
  86. struct rpc_clnt *
  87. rpc_new_client(struct rpc_xprt *xprt, char *servname,
  88. struct rpc_program *program, u32 vers,
  89. rpc_authflavor_t flavor)
  90. {
  91. struct rpc_version *version;
  92. struct rpc_clnt *clnt = NULL;
  93. struct rpc_auth *auth;
  94. int err;
  95. int len;
  96. dprintk("RPC: creating %s client for %s (xprt %p)\n",
  97. program->name, servname, xprt);
  98. err = -EINVAL;
  99. if (!xprt)
  100. goto out_err;
  101. if (vers >= program->nrvers || !(version = program->version[vers]))
  102. goto out_err;
  103. err = -ENOMEM;
  104. clnt = (struct rpc_clnt *) kmalloc(sizeof(*clnt), GFP_KERNEL);
  105. if (!clnt)
  106. goto out_err;
  107. memset(clnt, 0, sizeof(*clnt));
  108. atomic_set(&clnt->cl_users, 0);
  109. atomic_set(&clnt->cl_count, 1);
  110. clnt->cl_parent = clnt;
  111. clnt->cl_server = clnt->cl_inline_name;
  112. len = strlen(servname) + 1;
  113. if (len > sizeof(clnt->cl_inline_name)) {
  114. char *buf = kmalloc(len, GFP_KERNEL);
  115. if (buf != 0)
  116. clnt->cl_server = buf;
  117. else
  118. len = sizeof(clnt->cl_inline_name);
  119. }
  120. strlcpy(clnt->cl_server, servname, len);
  121. clnt->cl_xprt = xprt;
  122. clnt->cl_procinfo = version->procs;
  123. clnt->cl_maxproc = version->nrprocs;
  124. clnt->cl_protname = program->name;
  125. clnt->cl_pmap = &clnt->cl_pmap_default;
  126. clnt->cl_port = xprt->addr.sin_port;
  127. clnt->cl_prog = program->number;
  128. clnt->cl_vers = version->number;
  129. clnt->cl_prot = xprt->prot;
  130. clnt->cl_stats = program->stats;
  131. rpc_init_wait_queue(&clnt->cl_pmap_default.pm_bindwait, "bindwait");
  132. if (!clnt->cl_port)
  133. clnt->cl_autobind = 1;
  134. clnt->cl_rtt = &clnt->cl_rtt_default;
  135. rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
  136. err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
  137. if (err < 0)
  138. goto out_no_path;
  139. auth = rpcauth_create(flavor, clnt);
  140. if (IS_ERR(auth)) {
  141. printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
  142. flavor);
  143. err = PTR_ERR(auth);
  144. goto out_no_auth;
  145. }
  146. /* save the nodename */
  147. clnt->cl_nodelen = strlen(system_utsname.nodename);
  148. if (clnt->cl_nodelen > UNX_MAXNODENAME)
  149. clnt->cl_nodelen = UNX_MAXNODENAME;
  150. memcpy(clnt->cl_nodename, system_utsname.nodename, clnt->cl_nodelen);
  151. return clnt;
  152. out_no_auth:
  153. rpc_rmdir(clnt->cl_pathname);
  154. out_no_path:
  155. if (clnt->cl_server != clnt->cl_inline_name)
  156. kfree(clnt->cl_server);
  157. kfree(clnt);
  158. out_err:
  159. xprt_destroy(xprt);
  160. return ERR_PTR(err);
  161. }
  162. /**
  163. * Create an RPC client
  164. * @xprt - pointer to xprt struct
  165. * @servname - name of server
  166. * @info - rpc_program
  167. * @version - rpc_program version
  168. * @authflavor - rpc_auth flavour to use
  169. *
  170. * Creates an RPC client structure, then pings the server in order to
  171. * determine if it is up, and if it supports this program and version.
  172. *
  173. * This function should never be called by asynchronous tasks such as
  174. * the portmapper.
  175. */
  176. struct rpc_clnt *rpc_create_client(struct rpc_xprt *xprt, char *servname,
  177. struct rpc_program *info, u32 version, rpc_authflavor_t authflavor)
  178. {
  179. struct rpc_clnt *clnt;
  180. int err;
  181. clnt = rpc_new_client(xprt, servname, info, version, authflavor);
  182. if (IS_ERR(clnt))
  183. return clnt;
  184. err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
  185. if (err == 0)
  186. return clnt;
  187. rpc_shutdown_client(clnt);
  188. return ERR_PTR(err);
  189. }
  190. /*
  191. * This function clones the RPC client structure. It allows us to share the
  192. * same transport while varying parameters such as the authentication
  193. * flavour.
  194. */
  195. struct rpc_clnt *
  196. rpc_clone_client(struct rpc_clnt *clnt)
  197. {
  198. struct rpc_clnt *new;
  199. new = (struct rpc_clnt *)kmalloc(sizeof(*new), GFP_KERNEL);
  200. if (!new)
  201. goto out_no_clnt;
  202. memcpy(new, clnt, sizeof(*new));
  203. atomic_set(&new->cl_count, 1);
  204. atomic_set(&new->cl_users, 0);
  205. new->cl_parent = clnt;
  206. atomic_inc(&clnt->cl_count);
  207. /* Duplicate portmapper */
  208. rpc_init_wait_queue(&new->cl_pmap_default.pm_bindwait, "bindwait");
  209. /* Turn off autobind on clones */
  210. new->cl_autobind = 0;
  211. new->cl_oneshot = 0;
  212. new->cl_dead = 0;
  213. rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
  214. if (new->cl_auth)
  215. atomic_inc(&new->cl_auth->au_count);
  216. new->cl_pmap = &new->cl_pmap_default;
  217. rpc_init_wait_queue(&new->cl_pmap_default.pm_bindwait, "bindwait");
  218. return new;
  219. out_no_clnt:
  220. printk(KERN_INFO "RPC: out of memory in %s\n", __FUNCTION__);
  221. return ERR_PTR(-ENOMEM);
  222. }
  223. /*
  224. * Properly shut down an RPC client, terminating all outstanding
  225. * requests. Note that we must be certain that cl_oneshot and
  226. * cl_dead are cleared, or else the client would be destroyed
  227. * when the last task releases it.
  228. */
  229. int
  230. rpc_shutdown_client(struct rpc_clnt *clnt)
  231. {
  232. dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
  233. clnt->cl_protname, clnt->cl_server,
  234. atomic_read(&clnt->cl_users));
  235. while (atomic_read(&clnt->cl_users) > 0) {
  236. /* Don't let rpc_release_client destroy us */
  237. clnt->cl_oneshot = 0;
  238. clnt->cl_dead = 0;
  239. rpc_killall_tasks(clnt);
  240. sleep_on_timeout(&destroy_wait, 1*HZ);
  241. }
  242. if (atomic_read(&clnt->cl_users) < 0) {
  243. printk(KERN_ERR "RPC: rpc_shutdown_client clnt %p tasks=%d\n",
  244. clnt, atomic_read(&clnt->cl_users));
  245. #ifdef RPC_DEBUG
  246. rpc_show_tasks();
  247. #endif
  248. BUG();
  249. }
  250. return rpc_destroy_client(clnt);
  251. }
  252. /*
  253. * Delete an RPC client
  254. */
  255. int
  256. rpc_destroy_client(struct rpc_clnt *clnt)
  257. {
  258. if (!atomic_dec_and_test(&clnt->cl_count))
  259. return 1;
  260. BUG_ON(atomic_read(&clnt->cl_users) != 0);
  261. dprintk("RPC: destroying %s client for %s\n",
  262. clnt->cl_protname, clnt->cl_server);
  263. if (clnt->cl_auth) {
  264. rpcauth_destroy(clnt->cl_auth);
  265. clnt->cl_auth = NULL;
  266. }
  267. if (clnt->cl_parent != clnt) {
  268. rpc_destroy_client(clnt->cl_parent);
  269. goto out_free;
  270. }
  271. if (clnt->cl_pathname[0])
  272. rpc_rmdir(clnt->cl_pathname);
  273. if (clnt->cl_xprt) {
  274. xprt_destroy(clnt->cl_xprt);
  275. clnt->cl_xprt = NULL;
  276. }
  277. if (clnt->cl_server != clnt->cl_inline_name)
  278. kfree(clnt->cl_server);
  279. out_free:
  280. kfree(clnt);
  281. return 0;
  282. }
  283. /*
  284. * Release an RPC client
  285. */
  286. void
  287. rpc_release_client(struct rpc_clnt *clnt)
  288. {
  289. dprintk("RPC: rpc_release_client(%p, %d)\n",
  290. clnt, atomic_read(&clnt->cl_users));
  291. if (!atomic_dec_and_test(&clnt->cl_users))
  292. return;
  293. wake_up(&destroy_wait);
  294. if (clnt->cl_oneshot || clnt->cl_dead)
  295. rpc_destroy_client(clnt);
  296. }
  297. /**
  298. * rpc_bind_new_program - bind a new RPC program to an existing client
  299. * @old - old rpc_client
  300. * @program - rpc program to set
  301. * @vers - rpc program version
  302. *
  303. * Clones the rpc client and sets up a new RPC program. This is mainly
  304. * of use for enabling different RPC programs to share the same transport.
  305. * The Sun NFSv2/v3 ACL protocol can do this.
  306. */
  307. struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
  308. struct rpc_program *program,
  309. int vers)
  310. {
  311. struct rpc_clnt *clnt;
  312. struct rpc_version *version;
  313. int err;
  314. BUG_ON(vers >= program->nrvers || !program->version[vers]);
  315. version = program->version[vers];
  316. clnt = rpc_clone_client(old);
  317. if (IS_ERR(clnt))
  318. goto out;
  319. clnt->cl_procinfo = version->procs;
  320. clnt->cl_maxproc = version->nrprocs;
  321. clnt->cl_protname = program->name;
  322. clnt->cl_prog = program->number;
  323. clnt->cl_vers = version->number;
  324. clnt->cl_stats = program->stats;
  325. err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
  326. if (err != 0) {
  327. rpc_shutdown_client(clnt);
  328. clnt = ERR_PTR(err);
  329. }
  330. out:
  331. return clnt;
  332. }
  333. /*
  334. * Default callback for async RPC calls
  335. */
  336. static void
  337. rpc_default_callback(struct rpc_task *task)
  338. {
  339. }
  340. /*
  341. * Export the signal mask handling for synchronous code that
  342. * sleeps on RPC calls
  343. */
  344. #define RPC_INTR_SIGNALS (sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGKILL))
  345. static void rpc_save_sigmask(sigset_t *oldset, int intr)
  346. {
  347. unsigned long sigallow = 0;
  348. sigset_t sigmask;
  349. /* Block all signals except those listed in sigallow */
  350. if (intr)
  351. sigallow |= RPC_INTR_SIGNALS;
  352. siginitsetinv(&sigmask, sigallow);
  353. sigprocmask(SIG_BLOCK, &sigmask, oldset);
  354. }
  355. static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
  356. {
  357. rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
  358. }
  359. static inline void rpc_restore_sigmask(sigset_t *oldset)
  360. {
  361. sigprocmask(SIG_SETMASK, oldset, NULL);
  362. }
  363. void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
  364. {
  365. rpc_save_sigmask(oldset, clnt->cl_intr);
  366. }
  367. void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
  368. {
  369. rpc_restore_sigmask(oldset);
  370. }
  371. /*
  372. * New rpc_call implementation
  373. */
  374. int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
  375. {
  376. struct rpc_task *task;
  377. sigset_t oldset;
  378. int status;
  379. /* If this client is slain all further I/O fails */
  380. if (clnt->cl_dead)
  381. return -EIO;
  382. BUG_ON(flags & RPC_TASK_ASYNC);
  383. status = -ENOMEM;
  384. task = rpc_new_task(clnt, NULL, flags);
  385. if (task == NULL)
  386. goto out;
  387. /* Mask signals on RPC calls _and_ GSS_AUTH upcalls */
  388. rpc_task_sigmask(task, &oldset);
  389. rpc_call_setup(task, msg, 0);
  390. /* Set up the call info struct and execute the task */
  391. if (task->tk_status == 0) {
  392. status = rpc_execute(task);
  393. } else {
  394. status = task->tk_status;
  395. rpc_release_task(task);
  396. }
  397. rpc_restore_sigmask(&oldset);
  398. out:
  399. return status;
  400. }
  401. /*
  402. * New rpc_call implementation
  403. */
  404. int
  405. rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
  406. rpc_action callback, void *data)
  407. {
  408. struct rpc_task *task;
  409. sigset_t oldset;
  410. int status;
  411. /* If this client is slain all further I/O fails */
  412. if (clnt->cl_dead)
  413. return -EIO;
  414. flags |= RPC_TASK_ASYNC;
  415. /* Create/initialize a new RPC task */
  416. if (!callback)
  417. callback = rpc_default_callback;
  418. status = -ENOMEM;
  419. if (!(task = rpc_new_task(clnt, callback, flags)))
  420. goto out;
  421. task->tk_calldata = data;
  422. /* Mask signals on GSS_AUTH upcalls */
  423. rpc_task_sigmask(task, &oldset);
  424. rpc_call_setup(task, msg, 0);
  425. /* Set up the call info struct and execute the task */
  426. status = task->tk_status;
  427. if (status == 0)
  428. rpc_execute(task);
  429. else
  430. rpc_release_task(task);
  431. rpc_restore_sigmask(&oldset);
  432. out:
  433. return status;
  434. }
  435. void
  436. rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
  437. {
  438. task->tk_msg = *msg;
  439. task->tk_flags |= flags;
  440. /* Bind the user cred */
  441. if (task->tk_msg.rpc_cred != NULL)
  442. rpcauth_holdcred(task);
  443. else
  444. rpcauth_bindcred(task);
  445. if (task->tk_status == 0)
  446. task->tk_action = call_start;
  447. else
  448. task->tk_action = NULL;
  449. }
  450. void
  451. rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
  452. {
  453. struct rpc_xprt *xprt = clnt->cl_xprt;
  454. if (xprt->ops->set_buffer_size)
  455. xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
  456. }
  457. /*
  458. * Return size of largest payload RPC client can support, in bytes
  459. *
  460. * For stream transports, this is one RPC record fragment (see RFC
  461. * 1831), as we don't support multi-record requests yet. For datagram
  462. * transports, this is the size of an IP packet minus the IP, UDP, and
  463. * RPC header sizes.
  464. */
  465. size_t rpc_max_payload(struct rpc_clnt *clnt)
  466. {
  467. return clnt->cl_xprt->max_payload;
  468. }
  469. EXPORT_SYMBOL(rpc_max_payload);
  470. /*
  471. * Restart an (async) RPC call. Usually called from within the
  472. * exit handler.
  473. */
  474. void
  475. rpc_restart_call(struct rpc_task *task)
  476. {
  477. if (RPC_ASSASSINATED(task))
  478. return;
  479. task->tk_action = call_start;
  480. }
  481. /*
  482. * 0. Initial state
  483. *
  484. * Other FSM states can be visited zero or more times, but
  485. * this state is visited exactly once for each RPC.
  486. */
  487. static void
  488. call_start(struct rpc_task *task)
  489. {
  490. struct rpc_clnt *clnt = task->tk_client;
  491. dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task->tk_pid,
  492. clnt->cl_protname, clnt->cl_vers, task->tk_msg.rpc_proc->p_proc,
  493. (RPC_IS_ASYNC(task) ? "async" : "sync"));
  494. /* Increment call count */
  495. task->tk_msg.rpc_proc->p_count++;
  496. clnt->cl_stats->rpccnt++;
  497. task->tk_action = call_reserve;
  498. }
  499. /*
  500. * 1. Reserve an RPC call slot
  501. */
  502. static void
  503. call_reserve(struct rpc_task *task)
  504. {
  505. dprintk("RPC: %4d call_reserve\n", task->tk_pid);
  506. if (!rpcauth_uptodatecred(task)) {
  507. task->tk_action = call_refresh;
  508. return;
  509. }
  510. task->tk_status = 0;
  511. task->tk_action = call_reserveresult;
  512. xprt_reserve(task);
  513. }
  514. /*
  515. * 1b. Grok the result of xprt_reserve()
  516. */
  517. static void
  518. call_reserveresult(struct rpc_task *task)
  519. {
  520. int status = task->tk_status;
  521. dprintk("RPC: %4d call_reserveresult (status %d)\n",
  522. task->tk_pid, task->tk_status);
  523. /*
  524. * After a call to xprt_reserve(), we must have either
  525. * a request slot or else an error status.
  526. */
  527. task->tk_status = 0;
  528. if (status >= 0) {
  529. if (task->tk_rqstp) {
  530. task->tk_action = call_allocate;
  531. return;
  532. }
  533. printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
  534. __FUNCTION__, status);
  535. rpc_exit(task, -EIO);
  536. return;
  537. }
  538. /*
  539. * Even though there was an error, we may have acquired
  540. * a request slot somehow. Make sure not to leak it.
  541. */
  542. if (task->tk_rqstp) {
  543. printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
  544. __FUNCTION__, status);
  545. xprt_release(task);
  546. }
  547. switch (status) {
  548. case -EAGAIN: /* woken up; retry */
  549. task->tk_action = call_reserve;
  550. return;
  551. case -EIO: /* probably a shutdown */
  552. break;
  553. default:
  554. printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
  555. __FUNCTION__, status);
  556. break;
  557. }
  558. rpc_exit(task, status);
  559. }
  560. /*
  561. * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
  562. * (Note: buffer memory is freed in rpc_task_release).
  563. */
  564. static void
  565. call_allocate(struct rpc_task *task)
  566. {
  567. unsigned int bufsiz;
  568. dprintk("RPC: %4d call_allocate (status %d)\n",
  569. task->tk_pid, task->tk_status);
  570. task->tk_action = call_bind;
  571. if (task->tk_buffer)
  572. return;
  573. /* FIXME: compute buffer requirements more exactly using
  574. * auth->au_wslack */
  575. bufsiz = task->tk_msg.rpc_proc->p_bufsiz + RPC_SLACK_SPACE;
  576. if (rpc_malloc(task, bufsiz << 1) != NULL)
  577. return;
  578. printk(KERN_INFO "RPC: buffer allocation failed for task %p\n", task);
  579. if (RPC_IS_ASYNC(task) || !signalled()) {
  580. xprt_release(task);
  581. task->tk_action = call_reserve;
  582. rpc_delay(task, HZ>>4);
  583. return;
  584. }
  585. rpc_exit(task, -ERESTARTSYS);
  586. }
  587. static inline int
  588. rpc_task_need_encode(struct rpc_task *task)
  589. {
  590. return task->tk_rqstp->rq_snd_buf.len == 0;
  591. }
  592. static inline void
  593. rpc_task_force_reencode(struct rpc_task *task)
  594. {
  595. task->tk_rqstp->rq_snd_buf.len = 0;
  596. }
  597. /*
  598. * 3. Encode arguments of an RPC call
  599. */
  600. static void
  601. call_encode(struct rpc_task *task)
  602. {
  603. struct rpc_rqst *req = task->tk_rqstp;
  604. struct xdr_buf *sndbuf = &req->rq_snd_buf;
  605. struct xdr_buf *rcvbuf = &req->rq_rcv_buf;
  606. unsigned int bufsiz;
  607. kxdrproc_t encode;
  608. u32 *p;
  609. dprintk("RPC: %4d call_encode (status %d)\n",
  610. task->tk_pid, task->tk_status);
  611. /* Default buffer setup */
  612. bufsiz = task->tk_bufsize >> 1;
  613. sndbuf->head[0].iov_base = (void *)task->tk_buffer;
  614. sndbuf->head[0].iov_len = bufsiz;
  615. sndbuf->tail[0].iov_len = 0;
  616. sndbuf->page_len = 0;
  617. sndbuf->len = 0;
  618. sndbuf->buflen = bufsiz;
  619. rcvbuf->head[0].iov_base = (void *)((char *)task->tk_buffer + bufsiz);
  620. rcvbuf->head[0].iov_len = bufsiz;
  621. rcvbuf->tail[0].iov_len = 0;
  622. rcvbuf->page_len = 0;
  623. rcvbuf->len = 0;
  624. rcvbuf->buflen = bufsiz;
  625. /* Encode header and provided arguments */
  626. encode = task->tk_msg.rpc_proc->p_encode;
  627. if (!(p = call_header(task))) {
  628. printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
  629. rpc_exit(task, -EIO);
  630. return;
  631. }
  632. if (encode == NULL)
  633. return;
  634. task->tk_status = rpcauth_wrap_req(task, encode, req, p,
  635. task->tk_msg.rpc_argp);
  636. if (task->tk_status == -ENOMEM) {
  637. /* XXX: Is this sane? */
  638. rpc_delay(task, 3*HZ);
  639. task->tk_status = -EAGAIN;
  640. }
  641. }
  642. /*
  643. * 4. Get the server port number if not yet set
  644. */
  645. static void
  646. call_bind(struct rpc_task *task)
  647. {
  648. struct rpc_clnt *clnt = task->tk_client;
  649. dprintk("RPC: %4d call_bind (status %d)\n",
  650. task->tk_pid, task->tk_status);
  651. task->tk_action = call_connect;
  652. if (!clnt->cl_port) {
  653. task->tk_action = call_bind_status;
  654. task->tk_timeout = task->tk_xprt->bind_timeout;
  655. rpc_getport(task, clnt);
  656. }
  657. }
  658. /*
  659. * 4a. Sort out bind result
  660. */
  661. static void
  662. call_bind_status(struct rpc_task *task)
  663. {
  664. int status = -EACCES;
  665. if (task->tk_status >= 0) {
  666. dprintk("RPC: %4d call_bind_status (status %d)\n",
  667. task->tk_pid, task->tk_status);
  668. task->tk_status = 0;
  669. task->tk_action = call_connect;
  670. return;
  671. }
  672. switch (task->tk_status) {
  673. case -EACCES:
  674. dprintk("RPC: %4d remote rpcbind: RPC program/version unavailable\n",
  675. task->tk_pid);
  676. rpc_delay(task, 3*HZ);
  677. goto retry_bind;
  678. case -ETIMEDOUT:
  679. dprintk("RPC: %4d rpcbind request timed out\n",
  680. task->tk_pid);
  681. if (RPC_IS_SOFT(task)) {
  682. status = -EIO;
  683. break;
  684. }
  685. goto retry_bind;
  686. case -EPFNOSUPPORT:
  687. dprintk("RPC: %4d remote rpcbind service unavailable\n",
  688. task->tk_pid);
  689. break;
  690. case -EPROTONOSUPPORT:
  691. dprintk("RPC: %4d remote rpcbind version 2 unavailable\n",
  692. task->tk_pid);
  693. break;
  694. default:
  695. dprintk("RPC: %4d unrecognized rpcbind error (%d)\n",
  696. task->tk_pid, -task->tk_status);
  697. status = -EIO;
  698. break;
  699. }
  700. rpc_exit(task, status);
  701. return;
  702. retry_bind:
  703. task->tk_status = 0;
  704. task->tk_action = call_bind;
  705. return;
  706. }
  707. /*
  708. * 4b. Connect to the RPC server
  709. */
  710. static void
  711. call_connect(struct rpc_task *task)
  712. {
  713. struct rpc_xprt *xprt = task->tk_xprt;
  714. dprintk("RPC: %4d call_connect xprt %p %s connected\n",
  715. task->tk_pid, xprt,
  716. (xprt_connected(xprt) ? "is" : "is not"));
  717. task->tk_action = call_transmit;
  718. if (!xprt_connected(xprt)) {
  719. task->tk_action = call_connect_status;
  720. if (task->tk_status < 0)
  721. return;
  722. xprt_connect(task);
  723. }
  724. }
  725. /*
  726. * 4c. Sort out connect result
  727. */
  728. static void
  729. call_connect_status(struct rpc_task *task)
  730. {
  731. struct rpc_clnt *clnt = task->tk_client;
  732. int status = task->tk_status;
  733. dprintk("RPC: %5u call_connect_status (status %d)\n",
  734. task->tk_pid, task->tk_status);
  735. task->tk_status = 0;
  736. if (status >= 0) {
  737. clnt->cl_stats->netreconn++;
  738. task->tk_action = call_transmit;
  739. return;
  740. }
  741. /* Something failed: remote service port may have changed */
  742. if (clnt->cl_autobind)
  743. clnt->cl_port = 0;
  744. switch (status) {
  745. case -ENOTCONN:
  746. case -ETIMEDOUT:
  747. case -EAGAIN:
  748. task->tk_action = call_bind;
  749. break;
  750. default:
  751. rpc_exit(task, -EIO);
  752. break;
  753. }
  754. }
  755. /*
  756. * 5. Transmit the RPC request, and wait for reply
  757. */
  758. static void
  759. call_transmit(struct rpc_task *task)
  760. {
  761. dprintk("RPC: %4d call_transmit (status %d)\n",
  762. task->tk_pid, task->tk_status);
  763. task->tk_action = call_status;
  764. if (task->tk_status < 0)
  765. return;
  766. task->tk_status = xprt_prepare_transmit(task);
  767. if (task->tk_status != 0)
  768. return;
  769. /* Encode here so that rpcsec_gss can use correct sequence number. */
  770. if (rpc_task_need_encode(task)) {
  771. task->tk_rqstp->rq_bytes_sent = 0;
  772. call_encode(task);
  773. /* Did the encode result in an error condition? */
  774. if (task->tk_status != 0)
  775. goto out_nosend;
  776. }
  777. task->tk_action = call_transmit_status;
  778. xprt_transmit(task);
  779. if (task->tk_status < 0)
  780. return;
  781. if (!task->tk_msg.rpc_proc->p_decode) {
  782. task->tk_action = NULL;
  783. rpc_wake_up_task(task);
  784. }
  785. return;
  786. out_nosend:
  787. /* release socket write lock before attempting to handle error */
  788. xprt_abort_transmit(task);
  789. rpc_task_force_reencode(task);
  790. }
  791. /*
  792. * 6. Sort out the RPC call status
  793. */
  794. static void
  795. call_status(struct rpc_task *task)
  796. {
  797. struct rpc_clnt *clnt = task->tk_client;
  798. struct rpc_rqst *req = task->tk_rqstp;
  799. int status;
  800. if (req->rq_received > 0 && !req->rq_bytes_sent)
  801. task->tk_status = req->rq_received;
  802. dprintk("RPC: %4d call_status (status %d)\n",
  803. task->tk_pid, task->tk_status);
  804. status = task->tk_status;
  805. if (status >= 0) {
  806. task->tk_action = call_decode;
  807. return;
  808. }
  809. task->tk_status = 0;
  810. switch(status) {
  811. case -ETIMEDOUT:
  812. task->tk_action = call_timeout;
  813. break;
  814. case -ECONNREFUSED:
  815. case -ENOTCONN:
  816. if (clnt->cl_autobind)
  817. clnt->cl_port = 0;
  818. task->tk_action = call_bind;
  819. break;
  820. case -EAGAIN:
  821. task->tk_action = call_transmit;
  822. break;
  823. case -EIO:
  824. /* shutdown or soft timeout */
  825. rpc_exit(task, status);
  826. break;
  827. default:
  828. if (clnt->cl_chatty)
  829. printk("%s: RPC call returned error %d\n",
  830. clnt->cl_protname, -status);
  831. rpc_exit(task, status);
  832. break;
  833. }
  834. }
  835. /*
  836. * 6a. Handle transmission errors.
  837. */
  838. static void
  839. call_transmit_status(struct rpc_task *task)
  840. {
  841. if (task->tk_status != -EAGAIN)
  842. rpc_task_force_reencode(task);
  843. call_status(task);
  844. }
  845. /*
  846. * 6b. Handle RPC timeout
  847. * We do not release the request slot, so we keep using the
  848. * same XID for all retransmits.
  849. */
  850. static void
  851. call_timeout(struct rpc_task *task)
  852. {
  853. struct rpc_clnt *clnt = task->tk_client;
  854. if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
  855. dprintk("RPC: %4d call_timeout (minor)\n", task->tk_pid);
  856. goto retry;
  857. }
  858. dprintk("RPC: %4d call_timeout (major)\n", task->tk_pid);
  859. if (RPC_IS_SOFT(task)) {
  860. if (clnt->cl_chatty)
  861. printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
  862. clnt->cl_protname, clnt->cl_server);
  863. rpc_exit(task, -EIO);
  864. return;
  865. }
  866. if (clnt->cl_chatty && !(task->tk_flags & RPC_CALL_MAJORSEEN)) {
  867. task->tk_flags |= RPC_CALL_MAJORSEEN;
  868. printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
  869. clnt->cl_protname, clnt->cl_server);
  870. }
  871. if (clnt->cl_autobind)
  872. clnt->cl_port = 0;
  873. retry:
  874. clnt->cl_stats->rpcretrans++;
  875. task->tk_action = call_bind;
  876. task->tk_status = 0;
  877. }
  878. /*
  879. * 7. Decode the RPC reply
  880. */
  881. static void
  882. call_decode(struct rpc_task *task)
  883. {
  884. struct rpc_clnt *clnt = task->tk_client;
  885. struct rpc_rqst *req = task->tk_rqstp;
  886. kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
  887. u32 *p;
  888. dprintk("RPC: %4d call_decode (status %d)\n",
  889. task->tk_pid, task->tk_status);
  890. if (clnt->cl_chatty && (task->tk_flags & RPC_CALL_MAJORSEEN)) {
  891. printk(KERN_NOTICE "%s: server %s OK\n",
  892. clnt->cl_protname, clnt->cl_server);
  893. task->tk_flags &= ~RPC_CALL_MAJORSEEN;
  894. }
  895. if (task->tk_status < 12) {
  896. if (!RPC_IS_SOFT(task)) {
  897. task->tk_action = call_bind;
  898. clnt->cl_stats->rpcretrans++;
  899. goto out_retry;
  900. }
  901. printk(KERN_WARNING "%s: too small RPC reply size (%d bytes)\n",
  902. clnt->cl_protname, task->tk_status);
  903. rpc_exit(task, -EIO);
  904. return;
  905. }
  906. req->rq_rcv_buf.len = req->rq_private_buf.len;
  907. /* Check that the softirq receive buffer is valid */
  908. WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
  909. sizeof(req->rq_rcv_buf)) != 0);
  910. /* Verify the RPC header */
  911. if (!(p = call_verify(task))) {
  912. if (task->tk_action == NULL)
  913. return;
  914. goto out_retry;
  915. }
  916. task->tk_action = NULL;
  917. if (decode)
  918. task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
  919. task->tk_msg.rpc_resp);
  920. dprintk("RPC: %4d call_decode result %d\n", task->tk_pid,
  921. task->tk_status);
  922. return;
  923. out_retry:
  924. req->rq_received = req->rq_private_buf.len = 0;
  925. task->tk_status = 0;
  926. }
  927. /*
  928. * 8. Refresh the credentials if rejected by the server
  929. */
  930. static void
  931. call_refresh(struct rpc_task *task)
  932. {
  933. dprintk("RPC: %4d call_refresh\n", task->tk_pid);
  934. xprt_release(task); /* Must do to obtain new XID */
  935. task->tk_action = call_refreshresult;
  936. task->tk_status = 0;
  937. task->tk_client->cl_stats->rpcauthrefresh++;
  938. rpcauth_refreshcred(task);
  939. }
  940. /*
  941. * 8a. Process the results of a credential refresh
  942. */
  943. static void
  944. call_refreshresult(struct rpc_task *task)
  945. {
  946. int status = task->tk_status;
  947. dprintk("RPC: %4d call_refreshresult (status %d)\n",
  948. task->tk_pid, task->tk_status);
  949. task->tk_status = 0;
  950. task->tk_action = call_reserve;
  951. if (status >= 0 && rpcauth_uptodatecred(task))
  952. return;
  953. if (status == -EACCES) {
  954. rpc_exit(task, -EACCES);
  955. return;
  956. }
  957. task->tk_action = call_refresh;
  958. if (status != -ETIMEDOUT)
  959. rpc_delay(task, 3*HZ);
  960. return;
  961. }
  962. /*
  963. * Call header serialization
  964. */
  965. static u32 *
  966. call_header(struct rpc_task *task)
  967. {
  968. struct rpc_clnt *clnt = task->tk_client;
  969. struct rpc_rqst *req = task->tk_rqstp;
  970. u32 *p = req->rq_svec[0].iov_base;
  971. /* FIXME: check buffer size? */
  972. p = xprt_skip_transport_header(task->tk_xprt, p);
  973. *p++ = req->rq_xid; /* XID */
  974. *p++ = htonl(RPC_CALL); /* CALL */
  975. *p++ = htonl(RPC_VERSION); /* RPC version */
  976. *p++ = htonl(clnt->cl_prog); /* program number */
  977. *p++ = htonl(clnt->cl_vers); /* program version */
  978. *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
  979. p = rpcauth_marshcred(task, p);
  980. req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
  981. return p;
  982. }
  983. /*
  984. * Reply header verification
  985. */
  986. static u32 *
  987. call_verify(struct rpc_task *task)
  988. {
  989. struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
  990. int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
  991. u32 *p = iov->iov_base, n;
  992. int error = -EACCES;
  993. if ((len -= 3) < 0)
  994. goto out_overflow;
  995. p += 1; /* skip XID */
  996. if ((n = ntohl(*p++)) != RPC_REPLY) {
  997. printk(KERN_WARNING "call_verify: not an RPC reply: %x\n", n);
  998. goto out_retry;
  999. }
  1000. if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
  1001. if (--len < 0)
  1002. goto out_overflow;
  1003. switch ((n = ntohl(*p++))) {
  1004. case RPC_AUTH_ERROR:
  1005. break;
  1006. case RPC_MISMATCH:
  1007. dprintk("%s: RPC call version mismatch!\n", __FUNCTION__);
  1008. error = -EPROTONOSUPPORT;
  1009. goto out_err;
  1010. default:
  1011. dprintk("%s: RPC call rejected, unknown error: %x\n", __FUNCTION__, n);
  1012. goto out_eio;
  1013. }
  1014. if (--len < 0)
  1015. goto out_overflow;
  1016. switch ((n = ntohl(*p++))) {
  1017. case RPC_AUTH_REJECTEDCRED:
  1018. case RPC_AUTH_REJECTEDVERF:
  1019. case RPCSEC_GSS_CREDPROBLEM:
  1020. case RPCSEC_GSS_CTXPROBLEM:
  1021. if (!task->tk_cred_retry)
  1022. break;
  1023. task->tk_cred_retry--;
  1024. dprintk("RPC: %4d call_verify: retry stale creds\n",
  1025. task->tk_pid);
  1026. rpcauth_invalcred(task);
  1027. task->tk_action = call_refresh;
  1028. return NULL;
  1029. case RPC_AUTH_BADCRED:
  1030. case RPC_AUTH_BADVERF:
  1031. /* possibly garbled cred/verf? */
  1032. if (!task->tk_garb_retry)
  1033. break;
  1034. task->tk_garb_retry--;
  1035. dprintk("RPC: %4d call_verify: retry garbled creds\n",
  1036. task->tk_pid);
  1037. task->tk_action = call_bind;
  1038. return NULL;
  1039. case RPC_AUTH_TOOWEAK:
  1040. printk(KERN_NOTICE "call_verify: server requires stronger "
  1041. "authentication.\n");
  1042. break;
  1043. default:
  1044. printk(KERN_WARNING "call_verify: unknown auth error: %x\n", n);
  1045. error = -EIO;
  1046. }
  1047. dprintk("RPC: %4d call_verify: call rejected %d\n",
  1048. task->tk_pid, n);
  1049. goto out_err;
  1050. }
  1051. if (!(p = rpcauth_checkverf(task, p))) {
  1052. printk(KERN_WARNING "call_verify: auth check failed\n");
  1053. goto out_retry; /* bad verifier, retry */
  1054. }
  1055. len = p - (u32 *)iov->iov_base - 1;
  1056. if (len < 0)
  1057. goto out_overflow;
  1058. switch ((n = ntohl(*p++))) {
  1059. case RPC_SUCCESS:
  1060. return p;
  1061. case RPC_PROG_UNAVAIL:
  1062. dprintk("RPC: call_verify: program %u is unsupported by server %s\n",
  1063. (unsigned int)task->tk_client->cl_prog,
  1064. task->tk_client->cl_server);
  1065. error = -EPFNOSUPPORT;
  1066. goto out_err;
  1067. case RPC_PROG_MISMATCH:
  1068. dprintk("RPC: call_verify: program %u, version %u unsupported by server %s\n",
  1069. (unsigned int)task->tk_client->cl_prog,
  1070. (unsigned int)task->tk_client->cl_vers,
  1071. task->tk_client->cl_server);
  1072. error = -EPROTONOSUPPORT;
  1073. goto out_err;
  1074. case RPC_PROC_UNAVAIL:
  1075. dprintk("RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
  1076. task->tk_msg.rpc_proc,
  1077. task->tk_client->cl_prog,
  1078. task->tk_client->cl_vers,
  1079. task->tk_client->cl_server);
  1080. error = -EOPNOTSUPP;
  1081. goto out_err;
  1082. case RPC_GARBAGE_ARGS:
  1083. dprintk("RPC: %4d %s: server saw garbage\n", task->tk_pid, __FUNCTION__);
  1084. break; /* retry */
  1085. default:
  1086. printk(KERN_WARNING "call_verify: server accept status: %x\n", n);
  1087. /* Also retry */
  1088. }
  1089. out_retry:
  1090. task->tk_client->cl_stats->rpcgarbage++;
  1091. if (task->tk_garb_retry) {
  1092. task->tk_garb_retry--;
  1093. dprintk("RPC %s: retrying %4d\n", __FUNCTION__, task->tk_pid);
  1094. task->tk_action = call_bind;
  1095. return NULL;
  1096. }
  1097. printk(KERN_WARNING "RPC %s: retry failed, exit EIO\n", __FUNCTION__);
  1098. out_eio:
  1099. error = -EIO;
  1100. out_err:
  1101. rpc_exit(task, error);
  1102. return NULL;
  1103. out_overflow:
  1104. printk(KERN_WARNING "RPC %s: server reply was truncated.\n", __FUNCTION__);
  1105. goto out_retry;
  1106. }
  1107. static int rpcproc_encode_null(void *rqstp, u32 *data, void *obj)
  1108. {
  1109. return 0;
  1110. }
  1111. static int rpcproc_decode_null(void *rqstp, u32 *data, void *obj)
  1112. {
  1113. return 0;
  1114. }
  1115. static struct rpc_procinfo rpcproc_null = {
  1116. .p_encode = rpcproc_encode_null,
  1117. .p_decode = rpcproc_decode_null,
  1118. };
  1119. int rpc_ping(struct rpc_clnt *clnt, int flags)
  1120. {
  1121. struct rpc_message msg = {
  1122. .rpc_proc = &rpcproc_null,
  1123. };
  1124. int err;
  1125. msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
  1126. err = rpc_call_sync(clnt, &msg, flags);
  1127. put_rpccred(msg.rpc_cred);
  1128. return err;
  1129. }