clnt.c 64 KB

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