fs/lockd/mon.c

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