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