clnt.c 69 KB

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