clnt.c 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268
  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. * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
  17. * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
  18. */
  19. #include <linux/module.h>
  20. #include <linux/types.h>
  21. #include <linux/kallsyms.h>
  22. #include <linux/mm.h>
  23. #include <linux/namei.h>
  24. #include <linux/mount.h>
  25. #include <linux/slab.h>
  26. #include <linux/utsname.h>
  27. #include <linux/workqueue.h>
  28. #include <linux/in.h>
  29. #include <linux/in6.h>
  30. #include <linux/un.h>
  31. #include <linux/rcupdate.h>
  32. #include <linux/sunrpc/clnt.h>
  33. #include <linux/sunrpc/rpc_pipe_fs.h>
  34. #include <linux/sunrpc/metrics.h>
  35. #include <linux/sunrpc/bc_xprt.h>
  36. #include <trace/events/sunrpc.h>
  37. #include "sunrpc.h"
  38. #include "netns.h"
  39. #ifdef RPC_DEBUG
  40. # define RPCDBG_FACILITY RPCDBG_CALL
  41. #endif
  42. #define dprint_status(t) \
  43. dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
  44. __func__, t->tk_status)
  45. /*
  46. * All RPC clients are linked into this list
  47. */
  48. static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
  49. static void call_start(struct rpc_task *task);
  50. static void call_reserve(struct rpc_task *task);
  51. static void call_reserveresult(struct rpc_task *task);
  52. static void call_allocate(struct rpc_task *task);
  53. static void call_decode(struct rpc_task *task);
  54. static void call_bind(struct rpc_task *task);
  55. static void call_bind_status(struct rpc_task *task);
  56. static void call_transmit(struct rpc_task *task);
  57. #if defined(CONFIG_SUNRPC_BACKCHANNEL)
  58. static void call_bc_transmit(struct rpc_task *task);
  59. #endif /* CONFIG_SUNRPC_BACKCHANNEL */
  60. static void call_status(struct rpc_task *task);
  61. static void call_transmit_status(struct rpc_task *task);
  62. static void call_refresh(struct rpc_task *task);
  63. static void call_refreshresult(struct rpc_task *task);
  64. static void call_timeout(struct rpc_task *task);
  65. static void call_connect(struct rpc_task *task);
  66. static void call_connect_status(struct rpc_task *task);
  67. static __be32 *rpc_encode_header(struct rpc_task *task);
  68. static __be32 *rpc_verify_header(struct rpc_task *task);
  69. static int rpc_ping(struct rpc_clnt *clnt);
  70. static void rpc_register_client(struct rpc_clnt *clnt)
  71. {
  72. struct net *net = rpc_net_ns(clnt);
  73. struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
  74. spin_lock(&sn->rpc_client_lock);
  75. list_add(&clnt->cl_clients, &sn->all_clients);
  76. spin_unlock(&sn->rpc_client_lock);
  77. }
  78. static void rpc_unregister_client(struct rpc_clnt *clnt)
  79. {
  80. struct net *net = rpc_net_ns(clnt);
  81. struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
  82. spin_lock(&sn->rpc_client_lock);
  83. list_del(&clnt->cl_clients);
  84. spin_unlock(&sn->rpc_client_lock);
  85. }
  86. static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
  87. {
  88. if (clnt->cl_dentry) {
  89. if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
  90. clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
  91. rpc_remove_client_dir(clnt->cl_dentry);
  92. }
  93. clnt->cl_dentry = NULL;
  94. }
  95. static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
  96. {
  97. struct net *net = rpc_net_ns(clnt);
  98. struct super_block *pipefs_sb;
  99. pipefs_sb = rpc_get_sb_net(net);
  100. if (pipefs_sb) {
  101. __rpc_clnt_remove_pipedir(clnt);
  102. rpc_put_sb_net(net);
  103. }
  104. }
  105. static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
  106. struct rpc_clnt *clnt,
  107. const char *dir_name)
  108. {
  109. static uint32_t clntid;
  110. char name[15];
  111. struct qstr q = { .name = name };
  112. struct dentry *dir, *dentry;
  113. int error;
  114. dir = rpc_d_lookup_sb(sb, dir_name);
  115. if (dir == NULL) {
  116. pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
  117. return dir;
  118. }
  119. for (;;) {
  120. q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
  121. name[sizeof(name) - 1] = '\0';
  122. q.hash = full_name_hash(q.name, q.len);
  123. dentry = rpc_create_client_dir(dir, &q, clnt);
  124. if (!IS_ERR(dentry))
  125. break;
  126. error = PTR_ERR(dentry);
  127. if (error != -EEXIST) {
  128. printk(KERN_INFO "RPC: Couldn't create pipefs entry"
  129. " %s/%s, error %d\n",
  130. dir_name, name, error);
  131. break;
  132. }
  133. }
  134. dput(dir);
  135. return dentry;
  136. }
  137. static int
  138. rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name)
  139. {
  140. struct net *net = rpc_net_ns(clnt);
  141. struct super_block *pipefs_sb;
  142. struct dentry *dentry;
  143. clnt->cl_dentry = NULL;
  144. if (dir_name == NULL)
  145. return 0;
  146. pipefs_sb = rpc_get_sb_net(net);
  147. if (!pipefs_sb)
  148. return 0;
  149. dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
  150. rpc_put_sb_net(net);
  151. if (IS_ERR(dentry))
  152. return PTR_ERR(dentry);
  153. clnt->cl_dentry = dentry;
  154. return 0;
  155. }
  156. static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
  157. {
  158. if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
  159. ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
  160. return 1;
  161. return 0;
  162. }
  163. static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
  164. struct super_block *sb)
  165. {
  166. struct dentry *dentry;
  167. int err = 0;
  168. switch (event) {
  169. case RPC_PIPEFS_MOUNT:
  170. dentry = rpc_setup_pipedir_sb(sb, clnt,
  171. clnt->cl_program->pipe_dir_name);
  172. if (!dentry)
  173. return -ENOENT;
  174. if (IS_ERR(dentry))
  175. return PTR_ERR(dentry);
  176. clnt->cl_dentry = dentry;
  177. if (clnt->cl_auth->au_ops->pipes_create) {
  178. err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
  179. if (err)
  180. __rpc_clnt_remove_pipedir(clnt);
  181. }
  182. break;
  183. case RPC_PIPEFS_UMOUNT:
  184. __rpc_clnt_remove_pipedir(clnt);
  185. break;
  186. default:
  187. printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
  188. return -ENOTSUPP;
  189. }
  190. return err;
  191. }
  192. static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
  193. struct super_block *sb)
  194. {
  195. int error = 0;
  196. for (;; clnt = clnt->cl_parent) {
  197. if (!rpc_clnt_skip_event(clnt, event))
  198. error = __rpc_clnt_handle_event(clnt, event, sb);
  199. if (error || clnt == clnt->cl_parent)
  200. break;
  201. }
  202. return error;
  203. }
  204. static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
  205. {
  206. struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
  207. struct rpc_clnt *clnt;
  208. spin_lock(&sn->rpc_client_lock);
  209. list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
  210. if (clnt->cl_program->pipe_dir_name == NULL)
  211. break;
  212. if (rpc_clnt_skip_event(clnt, event))
  213. continue;
  214. if (atomic_inc_not_zero(&clnt->cl_count) == 0)
  215. continue;
  216. spin_unlock(&sn->rpc_client_lock);
  217. return clnt;
  218. }
  219. spin_unlock(&sn->rpc_client_lock);
  220. return NULL;
  221. }
  222. static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
  223. void *ptr)
  224. {
  225. struct super_block *sb = ptr;
  226. struct rpc_clnt *clnt;
  227. int error = 0;
  228. while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
  229. error = __rpc_pipefs_event(clnt, event, sb);
  230. rpc_release_client(clnt);
  231. if (error)
  232. break;
  233. }
  234. return error;
  235. }
  236. static struct notifier_block rpc_clients_block = {
  237. .notifier_call = rpc_pipefs_event,
  238. .priority = SUNRPC_PIPEFS_RPC_PRIO,
  239. };
  240. int rpc_clients_notifier_register(void)
  241. {
  242. return rpc_pipefs_notifier_register(&rpc_clients_block);
  243. }
  244. void rpc_clients_notifier_unregister(void)
  245. {
  246. return rpc_pipefs_notifier_unregister(&rpc_clients_block);
  247. }
  248. static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
  249. {
  250. clnt->cl_nodelen = strlen(nodename);
  251. if (clnt->cl_nodelen > UNX_MAXNODENAME)
  252. clnt->cl_nodelen = UNX_MAXNODENAME;
  253. memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
  254. }
  255. static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
  256. {
  257. const struct rpc_program *program = args->program;
  258. const struct rpc_version *version;
  259. struct rpc_clnt *clnt = NULL;
  260. struct rpc_auth *auth;
  261. int err;
  262. /* sanity check the name before trying to print it */
  263. dprintk("RPC: creating %s client for %s (xprt %p)\n",
  264. program->name, args->servername, xprt);
  265. err = rpciod_up();
  266. if (err)
  267. goto out_no_rpciod;
  268. err = -EINVAL;
  269. if (!xprt)
  270. goto out_no_xprt;
  271. if (args->version >= program->nrvers)
  272. goto out_err;
  273. version = program->version[args->version];
  274. if (version == NULL)
  275. goto out_err;
  276. err = -ENOMEM;
  277. clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
  278. if (!clnt)
  279. goto out_err;
  280. clnt->cl_parent = clnt;
  281. rcu_assign_pointer(clnt->cl_xprt, xprt);
  282. clnt->cl_procinfo = version->procs;
  283. clnt->cl_maxproc = version->nrprocs;
  284. clnt->cl_protname = program->name;
  285. clnt->cl_prog = args->prognumber ? : program->number;
  286. clnt->cl_vers = version->number;
  287. clnt->cl_stats = program->stats;
  288. clnt->cl_metrics = rpc_alloc_iostats(clnt);
  289. err = -ENOMEM;
  290. if (clnt->cl_metrics == NULL)
  291. goto out_no_stats;
  292. clnt->cl_program = program;
  293. INIT_LIST_HEAD(&clnt->cl_tasks);
  294. spin_lock_init(&clnt->cl_lock);
  295. if (!xprt_bound(xprt))
  296. clnt->cl_autobind = 1;
  297. clnt->cl_timeout = xprt->timeout;
  298. if (args->timeout != NULL) {
  299. memcpy(&clnt->cl_timeout_default, args->timeout,
  300. sizeof(clnt->cl_timeout_default));
  301. clnt->cl_timeout = &clnt->cl_timeout_default;
  302. }
  303. clnt->cl_rtt = &clnt->cl_rtt_default;
  304. rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
  305. clnt->cl_principal = NULL;
  306. if (args->client_name) {
  307. clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
  308. if (!clnt->cl_principal)
  309. goto out_no_principal;
  310. }
  311. atomic_set(&clnt->cl_count, 1);
  312. err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
  313. if (err < 0)
  314. goto out_no_path;
  315. auth = rpcauth_create(args->authflavor, clnt);
  316. if (IS_ERR(auth)) {
  317. printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
  318. args->authflavor);
  319. err = PTR_ERR(auth);
  320. goto out_no_auth;
  321. }
  322. /* save the nodename */
  323. rpc_clnt_set_nodename(clnt, utsname()->nodename);
  324. rpc_register_client(clnt);
  325. return clnt;
  326. out_no_auth:
  327. rpc_clnt_remove_pipedir(clnt);
  328. out_no_path:
  329. kfree(clnt->cl_principal);
  330. out_no_principal:
  331. rpc_free_iostats(clnt->cl_metrics);
  332. out_no_stats:
  333. kfree(clnt);
  334. out_err:
  335. xprt_put(xprt);
  336. out_no_xprt:
  337. rpciod_down();
  338. out_no_rpciod:
  339. return ERR_PTR(err);
  340. }
  341. /**
  342. * rpc_create - create an RPC client and transport with one call
  343. * @args: rpc_clnt create argument structure
  344. *
  345. * Creates and initializes an RPC transport and an RPC client.
  346. *
  347. * It can ping the server in order to determine if it is up, and to see if
  348. * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
  349. * this behavior so asynchronous tasks can also use rpc_create.
  350. */
  351. struct rpc_clnt *rpc_create(struct rpc_create_args *args)
  352. {
  353. struct rpc_xprt *xprt;
  354. struct rpc_clnt *clnt;
  355. struct xprt_create xprtargs = {
  356. .net = args->net,
  357. .ident = args->protocol,
  358. .srcaddr = args->saddress,
  359. .dstaddr = args->address,
  360. .addrlen = args->addrsize,
  361. .servername = args->servername,
  362. .bc_xprt = args->bc_xprt,
  363. };
  364. char servername[48];
  365. /*
  366. * If the caller chooses not to specify a hostname, whip
  367. * up a string representation of the passed-in address.
  368. */
  369. if (xprtargs.servername == NULL) {
  370. struct sockaddr_un *sun =
  371. (struct sockaddr_un *)args->address;
  372. struct sockaddr_in *sin =
  373. (struct sockaddr_in *)args->address;
  374. struct sockaddr_in6 *sin6 =
  375. (struct sockaddr_in6 *)args->address;
  376. servername[0] = '\0';
  377. switch (args->address->sa_family) {
  378. case AF_LOCAL:
  379. snprintf(servername, sizeof(servername), "%s",
  380. sun->sun_path);
  381. break;
  382. case AF_INET:
  383. snprintf(servername, sizeof(servername), "%pI4",
  384. &sin->sin_addr.s_addr);
  385. break;
  386. case AF_INET6:
  387. snprintf(servername, sizeof(servername), "%pI6",
  388. &sin6->sin6_addr);
  389. break;
  390. default:
  391. /* caller wants default server name, but
  392. * address family isn't recognized. */
  393. return ERR_PTR(-EINVAL);
  394. }
  395. xprtargs.servername = servername;
  396. }
  397. xprt = xprt_create_transport(&xprtargs);
  398. if (IS_ERR(xprt))
  399. return (struct rpc_clnt *)xprt;
  400. /*
  401. * By default, kernel RPC client connects from a reserved port.
  402. * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
  403. * but it is always enabled for rpciod, which handles the connect
  404. * operation.
  405. */
  406. xprt->resvport = 1;
  407. if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
  408. xprt->resvport = 0;
  409. clnt = rpc_new_client(args, xprt);
  410. if (IS_ERR(clnt))
  411. return clnt;
  412. if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
  413. int err = rpc_ping(clnt);
  414. if (err != 0) {
  415. rpc_shutdown_client(clnt);
  416. return ERR_PTR(err);
  417. }
  418. }
  419. clnt->cl_softrtry = 1;
  420. if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
  421. clnt->cl_softrtry = 0;
  422. if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
  423. clnt->cl_autobind = 1;
  424. if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
  425. clnt->cl_discrtry = 1;
  426. if (!(args->flags & RPC_CLNT_CREATE_QUIET))
  427. clnt->cl_chatty = 1;
  428. return clnt;
  429. }
  430. EXPORT_SYMBOL_GPL(rpc_create);
  431. /*
  432. * This function clones the RPC client structure. It allows us to share the
  433. * same transport while varying parameters such as the authentication
  434. * flavour.
  435. */
  436. static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
  437. struct rpc_clnt *clnt)
  438. {
  439. struct rpc_xprt *xprt;
  440. struct rpc_clnt *new;
  441. int err;
  442. err = -ENOMEM;
  443. rcu_read_lock();
  444. xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
  445. rcu_read_unlock();
  446. if (xprt == NULL)
  447. goto out_err;
  448. args->servername = xprt->servername;
  449. new = rpc_new_client(args, xprt);
  450. if (IS_ERR(new)) {
  451. err = PTR_ERR(new);
  452. goto out_put;
  453. }
  454. atomic_inc(&clnt->cl_count);
  455. new->cl_parent = clnt;
  456. /* Turn off autobind on clones */
  457. new->cl_autobind = 0;
  458. new->cl_softrtry = clnt->cl_softrtry;
  459. new->cl_discrtry = clnt->cl_discrtry;
  460. new->cl_chatty = clnt->cl_chatty;
  461. return new;
  462. out_put:
  463. xprt_put(xprt);
  464. out_err:
  465. dprintk("RPC: %s: returned error %d\n", __func__, err);
  466. return ERR_PTR(err);
  467. }
  468. /**
  469. * rpc_clone_client - Clone an RPC client structure
  470. *
  471. * @clnt: RPC client whose parameters are copied
  472. *
  473. * Returns a fresh RPC client or an ERR_PTR.
  474. */
  475. struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
  476. {
  477. struct rpc_create_args args = {
  478. .program = clnt->cl_program,
  479. .prognumber = clnt->cl_prog,
  480. .version = clnt->cl_vers,
  481. .authflavor = clnt->cl_auth->au_flavor,
  482. .client_name = clnt->cl_principal,
  483. };
  484. return __rpc_clone_client(&args, clnt);
  485. }
  486. EXPORT_SYMBOL_GPL(rpc_clone_client);
  487. /**
  488. * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
  489. *
  490. * @clnt: RPC client whose parameters are copied
  491. * @auth: security flavor for new client
  492. *
  493. * Returns a fresh RPC client or an ERR_PTR.
  494. */
  495. struct rpc_clnt *
  496. rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
  497. {
  498. struct rpc_create_args args = {
  499. .program = clnt->cl_program,
  500. .prognumber = clnt->cl_prog,
  501. .version = clnt->cl_vers,
  502. .authflavor = flavor,
  503. .client_name = clnt->cl_principal,
  504. };
  505. return __rpc_clone_client(&args, clnt);
  506. }
  507. EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
  508. /*
  509. * Kill all tasks for the given client.
  510. * XXX: kill their descendants as well?
  511. */
  512. void rpc_killall_tasks(struct rpc_clnt *clnt)
  513. {
  514. struct rpc_task *rovr;
  515. if (list_empty(&clnt->cl_tasks))
  516. return;
  517. dprintk("RPC: killing all tasks for client %p\n", clnt);
  518. /*
  519. * Spin lock all_tasks to prevent changes...
  520. */
  521. spin_lock(&clnt->cl_lock);
  522. list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
  523. if (!RPC_IS_ACTIVATED(rovr))
  524. continue;
  525. if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
  526. rovr->tk_flags |= RPC_TASK_KILLED;
  527. rpc_exit(rovr, -EIO);
  528. if (RPC_IS_QUEUED(rovr))
  529. rpc_wake_up_queued_task(rovr->tk_waitqueue,
  530. rovr);
  531. }
  532. }
  533. spin_unlock(&clnt->cl_lock);
  534. }
  535. EXPORT_SYMBOL_GPL(rpc_killall_tasks);
  536. /*
  537. * Properly shut down an RPC client, terminating all outstanding
  538. * requests.
  539. */
  540. void rpc_shutdown_client(struct rpc_clnt *clnt)
  541. {
  542. /*
  543. * To avoid deadlock, never call rpc_shutdown_client from a
  544. * workqueue context!
  545. */
  546. WARN_ON_ONCE(current->flags & PF_WQ_WORKER);
  547. might_sleep();
  548. dprintk_rcu("RPC: shutting down %s client for %s\n",
  549. clnt->cl_protname,
  550. rcu_dereference(clnt->cl_xprt)->servername);
  551. while (!list_empty(&clnt->cl_tasks)) {
  552. rpc_killall_tasks(clnt);
  553. wait_event_timeout(destroy_wait,
  554. list_empty(&clnt->cl_tasks), 1*HZ);
  555. }
  556. rpc_release_client(clnt);
  557. }
  558. EXPORT_SYMBOL_GPL(rpc_shutdown_client);
  559. /*
  560. * Free an RPC client
  561. */
  562. static void
  563. rpc_free_client(struct rpc_clnt *clnt)
  564. {
  565. dprintk_rcu("RPC: destroying %s client for %s\n",
  566. clnt->cl_protname,
  567. rcu_dereference(clnt->cl_xprt)->servername);
  568. if (clnt->cl_parent != clnt)
  569. rpc_release_client(clnt->cl_parent);
  570. rpc_unregister_client(clnt);
  571. rpc_clnt_remove_pipedir(clnt);
  572. rpc_free_iostats(clnt->cl_metrics);
  573. kfree(clnt->cl_principal);
  574. clnt->cl_metrics = NULL;
  575. xprt_put(rcu_dereference_raw(clnt->cl_xprt));
  576. rpciod_down();
  577. kfree(clnt);
  578. }
  579. /*
  580. * Free an RPC client
  581. */
  582. static void
  583. rpc_free_auth(struct rpc_clnt *clnt)
  584. {
  585. if (clnt->cl_auth == NULL) {
  586. rpc_free_client(clnt);
  587. return;
  588. }
  589. /*
  590. * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
  591. * release remaining GSS contexts. This mechanism ensures
  592. * that it can do so safely.
  593. */
  594. atomic_inc(&clnt->cl_count);
  595. rpcauth_release(clnt->cl_auth);
  596. clnt->cl_auth = NULL;
  597. if (atomic_dec_and_test(&clnt->cl_count))
  598. rpc_free_client(clnt);
  599. }
  600. /*
  601. * Release reference to the RPC client
  602. */
  603. void
  604. rpc_release_client(struct rpc_clnt *clnt)
  605. {
  606. dprintk("RPC: rpc_release_client(%p)\n", clnt);
  607. if (list_empty(&clnt->cl_tasks))
  608. wake_up(&destroy_wait);
  609. if (atomic_dec_and_test(&clnt->cl_count))
  610. rpc_free_auth(clnt);
  611. }
  612. /**
  613. * rpc_bind_new_program - bind a new RPC program to an existing client
  614. * @old: old rpc_client
  615. * @program: rpc program to set
  616. * @vers: rpc program version
  617. *
  618. * Clones the rpc client and sets up a new RPC program. This is mainly
  619. * of use for enabling different RPC programs to share the same transport.
  620. * The Sun NFSv2/v3 ACL protocol can do this.
  621. */
  622. struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
  623. const struct rpc_program *program,
  624. u32 vers)
  625. {
  626. struct rpc_create_args args = {
  627. .program = program,
  628. .prognumber = program->number,
  629. .version = vers,
  630. .authflavor = old->cl_auth->au_flavor,
  631. .client_name = old->cl_principal,
  632. };
  633. struct rpc_clnt *clnt;
  634. int err;
  635. clnt = __rpc_clone_client(&args, old);
  636. if (IS_ERR(clnt))
  637. goto out;
  638. err = rpc_ping(clnt);
  639. if (err != 0) {
  640. rpc_shutdown_client(clnt);
  641. clnt = ERR_PTR(err);
  642. }
  643. out:
  644. return clnt;
  645. }
  646. EXPORT_SYMBOL_GPL(rpc_bind_new_program);
  647. void rpc_task_release_client(struct rpc_task *task)
  648. {
  649. struct rpc_clnt *clnt = task->tk_client;
  650. if (clnt != NULL) {
  651. /* Remove from client task list */
  652. spin_lock(&clnt->cl_lock);
  653. list_del(&task->tk_task);
  654. spin_unlock(&clnt->cl_lock);
  655. task->tk_client = NULL;
  656. rpc_release_client(clnt);
  657. }
  658. }
  659. static
  660. void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
  661. {
  662. if (clnt != NULL) {
  663. rpc_task_release_client(task);
  664. task->tk_client = clnt;
  665. atomic_inc(&clnt->cl_count);
  666. if (clnt->cl_softrtry)
  667. task->tk_flags |= RPC_TASK_SOFT;
  668. if (sk_memalloc_socks()) {
  669. struct rpc_xprt *xprt;
  670. rcu_read_lock();
  671. xprt = rcu_dereference(clnt->cl_xprt);
  672. if (xprt->swapper)
  673. task->tk_flags |= RPC_TASK_SWAPPER;
  674. rcu_read_unlock();
  675. }
  676. /* Add to the client's list of all tasks */
  677. spin_lock(&clnt->cl_lock);
  678. list_add_tail(&task->tk_task, &clnt->cl_tasks);
  679. spin_unlock(&clnt->cl_lock);
  680. }
  681. }
  682. void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
  683. {
  684. rpc_task_release_client(task);
  685. rpc_task_set_client(task, clnt);
  686. }
  687. EXPORT_SYMBOL_GPL(rpc_task_reset_client);
  688. static void
  689. rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
  690. {
  691. if (msg != NULL) {
  692. task->tk_msg.rpc_proc = msg->rpc_proc;
  693. task->tk_msg.rpc_argp = msg->rpc_argp;
  694. task->tk_msg.rpc_resp = msg->rpc_resp;
  695. if (msg->rpc_cred != NULL)
  696. task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
  697. }
  698. }
  699. /*
  700. * Default callback for async RPC calls
  701. */
  702. static void
  703. rpc_default_callback(struct rpc_task *task, void *data)
  704. {
  705. }
  706. static const struct rpc_call_ops rpc_default_ops = {
  707. .rpc_call_done = rpc_default_callback,
  708. };
  709. /**
  710. * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
  711. * @task_setup_data: pointer to task initialisation data
  712. */
  713. struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
  714. {
  715. struct rpc_task *task;
  716. task = rpc_new_task(task_setup_data);
  717. if (IS_ERR(task))
  718. goto out;
  719. rpc_task_set_client(task, task_setup_data->rpc_client);
  720. rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
  721. if (task->tk_action == NULL)
  722. rpc_call_start(task);
  723. atomic_inc(&task->tk_count);
  724. rpc_execute(task);
  725. out:
  726. return task;
  727. }
  728. EXPORT_SYMBOL_GPL(rpc_run_task);
  729. /**
  730. * rpc_call_sync - Perform a synchronous RPC call
  731. * @clnt: pointer to RPC client
  732. * @msg: RPC call parameters
  733. * @flags: RPC call flags
  734. */
  735. int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
  736. {
  737. struct rpc_task *task;
  738. struct rpc_task_setup task_setup_data = {
  739. .rpc_client = clnt,
  740. .rpc_message = msg,
  741. .callback_ops = &rpc_default_ops,
  742. .flags = flags,
  743. };
  744. int status;
  745. WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
  746. if (flags & RPC_TASK_ASYNC) {
  747. rpc_release_calldata(task_setup_data.callback_ops,
  748. task_setup_data.callback_data);
  749. return -EINVAL;
  750. }
  751. task = rpc_run_task(&task_setup_data);
  752. if (IS_ERR(task))
  753. return PTR_ERR(task);
  754. status = task->tk_status;
  755. rpc_put_task(task);
  756. return status;
  757. }
  758. EXPORT_SYMBOL_GPL(rpc_call_sync);
  759. /**
  760. * rpc_call_async - Perform an asynchronous RPC call
  761. * @clnt: pointer to RPC client
  762. * @msg: RPC call parameters
  763. * @flags: RPC call flags
  764. * @tk_ops: RPC call ops
  765. * @data: user call data
  766. */
  767. int
  768. rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
  769. const struct rpc_call_ops *tk_ops, void *data)
  770. {
  771. struct rpc_task *task;
  772. struct rpc_task_setup task_setup_data = {
  773. .rpc_client = clnt,
  774. .rpc_message = msg,
  775. .callback_ops = tk_ops,
  776. .callback_data = data,
  777. .flags = flags|RPC_TASK_ASYNC,
  778. };
  779. task = rpc_run_task(&task_setup_data);
  780. if (IS_ERR(task))
  781. return PTR_ERR(task);
  782. rpc_put_task(task);
  783. return 0;
  784. }
  785. EXPORT_SYMBOL_GPL(rpc_call_async);
  786. #if defined(CONFIG_SUNRPC_BACKCHANNEL)
  787. /**
  788. * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
  789. * rpc_execute against it
  790. * @req: RPC request
  791. * @tk_ops: RPC call ops
  792. */
  793. struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
  794. const struct rpc_call_ops *tk_ops)
  795. {
  796. struct rpc_task *task;
  797. struct xdr_buf *xbufp = &req->rq_snd_buf;
  798. struct rpc_task_setup task_setup_data = {
  799. .callback_ops = tk_ops,
  800. };
  801. dprintk("RPC: rpc_run_bc_task req= %p\n", req);
  802. /*
  803. * Create an rpc_task to send the data
  804. */
  805. task = rpc_new_task(&task_setup_data);
  806. if (IS_ERR(task)) {
  807. xprt_free_bc_request(req);
  808. goto out;
  809. }
  810. task->tk_rqstp = req;
  811. /*
  812. * Set up the xdr_buf length.
  813. * This also indicates that the buffer is XDR encoded already.
  814. */
  815. xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
  816. xbufp->tail[0].iov_len;
  817. task->tk_action = call_bc_transmit;
  818. atomic_inc(&task->tk_count);
  819. WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
  820. rpc_execute(task);
  821. out:
  822. dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
  823. return task;
  824. }
  825. #endif /* CONFIG_SUNRPC_BACKCHANNEL */
  826. void
  827. rpc_call_start(struct rpc_task *task)
  828. {
  829. task->tk_action = call_start;
  830. }
  831. EXPORT_SYMBOL_GPL(rpc_call_start);
  832. /**
  833. * rpc_peeraddr - extract remote peer address from clnt's xprt
  834. * @clnt: RPC client structure
  835. * @buf: target buffer
  836. * @bufsize: length of target buffer
  837. *
  838. * Returns the number of bytes that are actually in the stored address.
  839. */
  840. size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
  841. {
  842. size_t bytes;
  843. struct rpc_xprt *xprt;
  844. rcu_read_lock();
  845. xprt = rcu_dereference(clnt->cl_xprt);
  846. bytes = xprt->addrlen;
  847. if (bytes > bufsize)
  848. bytes = bufsize;
  849. memcpy(buf, &xprt->addr, bytes);
  850. rcu_read_unlock();
  851. return bytes;
  852. }
  853. EXPORT_SYMBOL_GPL(rpc_peeraddr);
  854. /**
  855. * rpc_peeraddr2str - return remote peer address in printable format
  856. * @clnt: RPC client structure
  857. * @format: address format
  858. *
  859. * NB: the lifetime of the memory referenced by the returned pointer is
  860. * the same as the rpc_xprt itself. As long as the caller uses this
  861. * pointer, it must hold the RCU read lock.
  862. */
  863. const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
  864. enum rpc_display_format_t format)
  865. {
  866. struct rpc_xprt *xprt;
  867. xprt = rcu_dereference(clnt->cl_xprt);
  868. if (xprt->address_strings[format] != NULL)
  869. return xprt->address_strings[format];
  870. else
  871. return "unprintable";
  872. }
  873. EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
  874. static const struct sockaddr_in rpc_inaddr_loopback = {
  875. .sin_family = AF_INET,
  876. .sin_addr.s_addr = htonl(INADDR_ANY),
  877. };
  878. static const struct sockaddr_in6 rpc_in6addr_loopback = {
  879. .sin6_family = AF_INET6,
  880. .sin6_addr = IN6ADDR_ANY_INIT,
  881. };
  882. /*
  883. * Try a getsockname() on a connected datagram socket. Using a
  884. * connected datagram socket prevents leaving a socket in TIME_WAIT.
  885. * This conserves the ephemeral port number space.
  886. *
  887. * Returns zero and fills in "buf" if successful; otherwise, a
  888. * negative errno is returned.
  889. */
  890. static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
  891. struct sockaddr *buf, int buflen)
  892. {
  893. struct socket *sock;
  894. int err;
  895. err = __sock_create(net, sap->sa_family,
  896. SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
  897. if (err < 0) {
  898. dprintk("RPC: can't create UDP socket (%d)\n", err);
  899. goto out;
  900. }
  901. switch (sap->sa_family) {
  902. case AF_INET:
  903. err = kernel_bind(sock,
  904. (struct sockaddr *)&rpc_inaddr_loopback,
  905. sizeof(rpc_inaddr_loopback));
  906. break;
  907. case AF_INET6:
  908. err = kernel_bind(sock,
  909. (struct sockaddr *)&rpc_in6addr_loopback,
  910. sizeof(rpc_in6addr_loopback));
  911. break;
  912. default:
  913. err = -EAFNOSUPPORT;
  914. goto out;
  915. }
  916. if (err < 0) {
  917. dprintk("RPC: can't bind UDP socket (%d)\n", err);
  918. goto out_release;
  919. }
  920. err = kernel_connect(sock, sap, salen, 0);
  921. if (err < 0) {
  922. dprintk("RPC: can't connect UDP socket (%d)\n", err);
  923. goto out_release;
  924. }
  925. err = kernel_getsockname(sock, buf, &buflen);
  926. if (err < 0) {
  927. dprintk("RPC: getsockname failed (%d)\n", err);
  928. goto out_release;
  929. }
  930. err = 0;
  931. if (buf->sa_family == AF_INET6) {
  932. struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
  933. sin6->sin6_scope_id = 0;
  934. }
  935. dprintk("RPC: %s succeeded\n", __func__);
  936. out_release:
  937. sock_release(sock);
  938. out:
  939. return err;
  940. }
  941. /*
  942. * Scraping a connected socket failed, so we don't have a useable
  943. * local address. Fallback: generate an address that will prevent
  944. * the server from calling us back.
  945. *
  946. * Returns zero and fills in "buf" if successful; otherwise, a
  947. * negative errno is returned.
  948. */
  949. static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
  950. {
  951. switch (family) {
  952. case AF_INET:
  953. if (buflen < sizeof(rpc_inaddr_loopback))
  954. return -EINVAL;
  955. memcpy(buf, &rpc_inaddr_loopback,
  956. sizeof(rpc_inaddr_loopback));
  957. break;
  958. case AF_INET6:
  959. if (buflen < sizeof(rpc_in6addr_loopback))
  960. return -EINVAL;
  961. memcpy(buf, &rpc_in6addr_loopback,
  962. sizeof(rpc_in6addr_loopback));
  963. default:
  964. dprintk("RPC: %s: address family not supported\n",
  965. __func__);
  966. return -EAFNOSUPPORT;
  967. }
  968. dprintk("RPC: %s: succeeded\n", __func__);
  969. return 0;
  970. }
  971. /**
  972. * rpc_localaddr - discover local endpoint address for an RPC client
  973. * @clnt: RPC client structure
  974. * @buf: target buffer
  975. * @buflen: size of target buffer, in bytes
  976. *
  977. * Returns zero and fills in "buf" and "buflen" if successful;
  978. * otherwise, a negative errno is returned.
  979. *
  980. * This works even if the underlying transport is not currently connected,
  981. * or if the upper layer never previously provided a source address.
  982. *
  983. * The result of this function call is transient: multiple calls in
  984. * succession may give different results, depending on how local
  985. * networking configuration changes over time.
  986. */
  987. int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
  988. {
  989. struct sockaddr_storage address;
  990. struct sockaddr *sap = (struct sockaddr *)&address;
  991. struct rpc_xprt *xprt;
  992. struct net *net;
  993. size_t salen;
  994. int err;
  995. rcu_read_lock();
  996. xprt = rcu_dereference(clnt->cl_xprt);
  997. salen = xprt->addrlen;
  998. memcpy(sap, &xprt->addr, salen);
  999. net = get_net(xprt->xprt_net);
  1000. rcu_read_unlock();
  1001. rpc_set_port(sap, 0);
  1002. err = rpc_sockname(net, sap, salen, buf, buflen);
  1003. put_net(net);
  1004. if (err != 0)
  1005. /* Couldn't discover local address, return ANYADDR */
  1006. return rpc_anyaddr(sap->sa_family, buf, buflen);
  1007. return 0;
  1008. }
  1009. EXPORT_SYMBOL_GPL(rpc_localaddr);
  1010. void
  1011. rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
  1012. {
  1013. struct rpc_xprt *xprt;
  1014. rcu_read_lock();
  1015. xprt = rcu_dereference(clnt->cl_xprt);
  1016. if (xprt->ops->set_buffer_size)
  1017. xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
  1018. rcu_read_unlock();
  1019. }
  1020. EXPORT_SYMBOL_GPL(rpc_setbufsize);
  1021. /**
  1022. * rpc_protocol - Get transport protocol number for an RPC client
  1023. * @clnt: RPC client to query
  1024. *
  1025. */
  1026. int rpc_protocol(struct rpc_clnt *clnt)
  1027. {
  1028. int protocol;
  1029. rcu_read_lock();
  1030. protocol = rcu_dereference(clnt->cl_xprt)->prot;
  1031. rcu_read_unlock();
  1032. return protocol;
  1033. }
  1034. EXPORT_SYMBOL_GPL(rpc_protocol);
  1035. /**
  1036. * rpc_net_ns - Get the network namespace for this RPC client
  1037. * @clnt: RPC client to query
  1038. *
  1039. */
  1040. struct net *rpc_net_ns(struct rpc_clnt *clnt)
  1041. {
  1042. struct net *ret;
  1043. rcu_read_lock();
  1044. ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
  1045. rcu_read_unlock();
  1046. return ret;
  1047. }
  1048. EXPORT_SYMBOL_GPL(rpc_net_ns);
  1049. /**
  1050. * rpc_max_payload - Get maximum payload size for a transport, in bytes
  1051. * @clnt: RPC client to query
  1052. *
  1053. * For stream transports, this is one RPC record fragment (see RFC
  1054. * 1831), as we don't support multi-record requests yet. For datagram
  1055. * transports, this is the size of an IP packet minus the IP, UDP, and
  1056. * RPC header sizes.
  1057. */
  1058. size_t rpc_max_payload(struct rpc_clnt *clnt)
  1059. {
  1060. size_t ret;
  1061. rcu_read_lock();
  1062. ret = rcu_dereference(clnt->cl_xprt)->max_payload;
  1063. rcu_read_unlock();
  1064. return ret;
  1065. }
  1066. EXPORT_SYMBOL_GPL(rpc_max_payload);
  1067. /**
  1068. * rpc_force_rebind - force transport to check that remote port is unchanged
  1069. * @clnt: client to rebind
  1070. *
  1071. */
  1072. void rpc_force_rebind(struct rpc_clnt *clnt)
  1073. {
  1074. if (clnt->cl_autobind) {
  1075. rcu_read_lock();
  1076. xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
  1077. rcu_read_unlock();
  1078. }
  1079. }
  1080. EXPORT_SYMBOL_GPL(rpc_force_rebind);
  1081. /*
  1082. * Restart an (async) RPC call from the call_prepare state.
  1083. * Usually called from within the exit handler.
  1084. */
  1085. int
  1086. rpc_restart_call_prepare(struct rpc_task *task)
  1087. {
  1088. if (RPC_ASSASSINATED(task))
  1089. return 0;
  1090. task->tk_action = call_start;
  1091. if (task->tk_ops->rpc_call_prepare != NULL)
  1092. task->tk_action = rpc_prepare_task;
  1093. return 1;
  1094. }
  1095. EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
  1096. /*
  1097. * Restart an (async) RPC call. Usually called from within the
  1098. * exit handler.
  1099. */
  1100. int
  1101. rpc_restart_call(struct rpc_task *task)
  1102. {
  1103. if (RPC_ASSASSINATED(task))
  1104. return 0;
  1105. task->tk_action = call_start;
  1106. return 1;
  1107. }
  1108. EXPORT_SYMBOL_GPL(rpc_restart_call);
  1109. #ifdef RPC_DEBUG
  1110. static const char *rpc_proc_name(const struct rpc_task *task)
  1111. {
  1112. const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
  1113. if (proc) {
  1114. if (proc->p_name)
  1115. return proc->p_name;
  1116. else
  1117. return "NULL";
  1118. } else
  1119. return "no proc";
  1120. }
  1121. #endif
  1122. /*
  1123. * 0. Initial state
  1124. *
  1125. * Other FSM states can be visited zero or more times, but
  1126. * this state is visited exactly once for each RPC.
  1127. */
  1128. static void
  1129. call_start(struct rpc_task *task)
  1130. {
  1131. struct rpc_clnt *clnt = task->tk_client;
  1132. dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
  1133. clnt->cl_protname, clnt->cl_vers,
  1134. rpc_proc_name(task),
  1135. (RPC_IS_ASYNC(task) ? "async" : "sync"));
  1136. /* Increment call count */
  1137. task->tk_msg.rpc_proc->p_count++;
  1138. clnt->cl_stats->rpccnt++;
  1139. task->tk_action = call_reserve;
  1140. }
  1141. /*
  1142. * 1. Reserve an RPC call slot
  1143. */
  1144. static void
  1145. call_reserve(struct rpc_task *task)
  1146. {
  1147. dprint_status(task);
  1148. task->tk_status = 0;
  1149. task->tk_action = call_reserveresult;
  1150. xprt_reserve(task);
  1151. }
  1152. /*
  1153. * 1b. Grok the result of xprt_reserve()
  1154. */
  1155. static void
  1156. call_reserveresult(struct rpc_task *task)
  1157. {
  1158. int status = task->tk_status;
  1159. dprint_status(task);
  1160. /*
  1161. * After a call to xprt_reserve(), we must have either
  1162. * a request slot or else an error status.
  1163. */
  1164. task->tk_status = 0;
  1165. if (status >= 0) {
  1166. if (task->tk_rqstp) {
  1167. task->tk_action = call_refresh;
  1168. return;
  1169. }
  1170. printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
  1171. __func__, status);
  1172. rpc_exit(task, -EIO);
  1173. return;
  1174. }
  1175. /*
  1176. * Even though there was an error, we may have acquired
  1177. * a request slot somehow. Make sure not to leak it.
  1178. */
  1179. if (task->tk_rqstp) {
  1180. printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
  1181. __func__, status);
  1182. xprt_release(task);
  1183. }
  1184. switch (status) {
  1185. case -ENOMEM:
  1186. rpc_delay(task, HZ >> 2);
  1187. case -EAGAIN: /* woken up; retry */
  1188. task->tk_action = call_reserve;
  1189. return;
  1190. case -EIO: /* probably a shutdown */
  1191. break;
  1192. default:
  1193. printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
  1194. __func__, status);
  1195. break;
  1196. }
  1197. rpc_exit(task, status);
  1198. }
  1199. /*
  1200. * 2. Bind and/or refresh the credentials
  1201. */
  1202. static void
  1203. call_refresh(struct rpc_task *task)
  1204. {
  1205. dprint_status(task);
  1206. task->tk_action = call_refreshresult;
  1207. task->tk_status = 0;
  1208. task->tk_client->cl_stats->rpcauthrefresh++;
  1209. rpcauth_refreshcred(task);
  1210. }
  1211. /*
  1212. * 2a. Process the results of a credential refresh
  1213. */
  1214. static void
  1215. call_refreshresult(struct rpc_task *task)
  1216. {
  1217. int status = task->tk_status;
  1218. dprint_status(task);
  1219. task->tk_status = 0;
  1220. task->tk_action = call_refresh;
  1221. switch (status) {
  1222. case 0:
  1223. if (rpcauth_uptodatecred(task))
  1224. task->tk_action = call_allocate;
  1225. return;
  1226. case -ETIMEDOUT:
  1227. rpc_delay(task, 3*HZ);
  1228. case -EAGAIN:
  1229. status = -EACCES;
  1230. if (!task->tk_cred_retry)
  1231. break;
  1232. task->tk_cred_retry--;
  1233. dprintk("RPC: %5u %s: retry refresh creds\n",
  1234. task->tk_pid, __func__);
  1235. return;
  1236. }
  1237. dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
  1238. task->tk_pid, __func__, status);
  1239. rpc_exit(task, status);
  1240. }
  1241. /*
  1242. * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
  1243. * (Note: buffer memory is freed in xprt_release).
  1244. */
  1245. static void
  1246. call_allocate(struct rpc_task *task)
  1247. {
  1248. unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
  1249. struct rpc_rqst *req = task->tk_rqstp;
  1250. struct rpc_xprt *xprt = task->tk_xprt;
  1251. struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
  1252. dprint_status(task);
  1253. task->tk_status = 0;
  1254. task->tk_action = call_bind;
  1255. if (req->rq_buffer)
  1256. return;
  1257. if (proc->p_proc != 0) {
  1258. BUG_ON(proc->p_arglen == 0);
  1259. if (proc->p_decode != NULL)
  1260. BUG_ON(proc->p_replen == 0);
  1261. }
  1262. /*
  1263. * Calculate the size (in quads) of the RPC call
  1264. * and reply headers, and convert both values
  1265. * to byte sizes.
  1266. */
  1267. req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
  1268. req->rq_callsize <<= 2;
  1269. req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
  1270. req->rq_rcvsize <<= 2;
  1271. req->rq_buffer = xprt->ops->buf_alloc(task,
  1272. req->rq_callsize + req->rq_rcvsize);
  1273. if (req->rq_buffer != NULL)
  1274. return;
  1275. dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
  1276. if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
  1277. task->tk_action = call_allocate;
  1278. rpc_delay(task, HZ>>4);
  1279. return;
  1280. }
  1281. rpc_exit(task, -ERESTARTSYS);
  1282. }
  1283. static inline int
  1284. rpc_task_need_encode(struct rpc_task *task)
  1285. {
  1286. return task->tk_rqstp->rq_snd_buf.len == 0;
  1287. }
  1288. static inline void
  1289. rpc_task_force_reencode(struct rpc_task *task)
  1290. {
  1291. task->tk_rqstp->rq_snd_buf.len = 0;
  1292. task->tk_rqstp->rq_bytes_sent = 0;
  1293. }
  1294. static inline void
  1295. rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
  1296. {
  1297. buf->head[0].iov_base = start;
  1298. buf->head[0].iov_len = len;
  1299. buf->tail[0].iov_len = 0;
  1300. buf->page_len = 0;
  1301. buf->flags = 0;
  1302. buf->len = 0;
  1303. buf->buflen = len;
  1304. }
  1305. /*
  1306. * 3. Encode arguments of an RPC call
  1307. */
  1308. static void
  1309. rpc_xdr_encode(struct rpc_task *task)
  1310. {
  1311. struct rpc_rqst *req = task->tk_rqstp;
  1312. kxdreproc_t encode;
  1313. __be32 *p;
  1314. dprint_status(task);
  1315. rpc_xdr_buf_init(&req->rq_snd_buf,
  1316. req->rq_buffer,
  1317. req->rq_callsize);
  1318. rpc_xdr_buf_init(&req->rq_rcv_buf,
  1319. (char *)req->rq_buffer + req->rq_callsize,
  1320. req->rq_rcvsize);
  1321. p = rpc_encode_header(task);
  1322. if (p == NULL) {
  1323. printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
  1324. rpc_exit(task, -EIO);
  1325. return;
  1326. }
  1327. encode = task->tk_msg.rpc_proc->p_encode;
  1328. if (encode == NULL)
  1329. return;
  1330. task->tk_status = rpcauth_wrap_req(task, encode, req, p,
  1331. task->tk_msg.rpc_argp);
  1332. }
  1333. /*
  1334. * 4. Get the server port number if not yet set
  1335. */
  1336. static void
  1337. call_bind(struct rpc_task *task)
  1338. {
  1339. struct rpc_xprt *xprt = task->tk_xprt;
  1340. dprint_status(task);
  1341. task->tk_action = call_connect;
  1342. if (!xprt_bound(xprt)) {
  1343. task->tk_action = call_bind_status;
  1344. task->tk_timeout = xprt->bind_timeout;
  1345. xprt->ops->rpcbind(task);
  1346. }
  1347. }
  1348. /*
  1349. * 4a. Sort out bind result
  1350. */
  1351. static void
  1352. call_bind_status(struct rpc_task *task)
  1353. {
  1354. int status = -EIO;
  1355. if (task->tk_status >= 0) {
  1356. dprint_status(task);
  1357. task->tk_status = 0;
  1358. task->tk_action = call_connect;
  1359. return;
  1360. }
  1361. trace_rpc_bind_status(task);
  1362. switch (task->tk_status) {
  1363. case -ENOMEM:
  1364. dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
  1365. rpc_delay(task, HZ >> 2);
  1366. goto retry_timeout;
  1367. case -EACCES:
  1368. dprintk("RPC: %5u remote rpcbind: RPC program/version "
  1369. "unavailable\n", task->tk_pid);
  1370. /* fail immediately if this is an RPC ping */
  1371. if (task->tk_msg.rpc_proc->p_proc == 0) {
  1372. status = -EOPNOTSUPP;
  1373. break;
  1374. }
  1375. if (task->tk_rebind_retry == 0)
  1376. break;
  1377. task->tk_rebind_retry--;
  1378. rpc_delay(task, 3*HZ);
  1379. goto retry_timeout;
  1380. case -ETIMEDOUT:
  1381. dprintk("RPC: %5u rpcbind request timed out\n",
  1382. task->tk_pid);
  1383. goto retry_timeout;
  1384. case -EPFNOSUPPORT:
  1385. /* server doesn't support any rpcbind version we know of */
  1386. dprintk("RPC: %5u unrecognized remote rpcbind service\n",
  1387. task->tk_pid);
  1388. break;
  1389. case -EPROTONOSUPPORT:
  1390. dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
  1391. task->tk_pid);
  1392. task->tk_status = 0;
  1393. task->tk_action = call_bind;
  1394. return;
  1395. case -ECONNREFUSED: /* connection problems */
  1396. case -ECONNRESET:
  1397. case -ENOTCONN:
  1398. case -EHOSTDOWN:
  1399. case -EHOSTUNREACH:
  1400. case -ENETUNREACH:
  1401. case -EPIPE:
  1402. dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
  1403. task->tk_pid, task->tk_status);
  1404. if (!RPC_IS_SOFTCONN(task)) {
  1405. rpc_delay(task, 5*HZ);
  1406. goto retry_timeout;
  1407. }
  1408. status = task->tk_status;
  1409. break;
  1410. default:
  1411. dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
  1412. task->tk_pid, -task->tk_status);
  1413. }
  1414. rpc_exit(task, status);
  1415. return;
  1416. retry_timeout:
  1417. task->tk_action = call_timeout;
  1418. }
  1419. /*
  1420. * 4b. Connect to the RPC server
  1421. */
  1422. static void
  1423. call_connect(struct rpc_task *task)
  1424. {
  1425. struct rpc_xprt *xprt = task->tk_xprt;
  1426. dprintk("RPC: %5u call_connect xprt %p %s connected\n",
  1427. task->tk_pid, xprt,
  1428. (xprt_connected(xprt) ? "is" : "is not"));
  1429. task->tk_action = call_transmit;
  1430. if (!xprt_connected(xprt)) {
  1431. task->tk_action = call_connect_status;
  1432. if (task->tk_status < 0)
  1433. return;
  1434. xprt_connect(task);
  1435. }
  1436. }
  1437. /*
  1438. * 4c. Sort out connect result
  1439. */
  1440. static void
  1441. call_connect_status(struct rpc_task *task)
  1442. {
  1443. struct rpc_clnt *clnt = task->tk_client;
  1444. int status = task->tk_status;
  1445. dprint_status(task);
  1446. task->tk_status = 0;
  1447. if (status >= 0 || status == -EAGAIN) {
  1448. clnt->cl_stats->netreconn++;
  1449. task->tk_action = call_transmit;
  1450. return;
  1451. }
  1452. trace_rpc_connect_status(task, status);
  1453. switch (status) {
  1454. /* if soft mounted, test if we've timed out */
  1455. case -ETIMEDOUT:
  1456. task->tk_action = call_timeout;
  1457. break;
  1458. default:
  1459. rpc_exit(task, -EIO);
  1460. }
  1461. }
  1462. /*
  1463. * 5. Transmit the RPC request, and wait for reply
  1464. */
  1465. static void
  1466. call_transmit(struct rpc_task *task)
  1467. {
  1468. dprint_status(task);
  1469. task->tk_action = call_status;
  1470. if (task->tk_status < 0)
  1471. return;
  1472. task->tk_status = xprt_prepare_transmit(task);
  1473. if (task->tk_status != 0)
  1474. return;
  1475. task->tk_action = call_transmit_status;
  1476. /* Encode here so that rpcsec_gss can use correct sequence number. */
  1477. if (rpc_task_need_encode(task)) {
  1478. rpc_xdr_encode(task);
  1479. /* Did the encode result in an error condition? */
  1480. if (task->tk_status != 0) {
  1481. /* Was the error nonfatal? */
  1482. if (task->tk_status == -EAGAIN)
  1483. rpc_delay(task, HZ >> 4);
  1484. else
  1485. rpc_exit(task, task->tk_status);
  1486. return;
  1487. }
  1488. }
  1489. xprt_transmit(task);
  1490. if (task->tk_status < 0)
  1491. return;
  1492. /*
  1493. * On success, ensure that we call xprt_end_transmit() before sleeping
  1494. * in order to allow access to the socket to other RPC requests.
  1495. */
  1496. call_transmit_status(task);
  1497. if (rpc_reply_expected(task))
  1498. return;
  1499. task->tk_action = rpc_exit_task;
  1500. rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
  1501. }
  1502. /*
  1503. * 5a. Handle cleanup after a transmission
  1504. */
  1505. static void
  1506. call_transmit_status(struct rpc_task *task)
  1507. {
  1508. task->tk_action = call_status;
  1509. /*
  1510. * Common case: success. Force the compiler to put this
  1511. * test first.
  1512. */
  1513. if (task->tk_status == 0) {
  1514. xprt_end_transmit(task);
  1515. rpc_task_force_reencode(task);
  1516. return;
  1517. }
  1518. switch (task->tk_status) {
  1519. case -EAGAIN:
  1520. break;
  1521. default:
  1522. dprint_status(task);
  1523. xprt_end_transmit(task);
  1524. rpc_task_force_reencode(task);
  1525. break;
  1526. /*
  1527. * Special cases: if we've been waiting on the
  1528. * socket's write_space() callback, or if the
  1529. * socket just returned a connection error,
  1530. * then hold onto the transport lock.
  1531. */
  1532. case -ECONNREFUSED:
  1533. case -EHOSTDOWN:
  1534. case -EHOSTUNREACH:
  1535. case -ENETUNREACH:
  1536. if (RPC_IS_SOFTCONN(task)) {
  1537. xprt_end_transmit(task);
  1538. rpc_exit(task, task->tk_status);
  1539. break;
  1540. }
  1541. case -ECONNRESET:
  1542. case -ENOTCONN:
  1543. case -EPIPE:
  1544. rpc_task_force_reencode(task);
  1545. }
  1546. }
  1547. #if defined(CONFIG_SUNRPC_BACKCHANNEL)
  1548. /*
  1549. * 5b. Send the backchannel RPC reply. On error, drop the reply. In
  1550. * addition, disconnect on connectivity errors.
  1551. */
  1552. static void
  1553. call_bc_transmit(struct rpc_task *task)
  1554. {
  1555. struct rpc_rqst *req = task->tk_rqstp;
  1556. task->tk_status = xprt_prepare_transmit(task);
  1557. if (task->tk_status == -EAGAIN) {
  1558. /*
  1559. * Could not reserve the transport. Try again after the
  1560. * transport is released.
  1561. */
  1562. task->tk_status = 0;
  1563. task->tk_action = call_bc_transmit;
  1564. return;
  1565. }
  1566. task->tk_action = rpc_exit_task;
  1567. if (task->tk_status < 0) {
  1568. printk(KERN_NOTICE "RPC: Could not send backchannel reply "
  1569. "error: %d\n", task->tk_status);
  1570. return;
  1571. }
  1572. xprt_transmit(task);
  1573. xprt_end_transmit(task);
  1574. dprint_status(task);
  1575. switch (task->tk_status) {
  1576. case 0:
  1577. /* Success */
  1578. break;
  1579. case -EHOSTDOWN:
  1580. case -EHOSTUNREACH:
  1581. case -ENETUNREACH:
  1582. case -ETIMEDOUT:
  1583. /*
  1584. * Problem reaching the server. Disconnect and let the
  1585. * forechannel reestablish the connection. The server will
  1586. * have to retransmit the backchannel request and we'll
  1587. * reprocess it. Since these ops are idempotent, there's no
  1588. * need to cache our reply at this time.
  1589. */
  1590. printk(KERN_NOTICE "RPC: Could not send backchannel reply "
  1591. "error: %d\n", task->tk_status);
  1592. xprt_conditional_disconnect(task->tk_xprt,
  1593. req->rq_connect_cookie);
  1594. break;
  1595. default:
  1596. /*
  1597. * We were unable to reply and will have to drop the
  1598. * request. The server should reconnect and retransmit.
  1599. */
  1600. WARN_ON_ONCE(task->tk_status == -EAGAIN);
  1601. printk(KERN_NOTICE "RPC: Could not send backchannel reply "
  1602. "error: %d\n", task->tk_status);
  1603. break;
  1604. }
  1605. rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
  1606. }
  1607. #endif /* CONFIG_SUNRPC_BACKCHANNEL */
  1608. /*
  1609. * 6. Sort out the RPC call status
  1610. */
  1611. static void
  1612. call_status(struct rpc_task *task)
  1613. {
  1614. struct rpc_clnt *clnt = task->tk_client;
  1615. struct rpc_rqst *req = task->tk_rqstp;
  1616. int status;
  1617. if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
  1618. task->tk_status = req->rq_reply_bytes_recvd;
  1619. dprint_status(task);
  1620. status = task->tk_status;
  1621. if (status >= 0) {
  1622. task->tk_action = call_decode;
  1623. return;
  1624. }
  1625. trace_rpc_call_status(task);
  1626. task->tk_status = 0;
  1627. switch(status) {
  1628. case -EHOSTDOWN:
  1629. case -EHOSTUNREACH:
  1630. case -ENETUNREACH:
  1631. /*
  1632. * Delay any retries for 3 seconds, then handle as if it
  1633. * were a timeout.
  1634. */
  1635. rpc_delay(task, 3*HZ);
  1636. case -ETIMEDOUT:
  1637. task->tk_action = call_timeout;
  1638. if (task->tk_client->cl_discrtry)
  1639. xprt_conditional_disconnect(task->tk_xprt,
  1640. req->rq_connect_cookie);
  1641. break;
  1642. case -ECONNRESET:
  1643. case -ECONNREFUSED:
  1644. rpc_force_rebind(clnt);
  1645. rpc_delay(task, 3*HZ);
  1646. case -EPIPE:
  1647. case -ENOTCONN:
  1648. task->tk_action = call_bind;
  1649. break;
  1650. case -EAGAIN:
  1651. task->tk_action = call_transmit;
  1652. break;
  1653. case -EIO:
  1654. /* shutdown or soft timeout */
  1655. rpc_exit(task, status);
  1656. break;
  1657. default:
  1658. if (clnt->cl_chatty)
  1659. printk("%s: RPC call returned error %d\n",
  1660. clnt->cl_protname, -status);
  1661. rpc_exit(task, status);
  1662. }
  1663. }
  1664. /*
  1665. * 6a. Handle RPC timeout
  1666. * We do not release the request slot, so we keep using the
  1667. * same XID for all retransmits.
  1668. */
  1669. static void
  1670. call_timeout(struct rpc_task *task)
  1671. {
  1672. struct rpc_clnt *clnt = task->tk_client;
  1673. if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
  1674. dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
  1675. goto retry;
  1676. }
  1677. dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
  1678. task->tk_timeouts++;
  1679. if (RPC_IS_SOFTCONN(task)) {
  1680. rpc_exit(task, -ETIMEDOUT);
  1681. return;
  1682. }
  1683. if (RPC_IS_SOFT(task)) {
  1684. if (clnt->cl_chatty) {
  1685. rcu_read_lock();
  1686. printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
  1687. clnt->cl_protname,
  1688. rcu_dereference(clnt->cl_xprt)->servername);
  1689. rcu_read_unlock();
  1690. }
  1691. if (task->tk_flags & RPC_TASK_TIMEOUT)
  1692. rpc_exit(task, -ETIMEDOUT);
  1693. else
  1694. rpc_exit(task, -EIO);
  1695. return;
  1696. }
  1697. if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
  1698. task->tk_flags |= RPC_CALL_MAJORSEEN;
  1699. if (clnt->cl_chatty) {
  1700. rcu_read_lock();
  1701. printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
  1702. clnt->cl_protname,
  1703. rcu_dereference(clnt->cl_xprt)->servername);
  1704. rcu_read_unlock();
  1705. }
  1706. }
  1707. rpc_force_rebind(clnt);
  1708. /*
  1709. * Did our request time out due to an RPCSEC_GSS out-of-sequence
  1710. * event? RFC2203 requires the server to drop all such requests.
  1711. */
  1712. rpcauth_invalcred(task);
  1713. retry:
  1714. clnt->cl_stats->rpcretrans++;
  1715. task->tk_action = call_bind;
  1716. task->tk_status = 0;
  1717. }
  1718. /*
  1719. * 7. Decode the RPC reply
  1720. */
  1721. static void
  1722. call_decode(struct rpc_task *task)
  1723. {
  1724. struct rpc_clnt *clnt = task->tk_client;
  1725. struct rpc_rqst *req = task->tk_rqstp;
  1726. kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
  1727. __be32 *p;
  1728. dprint_status(task);
  1729. if (task->tk_flags & RPC_CALL_MAJORSEEN) {
  1730. if (clnt->cl_chatty) {
  1731. rcu_read_lock();
  1732. printk(KERN_NOTICE "%s: server %s OK\n",
  1733. clnt->cl_protname,
  1734. rcu_dereference(clnt->cl_xprt)->servername);
  1735. rcu_read_unlock();
  1736. }
  1737. task->tk_flags &= ~RPC_CALL_MAJORSEEN;
  1738. }
  1739. /*
  1740. * Ensure that we see all writes made by xprt_complete_rqst()
  1741. * before it changed req->rq_reply_bytes_recvd.
  1742. */
  1743. smp_rmb();
  1744. req->rq_rcv_buf.len = req->rq_private_buf.len;
  1745. /* Check that the softirq receive buffer is valid */
  1746. WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
  1747. sizeof(req->rq_rcv_buf)) != 0);
  1748. if (req->rq_rcv_buf.len < 12) {
  1749. if (!RPC_IS_SOFT(task)) {
  1750. task->tk_action = call_bind;
  1751. clnt->cl_stats->rpcretrans++;
  1752. goto out_retry;
  1753. }
  1754. dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
  1755. clnt->cl_protname, task->tk_status);
  1756. task->tk_action = call_timeout;
  1757. goto out_retry;
  1758. }
  1759. p = rpc_verify_header(task);
  1760. if (IS_ERR(p)) {
  1761. if (p == ERR_PTR(-EAGAIN))
  1762. goto out_retry;
  1763. return;
  1764. }
  1765. task->tk_action = rpc_exit_task;
  1766. if (decode) {
  1767. task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
  1768. task->tk_msg.rpc_resp);
  1769. }
  1770. dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
  1771. task->tk_status);
  1772. return;
  1773. out_retry:
  1774. task->tk_status = 0;
  1775. /* Note: rpc_verify_header() may have freed the RPC slot */
  1776. if (task->tk_rqstp == req) {
  1777. req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
  1778. if (task->tk_client->cl_discrtry)
  1779. xprt_conditional_disconnect(task->tk_xprt,
  1780. req->rq_connect_cookie);
  1781. }
  1782. }
  1783. static __be32 *
  1784. rpc_encode_header(struct rpc_task *task)
  1785. {
  1786. struct rpc_clnt *clnt = task->tk_client;
  1787. struct rpc_rqst *req = task->tk_rqstp;
  1788. __be32 *p = req->rq_svec[0].iov_base;
  1789. /* FIXME: check buffer size? */
  1790. p = xprt_skip_transport_header(task->tk_xprt, p);
  1791. *p++ = req->rq_xid; /* XID */
  1792. *p++ = htonl(RPC_CALL); /* CALL */
  1793. *p++ = htonl(RPC_VERSION); /* RPC version */
  1794. *p++ = htonl(clnt->cl_prog); /* program number */
  1795. *p++ = htonl(clnt->cl_vers); /* program version */
  1796. *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
  1797. p = rpcauth_marshcred(task, p);
  1798. req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
  1799. return p;
  1800. }
  1801. static __be32 *
  1802. rpc_verify_header(struct rpc_task *task)
  1803. {
  1804. struct rpc_clnt *clnt = task->tk_client;
  1805. struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
  1806. int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
  1807. __be32 *p = iov->iov_base;
  1808. u32 n;
  1809. int error = -EACCES;
  1810. if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
  1811. /* RFC-1014 says that the representation of XDR data must be a
  1812. * multiple of four bytes
  1813. * - if it isn't pointer subtraction in the NFS client may give
  1814. * undefined results
  1815. */
  1816. dprintk("RPC: %5u %s: XDR representation not a multiple of"
  1817. " 4 bytes: 0x%x\n", task->tk_pid, __func__,
  1818. task->tk_rqstp->rq_rcv_buf.len);
  1819. goto out_eio;
  1820. }
  1821. if ((len -= 3) < 0)
  1822. goto out_overflow;
  1823. p += 1; /* skip XID */
  1824. if ((n = ntohl(*p++)) != RPC_REPLY) {
  1825. dprintk("RPC: %5u %s: not an RPC reply: %x\n",
  1826. task->tk_pid, __func__, n);
  1827. goto out_garbage;
  1828. }
  1829. if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
  1830. if (--len < 0)
  1831. goto out_overflow;
  1832. switch ((n = ntohl(*p++))) {
  1833. case RPC_AUTH_ERROR:
  1834. break;
  1835. case RPC_MISMATCH:
  1836. dprintk("RPC: %5u %s: RPC call version mismatch!\n",
  1837. task->tk_pid, __func__);
  1838. error = -EPROTONOSUPPORT;
  1839. goto out_err;
  1840. default:
  1841. dprintk("RPC: %5u %s: RPC call rejected, "
  1842. "unknown error: %x\n",
  1843. task->tk_pid, __func__, n);
  1844. goto out_eio;
  1845. }
  1846. if (--len < 0)
  1847. goto out_overflow;
  1848. switch ((n = ntohl(*p++))) {
  1849. case RPC_AUTH_REJECTEDCRED:
  1850. case RPC_AUTH_REJECTEDVERF:
  1851. case RPCSEC_GSS_CREDPROBLEM:
  1852. case RPCSEC_GSS_CTXPROBLEM:
  1853. if (!task->tk_cred_retry)
  1854. break;
  1855. task->tk_cred_retry--;
  1856. dprintk("RPC: %5u %s: retry stale creds\n",
  1857. task->tk_pid, __func__);
  1858. rpcauth_invalcred(task);
  1859. /* Ensure we obtain a new XID! */
  1860. xprt_release(task);
  1861. task->tk_action = call_reserve;
  1862. goto out_retry;
  1863. case RPC_AUTH_BADCRED:
  1864. case RPC_AUTH_BADVERF:
  1865. /* possibly garbled cred/verf? */
  1866. if (!task->tk_garb_retry)
  1867. break;
  1868. task->tk_garb_retry--;
  1869. dprintk("RPC: %5u %s: retry garbled creds\n",
  1870. task->tk_pid, __func__);
  1871. task->tk_action = call_bind;
  1872. goto out_retry;
  1873. case RPC_AUTH_TOOWEAK:
  1874. rcu_read_lock();
  1875. printk(KERN_NOTICE "RPC: server %s requires stronger "
  1876. "authentication.\n",
  1877. rcu_dereference(clnt->cl_xprt)->servername);
  1878. rcu_read_unlock();
  1879. break;
  1880. default:
  1881. dprintk("RPC: %5u %s: unknown auth error: %x\n",
  1882. task->tk_pid, __func__, n);
  1883. error = -EIO;
  1884. }
  1885. dprintk("RPC: %5u %s: call rejected %d\n",
  1886. task->tk_pid, __func__, n);
  1887. goto out_err;
  1888. }
  1889. if (!(p = rpcauth_checkverf(task, p))) {
  1890. dprintk("RPC: %5u %s: auth check failed\n",
  1891. task->tk_pid, __func__);
  1892. goto out_garbage; /* bad verifier, retry */
  1893. }
  1894. len = p - (__be32 *)iov->iov_base - 1;
  1895. if (len < 0)
  1896. goto out_overflow;
  1897. switch ((n = ntohl(*p++))) {
  1898. case RPC_SUCCESS:
  1899. return p;
  1900. case RPC_PROG_UNAVAIL:
  1901. dprintk_rcu("RPC: %5u %s: program %u is unsupported "
  1902. "by server %s\n", task->tk_pid, __func__,
  1903. (unsigned int)clnt->cl_prog,
  1904. rcu_dereference(clnt->cl_xprt)->servername);
  1905. error = -EPFNOSUPPORT;
  1906. goto out_err;
  1907. case RPC_PROG_MISMATCH:
  1908. dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
  1909. "by server %s\n", task->tk_pid, __func__,
  1910. (unsigned int)clnt->cl_prog,
  1911. (unsigned int)clnt->cl_vers,
  1912. rcu_dereference(clnt->cl_xprt)->servername);
  1913. error = -EPROTONOSUPPORT;
  1914. goto out_err;
  1915. case RPC_PROC_UNAVAIL:
  1916. dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
  1917. "version %u on server %s\n",
  1918. task->tk_pid, __func__,
  1919. rpc_proc_name(task),
  1920. clnt->cl_prog, clnt->cl_vers,
  1921. rcu_dereference(clnt->cl_xprt)->servername);
  1922. error = -EOPNOTSUPP;
  1923. goto out_err;
  1924. case RPC_GARBAGE_ARGS:
  1925. dprintk("RPC: %5u %s: server saw garbage\n",
  1926. task->tk_pid, __func__);
  1927. break; /* retry */
  1928. default:
  1929. dprintk("RPC: %5u %s: server accept status: %x\n",
  1930. task->tk_pid, __func__, n);
  1931. /* Also retry */
  1932. }
  1933. out_garbage:
  1934. clnt->cl_stats->rpcgarbage++;
  1935. if (task->tk_garb_retry) {
  1936. task->tk_garb_retry--;
  1937. dprintk("RPC: %5u %s: retrying\n",
  1938. task->tk_pid, __func__);
  1939. task->tk_action = call_bind;
  1940. out_retry:
  1941. return ERR_PTR(-EAGAIN);
  1942. }
  1943. out_eio:
  1944. error = -EIO;
  1945. out_err:
  1946. rpc_exit(task, error);
  1947. dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
  1948. __func__, error);
  1949. return ERR_PTR(error);
  1950. out_overflow:
  1951. dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
  1952. __func__);
  1953. goto out_garbage;
  1954. }
  1955. static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
  1956. {
  1957. }
  1958. static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
  1959. {
  1960. return 0;
  1961. }
  1962. static struct rpc_procinfo rpcproc_null = {
  1963. .p_encode = rpcproc_encode_null,
  1964. .p_decode = rpcproc_decode_null,
  1965. };
  1966. static int rpc_ping(struct rpc_clnt *clnt)
  1967. {
  1968. struct rpc_message msg = {
  1969. .rpc_proc = &rpcproc_null,
  1970. };
  1971. int err;
  1972. msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
  1973. err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
  1974. put_rpccred(msg.rpc_cred);
  1975. return err;
  1976. }
  1977. struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
  1978. {
  1979. struct rpc_message msg = {
  1980. .rpc_proc = &rpcproc_null,
  1981. .rpc_cred = cred,
  1982. };
  1983. struct rpc_task_setup task_setup_data = {
  1984. .rpc_client = clnt,
  1985. .rpc_message = &msg,
  1986. .callback_ops = &rpc_default_ops,
  1987. .flags = flags,
  1988. };
  1989. return rpc_run_task(&task_setup_data);
  1990. }
  1991. EXPORT_SYMBOL_GPL(rpc_call_null);
  1992. #ifdef RPC_DEBUG
  1993. static void rpc_show_header(void)
  1994. {
  1995. printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
  1996. "-timeout ---ops--\n");
  1997. }
  1998. static void rpc_show_task(const struct rpc_clnt *clnt,
  1999. const struct rpc_task *task)
  2000. {
  2001. const char *rpc_waitq = "none";
  2002. if (RPC_IS_QUEUED(task))
  2003. rpc_waitq = rpc_qname(task->tk_waitqueue);
  2004. printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
  2005. task->tk_pid, task->tk_flags, task->tk_status,
  2006. clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
  2007. clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
  2008. task->tk_action, rpc_waitq);
  2009. }
  2010. void rpc_show_tasks(struct net *net)
  2011. {
  2012. struct rpc_clnt *clnt;
  2013. struct rpc_task *task;
  2014. int header = 0;
  2015. struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
  2016. spin_lock(&sn->rpc_client_lock);
  2017. list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
  2018. spin_lock(&clnt->cl_lock);
  2019. list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
  2020. if (!header) {
  2021. rpc_show_header();
  2022. header++;
  2023. }
  2024. rpc_show_task(clnt, task);
  2025. }
  2026. spin_unlock(&clnt->cl_lock);
  2027. }
  2028. spin_unlock(&sn->rpc_client_lock);
  2029. }
  2030. #endif