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