mon.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565
  1. /*
  2. * linux/fs/lockd/mon.c
  3. *
  4. * The kernel statd client.
  5. *
  6. * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
  7. */
  8. #include <linux/types.h>
  9. #include <linux/utsname.h>
  10. #include <linux/kernel.h>
  11. #include <linux/ktime.h>
  12. #include <linux/slab.h>
  13. #include <linux/sunrpc/clnt.h>
  14. #include <linux/sunrpc/xprtsock.h>
  15. #include <linux/sunrpc/svc.h>
  16. #include <linux/lockd/lockd.h>
  17. #include <asm/unaligned.h>
  18. #define NLMDBG_FACILITY NLMDBG_MONITOR
  19. #define NSM_PROGRAM 100024
  20. #define NSM_VERSION 1
  21. enum {
  22. NSMPROC_NULL,
  23. NSMPROC_STAT,
  24. NSMPROC_MON,
  25. NSMPROC_UNMON,
  26. NSMPROC_UNMON_ALL,
  27. NSMPROC_SIMU_CRASH,
  28. NSMPROC_NOTIFY,
  29. };
  30. struct nsm_args {
  31. struct nsm_private *priv;
  32. u32 prog; /* RPC callback info */
  33. u32 vers;
  34. u32 proc;
  35. char *mon_name;
  36. char *nodename;
  37. };
  38. struct nsm_res {
  39. u32 status;
  40. u32 state;
  41. };
  42. static const struct rpc_program nsm_program;
  43. static LIST_HEAD(nsm_handles);
  44. static DEFINE_SPINLOCK(nsm_lock);
  45. /*
  46. * Local NSM state
  47. */
  48. u32 __read_mostly nsm_local_state;
  49. bool __read_mostly nsm_use_hostnames;
  50. static inline struct sockaddr *nsm_addr(const struct nsm_handle *nsm)
  51. {
  52. return (struct sockaddr *)&nsm->sm_addr;
  53. }
  54. static struct rpc_clnt *nsm_create(struct net *net)
  55. {
  56. struct sockaddr_in sin = {
  57. .sin_family = AF_INET,
  58. .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
  59. };
  60. struct rpc_create_args args = {
  61. .net = net,
  62. .protocol = XPRT_TRANSPORT_UDP,
  63. .address = (struct sockaddr *)&sin,
  64. .addrsize = sizeof(sin),
  65. .servername = "rpc.statd",
  66. .program = &nsm_program,
  67. .version = NSM_VERSION,
  68. .authflavor = RPC_AUTH_NULL,
  69. .flags = RPC_CLNT_CREATE_NOPING,
  70. };
  71. return rpc_create(&args);
  72. }
  73. static int nsm_mon_unmon(struct nsm_handle *nsm, u32 proc, struct nsm_res *res,
  74. struct net *net)
  75. {
  76. struct rpc_clnt *clnt;
  77. int status;
  78. struct nsm_args args = {
  79. .priv = &nsm->sm_priv,
  80. .prog = NLM_PROGRAM,
  81. .vers = 3,
  82. .proc = NLMPROC_NSM_NOTIFY,
  83. .mon_name = nsm->sm_mon_name,
  84. .nodename = utsname()->nodename,
  85. };
  86. struct rpc_message msg = {
  87. .rpc_argp = &args,
  88. .rpc_resp = res,
  89. };
  90. clnt = nsm_create(net);
  91. if (IS_ERR(clnt)) {
  92. status = PTR_ERR(clnt);
  93. dprintk("lockd: failed to create NSM upcall transport, "
  94. "status=%d\n", status);
  95. goto out;
  96. }
  97. memset(res, 0, sizeof(*res));
  98. msg.rpc_proc = &clnt->cl_procinfo[proc];
  99. status = rpc_call_sync(clnt, &msg, 0);
  100. if (status == -ECONNREFUSED) {
  101. dprintk("lockd: NSM upcall RPC failed, status=%d, forcing rebind\n",
  102. status);
  103. rpc_force_rebind(clnt);
  104. status = rpc_call_sync(clnt, &msg, RPC_TASK_SOFTCONN);
  105. }
  106. if (status < 0)
  107. dprintk("lockd: NSM upcall RPC failed, status=%d\n",
  108. status);
  109. else
  110. status = 0;
  111. rpc_shutdown_client(clnt);
  112. out:
  113. return status;
  114. }
  115. /**
  116. * nsm_monitor - Notify a peer in case we reboot
  117. * @host: pointer to nlm_host of peer to notify
  118. *
  119. * If this peer is not already monitored, this function sends an
  120. * upcall to the local rpc.statd to record the name/address of
  121. * the peer to notify in case we reboot.
  122. *
  123. * Returns zero if the peer is monitored by the local rpc.statd;
  124. * otherwise a negative errno value is returned.
  125. */
  126. int nsm_monitor(const struct nlm_host *host)
  127. {
  128. struct nsm_handle *nsm = host->h_nsmhandle;
  129. struct nsm_res res;
  130. int status;
  131. dprintk("lockd: nsm_monitor(%s)\n", nsm->sm_name);
  132. if (nsm->sm_monitored)
  133. return 0;
  134. /*
  135. * Choose whether to record the caller_name or IP address of
  136. * this peer in the local rpc.statd's database.
  137. */
  138. nsm->sm_mon_name = nsm_use_hostnames ? nsm->sm_name : nsm->sm_addrbuf;
  139. status = nsm_mon_unmon(nsm, NSMPROC_MON, &res, host->net);
  140. if (unlikely(res.status != 0))
  141. status = -EIO;
  142. if (unlikely(status < 0)) {
  143. printk(KERN_NOTICE "lockd: cannot monitor %s\n", nsm->sm_name);
  144. return status;
  145. }
  146. nsm->sm_monitored = 1;
  147. if (unlikely(nsm_local_state != res.state)) {
  148. nsm_local_state = res.state;
  149. dprintk("lockd: NSM state changed to %d\n", nsm_local_state);
  150. }
  151. return 0;
  152. }
  153. /**
  154. * nsm_unmonitor - Unregister peer notification
  155. * @host: pointer to nlm_host of peer to stop monitoring
  156. *
  157. * If this peer is monitored, this function sends an upcall to
  158. * tell the local rpc.statd not to send this peer a notification
  159. * when we reboot.
  160. */
  161. void nsm_unmonitor(const struct nlm_host *host)
  162. {
  163. struct nsm_handle *nsm = host->h_nsmhandle;
  164. struct nsm_res res;
  165. int status;
  166. if (atomic_read(&nsm->sm_count) == 1
  167. && nsm->sm_monitored && !nsm->sm_sticky) {
  168. dprintk("lockd: nsm_unmonitor(%s)\n", nsm->sm_name);
  169. status = nsm_mon_unmon(nsm, NSMPROC_UNMON, &res, host->net);
  170. if (res.status != 0)
  171. status = -EIO;
  172. if (status < 0)
  173. printk(KERN_NOTICE "lockd: cannot unmonitor %s\n",
  174. nsm->sm_name);
  175. else
  176. nsm->sm_monitored = 0;
  177. }
  178. }
  179. static struct nsm_handle *nsm_lookup_hostname(const char *hostname,
  180. const size_t len)
  181. {
  182. struct nsm_handle *nsm;
  183. list_for_each_entry(nsm, &nsm_handles, sm_link)
  184. if (strlen(nsm->sm_name) == len &&
  185. memcmp(nsm->sm_name, hostname, len) == 0)
  186. return nsm;
  187. return NULL;
  188. }
  189. static struct nsm_handle *nsm_lookup_addr(const struct sockaddr *sap)
  190. {
  191. struct nsm_handle *nsm;
  192. list_for_each_entry(nsm, &nsm_handles, sm_link)
  193. if (rpc_cmp_addr(nsm_addr(nsm), sap))
  194. return nsm;
  195. return NULL;
  196. }
  197. static struct nsm_handle *nsm_lookup_priv(const struct nsm_private *priv)
  198. {
  199. struct nsm_handle *nsm;
  200. list_for_each_entry(nsm, &nsm_handles, sm_link)
  201. if (memcmp(nsm->sm_priv.data, priv->data,
  202. sizeof(priv->data)) == 0)
  203. return nsm;
  204. return NULL;
  205. }
  206. /*
  207. * Construct a unique cookie to match this nsm_handle to this monitored
  208. * host. It is passed to the local rpc.statd via NSMPROC_MON, and
  209. * returned via NLMPROC_SM_NOTIFY, in the "priv" field of these
  210. * requests.
  211. *
  212. * The NSM protocol requires that these cookies be unique while the
  213. * system is running. We prefer a stronger requirement of making them
  214. * unique across reboots. If user space bugs cause a stale cookie to
  215. * be sent to the kernel, it could cause the wrong host to lose its
  216. * lock state if cookies were not unique across reboots.
  217. *
  218. * The cookies are exposed only to local user space via loopback. They
  219. * do not appear on the physical network. If we want greater security
  220. * for some reason, nsm_init_private() could perform a one-way hash to
  221. * obscure the contents of the cookie.
  222. */
  223. static void nsm_init_private(struct nsm_handle *nsm)
  224. {
  225. u64 *p = (u64 *)&nsm->sm_priv.data;
  226. struct timespec ts;
  227. s64 ns;
  228. ktime_get_ts(&ts);
  229. ns = timespec_to_ns(&ts);
  230. put_unaligned(ns, p);
  231. put_unaligned((unsigned long)nsm, p + 1);
  232. }
  233. static struct nsm_handle *nsm_create_handle(const struct sockaddr *sap,
  234. const size_t salen,
  235. const char *hostname,
  236. const size_t hostname_len)
  237. {
  238. struct nsm_handle *new;
  239. new = kzalloc(sizeof(*new) + hostname_len + 1, GFP_KERNEL);
  240. if (unlikely(new == NULL))
  241. return NULL;
  242. atomic_set(&new->sm_count, 1);
  243. new->sm_name = (char *)(new + 1);
  244. memcpy(nsm_addr(new), sap, salen);
  245. new->sm_addrlen = salen;
  246. nsm_init_private(new);
  247. if (rpc_ntop(nsm_addr(new), new->sm_addrbuf,
  248. sizeof(new->sm_addrbuf)) == 0)
  249. (void)snprintf(new->sm_addrbuf, sizeof(new->sm_addrbuf),
  250. "unsupported address family");
  251. memcpy(new->sm_name, hostname, hostname_len);
  252. new->sm_name[hostname_len] = '\0';
  253. return new;
  254. }
  255. /**
  256. * nsm_get_handle - Find or create a cached nsm_handle
  257. * @sap: pointer to socket address of handle to find
  258. * @salen: length of socket address
  259. * @hostname: pointer to C string containing hostname to find
  260. * @hostname_len: length of C string
  261. *
  262. * Behavior is modulated by the global nsm_use_hostnames variable.
  263. *
  264. * Returns a cached nsm_handle after bumping its ref count, or
  265. * returns a fresh nsm_handle if a handle that matches @sap and/or
  266. * @hostname cannot be found in the handle cache. Returns NULL if
  267. * an error occurs.
  268. */
  269. struct nsm_handle *nsm_get_handle(const struct sockaddr *sap,
  270. const size_t salen, const char *hostname,
  271. const size_t hostname_len)
  272. {
  273. struct nsm_handle *cached, *new = NULL;
  274. if (hostname && memchr(hostname, '/', hostname_len) != NULL) {
  275. if (printk_ratelimit()) {
  276. printk(KERN_WARNING "Invalid hostname \"%.*s\" "
  277. "in NFS lock request\n",
  278. (int)hostname_len, hostname);
  279. }
  280. return NULL;
  281. }
  282. retry:
  283. spin_lock(&nsm_lock);
  284. if (nsm_use_hostnames && hostname != NULL)
  285. cached = nsm_lookup_hostname(hostname, hostname_len);
  286. else
  287. cached = nsm_lookup_addr(sap);
  288. if (cached != NULL) {
  289. atomic_inc(&cached->sm_count);
  290. spin_unlock(&nsm_lock);
  291. kfree(new);
  292. dprintk("lockd: found nsm_handle for %s (%s), "
  293. "cnt %d\n", cached->sm_name,
  294. cached->sm_addrbuf,
  295. atomic_read(&cached->sm_count));
  296. return cached;
  297. }
  298. if (new != NULL) {
  299. list_add(&new->sm_link, &nsm_handles);
  300. spin_unlock(&nsm_lock);
  301. dprintk("lockd: created nsm_handle for %s (%s)\n",
  302. new->sm_name, new->sm_addrbuf);
  303. return new;
  304. }
  305. spin_unlock(&nsm_lock);
  306. new = nsm_create_handle(sap, salen, hostname, hostname_len);
  307. if (unlikely(new == NULL))
  308. return NULL;
  309. goto retry;
  310. }
  311. /**
  312. * nsm_reboot_lookup - match NLMPROC_SM_NOTIFY arguments to an nsm_handle
  313. * @info: pointer to NLMPROC_SM_NOTIFY arguments
  314. *
  315. * Returns a matching nsm_handle if found in the nsm cache. The returned
  316. * nsm_handle's reference count is bumped. Otherwise returns NULL if some
  317. * error occurred.
  318. */
  319. struct nsm_handle *nsm_reboot_lookup(const struct nlm_reboot *info)
  320. {
  321. struct nsm_handle *cached;
  322. spin_lock(&nsm_lock);
  323. cached = nsm_lookup_priv(&info->priv);
  324. if (unlikely(cached == NULL)) {
  325. spin_unlock(&nsm_lock);
  326. dprintk("lockd: never saw rebooted peer '%.*s' before\n",
  327. info->len, info->mon);
  328. return cached;
  329. }
  330. atomic_inc(&cached->sm_count);
  331. spin_unlock(&nsm_lock);
  332. dprintk("lockd: host %s (%s) rebooted, cnt %d\n",
  333. cached->sm_name, cached->sm_addrbuf,
  334. atomic_read(&cached->sm_count));
  335. return cached;
  336. }
  337. /**
  338. * nsm_release - Release an NSM handle
  339. * @nsm: pointer to handle to be released
  340. *
  341. */
  342. void nsm_release(struct nsm_handle *nsm)
  343. {
  344. if (atomic_dec_and_lock(&nsm->sm_count, &nsm_lock)) {
  345. list_del(&nsm->sm_link);
  346. spin_unlock(&nsm_lock);
  347. dprintk("lockd: destroyed nsm_handle for %s (%s)\n",
  348. nsm->sm_name, nsm->sm_addrbuf);
  349. kfree(nsm);
  350. }
  351. }
  352. /*
  353. * XDR functions for NSM.
  354. *
  355. * See http://www.opengroup.org/ for details on the Network
  356. * Status Monitor wire protocol.
  357. */
  358. static void encode_nsm_string(struct xdr_stream *xdr, const char *string)
  359. {
  360. const u32 len = strlen(string);
  361. __be32 *p;
  362. BUG_ON(len > SM_MAXSTRLEN);
  363. p = xdr_reserve_space(xdr, 4 + len);
  364. xdr_encode_opaque(p, string, len);
  365. }
  366. /*
  367. * "mon_name" specifies the host to be monitored.
  368. */
  369. static void encode_mon_name(struct xdr_stream *xdr, const struct nsm_args *argp)
  370. {
  371. encode_nsm_string(xdr, argp->mon_name);
  372. }
  373. /*
  374. * The "my_id" argument specifies the hostname and RPC procedure
  375. * to be called when the status manager receives notification
  376. * (via the NLMPROC_SM_NOTIFY call) that the state of host "mon_name"
  377. * has changed.
  378. */
  379. static void encode_my_id(struct xdr_stream *xdr, const struct nsm_args *argp)
  380. {
  381. __be32 *p;
  382. encode_nsm_string(xdr, argp->nodename);
  383. p = xdr_reserve_space(xdr, 4 + 4 + 4);
  384. *p++ = cpu_to_be32(argp->prog);
  385. *p++ = cpu_to_be32(argp->vers);
  386. *p = cpu_to_be32(argp->proc);
  387. }
  388. /*
  389. * The "mon_id" argument specifies the non-private arguments
  390. * of an NSMPROC_MON or NSMPROC_UNMON call.
  391. */
  392. static void encode_mon_id(struct xdr_stream *xdr, const struct nsm_args *argp)
  393. {
  394. encode_mon_name(xdr, argp);
  395. encode_my_id(xdr, argp);
  396. }
  397. /*
  398. * The "priv" argument may contain private information required
  399. * by the NSMPROC_MON call. This information will be supplied in the
  400. * NLMPROC_SM_NOTIFY call.
  401. */
  402. static void encode_priv(struct xdr_stream *xdr, const struct nsm_args *argp)
  403. {
  404. __be32 *p;
  405. p = xdr_reserve_space(xdr, SM_PRIV_SIZE);
  406. xdr_encode_opaque_fixed(p, argp->priv->data, SM_PRIV_SIZE);
  407. }
  408. static void nsm_xdr_enc_mon(struct rpc_rqst *req, struct xdr_stream *xdr,
  409. const struct nsm_args *argp)
  410. {
  411. encode_mon_id(xdr, argp);
  412. encode_priv(xdr, argp);
  413. }
  414. static void nsm_xdr_enc_unmon(struct rpc_rqst *req, struct xdr_stream *xdr,
  415. const struct nsm_args *argp)
  416. {
  417. encode_mon_id(xdr, argp);
  418. }
  419. static int nsm_xdr_dec_stat_res(struct rpc_rqst *rqstp,
  420. struct xdr_stream *xdr,
  421. struct nsm_res *resp)
  422. {
  423. __be32 *p;
  424. p = xdr_inline_decode(xdr, 4 + 4);
  425. if (unlikely(p == NULL))
  426. return -EIO;
  427. resp->status = be32_to_cpup(p++);
  428. resp->state = be32_to_cpup(p);
  429. dprintk("lockd: %s status %d state %d\n",
  430. __func__, resp->status, resp->state);
  431. return 0;
  432. }
  433. static int nsm_xdr_dec_stat(struct rpc_rqst *rqstp,
  434. struct xdr_stream *xdr,
  435. struct nsm_res *resp)
  436. {
  437. __be32 *p;
  438. p = xdr_inline_decode(xdr, 4);
  439. if (unlikely(p == NULL))
  440. return -EIO;
  441. resp->state = be32_to_cpup(p);
  442. dprintk("lockd: %s state %d\n", __func__, resp->state);
  443. return 0;
  444. }
  445. #define SM_my_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
  446. #define SM_my_id_sz (SM_my_name_sz+3)
  447. #define SM_mon_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
  448. #define SM_mon_id_sz (SM_mon_name_sz+SM_my_id_sz)
  449. #define SM_priv_sz (XDR_QUADLEN(SM_PRIV_SIZE))
  450. #define SM_mon_sz (SM_mon_id_sz+SM_priv_sz)
  451. #define SM_monres_sz 2
  452. #define SM_unmonres_sz 1
  453. static struct rpc_procinfo nsm_procedures[] = {
  454. [NSMPROC_MON] = {
  455. .p_proc = NSMPROC_MON,
  456. .p_encode = (kxdreproc_t)nsm_xdr_enc_mon,
  457. .p_decode = (kxdrdproc_t)nsm_xdr_dec_stat_res,
  458. .p_arglen = SM_mon_sz,
  459. .p_replen = SM_monres_sz,
  460. .p_statidx = NSMPROC_MON,
  461. .p_name = "MONITOR",
  462. },
  463. [NSMPROC_UNMON] = {
  464. .p_proc = NSMPROC_UNMON,
  465. .p_encode = (kxdreproc_t)nsm_xdr_enc_unmon,
  466. .p_decode = (kxdrdproc_t)nsm_xdr_dec_stat,
  467. .p_arglen = SM_mon_id_sz,
  468. .p_replen = SM_unmonres_sz,
  469. .p_statidx = NSMPROC_UNMON,
  470. .p_name = "UNMONITOR",
  471. },
  472. };
  473. static const struct rpc_version nsm_version1 = {
  474. .number = 1,
  475. .nrprocs = ARRAY_SIZE(nsm_procedures),
  476. .procs = nsm_procedures
  477. };
  478. static const struct rpc_version *nsm_version[] = {
  479. [1] = &nsm_version1,
  480. };
  481. static struct rpc_stat nsm_stats;
  482. static const struct rpc_program nsm_program = {
  483. .name = "statd",
  484. .number = NSM_PROGRAM,
  485. .nrvers = ARRAY_SIZE(nsm_version),
  486. .version = nsm_version,
  487. .stats = &nsm_stats
  488. };