clnt.c 69 KB

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