Pileus Git - ~andy/linux/blob - fs/lockd/mon.c

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