callback.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415
  1. /*
  2. * linux/fs/nfs/callback.c
  3. *
  4. * Copyright (C) 2004 Trond Myklebust
  5. *
  6. * NFSv4 callback handling
  7. */
  8. #include <linux/completion.h>
  9. #include <linux/ip.h>
  10. #include <linux/module.h>
  11. #include <linux/sunrpc/svc.h>
  12. #include <linux/sunrpc/svcsock.h>
  13. #include <linux/nfs_fs.h>
  14. #include <linux/mutex.h>
  15. #include <linux/freezer.h>
  16. #include <linux/kthread.h>
  17. #include <linux/sunrpc/svcauth_gss.h>
  18. #include <linux/sunrpc/bc_xprt.h>
  19. #include <net/inet_sock.h>
  20. #include "nfs4_fs.h"
  21. #include "callback.h"
  22. #include "internal.h"
  23. #define NFSDBG_FACILITY NFSDBG_CALLBACK
  24. struct nfs_callback_data {
  25. unsigned int users;
  26. struct svc_serv *serv;
  27. struct svc_rqst *rqst;
  28. struct task_struct *task;
  29. };
  30. static struct nfs_callback_data nfs_callback_info[NFS4_MAX_MINOR_VERSION + 1];
  31. static DEFINE_MUTEX(nfs_callback_mutex);
  32. static struct svc_program nfs4_callback_program;
  33. unsigned int nfs_callback_set_tcpport;
  34. unsigned short nfs_callback_tcpport;
  35. unsigned short nfs_callback_tcpport6;
  36. #define NFS_CALLBACK_MAXPORTNR (65535U)
  37. static int param_set_portnr(const char *val, const struct kernel_param *kp)
  38. {
  39. unsigned long num;
  40. int ret;
  41. if (!val)
  42. return -EINVAL;
  43. ret = strict_strtoul(val, 0, &num);
  44. if (ret == -EINVAL || num > NFS_CALLBACK_MAXPORTNR)
  45. return -EINVAL;
  46. *((unsigned int *)kp->arg) = num;
  47. return 0;
  48. }
  49. static struct kernel_param_ops param_ops_portnr = {
  50. .set = param_set_portnr,
  51. .get = param_get_uint,
  52. };
  53. #define param_check_portnr(name, p) __param_check(name, p, unsigned int);
  54. module_param_named(callback_tcpport, nfs_callback_set_tcpport, portnr, 0644);
  55. /*
  56. * This is the NFSv4 callback kernel thread.
  57. */
  58. static int
  59. nfs4_callback_svc(void *vrqstp)
  60. {
  61. int err, preverr = 0;
  62. struct svc_rqst *rqstp = vrqstp;
  63. set_freezable();
  64. while (!kthread_should_stop()) {
  65. /*
  66. * Listen for a request on the socket
  67. */
  68. err = svc_recv(rqstp, MAX_SCHEDULE_TIMEOUT);
  69. if (err == -EAGAIN || err == -EINTR) {
  70. preverr = err;
  71. continue;
  72. }
  73. if (err < 0) {
  74. if (err != preverr) {
  75. printk(KERN_WARNING "NFS: %s: unexpected error "
  76. "from svc_recv (%d)\n", __func__, err);
  77. preverr = err;
  78. }
  79. schedule_timeout_uninterruptible(HZ);
  80. continue;
  81. }
  82. preverr = err;
  83. svc_process(rqstp);
  84. }
  85. return 0;
  86. }
  87. /*
  88. * Prepare to bring up the NFSv4 callback service
  89. */
  90. static struct svc_rqst *
  91. nfs4_callback_up(struct svc_serv *serv, struct rpc_xprt *xprt)
  92. {
  93. int ret;
  94. ret = svc_create_xprt(serv, "tcp", &init_net, PF_INET,
  95. nfs_callback_set_tcpport, SVC_SOCK_ANONYMOUS);
  96. if (ret <= 0)
  97. goto out_err;
  98. nfs_callback_tcpport = ret;
  99. dprintk("NFS: Callback listener port = %u (af %u)\n",
  100. nfs_callback_tcpport, PF_INET);
  101. ret = svc_create_xprt(serv, "tcp", &init_net, PF_INET6,
  102. nfs_callback_set_tcpport, SVC_SOCK_ANONYMOUS);
  103. if (ret > 0) {
  104. nfs_callback_tcpport6 = ret;
  105. dprintk("NFS: Callback listener port = %u (af %u)\n",
  106. nfs_callback_tcpport6, PF_INET6);
  107. } else if (ret == -EAFNOSUPPORT)
  108. ret = 0;
  109. else
  110. goto out_err;
  111. return svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
  112. out_err:
  113. if (ret == 0)
  114. ret = -ENOMEM;
  115. return ERR_PTR(ret);
  116. }
  117. #if defined(CONFIG_NFS_V4_1)
  118. /*
  119. * The callback service for NFSv4.1 callbacks
  120. */
  121. static int
  122. nfs41_callback_svc(void *vrqstp)
  123. {
  124. struct svc_rqst *rqstp = vrqstp;
  125. struct svc_serv *serv = rqstp->rq_server;
  126. struct rpc_rqst *req;
  127. int error;
  128. DEFINE_WAIT(wq);
  129. set_freezable();
  130. while (!kthread_should_stop()) {
  131. prepare_to_wait(&serv->sv_cb_waitq, &wq, TASK_INTERRUPTIBLE);
  132. spin_lock_bh(&serv->sv_cb_lock);
  133. if (!list_empty(&serv->sv_cb_list)) {
  134. req = list_first_entry(&serv->sv_cb_list,
  135. struct rpc_rqst, rq_bc_list);
  136. list_del(&req->rq_bc_list);
  137. spin_unlock_bh(&serv->sv_cb_lock);
  138. finish_wait(&serv->sv_cb_waitq, &wq);
  139. dprintk("Invoking bc_svc_process()\n");
  140. error = bc_svc_process(serv, req, rqstp);
  141. dprintk("bc_svc_process() returned w/ error code= %d\n",
  142. error);
  143. } else {
  144. spin_unlock_bh(&serv->sv_cb_lock);
  145. schedule();
  146. finish_wait(&serv->sv_cb_waitq, &wq);
  147. }
  148. flush_signals(current);
  149. }
  150. return 0;
  151. }
  152. /*
  153. * Bring up the NFSv4.1 callback service
  154. */
  155. static struct svc_rqst *
  156. nfs41_callback_up(struct svc_serv *serv, struct rpc_xprt *xprt)
  157. {
  158. struct svc_rqst *rqstp;
  159. int ret;
  160. /*
  161. * Create an svc_sock for the back channel service that shares the
  162. * fore channel connection.
  163. * Returns the input port (0) and sets the svc_serv bc_xprt on success
  164. */
  165. ret = svc_create_xprt(serv, "tcp-bc", &init_net, PF_INET, 0,
  166. SVC_SOCK_ANONYMOUS);
  167. if (ret < 0) {
  168. rqstp = ERR_PTR(ret);
  169. goto out;
  170. }
  171. /*
  172. * Save the svc_serv in the transport so that it can
  173. * be referenced when the session backchannel is initialized
  174. */
  175. xprt->bc_serv = serv;
  176. INIT_LIST_HEAD(&serv->sv_cb_list);
  177. spin_lock_init(&serv->sv_cb_lock);
  178. init_waitqueue_head(&serv->sv_cb_waitq);
  179. rqstp = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
  180. if (IS_ERR(rqstp)) {
  181. svc_xprt_put(serv->sv_bc_xprt);
  182. serv->sv_bc_xprt = NULL;
  183. }
  184. out:
  185. dprintk("--> %s return %ld\n", __func__,
  186. IS_ERR(rqstp) ? PTR_ERR(rqstp) : 0);
  187. return rqstp;
  188. }
  189. static inline int nfs_minorversion_callback_svc_setup(u32 minorversion,
  190. struct svc_serv *serv, struct rpc_xprt *xprt,
  191. struct svc_rqst **rqstpp, int (**callback_svc)(void *vrqstp))
  192. {
  193. if (minorversion) {
  194. *rqstpp = nfs41_callback_up(serv, xprt);
  195. *callback_svc = nfs41_callback_svc;
  196. }
  197. return minorversion;
  198. }
  199. static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
  200. struct nfs_callback_data *cb_info)
  201. {
  202. if (minorversion)
  203. xprt->bc_serv = cb_info->serv;
  204. }
  205. #else
  206. static inline int nfs_minorversion_callback_svc_setup(u32 minorversion,
  207. struct svc_serv *serv, struct rpc_xprt *xprt,
  208. struct svc_rqst **rqstpp, int (**callback_svc)(void *vrqstp))
  209. {
  210. return 0;
  211. }
  212. static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
  213. struct nfs_callback_data *cb_info)
  214. {
  215. }
  216. #endif /* CONFIG_NFS_V4_1 */
  217. /*
  218. * Bring up the callback thread if it is not already up.
  219. */
  220. int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt)
  221. {
  222. struct svc_serv *serv = NULL;
  223. struct svc_rqst *rqstp;
  224. int (*callback_svc)(void *vrqstp);
  225. struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
  226. char svc_name[12];
  227. int ret = 0;
  228. int minorversion_setup;
  229. struct net *net = &init_net;
  230. mutex_lock(&nfs_callback_mutex);
  231. if (cb_info->users++ || cb_info->task != NULL) {
  232. nfs_callback_bc_serv(minorversion, xprt, cb_info);
  233. goto out;
  234. }
  235. serv = svc_create(&nfs4_callback_program, NFS4_CALLBACK_BUFSIZE, NULL);
  236. if (!serv) {
  237. ret = -ENOMEM;
  238. goto out_err;
  239. }
  240. ret = svc_bind(serv, net);
  241. if (ret < 0) {
  242. printk(KERN_WARNING "NFS: bind callback service failed\n");
  243. goto out_err;
  244. }
  245. minorversion_setup = nfs_minorversion_callback_svc_setup(minorversion,
  246. serv, xprt, &rqstp, &callback_svc);
  247. if (!minorversion_setup) {
  248. /* v4.0 callback setup */
  249. rqstp = nfs4_callback_up(serv, xprt);
  250. callback_svc = nfs4_callback_svc;
  251. }
  252. if (IS_ERR(rqstp)) {
  253. ret = PTR_ERR(rqstp);
  254. goto out_err;
  255. }
  256. svc_sock_update_bufs(serv);
  257. sprintf(svc_name, "nfsv4.%u-svc", minorversion);
  258. cb_info->serv = serv;
  259. cb_info->rqst = rqstp;
  260. cb_info->task = kthread_run(callback_svc, cb_info->rqst, svc_name);
  261. if (IS_ERR(cb_info->task)) {
  262. ret = PTR_ERR(cb_info->task);
  263. svc_exit_thread(cb_info->rqst);
  264. cb_info->rqst = NULL;
  265. cb_info->task = NULL;
  266. goto out_err;
  267. }
  268. out:
  269. /*
  270. * svc_create creates the svc_serv with sv_nrthreads == 1, and then
  271. * svc_prepare_thread increments that. So we need to call svc_destroy
  272. * on both success and failure so that the refcount is 1 when the
  273. * thread exits.
  274. */
  275. if (serv)
  276. svc_destroy(serv);
  277. mutex_unlock(&nfs_callback_mutex);
  278. return ret;
  279. out_err:
  280. dprintk("NFS: Couldn't create callback socket or server thread; "
  281. "err = %d\n", ret);
  282. cb_info->users--;
  283. if (serv)
  284. svc_shutdown_net(serv, net);
  285. goto out;
  286. }
  287. /*
  288. * Kill the callback thread if it's no longer being used.
  289. */
  290. void nfs_callback_down(int minorversion)
  291. {
  292. struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
  293. mutex_lock(&nfs_callback_mutex);
  294. cb_info->users--;
  295. if (cb_info->users == 0 && cb_info->task != NULL) {
  296. kthread_stop(cb_info->task);
  297. svc_shutdown_net(cb_info->serv, &init_net);
  298. svc_exit_thread(cb_info->rqst);
  299. cb_info->serv = NULL;
  300. cb_info->rqst = NULL;
  301. cb_info->task = NULL;
  302. }
  303. mutex_unlock(&nfs_callback_mutex);
  304. }
  305. /* Boolean check of RPC_AUTH_GSS principal */
  306. int
  307. check_gss_callback_principal(struct nfs_client *clp, struct svc_rqst *rqstp)
  308. {
  309. char *p = svc_gss_principal(rqstp);
  310. if (rqstp->rq_authop->flavour != RPC_AUTH_GSS)
  311. return 1;
  312. /* No RPC_AUTH_GSS on NFSv4.1 back channel yet */
  313. if (clp->cl_minorversion != 0)
  314. return 0;
  315. /*
  316. * It might just be a normal user principal, in which case
  317. * userspace won't bother to tell us the name at all.
  318. */
  319. if (p == NULL)
  320. return 0;
  321. /* Expect a GSS_C_NT_HOSTBASED_NAME like "nfs@serverhostname" */
  322. if (memcmp(p, "nfs@", 4) != 0)
  323. return 0;
  324. p += 4;
  325. if (strcmp(p, clp->cl_hostname) != 0)
  326. return 0;
  327. return 1;
  328. }
  329. /*
  330. * pg_authenticate method for nfsv4 callback threads.
  331. *
  332. * The authflavor has been negotiated, so an incorrect flavor is a server
  333. * bug. Drop packets with incorrect authflavor.
  334. *
  335. * All other checking done after NFS decoding where the nfs_client can be
  336. * found in nfs4_callback_compound
  337. */
  338. static int nfs_callback_authenticate(struct svc_rqst *rqstp)
  339. {
  340. switch (rqstp->rq_authop->flavour) {
  341. case RPC_AUTH_NULL:
  342. if (rqstp->rq_proc != CB_NULL)
  343. return SVC_DROP;
  344. break;
  345. case RPC_AUTH_GSS:
  346. /* No RPC_AUTH_GSS support yet in NFSv4.1 */
  347. if (svc_is_backchannel(rqstp))
  348. return SVC_DROP;
  349. }
  350. return SVC_OK;
  351. }
  352. /*
  353. * Define NFS4 callback program
  354. */
  355. static struct svc_version *nfs4_callback_version[] = {
  356. [1] = &nfs4_callback_version1,
  357. [4] = &nfs4_callback_version4,
  358. };
  359. static struct svc_stat nfs4_callback_stats;
  360. static struct svc_program nfs4_callback_program = {
  361. .pg_prog = NFS4_CALLBACK, /* RPC service number */
  362. .pg_nvers = ARRAY_SIZE(nfs4_callback_version), /* Number of entries */
  363. .pg_vers = nfs4_callback_version, /* version table */
  364. .pg_name = "NFSv4 callback", /* service name */
  365. .pg_class = "nfs", /* authentication class */
  366. .pg_stats = &nfs4_callback_stats,
  367. .pg_authenticate = nfs_callback_authenticate,
  368. };