clnt.c 68 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. if (IS_ERR(task))
  919. goto out;
  920. rpc_task_set_client(task, task_setup_data->rpc_client);
  921. rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
  922. if (task->tk_action == NULL)
  923. rpc_call_start(task);
  924. atomic_inc(&task->tk_count);
  925. rpc_execute(task);
  926. out:
  927. return task;
  928. }
  929. EXPORT_SYMBOL_GPL(rpc_run_task);
  930. /**
  931. * rpc_call_sync - Perform a synchronous RPC call
  932. * @clnt: pointer to RPC client
  933. * @msg: RPC call parameters
  934. * @flags: RPC call flags
  935. */
  936. int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
  937. {
  938. struct rpc_task *task;
  939. struct rpc_task_setup task_setup_data = {
  940. .rpc_client = clnt,
  941. .rpc_message = msg,
  942. .callback_ops = &rpc_default_ops,
  943. .flags = flags,
  944. };
  945. int status;
  946. WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
  947. if (flags & RPC_TASK_ASYNC) {
  948. rpc_release_calldata(task_setup_data.callback_ops,
  949. task_setup_data.callback_data);
  950. return -EINVAL;
  951. }
  952. task = rpc_run_task(&task_setup_data);
  953. if (IS_ERR(task))
  954. return PTR_ERR(task);
  955. status = task->tk_status;
  956. rpc_put_task(task);
  957. return status;
  958. }
  959. EXPORT_SYMBOL_GPL(rpc_call_sync);
  960. /**
  961. * rpc_call_async - Perform an asynchronous RPC call
  962. * @clnt: pointer to RPC client
  963. * @msg: RPC call parameters
  964. * @flags: RPC call flags
  965. * @tk_ops: RPC call ops
  966. * @data: user call data
  967. */
  968. int
  969. rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
  970. const struct rpc_call_ops *tk_ops, void *data)
  971. {
  972. struct rpc_task *task;
  973. struct rpc_task_setup task_setup_data = {
  974. .rpc_client = clnt,
  975. .rpc_message = msg,
  976. .callback_ops = tk_ops,
  977. .callback_data = data,
  978. .flags = flags|RPC_TASK_ASYNC,
  979. };
  980. task = rpc_run_task(&task_setup_data);
  981. if (IS_ERR(task))
  982. return PTR_ERR(task);
  983. rpc_put_task(task);
  984. return 0;
  985. }
  986. EXPORT_SYMBOL_GPL(rpc_call_async);
  987. #if defined(CONFIG_SUNRPC_BACKCHANNEL)
  988. /**
  989. * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
  990. * rpc_execute against it
  991. * @req: RPC request
  992. */
  993. struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
  994. {
  995. struct rpc_task *task;
  996. struct xdr_buf *xbufp = &req->rq_snd_buf;
  997. struct rpc_task_setup task_setup_data = {
  998. .callback_ops = &rpc_default_ops,
  999. .flags = RPC_TASK_SOFTCONN,
  1000. };
  1001. dprintk("RPC: rpc_run_bc_task req= %p\n", req);
  1002. /*
  1003. * Create an rpc_task to send the data
  1004. */
  1005. task = rpc_new_task(&task_setup_data);
  1006. if (IS_ERR(task)) {
  1007. xprt_free_bc_request(req);
  1008. goto out;
  1009. }
  1010. task->tk_rqstp = req;
  1011. /*
  1012. * Set up the xdr_buf length.
  1013. * This also indicates that the buffer is XDR encoded already.
  1014. */
  1015. xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
  1016. xbufp->tail[0].iov_len;
  1017. task->tk_action = call_bc_transmit;
  1018. atomic_inc(&task->tk_count);
  1019. WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
  1020. rpc_execute(task);
  1021. out:
  1022. dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
  1023. return task;
  1024. }
  1025. #endif /* CONFIG_SUNRPC_BACKCHANNEL */
  1026. void
  1027. rpc_call_start(struct rpc_task *task)
  1028. {
  1029. task->tk_action = call_start;
  1030. }
  1031. EXPORT_SYMBOL_GPL(rpc_call_start);
  1032. /**
  1033. * rpc_peeraddr - extract remote peer address from clnt's xprt
  1034. * @clnt: RPC client structure
  1035. * @buf: target buffer
  1036. * @bufsize: length of target buffer
  1037. *
  1038. * Returns the number of bytes that are actually in the stored address.
  1039. */
  1040. size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
  1041. {
  1042. size_t bytes;
  1043. struct rpc_xprt *xprt;
  1044. rcu_read_lock();
  1045. xprt = rcu_dereference(clnt->cl_xprt);
  1046. bytes = xprt->addrlen;
  1047. if (bytes > bufsize)
  1048. bytes = bufsize;
  1049. memcpy(buf, &xprt->addr, bytes);
  1050. rcu_read_unlock();
  1051. return bytes;
  1052. }
  1053. EXPORT_SYMBOL_GPL(rpc_peeraddr);
  1054. /**
  1055. * rpc_peeraddr2str - return remote peer address in printable format
  1056. * @clnt: RPC client structure
  1057. * @format: address format
  1058. *
  1059. * NB: the lifetime of the memory referenced by the returned pointer is
  1060. * the same as the rpc_xprt itself. As long as the caller uses this
  1061. * pointer, it must hold the RCU read lock.
  1062. */
  1063. const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
  1064. enum rpc_display_format_t format)
  1065. {
  1066. struct rpc_xprt *xprt;
  1067. xprt = rcu_dereference(clnt->cl_xprt);
  1068. if (xprt->address_strings[format] != NULL)
  1069. return xprt->address_strings[format];
  1070. else
  1071. return "unprintable";
  1072. }
  1073. EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
  1074. static const struct sockaddr_in rpc_inaddr_loopback = {
  1075. .sin_family = AF_INET,
  1076. .sin_addr.s_addr = htonl(INADDR_ANY),
  1077. };
  1078. static const struct sockaddr_in6 rpc_in6addr_loopback = {
  1079. .sin6_family = AF_INET6,
  1080. .sin6_addr = IN6ADDR_ANY_INIT,
  1081. };
  1082. /*
  1083. * Try a getsockname() on a connected datagram socket. Using a
  1084. * connected datagram socket prevents leaving a socket in TIME_WAIT.
  1085. * This conserves the ephemeral port number space.
  1086. *
  1087. * Returns zero and fills in "buf" if successful; otherwise, a
  1088. * negative errno is returned.
  1089. */
  1090. static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
  1091. struct sockaddr *buf, int buflen)
  1092. {
  1093. struct socket *sock;
  1094. int err;
  1095. err = __sock_create(net, sap->sa_family,
  1096. SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
  1097. if (err < 0) {
  1098. dprintk("RPC: can't create UDP socket (%d)\n", err);
  1099. goto out;
  1100. }
  1101. switch (sap->sa_family) {
  1102. case AF_INET:
  1103. err = kernel_bind(sock,
  1104. (struct sockaddr *)&rpc_inaddr_loopback,
  1105. sizeof(rpc_inaddr_loopback));
  1106. break;
  1107. case AF_INET6:
  1108. err = kernel_bind(sock,
  1109. (struct sockaddr *)&rpc_in6addr_loopback,
  1110. sizeof(rpc_in6addr_loopback));
  1111. break;
  1112. default:
  1113. err = -EAFNOSUPPORT;
  1114. goto out;
  1115. }
  1116. if (err < 0) {
  1117. dprintk("RPC: can't bind UDP socket (%d)\n", err);
  1118. goto out_release;
  1119. }
  1120. err = kernel_connect(sock, sap, salen, 0);
  1121. if (err < 0) {
  1122. dprintk("RPC: can't connect UDP socket (%d)\n", err);
  1123. goto out_release;
  1124. }
  1125. err = kernel_getsockname(sock, buf, &buflen);
  1126. if (err < 0) {
  1127. dprintk("RPC: getsockname failed (%d)\n", err);
  1128. goto out_release;
  1129. }
  1130. err = 0;
  1131. if (buf->sa_family == AF_INET6) {
  1132. struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
  1133. sin6->sin6_scope_id = 0;
  1134. }
  1135. dprintk("RPC: %s succeeded\n", __func__);
  1136. out_release:
  1137. sock_release(sock);
  1138. out:
  1139. return err;
  1140. }
  1141. /*
  1142. * Scraping a connected socket failed, so we don't have a useable
  1143. * local address. Fallback: generate an address that will prevent
  1144. * the server from calling us back.
  1145. *
  1146. * Returns zero and fills in "buf" if successful; otherwise, a
  1147. * negative errno is returned.
  1148. */
  1149. static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
  1150. {
  1151. switch (family) {
  1152. case AF_INET:
  1153. if (buflen < sizeof(rpc_inaddr_loopback))
  1154. return -EINVAL;
  1155. memcpy(buf, &rpc_inaddr_loopback,
  1156. sizeof(rpc_inaddr_loopback));
  1157. break;
  1158. case AF_INET6:
  1159. if (buflen < sizeof(rpc_in6addr_loopback))
  1160. return -EINVAL;
  1161. memcpy(buf, &rpc_in6addr_loopback,
  1162. sizeof(rpc_in6addr_loopback));
  1163. break;
  1164. default:
  1165. dprintk("RPC: %s: address family not supported\n",
  1166. __func__);
  1167. return -EAFNOSUPPORT;
  1168. }
  1169. dprintk("RPC: %s: succeeded\n", __func__);
  1170. return 0;
  1171. }
  1172. /**
  1173. * rpc_localaddr - discover local endpoint address for an RPC client
  1174. * @clnt: RPC client structure
  1175. * @buf: target buffer
  1176. * @buflen: size of target buffer, in bytes
  1177. *
  1178. * Returns zero and fills in "buf" and "buflen" if successful;
  1179. * otherwise, a negative errno is returned.
  1180. *
  1181. * This works even if the underlying transport is not currently connected,
  1182. * or if the upper layer never previously provided a source address.
  1183. *
  1184. * The result of this function call is transient: multiple calls in
  1185. * succession may give different results, depending on how local
  1186. * networking configuration changes over time.
  1187. */
  1188. int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
  1189. {
  1190. struct sockaddr_storage address;
  1191. struct sockaddr *sap = (struct sockaddr *)&address;
  1192. struct rpc_xprt *xprt;
  1193. struct net *net;
  1194. size_t salen;
  1195. int err;
  1196. rcu_read_lock();
  1197. xprt = rcu_dereference(clnt->cl_xprt);
  1198. salen = xprt->addrlen;
  1199. memcpy(sap, &xprt->addr, salen);
  1200. net = get_net(xprt->xprt_net);
  1201. rcu_read_unlock();
  1202. rpc_set_port(sap, 0);
  1203. err = rpc_sockname(net, sap, salen, buf, buflen);
  1204. put_net(net);
  1205. if (err != 0)
  1206. /* Couldn't discover local address, return ANYADDR */
  1207. return rpc_anyaddr(sap->sa_family, buf, buflen);
  1208. return 0;
  1209. }
  1210. EXPORT_SYMBOL_GPL(rpc_localaddr);
  1211. void
  1212. rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
  1213. {
  1214. struct rpc_xprt *xprt;
  1215. rcu_read_lock();
  1216. xprt = rcu_dereference(clnt->cl_xprt);
  1217. if (xprt->ops->set_buffer_size)
  1218. xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
  1219. rcu_read_unlock();
  1220. }
  1221. EXPORT_SYMBOL_GPL(rpc_setbufsize);
  1222. /**
  1223. * rpc_protocol - Get transport protocol number for an RPC client
  1224. * @clnt: RPC client to query
  1225. *
  1226. */
  1227. int rpc_protocol(struct rpc_clnt *clnt)
  1228. {
  1229. int protocol;
  1230. rcu_read_lock();
  1231. protocol = rcu_dereference(clnt->cl_xprt)->prot;
  1232. rcu_read_unlock();
  1233. return protocol;
  1234. }
  1235. EXPORT_SYMBOL_GPL(rpc_protocol);
  1236. /**
  1237. * rpc_net_ns - Get the network namespace for this RPC client
  1238. * @clnt: RPC client to query
  1239. *
  1240. */
  1241. struct net *rpc_net_ns(struct rpc_clnt *clnt)
  1242. {
  1243. struct net *ret;
  1244. rcu_read_lock();
  1245. ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
  1246. rcu_read_unlock();
  1247. return ret;
  1248. }
  1249. EXPORT_SYMBOL_GPL(rpc_net_ns);
  1250. /**
  1251. * rpc_max_payload - Get maximum payload size for a transport, in bytes
  1252. * @clnt: RPC client to query
  1253. *
  1254. * For stream transports, this is one RPC record fragment (see RFC
  1255. * 1831), as we don't support multi-record requests yet. For datagram
  1256. * transports, this is the size of an IP packet minus the IP, UDP, and
  1257. * RPC header sizes.
  1258. */
  1259. size_t rpc_max_payload(struct rpc_clnt *clnt)
  1260. {
  1261. size_t ret;
  1262. rcu_read_lock();
  1263. ret = rcu_dereference(clnt->cl_xprt)->max_payload;
  1264. rcu_read_unlock();
  1265. return ret;
  1266. }
  1267. EXPORT_SYMBOL_GPL(rpc_max_payload);
  1268. /**
  1269. * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
  1270. * @clnt: RPC client to query
  1271. */
  1272. size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
  1273. {
  1274. struct rpc_xprt *xprt;
  1275. size_t ret;
  1276. rcu_read_lock();
  1277. xprt = rcu_dereference(clnt->cl_xprt);
  1278. ret = xprt->ops->bc_maxpayload(xprt);
  1279. rcu_read_unlock();
  1280. return ret;
  1281. }
  1282. EXPORT_SYMBOL_GPL(rpc_max_bc_payload);
  1283. /**
  1284. * rpc_get_timeout - Get timeout for transport in units of HZ
  1285. * @clnt: RPC client to query
  1286. */
  1287. unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
  1288. {
  1289. unsigned long ret;
  1290. rcu_read_lock();
  1291. ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
  1292. rcu_read_unlock();
  1293. return ret;
  1294. }
  1295. EXPORT_SYMBOL_GPL(rpc_get_timeout);
  1296. /**
  1297. * rpc_force_rebind - force transport to check that remote port is unchanged
  1298. * @clnt: client to rebind
  1299. *
  1300. */
  1301. void rpc_force_rebind(struct rpc_clnt *clnt)
  1302. {
  1303. if (clnt->cl_autobind) {
  1304. rcu_read_lock();
  1305. xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
  1306. rcu_read_unlock();
  1307. }
  1308. }
  1309. EXPORT_SYMBOL_GPL(rpc_force_rebind);
  1310. /*
  1311. * Restart an (async) RPC call from the call_prepare state.
  1312. * Usually called from within the exit handler.
  1313. */
  1314. int
  1315. rpc_restart_call_prepare(struct rpc_task *task)
  1316. {
  1317. if (RPC_ASSASSINATED(task))
  1318. return 0;
  1319. task->tk_action = call_start;
  1320. task->tk_status = 0;
  1321. if (task->tk_ops->rpc_call_prepare != NULL)
  1322. task->tk_action = rpc_prepare_task;
  1323. return 1;
  1324. }
  1325. EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
  1326. /*
  1327. * Restart an (async) RPC call. Usually called from within the
  1328. * exit handler.
  1329. */
  1330. int
  1331. rpc_restart_call(struct rpc_task *task)
  1332. {
  1333. if (RPC_ASSASSINATED(task))
  1334. return 0;
  1335. task->tk_action = call_start;
  1336. task->tk_status = 0;
  1337. return 1;
  1338. }
  1339. EXPORT_SYMBOL_GPL(rpc_restart_call);
  1340. #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
  1341. const char
  1342. *rpc_proc_name(const struct rpc_task *task)
  1343. {
  1344. const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
  1345. if (proc) {
  1346. if (proc->p_name)
  1347. return proc->p_name;
  1348. else
  1349. return "NULL";
  1350. } else
  1351. return "no proc";
  1352. }
  1353. #endif
  1354. /*
  1355. * 0. Initial state
  1356. *
  1357. * Other FSM states can be visited zero or more times, but
  1358. * this state is visited exactly once for each RPC.
  1359. */
  1360. static void
  1361. call_start(struct rpc_task *task)
  1362. {
  1363. struct rpc_clnt *clnt = task->tk_client;
  1364. dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
  1365. clnt->cl_program->name, clnt->cl_vers,
  1366. rpc_proc_name(task),
  1367. (RPC_IS_ASYNC(task) ? "async" : "sync"));
  1368. /* Increment call count */
  1369. task->tk_msg.rpc_proc->p_count++;
  1370. clnt->cl_stats->rpccnt++;
  1371. task->tk_action = call_reserve;
  1372. }
  1373. /*
  1374. * 1. Reserve an RPC call slot
  1375. */
  1376. static void
  1377. call_reserve(struct rpc_task *task)
  1378. {
  1379. dprint_status(task);
  1380. task->tk_status = 0;
  1381. task->tk_action = call_reserveresult;
  1382. xprt_reserve(task);
  1383. }
  1384. static void call_retry_reserve(struct rpc_task *task);
  1385. /*
  1386. * 1b. Grok the result of xprt_reserve()
  1387. */
  1388. static void
  1389. call_reserveresult(struct rpc_task *task)
  1390. {
  1391. int status = task->tk_status;
  1392. dprint_status(task);
  1393. /*
  1394. * After a call to xprt_reserve(), we must have either
  1395. * a request slot or else an error status.
  1396. */
  1397. task->tk_status = 0;
  1398. if (status >= 0) {
  1399. if (task->tk_rqstp) {
  1400. task->tk_action = call_refresh;
  1401. return;
  1402. }
  1403. printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
  1404. __func__, status);
  1405. rpc_exit(task, -EIO);
  1406. return;
  1407. }
  1408. /*
  1409. * Even though there was an error, we may have acquired
  1410. * a request slot somehow. Make sure not to leak it.
  1411. */
  1412. if (task->tk_rqstp) {
  1413. printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
  1414. __func__, status);
  1415. xprt_release(task);
  1416. }
  1417. switch (status) {
  1418. case -ENOMEM:
  1419. rpc_delay(task, HZ >> 2);
  1420. case -EAGAIN: /* woken up; retry */
  1421. task->tk_action = call_retry_reserve;
  1422. return;
  1423. case -EIO: /* probably a shutdown */
  1424. break;
  1425. default:
  1426. printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
  1427. __func__, status);
  1428. break;
  1429. }
  1430. rpc_exit(task, status);
  1431. }
  1432. /*
  1433. * 1c. Retry reserving an RPC call slot
  1434. */
  1435. static void
  1436. call_retry_reserve(struct rpc_task *task)
  1437. {
  1438. dprint_status(task);
  1439. task->tk_status = 0;
  1440. task->tk_action = call_reserveresult;
  1441. xprt_retry_reserve(task);
  1442. }
  1443. /*
  1444. * 2. Bind and/or refresh the credentials
  1445. */
  1446. static void
  1447. call_refresh(struct rpc_task *task)
  1448. {
  1449. dprint_status(task);
  1450. task->tk_action = call_refreshresult;
  1451. task->tk_status = 0;
  1452. task->tk_client->cl_stats->rpcauthrefresh++;
  1453. rpcauth_refreshcred(task);
  1454. }
  1455. /*
  1456. * 2a. Process the results of a credential refresh
  1457. */
  1458. static void
  1459. call_refreshresult(struct rpc_task *task)
  1460. {
  1461. int status = task->tk_status;
  1462. dprint_status(task);
  1463. task->tk_status = 0;
  1464. task->tk_action = call_refresh;
  1465. switch (status) {
  1466. case 0:
  1467. if (rpcauth_uptodatecred(task)) {
  1468. task->tk_action = call_allocate;
  1469. return;
  1470. }
  1471. /* Use rate-limiting and a max number of retries if refresh
  1472. * had status 0 but failed to update the cred.
  1473. */
  1474. case -ETIMEDOUT:
  1475. rpc_delay(task, 3*HZ);
  1476. case -EAGAIN:
  1477. status = -EACCES;
  1478. case -EKEYEXPIRED:
  1479. if (!task->tk_cred_retry)
  1480. break;
  1481. task->tk_cred_retry--;
  1482. dprintk("RPC: %5u %s: retry refresh creds\n",
  1483. task->tk_pid, __func__);
  1484. return;
  1485. }
  1486. dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
  1487. task->tk_pid, __func__, status);
  1488. rpc_exit(task, status);
  1489. }
  1490. /*
  1491. * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
  1492. * (Note: buffer memory is freed in xprt_release).
  1493. */
  1494. static void
  1495. call_allocate(struct rpc_task *task)
  1496. {
  1497. unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
  1498. struct rpc_rqst *req = task->tk_rqstp;
  1499. struct rpc_xprt *xprt = req->rq_xprt;
  1500. struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
  1501. int status;
  1502. dprint_status(task);
  1503. task->tk_status = 0;
  1504. task->tk_action = call_bind;
  1505. if (req->rq_buffer)
  1506. return;
  1507. if (proc->p_proc != 0) {
  1508. BUG_ON(proc->p_arglen == 0);
  1509. if (proc->p_decode != NULL)
  1510. BUG_ON(proc->p_replen == 0);
  1511. }
  1512. /*
  1513. * Calculate the size (in quads) of the RPC call
  1514. * and reply headers, and convert both values
  1515. * to byte sizes.
  1516. */
  1517. req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
  1518. req->rq_callsize <<= 2;
  1519. req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
  1520. req->rq_rcvsize <<= 2;
  1521. status = xprt->ops->buf_alloc(task);
  1522. xprt_inject_disconnect(xprt);
  1523. if (status == 0)
  1524. return;
  1525. if (status != -ENOMEM) {
  1526. rpc_exit(task, status);
  1527. return;
  1528. }
  1529. dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
  1530. if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
  1531. task->tk_action = call_allocate;
  1532. rpc_delay(task, HZ>>4);
  1533. return;
  1534. }
  1535. rpc_exit(task, -ERESTARTSYS);
  1536. }
  1537. static inline int
  1538. rpc_task_need_encode(struct rpc_task *task)
  1539. {
  1540. return task->tk_rqstp->rq_snd_buf.len == 0;
  1541. }
  1542. static inline void
  1543. rpc_task_force_reencode(struct rpc_task *task)
  1544. {
  1545. task->tk_rqstp->rq_snd_buf.len = 0;
  1546. task->tk_rqstp->rq_bytes_sent = 0;
  1547. }
  1548. /*
  1549. * 3. Encode arguments of an RPC call
  1550. */
  1551. static void
  1552. rpc_xdr_encode(struct rpc_task *task)
  1553. {
  1554. struct rpc_rqst *req = task->tk_rqstp;
  1555. kxdreproc_t encode;
  1556. __be32 *p;
  1557. dprint_status(task);
  1558. xdr_buf_init(&req->rq_snd_buf,
  1559. req->rq_buffer,
  1560. req->rq_callsize);
  1561. xdr_buf_init(&req->rq_rcv_buf,
  1562. req->rq_rbuffer,
  1563. req->rq_rcvsize);
  1564. p = rpc_encode_header(task);
  1565. if (p == NULL) {
  1566. printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
  1567. rpc_exit(task, -EIO);
  1568. return;
  1569. }
  1570. encode = task->tk_msg.rpc_proc->p_encode;
  1571. if (encode == NULL)
  1572. return;
  1573. task->tk_status = rpcauth_wrap_req(task, encode, req, p,
  1574. task->tk_msg.rpc_argp);
  1575. }
  1576. /*
  1577. * 4. Get the server port number if not yet set
  1578. */
  1579. static void
  1580. call_bind(struct rpc_task *task)
  1581. {
  1582. struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
  1583. dprint_status(task);
  1584. task->tk_action = call_connect;
  1585. if (!xprt_bound(xprt)) {
  1586. task->tk_action = call_bind_status;
  1587. task->tk_timeout = xprt->bind_timeout;
  1588. xprt->ops->rpcbind(task);
  1589. }
  1590. }
  1591. /*
  1592. * 4a. Sort out bind result
  1593. */
  1594. static void
  1595. call_bind_status(struct rpc_task *task)
  1596. {
  1597. int status = -EIO;
  1598. if (task->tk_status >= 0) {
  1599. dprint_status(task);
  1600. task->tk_status = 0;
  1601. task->tk_action = call_connect;
  1602. return;
  1603. }
  1604. trace_rpc_bind_status(task);
  1605. switch (task->tk_status) {
  1606. case -ENOMEM:
  1607. dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
  1608. rpc_delay(task, HZ >> 2);
  1609. goto retry_timeout;
  1610. case -EACCES:
  1611. dprintk("RPC: %5u remote rpcbind: RPC program/version "
  1612. "unavailable\n", task->tk_pid);
  1613. /* fail immediately if this is an RPC ping */
  1614. if (task->tk_msg.rpc_proc->p_proc == 0) {
  1615. status = -EOPNOTSUPP;
  1616. break;
  1617. }
  1618. if (task->tk_rebind_retry == 0)
  1619. break;
  1620. task->tk_rebind_retry--;
  1621. rpc_delay(task, 3*HZ);
  1622. goto retry_timeout;
  1623. case -ETIMEDOUT:
  1624. dprintk("RPC: %5u rpcbind request timed out\n",
  1625. task->tk_pid);
  1626. goto retry_timeout;
  1627. case -EPFNOSUPPORT:
  1628. /* server doesn't support any rpcbind version we know of */
  1629. dprintk("RPC: %5u unrecognized remote rpcbind service\n",
  1630. task->tk_pid);
  1631. break;
  1632. case -EPROTONOSUPPORT:
  1633. dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
  1634. task->tk_pid);
  1635. goto retry_timeout;
  1636. case -ECONNREFUSED: /* connection problems */
  1637. case -ECONNRESET:
  1638. case -ECONNABORTED:
  1639. case -ENOTCONN:
  1640. case -EHOSTDOWN:
  1641. case -EHOSTUNREACH:
  1642. case -ENETUNREACH:
  1643. case -ENOBUFS:
  1644. case -EPIPE:
  1645. dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
  1646. task->tk_pid, task->tk_status);
  1647. if (!RPC_IS_SOFTCONN(task)) {
  1648. rpc_delay(task, 5*HZ);
  1649. goto retry_timeout;
  1650. }
  1651. status = task->tk_status;
  1652. break;
  1653. default:
  1654. dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
  1655. task->tk_pid, -task->tk_status);
  1656. }
  1657. rpc_exit(task, status);
  1658. return;
  1659. retry_timeout:
  1660. task->tk_status = 0;
  1661. task->tk_action = call_timeout;
  1662. }
  1663. /*
  1664. * 4b. Connect to the RPC server
  1665. */
  1666. static void
  1667. call_connect(struct rpc_task *task)
  1668. {
  1669. struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
  1670. dprintk("RPC: %5u call_connect xprt %p %s connected\n",
  1671. task->tk_pid, xprt,
  1672. (xprt_connected(xprt) ? "is" : "is not"));
  1673. task->tk_action = call_transmit;
  1674. if (!xprt_connected(xprt)) {
  1675. task->tk_action = call_connect_status;
  1676. if (task->tk_status < 0)
  1677. return;
  1678. if (task->tk_flags & RPC_TASK_NOCONNECT) {
  1679. rpc_exit(task, -ENOTCONN);
  1680. return;
  1681. }
  1682. xprt_connect(task);
  1683. }
  1684. }
  1685. /*
  1686. * 4c. Sort out connect result
  1687. */
  1688. static void
  1689. call_connect_status(struct rpc_task *task)
  1690. {
  1691. struct rpc_clnt *clnt = task->tk_client;
  1692. int status = task->tk_status;
  1693. dprint_status(task);
  1694. trace_rpc_connect_status(task, status);
  1695. task->tk_status = 0;
  1696. switch (status) {
  1697. case -ECONNREFUSED:
  1698. case -ECONNRESET:
  1699. case -ECONNABORTED:
  1700. case -ENETUNREACH:
  1701. case -EHOSTUNREACH:
  1702. case -EADDRINUSE:
  1703. case -ENOBUFS:
  1704. case -EPIPE:
  1705. if (RPC_IS_SOFTCONN(task))
  1706. break;
  1707. /* retry with existing socket, after a delay */
  1708. rpc_delay(task, 3*HZ);
  1709. case -EAGAIN:
  1710. /* Check for timeouts before looping back to call_bind */
  1711. case -ETIMEDOUT:
  1712. task->tk_action = call_timeout;
  1713. return;
  1714. case 0:
  1715. clnt->cl_stats->netreconn++;
  1716. task->tk_action = call_transmit;
  1717. return;
  1718. }
  1719. rpc_exit(task, status);
  1720. }
  1721. /*
  1722. * 5. Transmit the RPC request, and wait for reply
  1723. */
  1724. static void
  1725. call_transmit(struct rpc_task *task)
  1726. {
  1727. int is_retrans = RPC_WAS_SENT(task);
  1728. dprint_status(task);
  1729. task->tk_action = call_status;
  1730. if (task->tk_status < 0)
  1731. return;
  1732. if (!xprt_prepare_transmit(task))
  1733. return;
  1734. task->tk_action = call_transmit_status;
  1735. /* Encode here so that rpcsec_gss can use correct sequence number. */
  1736. if (rpc_task_need_encode(task)) {
  1737. rpc_xdr_encode(task);
  1738. /* Did the encode result in an error condition? */
  1739. if (task->tk_status != 0) {
  1740. /* Was the error nonfatal? */
  1741. if (task->tk_status == -EAGAIN)
  1742. rpc_delay(task, HZ >> 4);
  1743. else
  1744. rpc_exit(task, task->tk_status);
  1745. return;
  1746. }
  1747. }
  1748. xprt_transmit(task);
  1749. if (task->tk_status < 0)
  1750. return;
  1751. if (is_retrans)
  1752. task->tk_client->cl_stats->rpcretrans++;
  1753. /*
  1754. * On success, ensure that we call xprt_end_transmit() before sleeping
  1755. * in order to allow access to the socket to other RPC requests.
  1756. */
  1757. call_transmit_status(task);
  1758. if (rpc_reply_expected(task))
  1759. return;
  1760. task->tk_action = rpc_exit_task;
  1761. rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
  1762. }
  1763. /*
  1764. * 5a. Handle cleanup after a transmission
  1765. */
  1766. static void
  1767. call_transmit_status(struct rpc_task *task)
  1768. {
  1769. task->tk_action = call_status;
  1770. /*
  1771. * Common case: success. Force the compiler to put this
  1772. * test first.
  1773. */
  1774. if (task->tk_status == 0) {
  1775. xprt_end_transmit(task);
  1776. rpc_task_force_reencode(task);
  1777. return;
  1778. }
  1779. switch (task->tk_status) {
  1780. case -EAGAIN:
  1781. case -ENOBUFS:
  1782. break;
  1783. default:
  1784. dprint_status(task);
  1785. xprt_end_transmit(task);
  1786. rpc_task_force_reencode(task);
  1787. break;
  1788. /*
  1789. * Special cases: if we've been waiting on the
  1790. * socket's write_space() callback, or if the
  1791. * socket just returned a connection error,
  1792. * then hold onto the transport lock.
  1793. */
  1794. case -ECONNREFUSED:
  1795. case -EHOSTDOWN:
  1796. case -EHOSTUNREACH:
  1797. case -ENETUNREACH:
  1798. case -EPERM:
  1799. if (RPC_IS_SOFTCONN(task)) {
  1800. xprt_end_transmit(task);
  1801. rpc_exit(task, task->tk_status);
  1802. break;
  1803. }
  1804. case -ECONNRESET:
  1805. case -ECONNABORTED:
  1806. case -EADDRINUSE:
  1807. case -ENOTCONN:
  1808. case -EPIPE:
  1809. rpc_task_force_reencode(task);
  1810. }
  1811. }
  1812. #if defined(CONFIG_SUNRPC_BACKCHANNEL)
  1813. /*
  1814. * 5b. Send the backchannel RPC reply. On error, drop the reply. In
  1815. * addition, disconnect on connectivity errors.
  1816. */
  1817. static void
  1818. call_bc_transmit(struct rpc_task *task)
  1819. {
  1820. struct rpc_rqst *req = task->tk_rqstp;
  1821. if (!xprt_prepare_transmit(task))
  1822. goto out_retry;
  1823. if (task->tk_status < 0) {
  1824. printk(KERN_NOTICE "RPC: Could not send backchannel reply "
  1825. "error: %d\n", task->tk_status);
  1826. goto out_done;
  1827. }
  1828. if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
  1829. req->rq_bytes_sent = 0;
  1830. xprt_transmit(task);
  1831. if (task->tk_status == -EAGAIN)
  1832. goto out_nospace;
  1833. xprt_end_transmit(task);
  1834. dprint_status(task);
  1835. switch (task->tk_status) {
  1836. case 0:
  1837. /* Success */
  1838. case -EHOSTDOWN:
  1839. case -EHOSTUNREACH:
  1840. case -ENETUNREACH:
  1841. case -ECONNRESET:
  1842. case -ECONNREFUSED:
  1843. case -EADDRINUSE:
  1844. case -ENOTCONN:
  1845. case -EPIPE:
  1846. break;
  1847. case -ETIMEDOUT:
  1848. /*
  1849. * Problem reaching the server. Disconnect and let the
  1850. * forechannel reestablish the connection. The server will
  1851. * have to retransmit the backchannel request and we'll
  1852. * reprocess it. Since these ops are idempotent, there's no
  1853. * need to cache our reply at this time.
  1854. */
  1855. printk(KERN_NOTICE "RPC: Could not send backchannel reply "
  1856. "error: %d\n", task->tk_status);
  1857. xprt_conditional_disconnect(req->rq_xprt,
  1858. req->rq_connect_cookie);
  1859. break;
  1860. default:
  1861. /*
  1862. * We were unable to reply and will have to drop the
  1863. * request. The server should reconnect and retransmit.
  1864. */
  1865. WARN_ON_ONCE(task->tk_status == -EAGAIN);
  1866. printk(KERN_NOTICE "RPC: Could not send backchannel reply "
  1867. "error: %d\n", task->tk_status);
  1868. break;
  1869. }
  1870. rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
  1871. out_done:
  1872. task->tk_action = rpc_exit_task;
  1873. return;
  1874. out_nospace:
  1875. req->rq_connect_cookie = req->rq_xprt->connect_cookie;
  1876. out_retry:
  1877. task->tk_status = 0;
  1878. }
  1879. #endif /* CONFIG_SUNRPC_BACKCHANNEL */
  1880. /*
  1881. * 6. Sort out the RPC call status
  1882. */
  1883. static void
  1884. call_status(struct rpc_task *task)
  1885. {
  1886. struct rpc_clnt *clnt = task->tk_client;
  1887. struct rpc_rqst *req = task->tk_rqstp;
  1888. int status;
  1889. if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
  1890. task->tk_status = req->rq_reply_bytes_recvd;
  1891. dprint_status(task);
  1892. status = task->tk_status;
  1893. if (status >= 0) {
  1894. task->tk_action = call_decode;
  1895. return;
  1896. }
  1897. trace_rpc_call_status(task);
  1898. task->tk_status = 0;
  1899. switch(status) {
  1900. case -EHOSTDOWN:
  1901. case -EHOSTUNREACH:
  1902. case -ENETUNREACH:
  1903. case -EPERM:
  1904. if (RPC_IS_SOFTCONN(task)) {
  1905. rpc_exit(task, status);
  1906. break;
  1907. }
  1908. /*
  1909. * Delay any retries for 3 seconds, then handle as if it
  1910. * were a timeout.
  1911. */
  1912. rpc_delay(task, 3*HZ);
  1913. case -ETIMEDOUT:
  1914. task->tk_action = call_timeout;
  1915. if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
  1916. && task->tk_client->cl_discrtry)
  1917. xprt_conditional_disconnect(req->rq_xprt,
  1918. req->rq_connect_cookie);
  1919. break;
  1920. case -ECONNREFUSED:
  1921. case -ECONNRESET:
  1922. case -ECONNABORTED:
  1923. rpc_force_rebind(clnt);
  1924. case -EADDRINUSE:
  1925. rpc_delay(task, 3*HZ);
  1926. case -EPIPE:
  1927. case -ENOTCONN:
  1928. task->tk_action = call_bind;
  1929. break;
  1930. case -ENOBUFS:
  1931. rpc_delay(task, HZ>>2);
  1932. case -EAGAIN:
  1933. task->tk_action = call_transmit;
  1934. break;
  1935. case -EIO:
  1936. /* shutdown or soft timeout */
  1937. rpc_exit(task, status);
  1938. break;
  1939. default:
  1940. if (clnt->cl_chatty)
  1941. printk("%s: RPC call returned error %d\n",
  1942. clnt->cl_program->name, -status);
  1943. rpc_exit(task, status);
  1944. }
  1945. }
  1946. /*
  1947. * 6a. Handle RPC timeout
  1948. * We do not release the request slot, so we keep using the
  1949. * same XID for all retransmits.
  1950. */
  1951. static void
  1952. call_timeout(struct rpc_task *task)
  1953. {
  1954. struct rpc_clnt *clnt = task->tk_client;
  1955. if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
  1956. dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
  1957. goto retry;
  1958. }
  1959. dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
  1960. task->tk_timeouts++;
  1961. if (RPC_IS_SOFTCONN(task)) {
  1962. rpc_exit(task, -ETIMEDOUT);
  1963. return;
  1964. }
  1965. if (RPC_IS_SOFT(task)) {
  1966. if (clnt->cl_chatty) {
  1967. printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
  1968. clnt->cl_program->name,
  1969. task->tk_xprt->servername);
  1970. }
  1971. if (task->tk_flags & RPC_TASK_TIMEOUT)
  1972. rpc_exit(task, -ETIMEDOUT);
  1973. else
  1974. rpc_exit(task, -EIO);
  1975. return;
  1976. }
  1977. if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
  1978. task->tk_flags |= RPC_CALL_MAJORSEEN;
  1979. if (clnt->cl_chatty) {
  1980. printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
  1981. clnt->cl_program->name,
  1982. task->tk_xprt->servername);
  1983. }
  1984. }
  1985. rpc_force_rebind(clnt);
  1986. /*
  1987. * Did our request time out due to an RPCSEC_GSS out-of-sequence
  1988. * event? RFC2203 requires the server to drop all such requests.
  1989. */
  1990. rpcauth_invalcred(task);
  1991. retry:
  1992. task->tk_action = call_bind;
  1993. task->tk_status = 0;
  1994. }
  1995. /*
  1996. * 7. Decode the RPC reply
  1997. */
  1998. static void
  1999. call_decode(struct rpc_task *task)
  2000. {
  2001. struct rpc_clnt *clnt = task->tk_client;
  2002. struct rpc_rqst *req = task->tk_rqstp;
  2003. kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
  2004. __be32 *p;
  2005. dprint_status(task);
  2006. if (task->tk_flags & RPC_CALL_MAJORSEEN) {
  2007. if (clnt->cl_chatty) {
  2008. printk(KERN_NOTICE "%s: server %s OK\n",
  2009. clnt->cl_program->name,
  2010. task->tk_xprt->servername);
  2011. }
  2012. task->tk_flags &= ~RPC_CALL_MAJORSEEN;
  2013. }
  2014. /*
  2015. * Ensure that we see all writes made by xprt_complete_rqst()
  2016. * before it changed req->rq_reply_bytes_recvd.
  2017. */
  2018. smp_rmb();
  2019. req->rq_rcv_buf.len = req->rq_private_buf.len;
  2020. /* Check that the softirq receive buffer is valid */
  2021. WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
  2022. sizeof(req->rq_rcv_buf)) != 0);
  2023. if (req->rq_rcv_buf.len < 12) {
  2024. if (!RPC_IS_SOFT(task)) {
  2025. task->tk_action = call_bind;
  2026. goto out_retry;
  2027. }
  2028. dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
  2029. clnt->cl_program->name, task->tk_status);
  2030. task->tk_action = call_timeout;
  2031. goto out_retry;
  2032. }
  2033. p = rpc_verify_header(task);
  2034. if (IS_ERR(p)) {
  2035. if (p == ERR_PTR(-EAGAIN))
  2036. goto out_retry;
  2037. return;
  2038. }
  2039. task->tk_action = rpc_exit_task;
  2040. if (decode) {
  2041. task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
  2042. task->tk_msg.rpc_resp);
  2043. }
  2044. dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
  2045. task->tk_status);
  2046. return;
  2047. out_retry:
  2048. task->tk_status = 0;
  2049. /* Note: rpc_verify_header() may have freed the RPC slot */
  2050. if (task->tk_rqstp == req) {
  2051. req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
  2052. if (task->tk_client->cl_discrtry)
  2053. xprt_conditional_disconnect(req->rq_xprt,
  2054. req->rq_connect_cookie);
  2055. }
  2056. }
  2057. static __be32 *
  2058. rpc_encode_header(struct rpc_task *task)
  2059. {
  2060. struct rpc_clnt *clnt = task->tk_client;
  2061. struct rpc_rqst *req = task->tk_rqstp;
  2062. __be32 *p = req->rq_svec[0].iov_base;
  2063. /* FIXME: check buffer size? */
  2064. p = xprt_skip_transport_header(req->rq_xprt, p);
  2065. *p++ = req->rq_xid; /* XID */
  2066. *p++ = htonl(RPC_CALL); /* CALL */
  2067. *p++ = htonl(RPC_VERSION); /* RPC version */
  2068. *p++ = htonl(clnt->cl_prog); /* program number */
  2069. *p++ = htonl(clnt->cl_vers); /* program version */
  2070. *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
  2071. p = rpcauth_marshcred(task, p);
  2072. req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
  2073. return p;
  2074. }
  2075. static __be32 *
  2076. rpc_verify_header(struct rpc_task *task)
  2077. {
  2078. struct rpc_clnt *clnt = task->tk_client;
  2079. struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
  2080. int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
  2081. __be32 *p = iov->iov_base;
  2082. u32 n;
  2083. int error = -EACCES;
  2084. if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
  2085. /* RFC-1014 says that the representation of XDR data must be a
  2086. * multiple of four bytes
  2087. * - if it isn't pointer subtraction in the NFS client may give
  2088. * undefined results
  2089. */
  2090. dprintk("RPC: %5u %s: XDR representation not a multiple of"
  2091. " 4 bytes: 0x%x\n", task->tk_pid, __func__,
  2092. task->tk_rqstp->rq_rcv_buf.len);
  2093. error = -EIO;
  2094. goto out_err;
  2095. }
  2096. if ((len -= 3) < 0)
  2097. goto out_overflow;
  2098. p += 1; /* skip XID */
  2099. if ((n = ntohl(*p++)) != RPC_REPLY) {
  2100. dprintk("RPC: %5u %s: not an RPC reply: %x\n",
  2101. task->tk_pid, __func__, n);
  2102. error = -EIO;
  2103. goto out_garbage;
  2104. }
  2105. if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
  2106. if (--len < 0)
  2107. goto out_overflow;
  2108. switch ((n = ntohl(*p++))) {
  2109. case RPC_AUTH_ERROR:
  2110. break;
  2111. case RPC_MISMATCH:
  2112. dprintk("RPC: %5u %s: RPC call version mismatch!\n",
  2113. task->tk_pid, __func__);
  2114. error = -EPROTONOSUPPORT;
  2115. goto out_err;
  2116. default:
  2117. dprintk("RPC: %5u %s: RPC call rejected, "
  2118. "unknown error: %x\n",
  2119. task->tk_pid, __func__, n);
  2120. error = -EIO;
  2121. goto out_err;
  2122. }
  2123. if (--len < 0)
  2124. goto out_overflow;
  2125. switch ((n = ntohl(*p++))) {
  2126. case RPC_AUTH_REJECTEDCRED:
  2127. case RPC_AUTH_REJECTEDVERF:
  2128. case RPCSEC_GSS_CREDPROBLEM:
  2129. case RPCSEC_GSS_CTXPROBLEM:
  2130. if (!task->tk_cred_retry)
  2131. break;
  2132. task->tk_cred_retry--;
  2133. dprintk("RPC: %5u %s: retry stale creds\n",
  2134. task->tk_pid, __func__);
  2135. rpcauth_invalcred(task);
  2136. /* Ensure we obtain a new XID! */
  2137. xprt_release(task);
  2138. task->tk_action = call_reserve;
  2139. goto out_retry;
  2140. case RPC_AUTH_BADCRED:
  2141. case RPC_AUTH_BADVERF:
  2142. /* possibly garbled cred/verf? */
  2143. if (!task->tk_garb_retry)
  2144. break;
  2145. task->tk_garb_retry--;
  2146. dprintk("RPC: %5u %s: retry garbled creds\n",
  2147. task->tk_pid, __func__);
  2148. task->tk_action = call_bind;
  2149. goto out_retry;
  2150. case RPC_AUTH_TOOWEAK:
  2151. printk(KERN_NOTICE "RPC: server %s requires stronger "
  2152. "authentication.\n",
  2153. task->tk_xprt->servername);
  2154. break;
  2155. default:
  2156. dprintk("RPC: %5u %s: unknown auth error: %x\n",
  2157. task->tk_pid, __func__, n);
  2158. error = -EIO;
  2159. }
  2160. dprintk("RPC: %5u %s: call rejected %d\n",
  2161. task->tk_pid, __func__, n);
  2162. goto out_err;
  2163. }
  2164. p = rpcauth_checkverf(task, p);
  2165. if (IS_ERR(p)) {
  2166. error = PTR_ERR(p);
  2167. dprintk("RPC: %5u %s: auth check failed with %d\n",
  2168. task->tk_pid, __func__, error);
  2169. goto out_garbage; /* bad verifier, retry */
  2170. }
  2171. len = p - (__be32 *)iov->iov_base - 1;
  2172. if (len < 0)
  2173. goto out_overflow;
  2174. switch ((n = ntohl(*p++))) {
  2175. case RPC_SUCCESS:
  2176. return p;
  2177. case RPC_PROG_UNAVAIL:
  2178. dprintk("RPC: %5u %s: program %u is unsupported "
  2179. "by server %s\n", task->tk_pid, __func__,
  2180. (unsigned int)clnt->cl_prog,
  2181. task->tk_xprt->servername);
  2182. error = -EPFNOSUPPORT;
  2183. goto out_err;
  2184. case RPC_PROG_MISMATCH:
  2185. dprintk("RPC: %5u %s: program %u, version %u unsupported "
  2186. "by server %s\n", task->tk_pid, __func__,
  2187. (unsigned int)clnt->cl_prog,
  2188. (unsigned int)clnt->cl_vers,
  2189. task->tk_xprt->servername);
  2190. error = -EPROTONOSUPPORT;
  2191. goto out_err;
  2192. case RPC_PROC_UNAVAIL:
  2193. dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
  2194. "version %u on server %s\n",
  2195. task->tk_pid, __func__,
  2196. rpc_proc_name(task),
  2197. clnt->cl_prog, clnt->cl_vers,
  2198. task->tk_xprt->servername);
  2199. error = -EOPNOTSUPP;
  2200. goto out_err;
  2201. case RPC_GARBAGE_ARGS:
  2202. dprintk("RPC: %5u %s: server saw garbage\n",
  2203. task->tk_pid, __func__);
  2204. break; /* retry */
  2205. default:
  2206. dprintk("RPC: %5u %s: server accept status: %x\n",
  2207. task->tk_pid, __func__, n);
  2208. /* Also retry */
  2209. }
  2210. out_garbage:
  2211. clnt->cl_stats->rpcgarbage++;
  2212. if (task->tk_garb_retry) {
  2213. task->tk_garb_retry--;
  2214. dprintk("RPC: %5u %s: retrying\n",
  2215. task->tk_pid, __func__);
  2216. task->tk_action = call_bind;
  2217. out_retry:
  2218. return ERR_PTR(-EAGAIN);
  2219. }
  2220. out_err:
  2221. rpc_exit(task, error);
  2222. dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
  2223. __func__, error);
  2224. return ERR_PTR(error);
  2225. out_overflow:
  2226. dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
  2227. __func__);
  2228. goto out_garbage;
  2229. }
  2230. static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
  2231. {
  2232. }
  2233. static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
  2234. {
  2235. return 0;
  2236. }
  2237. static struct rpc_procinfo rpcproc_null = {
  2238. .p_encode = rpcproc_encode_null,
  2239. .p_decode = rpcproc_decode_null,
  2240. };
  2241. static int rpc_ping(struct rpc_clnt *clnt)
  2242. {
  2243. struct rpc_message msg = {
  2244. .rpc_proc = &rpcproc_null,
  2245. };
  2246. int err;
  2247. msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
  2248. err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
  2249. put_rpccred(msg.rpc_cred);
  2250. return err;
  2251. }
  2252. static
  2253. struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
  2254. struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
  2255. const struct rpc_call_ops *ops, void *data)
  2256. {
  2257. struct rpc_message msg = {
  2258. .rpc_proc = &rpcproc_null,
  2259. .rpc_cred = cred,
  2260. };
  2261. struct rpc_task_setup task_setup_data = {
  2262. .rpc_client = clnt,
  2263. .rpc_xprt = xprt,
  2264. .rpc_message = &msg,
  2265. .callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
  2266. .callback_data = data,
  2267. .flags = flags,
  2268. };
  2269. return rpc_run_task(&task_setup_data);
  2270. }
  2271. struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
  2272. {
  2273. return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
  2274. }
  2275. EXPORT_SYMBOL_GPL(rpc_call_null);
  2276. struct rpc_cb_add_xprt_calldata {
  2277. struct rpc_xprt_switch *xps;
  2278. struct rpc_xprt *xprt;
  2279. };
  2280. static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
  2281. {
  2282. struct rpc_cb_add_xprt_calldata *data = calldata;
  2283. if (task->tk_status == 0)
  2284. rpc_xprt_switch_add_xprt(data->xps, data->xprt);
  2285. }
  2286. static void rpc_cb_add_xprt_release(void *calldata)
  2287. {
  2288. struct rpc_cb_add_xprt_calldata *data = calldata;
  2289. xprt_put(data->xprt);
  2290. xprt_switch_put(data->xps);
  2291. kfree(data);
  2292. }
  2293. static const struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
  2294. .rpc_call_done = rpc_cb_add_xprt_done,
  2295. .rpc_release = rpc_cb_add_xprt_release,
  2296. };
  2297. /**
  2298. * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
  2299. * @clnt: pointer to struct rpc_clnt
  2300. * @xps: pointer to struct rpc_xprt_switch,
  2301. * @xprt: pointer struct rpc_xprt
  2302. * @dummy: unused
  2303. */
  2304. int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
  2305. struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
  2306. void *dummy)
  2307. {
  2308. struct rpc_cb_add_xprt_calldata *data;
  2309. struct rpc_cred *cred;
  2310. struct rpc_task *task;
  2311. data = kmalloc(sizeof(*data), GFP_NOFS);
  2312. if (!data)
  2313. return -ENOMEM;
  2314. data->xps = xprt_switch_get(xps);
  2315. data->xprt = xprt_get(xprt);
  2316. cred = authnull_ops.lookup_cred(NULL, NULL, 0);
  2317. task = rpc_call_null_helper(clnt, xprt, cred,
  2318. RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
  2319. &rpc_cb_add_xprt_call_ops, data);
  2320. put_rpccred(cred);
  2321. if (IS_ERR(task))
  2322. return PTR_ERR(task);
  2323. rpc_put_task(task);
  2324. return 1;
  2325. }
  2326. EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
  2327. /**
  2328. * rpc_clnt_setup_test_and_add_xprt()
  2329. *
  2330. * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
  2331. * 1) caller of the test function must dereference the rpc_xprt_switch
  2332. * and the rpc_xprt.
  2333. * 2) test function must call rpc_xprt_switch_add_xprt, usually in
  2334. * the rpc_call_done routine.
  2335. *
  2336. * Upon success (return of 1), the test function adds the new
  2337. * transport to the rpc_clnt xprt switch
  2338. *
  2339. * @clnt: struct rpc_clnt to get the new transport
  2340. * @xps: the rpc_xprt_switch to hold the new transport
  2341. * @xprt: the rpc_xprt to test
  2342. * @data: a struct rpc_add_xprt_test pointer that holds the test function
  2343. * and test function call data
  2344. */
  2345. int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *clnt,
  2346. struct rpc_xprt_switch *xps,
  2347. struct rpc_xprt *xprt,
  2348. void *data)
  2349. {
  2350. struct rpc_cred *cred;
  2351. struct rpc_task *task;
  2352. struct rpc_add_xprt_test *xtest = (struct rpc_add_xprt_test *)data;
  2353. int status = -EADDRINUSE;
  2354. xprt = xprt_get(xprt);
  2355. xprt_switch_get(xps);
  2356. if (rpc_xprt_switch_has_addr(xps, (struct sockaddr *)&xprt->addr))
  2357. goto out_err;
  2358. /* Test the connection */
  2359. cred = authnull_ops.lookup_cred(NULL, NULL, 0);
  2360. task = rpc_call_null_helper(clnt, xprt, cred,
  2361. RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
  2362. NULL, NULL);
  2363. put_rpccred(cred);
  2364. if (IS_ERR(task)) {
  2365. status = PTR_ERR(task);
  2366. goto out_err;
  2367. }
  2368. status = task->tk_status;
  2369. rpc_put_task(task);
  2370. if (status < 0)
  2371. goto out_err;
  2372. /* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
  2373. xtest->add_xprt_test(clnt, xprt, xtest->data);
  2374. /* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
  2375. return 1;
  2376. out_err:
  2377. xprt_put(xprt);
  2378. xprt_switch_put(xps);
  2379. pr_info("RPC: rpc_clnt_test_xprt failed: %d addr %s not added\n",
  2380. status, xprt->address_strings[RPC_DISPLAY_ADDR]);
  2381. return status;
  2382. }
  2383. EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt);
  2384. /**
  2385. * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
  2386. * @clnt: pointer to struct rpc_clnt
  2387. * @xprtargs: pointer to struct xprt_create
  2388. * @setup: callback to test and/or set up the connection
  2389. * @data: pointer to setup function data
  2390. *
  2391. * Creates a new transport using the parameters set in args and
  2392. * adds it to clnt.
  2393. * If ping is set, then test that connectivity succeeds before
  2394. * adding the new transport.
  2395. *
  2396. */
  2397. int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
  2398. struct xprt_create *xprtargs,
  2399. int (*setup)(struct rpc_clnt *,
  2400. struct rpc_xprt_switch *,
  2401. struct rpc_xprt *,
  2402. void *),
  2403. void *data)
  2404. {
  2405. struct rpc_xprt_switch *xps;
  2406. struct rpc_xprt *xprt;
  2407. unsigned long reconnect_timeout;
  2408. unsigned char resvport;
  2409. int ret = 0;
  2410. rcu_read_lock();
  2411. xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
  2412. xprt = xprt_iter_xprt(&clnt->cl_xpi);
  2413. if (xps == NULL || xprt == NULL) {
  2414. rcu_read_unlock();
  2415. return -EAGAIN;
  2416. }
  2417. resvport = xprt->resvport;
  2418. reconnect_timeout = xprt->max_reconnect_timeout;
  2419. rcu_read_unlock();
  2420. xprt = xprt_create_transport(xprtargs);
  2421. if (IS_ERR(xprt)) {
  2422. ret = PTR_ERR(xprt);
  2423. goto out_put_switch;
  2424. }
  2425. xprt->resvport = resvport;
  2426. xprt->max_reconnect_timeout = reconnect_timeout;
  2427. rpc_xprt_switch_set_roundrobin(xps);
  2428. if (setup) {
  2429. ret = setup(clnt, xps, xprt, data);
  2430. if (ret != 0)
  2431. goto out_put_xprt;
  2432. }
  2433. rpc_xprt_switch_add_xprt(xps, xprt);
  2434. out_put_xprt:
  2435. xprt_put(xprt);
  2436. out_put_switch:
  2437. xprt_switch_put(xps);
  2438. return ret;
  2439. }
  2440. EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
  2441. static int
  2442. rpc_xprt_cap_max_reconnect_timeout(struct rpc_clnt *clnt,
  2443. struct rpc_xprt *xprt,
  2444. void *data)
  2445. {
  2446. unsigned long timeout = *((unsigned long *)data);
  2447. if (timeout < xprt->max_reconnect_timeout)
  2448. xprt->max_reconnect_timeout = timeout;
  2449. return 0;
  2450. }
  2451. void
  2452. rpc_cap_max_reconnect_timeout(struct rpc_clnt *clnt, unsigned long timeo)
  2453. {
  2454. rpc_clnt_iterate_for_each_xprt(clnt,
  2455. rpc_xprt_cap_max_reconnect_timeout,
  2456. &timeo);
  2457. }
  2458. EXPORT_SYMBOL_GPL(rpc_cap_max_reconnect_timeout);
  2459. void rpc_clnt_xprt_switch_put(struct rpc_clnt *clnt)
  2460. {
  2461. rcu_read_lock();
  2462. xprt_switch_put(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
  2463. rcu_read_unlock();
  2464. }
  2465. EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put);
  2466. void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *clnt, struct rpc_xprt *xprt)
  2467. {
  2468. rcu_read_lock();
  2469. rpc_xprt_switch_add_xprt(rcu_dereference(clnt->cl_xpi.xpi_xpswitch),
  2470. xprt);
  2471. rcu_read_unlock();
  2472. }
  2473. EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt);
  2474. bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt,
  2475. const struct sockaddr *sap)
  2476. {
  2477. struct rpc_xprt_switch *xps;
  2478. bool ret;
  2479. rcu_read_lock();
  2480. xps = rcu_dereference(clnt->cl_xpi.xpi_xpswitch);
  2481. ret = rpc_xprt_switch_has_addr(xps, sap);
  2482. rcu_read_unlock();
  2483. return ret;
  2484. }
  2485. EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr);
  2486. #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
  2487. static void rpc_show_header(void)
  2488. {
  2489. printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
  2490. "-timeout ---ops--\n");
  2491. }
  2492. static void rpc_show_task(const struct rpc_clnt *clnt,
  2493. const struct rpc_task *task)
  2494. {
  2495. const char *rpc_waitq = "none";
  2496. if (RPC_IS_QUEUED(task))
  2497. rpc_waitq = rpc_qname(task->tk_waitqueue);
  2498. printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
  2499. task->tk_pid, task->tk_flags, task->tk_status,
  2500. clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
  2501. clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
  2502. task->tk_action, rpc_waitq);
  2503. }
  2504. void rpc_show_tasks(struct net *net)
  2505. {
  2506. struct rpc_clnt *clnt;
  2507. struct rpc_task *task;
  2508. int header = 0;
  2509. struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
  2510. spin_lock(&sn->rpc_client_lock);
  2511. list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
  2512. spin_lock(&clnt->cl_lock);
  2513. list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
  2514. if (!header) {
  2515. rpc_show_header();
  2516. header++;
  2517. }
  2518. rpc_show_task(clnt, task);
  2519. }
  2520. spin_unlock(&clnt->cl_lock);
  2521. }
  2522. spin_unlock(&sn->rpc_client_lock);
  2523. }
  2524. #endif
  2525. #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
  2526. static int
  2527. rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
  2528. struct rpc_xprt *xprt,
  2529. void *dummy)
  2530. {
  2531. return xprt_enable_swap(xprt);
  2532. }
  2533. int
  2534. rpc_clnt_swap_activate(struct rpc_clnt *clnt)
  2535. {
  2536. if (atomic_inc_return(&clnt->cl_swapper) == 1)
  2537. return rpc_clnt_iterate_for_each_xprt(clnt,
  2538. rpc_clnt_swap_activate_callback, NULL);
  2539. return 0;
  2540. }
  2541. EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
  2542. static int
  2543. rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
  2544. struct rpc_xprt *xprt,
  2545. void *dummy)
  2546. {
  2547. xprt_disable_swap(xprt);
  2548. return 0;
  2549. }
  2550. void
  2551. rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
  2552. {
  2553. if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
  2554. rpc_clnt_iterate_for_each_xprt(clnt,
  2555. rpc_clnt_swap_deactivate_callback, NULL);
  2556. }
  2557. EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
  2558. #endif /* CONFIG_SUNRPC_SWAP */