lnet/lnet/acceptor.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #define DEBUG_SUBSYSTEM S_LNET
  34
  35 #include <linux/completion.h>
  36 #include <net/sock.h>
  37 #include <lnet/lib-lnet.h>
  38
  39 static int   accept_port    = 988;
  40 static int   accept_backlog = 127;
  41 static int   accept_timeout = 5;
  42
  43 static struct {
  44         int                     pta_shutdown;
  45         struct socket           *pta_sock;
  46         struct completion       pta_signal;
  47         struct net              *pta_ns;
  48 } lnet_acceptor_state = {
  49         .pta_shutdown = 1
  50 };
  51
  52 int
  53 lnet_acceptor_port(void)
  54 {
  55         return accept_port;
  56 }
  57
  58 static inline int
  59 lnet_accept_magic(__u32 magic, __u32 constant)
  60 {
  61         return (magic == constant ||
  62                 magic == __swab32(constant));
  63 }
  64
  65 EXPORT_SYMBOL(lnet_acceptor_port);
  66
  67 static char *accept = "secure";
  68
  69 module_param(accept, charp, 0444);
  70 MODULE_PARM_DESC(accept, "Accept connections (secure|all|none)");
  71 module_param(accept_port, int, 0444);
  72 MODULE_PARM_DESC(accept_port, "Acceptor's port (same on all nodes)");
  73 module_param(accept_backlog, int, 0444);
  74 MODULE_PARM_DESC(accept_backlog, "Acceptor's listen backlog");
  75 module_param(accept_timeout, int, 0644);
  76 MODULE_PARM_DESC(accept_timeout, "Acceptor's timeout (seconds)");
  77
  78 static char *accept_type = NULL;
  79
  80 static int
  81 lnet_acceptor_get_tunables(void)
  82 {
  83         /* Userland acceptor uses 'accept_type' instead of 'accept', due to
  84          * conflict with 'accept(2)', but kernel acceptor still uses 'accept'
  85          * for compatibility. Hence the trick. */
  86         accept_type = accept;
  87         return 0;
  88 }
  89
  90 int
  91 lnet_acceptor_timeout(void)
  92 {
  93         return accept_timeout;
  94 }
  95 EXPORT_SYMBOL(lnet_acceptor_timeout);
  96
  97 void
  98 lnet_connect_console_error (int rc, lnet_nid_t peer_nid,
  99                            __u32 peer_ip, int peer_port)
 100 {
 101         switch (rc) {
 102         /* "normal" errors */
 103         case -ECONNREFUSED:
 104                 CNETERR("Connection to %s at host %pI4h on port %d was "
 105                         "refused: check that Lustre is running on that node.\n",
 106                         libcfs_nid2str(peer_nid), &peer_ip, peer_port);
 107                 break;
 108         case -EHOSTUNREACH:
 109         case -ENETUNREACH:
 110                 CNETERR("Connection to %s at host %pI4h "
 111                         "was unreachable: the network or that node may "
 112                         "be down, or Lustre may be misconfigured.\n",
 113                         libcfs_nid2str(peer_nid), &peer_ip);
 114                 break;
 115         case -ETIMEDOUT:
 116                 CNETERR("Connection to %s at host %pI4h on "
 117                         "port %d took too long: that node may be hung "
 118                         "or experiencing high load.\n",
 119                         libcfs_nid2str(peer_nid), &peer_ip, peer_port);
 120                 break;
 121         case -ECONNRESET:
 122                 LCONSOLE_ERROR_MSG(0x11b, "Connection to %s at host %pI4h"
 123                                    " on port %d was reset: "
 124                                    "is it running a compatible version of "
 125                                    "Lustre and is %s one of its NIDs?\n",
 126                                    libcfs_nid2str(peer_nid), &peer_ip,
 127                                    peer_port, libcfs_nid2str(peer_nid));
 128                 break;
 129         case -EPROTO:
 130                 LCONSOLE_ERROR_MSG(0x11c, "Protocol error connecting to %s at "
 131                                    "host %pI4h on port %d: is it running "
 132                                    "a compatible version of Lustre?\n",
 133                                    libcfs_nid2str(peer_nid), &peer_ip,
 134                                    peer_port);
 135                 break;
 136         case -EADDRINUSE:
 137                 LCONSOLE_ERROR_MSG(0x11d, "No privileged ports available to "
 138                                    "connect to %s at host %pI4h on port "
 139                                    "%d\n", libcfs_nid2str(peer_nid),
 140                                    &peer_ip, peer_port);
 141                 break;
 142         default:
 143                 LCONSOLE_ERROR_MSG(0x11e, "Unexpected error %d connecting to %s"
 144                                    " at host %pI4h on port %d\n", rc,
 145                                    libcfs_nid2str(peer_nid),
 146                                    &peer_ip, peer_port);
 147                 break;
 148         }
 149 }
 150 EXPORT_SYMBOL(lnet_connect_console_error);
 151
 152 int
 153 lnet_connect(struct socket **sockp, lnet_nid_t peer_nid,
 154             __u32 local_ip, __u32 peer_ip, int peer_port, struct net *ns)
 155 {
 156         struct lnet_acceptor_connreq cr;
 157         struct socket           *sock;
 158         int                     rc;
 159         int                     port;
 160         int                     fatal;
 161
 162         BUILD_BUG_ON(sizeof(cr) > 16); /* not too big to be on the stack */
 163
 164         for (port = LNET_ACCEPTOR_MAX_RESERVED_PORT;
 165              port >= LNET_ACCEPTOR_MIN_RESERVED_PORT;
 166              --port) {
 167                 /* Iterate through reserved ports. */
 168
 169                 rc = lnet_sock_connect(&sock, &fatal,
 170                                          local_ip, port,
 171                                          peer_ip, peer_port, ns);
 172                 if (rc != 0) {
 173                         if (fatal)
 174                                 goto failed;
 175                         continue;
 176                 }
 177
 178                 BUILD_BUG_ON(LNET_PROTO_ACCEPTOR_VERSION != 1);
 179
 180                 cr.acr_magic   = LNET_PROTO_ACCEPTOR_MAGIC;
 181                 cr.acr_version = LNET_PROTO_ACCEPTOR_VERSION;
 182                 cr.acr_nid     = peer_nid;
 183
 184                 if (the_lnet.ln_testprotocompat) {
 185                         /* single-shot proto check */
 186                         if (test_and_clear_bit(2, &the_lnet.ln_testprotocompat))
 187                                 cr.acr_version++;
 188                         if (test_and_clear_bit(3, &the_lnet.ln_testprotocompat))
 189                                 cr.acr_magic = LNET_PROTO_MAGIC;
 190                 }
 191
 192                 rc = lnet_sock_write(sock, &cr, sizeof(cr),
 193                                        accept_timeout);
 194                 if (rc != 0)
 195                         goto failed_sock;
 196
 197                 *sockp = sock;
 198                 return 0;
 199         }
 200
 201         rc = -EADDRINUSE;
 202         goto failed;
 203
 204 failed_sock:
 205         sock_release(sock);
 206 failed:
 207         lnet_connect_console_error(rc, peer_nid, peer_ip, peer_port);
 208         return rc;
 209 }
 210 EXPORT_SYMBOL(lnet_connect);
 211
 212 static int
 213 lnet_accept(struct socket *sock, __u32 magic)
 214 {
 215         struct lnet_acceptor_connreq cr;
 216         __u32                   peer_ip;
 217         int                     peer_port;
 218         int                     rc;
 219         int                     flip;
 220         struct lnet_ni *ni;
 221         char                   *str;
 222
 223         LASSERT(sizeof(cr) <= 16);              /* not too big for the stack */
 224
 225         rc = lnet_sock_getaddr(sock, true, &peer_ip, &peer_port);
 226         LASSERT(rc == 0);                       /* we succeeded before */
 227
 228         if (!lnet_accept_magic(magic, LNET_PROTO_ACCEPTOR_MAGIC)) {
 229
 230                 if (lnet_accept_magic(magic, LNET_PROTO_MAGIC)) {
 231                         /* future version compatibility!
 232                          * When LNET unifies protocols over all LNDs, the first
 233                          * thing sent will be a version query.  I send back
 234                          * LNET_PROTO_ACCEPTOR_MAGIC to tell her I'm "old" */
 235
 236                         memset(&cr, 0, sizeof(cr));
 237                         cr.acr_magic = LNET_PROTO_ACCEPTOR_MAGIC;
 238                         cr.acr_version = LNET_PROTO_ACCEPTOR_VERSION;
 239                         rc = lnet_sock_write(sock, &cr, sizeof(cr),
 240                                                accept_timeout);
 241
 242                         if (rc != 0)
 243                                 CERROR("Error sending magic+version in response to LNET magic from %pI4h: %d\n",
 244                                        &peer_ip, rc);
 245                         return -EPROTO;
 246                 }
 247
 248                 if (lnet_accept_magic(magic, LNET_PROTO_TCP_MAGIC))
 249                         str = "'old' socknal/tcpnal";
 250                 else
 251                         str = "unrecognised";
 252
 253                 LCONSOLE_ERROR_MSG(0x11f, "Refusing connection from %pI4h"
 254                                    " magic %08x: %s acceptor protocol\n",
 255                                    &peer_ip, magic, str);
 256                 return -EPROTO;
 257         }
 258
 259         flip = (magic != LNET_PROTO_ACCEPTOR_MAGIC);
 260
 261         rc = lnet_sock_read(sock, &cr.acr_version,
 262                               sizeof(cr.acr_version),
 263                               accept_timeout);
 264         if (rc != 0) {
 265                 CERROR("Error %d reading connection request version from "
 266                        "%pI4h\n", rc, &peer_ip);
 267                 return -EIO;
 268         }
 269
 270         if (flip)
 271                 __swab32s(&cr.acr_version);
 272
 273         if (cr.acr_version != LNET_PROTO_ACCEPTOR_VERSION) {
 274                 /* future version compatibility!
 275                  * An acceptor-specific protocol rev will first send a version
 276                  * query.  I send back my current version to tell her I'm
 277                  * "old". */
 278                 int peer_version = cr.acr_version;
 279
 280                 memset(&cr, 0, sizeof(cr));
 281                 cr.acr_magic = LNET_PROTO_ACCEPTOR_MAGIC;
 282                 cr.acr_version = LNET_PROTO_ACCEPTOR_VERSION;
 283
 284                 rc = lnet_sock_write(sock, &cr, sizeof(cr),
 285                                        accept_timeout);
 286
 287                 if (rc != 0)
 288                         CERROR("Error sending magic+version in response to version %d from %pI4h: %d\n",
 289                                peer_version, &peer_ip, rc);
 290                 return -EPROTO;
 291         }
 292
 293         rc = lnet_sock_read(sock, &cr.acr_nid,
 294                               sizeof(cr) -
 295                               offsetof(struct lnet_acceptor_connreq, acr_nid),
 296                               accept_timeout);
 297         if (rc != 0) {
 298                 CERROR("Error %d reading connection request from "
 299                        "%pI4h\n", rc, &peer_ip);
 300                 return -EIO;
 301         }
 302
 303         if (flip)
 304                 __swab64s(&cr.acr_nid);
 305
 306         ni = lnet_nid2ni_addref(cr.acr_nid);
 307         if (ni == NULL ||               /* no matching net */
 308             ni->ni_nid != cr.acr_nid) { /* right NET, wrong NID! */
 309                 if (ni != NULL)
 310                         lnet_ni_decref(ni);
 311                 LCONSOLE_ERROR_MSG(0x120, "Refusing connection from %pI4h "
 312                                    "for %s: No matching NI\n",
 313                                    &peer_ip, libcfs_nid2str(cr.acr_nid));
 314                 return -EPERM;
 315         }
 316
 317         if (ni->ni_net->net_lnd->lnd_accept == NULL) {
 318                 /* This catches a request for the loopback LND */
 319                 lnet_ni_decref(ni);
 320                 LCONSOLE_ERROR_MSG(0x121, "Refusing connection from %pI4h "
 321                                   "for %s: NI doesn not accept IP connections\n",
 322                                   &peer_ip, libcfs_nid2str(cr.acr_nid));
 323                 return -EPERM;
 324         }
 325
 326         CDEBUG(D_NET, "Accept %s from %pI4h\n",
 327                libcfs_nid2str(cr.acr_nid), &peer_ip);
 328
 329         rc = ni->ni_net->net_lnd->lnd_accept(ni, sock);
 330
 331         lnet_ni_decref(ni);
 332         return rc;
 333 }
 334
 335 static int
 336 lnet_acceptor(void *arg)
 337 {
 338         struct socket  *newsock;
 339         int            rc;
 340         __u32          magic;
 341         __u32          peer_ip;
 342         int            peer_port;
 343         int            secure = (int)((uintptr_t)arg);
 344
 345         LASSERT(lnet_acceptor_state.pta_sock == NULL);
 346
 347         cfs_block_allsigs();
 348
 349         rc = lnet_sock_listen(&lnet_acceptor_state.pta_sock,
 350                               0, accept_port, accept_backlog,
 351                               lnet_acceptor_state.pta_ns);
 352         if (rc != 0) {
 353                 if (rc == -EADDRINUSE)
 354                         LCONSOLE_ERROR_MSG(0x122, "Can't start acceptor on port"
 355                                            " %d: port already in use\n",
 356                                            accept_port);
 357                 else
 358                         LCONSOLE_ERROR_MSG(0x123, "Can't start acceptor on port "
 359                                            "%d: unexpected error %d\n",
 360                                            accept_port, rc);
 361
 362                 lnet_acceptor_state.pta_sock = NULL;
 363         } else {
 364                 LCONSOLE(0, "Accept %s, port %d\n", accept_type, accept_port);
 365         }
 366
 367         /* set init status and unblock parent */
 368         lnet_acceptor_state.pta_shutdown = rc;
 369         complete(&lnet_acceptor_state.pta_signal);
 370
 371         if (rc != 0)
 372                 return rc;
 373
 374         while (!lnet_acceptor_state.pta_shutdown) {
 375
 376                 rc = lnet_sock_accept(&newsock, lnet_acceptor_state.pta_sock);
 377                 if (rc != 0) {
 378                         if (rc != -EAGAIN) {
 379                                 CWARN("Accept error %d: pausing...\n", rc);
 380                                 set_current_state(TASK_UNINTERRUPTIBLE);
 381                                 schedule_timeout(cfs_time_seconds(1));
 382                         }
 383                         continue;
 384                 }
 385
 386                 /* maybe we're waken up with lnet_sock_abort_accept() */
 387                 if (lnet_acceptor_state.pta_shutdown) {
 388                         sock_release(newsock);
 389                         break;
 390                 }
 391
 392                 rc = lnet_sock_getaddr(newsock, true, &peer_ip, &peer_port);
 393                 if (rc != 0) {
 394                         CERROR("Can't determine new connection's address\n");
 395                         goto failed;
 396                 }
 397
 398                 if (secure && peer_port > LNET_ACCEPTOR_MAX_RESERVED_PORT) {
 399                         CERROR("Refusing connection from %pI4h: "
 400                                "insecure port %d\n", &peer_ip, peer_port);
 401                         goto failed;
 402                 }
 403
 404                 rc = lnet_sock_read(newsock, &magic, sizeof(magic),
 405                                       accept_timeout);
 406                 if (rc != 0) {
 407                         CERROR("Error %d reading connection request from "
 408                                "%pI4h\n", rc, &peer_ip);
 409                         goto failed;
 410                 }
 411
 412                 rc = lnet_accept(newsock, magic);
 413                 if (rc != 0)
 414                         goto failed;
 415
 416                 continue;
 417
 418 failed:
 419                 sock_release(newsock);
 420         }
 421
 422         sock_release(lnet_acceptor_state.pta_sock);
 423         lnet_acceptor_state.pta_sock = NULL;
 424
 425         CDEBUG(D_NET, "Acceptor stopping\n");
 426
 427         /* unblock lnet_acceptor_stop() */
 428         complete(&lnet_acceptor_state.pta_signal);
 429         return 0;
 430 }
 431
 432 static inline int
 433 accept2secure(const char *acc, long *sec)
 434 {
 435         if (!strcmp(acc, "secure")) {
 436                 *sec = 1;
 437                 return 1;
 438         } else if (!strcmp(acc, "all")) {
 439                 *sec = 0;
 440                 return 1;
 441         } else if (!strcmp(acc, "none")) {
 442                 return 0;
 443         } else {
 444                 LCONSOLE_ERROR_MSG(0x124, "Can't parse 'accept=\"%s\"'\n",
 445                                    acc);
 446                 return -EINVAL;
 447         }
 448 }
 449
 450 int
 451 lnet_acceptor_start(void)
 452 {
 453         struct task_struct *task;
 454         int  rc;
 455         long rc2;
 456         long secure;
 457
 458         /* if acceptor is already running return immediately */
 459         if (!lnet_acceptor_state.pta_shutdown)
 460                 return 0;
 461
 462         LASSERT(lnet_acceptor_state.pta_sock == NULL);
 463
 464         rc = lnet_acceptor_get_tunables();
 465         if (rc != 0)
 466                 return rc;
 467
 468         init_completion(&lnet_acceptor_state.pta_signal);
 469         rc = accept2secure(accept_type, &secure);
 470         if (rc <= 0)
 471                 return rc;
 472
 473         if (lnet_count_acceptor_nets() == 0)  /* not required */
 474                 return 0;
 475         if (current->nsproxy && current->nsproxy->net_ns)
 476                 lnet_acceptor_state.pta_ns = current->nsproxy->net_ns;
 477         else
 478                 lnet_acceptor_state.pta_ns = &init_net;
 479         task = kthread_run(lnet_acceptor, (void *)(uintptr_t)secure,
 480                            "acceptor_%03ld", secure);
 481         if (IS_ERR(task)) {
 482                 rc2 = PTR_ERR(task);
 483                 CERROR("Can't start acceptor thread: %ld\n", rc2);
 484                 return -ESRCH;
 485         }
 486
 487         /* wait for acceptor to startup */
 488         wait_for_completion(&lnet_acceptor_state.pta_signal);
 489
 490         if (!lnet_acceptor_state.pta_shutdown) {
 491                 /* started OK */
 492                 LASSERT(lnet_acceptor_state.pta_sock != NULL);
 493                 return 0;
 494         }
 495
 496         LASSERT(lnet_acceptor_state.pta_sock == NULL);
 497
 498         return -ENETDOWN;
 499 }
 500
 501 void
 502 lnet_acceptor_stop(void)
 503 {
 504         struct sock *sk;
 505
 506         if (lnet_acceptor_state.pta_shutdown) /* not running */
 507                 return;
 508
 509         lnet_acceptor_state.pta_shutdown = 1;
 510
 511         sk = lnet_acceptor_state.pta_sock->sk;
 512
 513         /* awake any sleepers using safe method */
 514         sk->sk_state_change(sk);
 515
 516         /* block until acceptor signals exit */
 517         wait_for_completion(&lnet_acceptor_state.pta_signal);
 518 }