lnet/klnds/gmlnd/gmlnd.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (c) 2003 Los Alamos National Laboratory (LANL)
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org/
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22
  23 /*
  24  *      Portals GM kernel NAL header file
  25  *      This file makes all declaration and prototypes
  26  *      for the API side and CB side of the NAL
  27  */
  28 #ifndef __INCLUDE_GMNAL_H__
  29 #define __INCLUDE_GMNAL_H__
  30
  31 #ifndef EXPORT_SYMTAB
  32 # define EXPORT_SYMTAB
  33 #endif
  34
  35 #include "linux/config.h"
  36 #include "linux/module.h"
  37 #include "linux/tty.h"
  38 #include "linux/kernel.h"
  39 #include "linux/mm.h"
  40 #include "linux/string.h"
  41 #include "linux/stat.h"
  42 #include "linux/errno.h"
  43 #include "linux/locks.h"
  44 #include "linux/unistd.h"
  45 #include "linux/init.h"
  46 #include "linux/sem.h"
  47 #include "linux/vmalloc.h"
  48 #include "linux/sysctl.h"
  49
  50 #define DEBUG_SUBSYSTEM S_NAL
  51
  52 #include "portals/nal.h"
  53 #include "portals/api.h"
  54 #include "portals/errno.h"
  55 #include "libcfs/kp30.h"
  56 #include "portals/p30.h"
  57
  58 #include "portals/nal.h"
  59 #include "portals/lib-p30.h"
  60
  61 #define GM_STRONG_TYPES 1
  62 #ifdef VERSION
  63 #undef VERSION
  64 #endif
  65 #include "gm.h"
  66 #include "gm_internal.h"
  67
  68
  69
  70 /*
  71  *      Defines for the API NAL
  72  */
  73
  74 /*
  75  *      Small message size is configurable
  76  *      insmod can set small_msg_size
  77  *      which is used to populate nal_data.small_msg_size
  78  */
  79 #define GMNAL_SMALL_MESSAGE             1078
  80 #define GMNAL_LARGE_MESSAGE_INIT        1079
  81 #define GMNAL_LARGE_MESSAGE_ACK 1080
  82 #define GMNAL_LARGE_MESSAGE_FINI        1081
  83
  84 extern  int gmnal_small_msg_size;
  85 extern  int num_rx_threads;
  86 extern  int num_stxds;
  87 extern  int gm_port_id;
  88 #define GMNAL_SMALL_MSG_SIZE(a)         a->small_msg_size
  89 #define GMNAL_IS_SMALL_MESSAGE(n,a,b,c) gmnal_is_small_msg(n, a, b, c)
  90 #define GMNAL_MAGIC                             0x1234abcd
  91 /*
  92  *      The gm_port to use for gmnal
  93  */
  94 #define GMNAL_GM_PORT_ID        gm_port_id
  95
  96
  97 /*
  98  *      Small Transmit Descriptor
  99  *      A structre to keep track of a small transmit operation
 100  *      This structure has a one-to-one relationship with a small
 101  *      transmit buffer (both create by gmnal_stxd_alloc).
 102  *      There are two free list of stxd. One for use by clients of the NAL
 103  *      and the other by the NAL rxthreads when doing sends.
 104  *      This helps prevent deadlock caused by stxd starvation.
 105  */
 106 typedef struct _gmnal_stxd_t {
 107         void                    *buffer;
 108         int                     buffer_size;
 109         gm_size_t               gm_size;
 110         int                     msg_size;
 111         int                     gm_target_node;
 112         int                     gm_priority;
 113         int                     type;
 114         struct _gmnal_data_t    *nal_data;
 115         lib_msg_t               *cookie;
 116         int                     niov;
 117         struct iovec            iov[PTL_MD_MAX_IOV];
 118         struct _gmnal_stxd_t    *next;
 119         int                     rxt;
 120         int                     kniov;
 121         struct iovec            *iovec_dup;
 122 } gmnal_stxd_t;
 123
 124 /*
 125  *      keeps a transmit token for large transmit (gm_get)
 126  *      and a pointer to rxd that is used as context for large receive
 127  */
 128 typedef struct _gmnal_ltxd_t {
 129         struct _gmnal_ltxd_t    *next;
 130         struct  _gmnal_srxd_t  *srxd;
 131 } gmnal_ltxd_t;
 132
 133
 134 /*
 135  *      as for gmnal_stxd_t
 136  *      a hash table in nal_data find srxds from
 137  *      the rx buffer address. hash table populated at init time
 138  */
 139 typedef struct _gmnal_srxd_t {
 140         void                    *buffer;
 141         int                     size;
 142         gm_size_t               gmsize;
 143         unsigned int            gm_source_node;
 144         gmnal_stxd_t            *source_stxd;
 145         int                     type;
 146         int                     nsiov;
 147         int                     nriov;
 148         struct iovec            *riov;
 149         int                     ncallbacks;
 150         spinlock_t              callback_lock;
 151         int                     callback_status;
 152         lib_msg_t               *cookie;
 153         struct _gmnal_srxd_t    *next;
 154         struct _gmnal_data_t    *nal_data;
 155 } gmnal_srxd_t;
 156
 157 /*
 158  *      Header which lmgnal puts at the start of each message
 159  *      watch alignment for ia32/64 interaction
 160  */
 161 typedef struct  _gmnal_msghdr {
 162         int             magic;
 163         int             type;
 164         unsigned int    sender_node_id;
 165         int             niov;
 166         gm_remote_ptr_t stxd_remote_ptr; /* 64 bits */
 167         } gmnal_msghdr_t;
 168 #define GMNAL_MSGHDR_SIZE       sizeof(gmnal_msghdr_t)
 169
 170 /*
 171  *      the caretaker thread (ct_thread) gets receive events
 172  *      (and other events) from the myrinet device via the GM2 API.
 173  *      caretaker thread populates one work entry for each receive event,
 174  *      puts it on a Q in nal_data and wakes a receive thread to
 175  *      process the receive.
 176  *      Processing a portals receive can involve a transmit operation.
 177  *      Because of this the caretaker thread cannot process receives
 178  *      as it may get deadlocked when supply of transmit descriptors
 179  *      is exhausted (as caretaker thread is responsible for replacing
 180  *      transmit descriptors on the free list)
 181  */
 182 typedef struct _gmnal_rxtwe {
 183         void                    *buffer;
 184         unsigned                snode;
 185         unsigned                sport;
 186         unsigned                type;
 187         unsigned                length;
 188         struct _gmnal_rxtwe     *next;
 189 } gmnal_rxtwe_t;
 190
 191 /*
 192  *      1 receive thread started on each CPU
 193  */
 194 #define NRXTHREADS 10 /* max number of receiver threads */
 195
 196 typedef struct _gmnal_data_t {
 197         int             refcnt;
 198         spinlock_t      cb_lock;
 199         spinlock_t      stxd_lock;
 200         struct semaphore stxd_token;
 201         gmnal_stxd_t    *stxd;
 202         spinlock_t      rxt_stxd_lock;
 203         struct semaphore rxt_stxd_token;
 204         gmnal_stxd_t    *rxt_stxd;
 205         spinlock_t      ltxd_lock;
 206         struct semaphore ltxd_token;
 207         gmnal_ltxd_t    *ltxd;
 208         spinlock_t      srxd_lock;
 209         struct semaphore srxd_token;
 210         gmnal_srxd_t    *srxd;
 211         struct gm_hash  *srxd_hash;
 212         nal_t           *nal;
 213         lib_nal_t       *libnal;
 214         struct gm_port  *gm_port;
 215         unsigned int    gm_local_nid;
 216         unsigned int    gm_global_nid;
 217         spinlock_t      gm_lock;
 218         long            rxthread_pid[NRXTHREADS];
 219         int             rxthread_stop_flag;
 220         spinlock_t      rxthread_flag_lock;
 221         long            rxthread_flag;
 222         long            ctthread_pid;
 223         int             ctthread_flag;
 224         gm_alarm_t      ctthread_alarm;
 225         int             small_msg_size;
 226         int             small_msg_gmsize;
 227         gmnal_rxtwe_t   *rxtwe_head;
 228         gmnal_rxtwe_t   *rxtwe_tail;
 229         spinlock_t      rxtwe_lock;
 230         struct  semaphore rxtwe_wait;
 231         struct ctl_table_header *sysctl;
 232 } gmnal_data_t;
 233
 234 /*
 235  *      Flags to start/stop and check status of threads
 236  *      each rxthread sets 1 bit (any bit) of the flag on startup
 237  *      and clears 1 bit when exiting
 238  */
 239 #define GMNAL_THREAD_RESET      0
 240 #define GMNAL_THREAD_STOP       666
 241 #define GMNAL_CTTHREAD_STARTED  333
 242 #define GMNAL_RXTHREADS_STARTED ( (1<<num_rx_threads)-1)
 243
 244
 245 extern gmnal_data_t     *global_nal_data;
 246
 247 /*
 248  * for ioctl get pid
 249  */
 250 #define GMNAL_IOC_GET_GNID 1
 251
 252 /*
 253  *      Return codes
 254  */
 255 #define GMNAL_STATUS_OK 0
 256 #define GMNAL_STATUS_FAIL       1
 257 #define GMNAL_STATUS_NOMEM      2
 258
 259
 260 /*
 261  *      FUNCTION PROTOTYPES
 262  */
 263
 264 /*
 265  *      Locking macros
 266  */
 267
 268 /*
 269  *      For the Small tx and rx descriptor lists
 270  */
 271 #define GMNAL_TXD_LOCK_INIT(a)          spin_lock_init(&a->stxd_lock);
 272 #define GMNAL_TXD_LOCK(a)               spin_lock(&a->stxd_lock);
 273 #define GMNAL_TXD_UNLOCK(a)             spin_unlock(&a->stxd_lock);
 274 #define GMNAL_TXD_TOKEN_INIT(a, n)      sema_init(&a->stxd_token, n);
 275 #define GMNAL_TXD_GETTOKEN(a)           down(&a->stxd_token);
 276 #define GMNAL_TXD_TRYGETTOKEN(a)        down_trylock(&a->stxd_token)
 277 #define GMNAL_TXD_RETURNTOKEN(a)        up(&a->stxd_token);
 278
 279 #define GMNAL_RXT_TXD_LOCK_INIT(a)      spin_lock_init(&a->rxt_stxd_lock);
 280 #define GMNAL_RXT_TXD_LOCK(a)           spin_lock(&a->rxt_stxd_lock);
 281 #define GMNAL_RXT_TXD_UNLOCK(a)         spin_unlock(&a->rxt_stxd_lock);
 282 #define GMNAL_RXT_TXD_TOKEN_INIT(a, n)  sema_init(&a->rxt_stxd_token, n);
 283 #define GMNAL_RXT_TXD_GETTOKEN(a)       down(&a->rxt_stxd_token);
 284 #define GMNAL_RXT_TXD_TRYGETTOKEN(a)    down_trylock(&a->rxt_stxd_token)
 285 #define GMNAL_RXT_TXD_RETURNTOKEN(a)    up(&a->rxt_stxd_token);
 286
 287 #define GMNAL_LTXD_LOCK_INIT(a)         spin_lock_init(&a->ltxd_lock);
 288 #define GMNAL_LTXD_LOCK(a)              spin_lock(&a->ltxd_lock);
 289 #define GMNAL_LTXD_UNLOCK(a)            spin_unlock(&a->ltxd_lock);
 290 #define GMNAL_LTXD_TOKEN_INIT(a, n)     sema_init(&a->ltxd_token, n);
 291 #define GMNAL_LTXD_GETTOKEN(a)          down(&a->ltxd_token);
 292 #define GMNAL_LTXD_TRYGETTOKEN(a)       down_trylock(&a->ltxd_token)
 293 #define GMNAL_LTXD_RETURNTOKEN(a)       up(&a->ltxd_token);
 294
 295 #define GMNAL_RXD_LOCK_INIT(a)          spin_lock_init(&a->srxd_lock);
 296 #define GMNAL_RXD_LOCK(a)               spin_lock(&a->srxd_lock);
 297 #define GMNAL_RXD_UNLOCK(a)             spin_unlock(&a->srxd_lock);
 298 #define GMNAL_RXD_TOKEN_INIT(a, n)      sema_init(&a->srxd_token, n);
 299 #define GMNAL_RXD_GETTOKEN(a)           down(&a->srxd_token);
 300 #define GMNAL_RXD_TRYGETTOKEN(a)        down_trylock(&a->srxd_token)
 301 #define GMNAL_RXD_RETURNTOKEN(a)        up(&a->srxd_token);
 302
 303 #define GMNAL_GM_LOCK_INIT(a)           spin_lock_init(&a->gm_lock);
 304 #define GMNAL_GM_LOCK(a)                spin_lock(&a->gm_lock);
 305 #define GMNAL_GM_UNLOCK(a)              spin_unlock(&a->gm_lock);
 306 #define GMNAL_CB_LOCK_INIT(a)           spin_lock_init(&a->cb_lock);
 307
 308
 309 /*
 310  *      Memory Allocator
 311  */
 312
 313 /*
 314  *      API NAL
 315  */
 316 int gmnal_api_startup(nal_t *, ptl_pid_t,
 317                       ptl_ni_limits_t *, ptl_ni_limits_t *);
 318
 319 int gmnal_api_forward(nal_t *, int, void *, size_t, void *, size_t);
 320
 321 void gmnal_api_shutdown(nal_t *);
 322
 323 int gmnal_api_validate(nal_t *, void *, size_t);
 324
 325 void gmnal_api_yield(nal_t *, unsigned long *, int);
 326
 327 void gmnal_api_lock(nal_t *, unsigned long *);
 328
 329 void gmnal_api_unlock(nal_t *, unsigned long *);
 330
 331
 332 #define GMNAL_INIT_NAL(a)       do {    \
 333                                 (a)->nal_ni_init = gmnal_api_startup; \
 334                                 (a)->nal_ni_fini = gmnal_api_shutdown; \
 335                                 (a)->nal_data = NULL; \
 336                                 } while (0)
 337
 338
 339 /*
 340  *      CB NAL
 341  */
 342
 343 ptl_err_t gmnal_cb_send(lib_nal_t *, void *, lib_msg_t *, ptl_hdr_t *,
 344         int, ptl_nid_t, ptl_pid_t, unsigned int, struct iovec *, size_t, size_t);
 345
 346 ptl_err_t gmnal_cb_send_pages(lib_nal_t *, void *, lib_msg_t *, ptl_hdr_t *,
 347         int, ptl_nid_t, ptl_pid_t, unsigned int, ptl_kiov_t *, size_t, size_t);
 348
 349 ptl_err_t gmnal_cb_recv(lib_nal_t *, void *, lib_msg_t *,
 350         unsigned int, struct iovec *, size_t, size_t, size_t);
 351
 352 ptl_err_t gmnal_cb_recv_pages(lib_nal_t *, void *, lib_msg_t *,
 353         unsigned int, ptl_kiov_t *, size_t, size_t, size_t);
 354
 355 int gmnal_cb_dist(lib_nal_t *, ptl_nid_t, unsigned long *);
 356
 357 int gmnal_init(void);
 358
 359 void  gmnal_fini(void);
 360
 361
 362
 363 #define GMNAL_INIT_NAL_CB(a)    do {    \
 364                                 a->libnal_send = gmnal_cb_send; \
 365                                 a->libnal_send_pages = gmnal_cb_send_pages; \
 366                                 a->libnal_recv = gmnal_cb_recv; \
 367                                 a->libnal_recv_pages = gmnal_cb_recv_pages; \
 368                                 a->libnal_map = NULL; \
 369                                 a->libnal_unmap = NULL; \
 370                                 a->libnal_dist = gmnal_cb_dist; \
 371                                 a->libnal_data = NULL; \
 372                                 } while (0)
 373
 374
 375 /*
 376  *      Small and Large Transmit and Receive Descriptor Functions
 377  */
 378 int             gmnal_alloc_txd(gmnal_data_t *);
 379 void            gmnal_free_txd(gmnal_data_t *);
 380 gmnal_stxd_t*   gmnal_get_stxd(gmnal_data_t *, int);
 381 void            gmnal_return_stxd(gmnal_data_t *, gmnal_stxd_t *);
 382 gmnal_ltxd_t*   gmnal_get_ltxd(gmnal_data_t *);
 383 void            gmnal_return_ltxd(gmnal_data_t *, gmnal_ltxd_t *);
 384
 385 int             gmnal_alloc_srxd(gmnal_data_t *);
 386 void            gmnal_free_srxd(gmnal_data_t *);
 387 gmnal_srxd_t*   gmnal_get_srxd(gmnal_data_t *, int);
 388 void            gmnal_return_srxd(gmnal_data_t *, gmnal_srxd_t *);
 389
 390 /*
 391  *      general utility functions
 392  */
 393 gmnal_srxd_t    *gmnal_rxbuffer_to_srxd(gmnal_data_t *, void*);
 394 void            gmnal_stop_rxthread(gmnal_data_t *);
 395 void            gmnal_stop_ctthread(gmnal_data_t *);
 396 void            gmnal_drop_sends_callback(gm_port_t *, void *, gm_status_t);
 397 void            gmnal_resume_sending_callback(gm_port_t *, void *, gm_status_t);
 398 char            *gmnal_gm_error(gm_status_t);
 399 char            *gmnal_rxevent(gm_recv_event_t*);
 400 int             gmnal_is_small_msg(gmnal_data_t*, int, struct iovec*, int);
 401 void            gmnal_yield(int);
 402 int             gmnal_start_kernel_threads(gmnal_data_t *);
 403
 404
 405 /*
 406  *      Communication functions
 407  */
 408
 409 /*
 410  *      Receive threads
 411  */
 412 int             gmnal_ct_thread(void *); /* caretaker thread */
 413 int             gmnal_rx_thread(void *); /* receive thread */
 414 int             gmnal_pre_receive(gmnal_data_t*, gmnal_rxtwe_t*, int);
 415 int             gmnal_rx_bad(gmnal_data_t *, gmnal_rxtwe_t *, gmnal_srxd_t*);
 416 int             gmnal_rx_requeue_buffer(gmnal_data_t *, gmnal_srxd_t *);
 417 int             gmnal_add_rxtwe(gmnal_data_t *, gm_recv_t *);
 418 gmnal_rxtwe_t * gmnal_get_rxtwe(gmnal_data_t *);
 419 void            gmnal_remove_rxtwe(gmnal_data_t *);
 420
 421
 422 /*
 423  *      Small messages
 424  */
 425 ptl_err_t       gmnal_small_rx(lib_nal_t *, void *, lib_msg_t *);
 426 ptl_err_t       gmnal_small_tx(lib_nal_t *, void *, lib_msg_t *, ptl_hdr_t *,
 427                                 int, ptl_nid_t, ptl_pid_t,
 428                                 gmnal_stxd_t*, int);
 429 void            gmnal_small_tx_callback(gm_port_t *, void *, gm_status_t);
 430
 431
 432
 433 /*
 434  *      Large messages
 435  */
 436 int             gmnal_large_rx(lib_nal_t *, void *, lib_msg_t *, unsigned int,
 437                                 struct iovec *, size_t, size_t, size_t);
 438
 439 int             gmnal_large_tx(lib_nal_t *, void *, lib_msg_t *, ptl_hdr_t *,
 440                                 int, ptl_nid_t, ptl_pid_t, unsigned int,
 441                                 struct iovec*, size_t, int);
 442
 443 void            gmnal_large_tx_callback(gm_port_t *, void *, gm_status_t);
 444
 445 int             gmnal_remote_get(gmnal_srxd_t *, int, struct iovec*, int,
 446                                   struct iovec*);
 447
 448 void            gmnal_remote_get_callback(gm_port_t *, void *, gm_status_t);
 449
 450 int             gmnal_copyiov(int, gmnal_srxd_t *, int, struct iovec*, int,
 451                                struct iovec*);
 452
 453 void            gmnal_large_tx_ack(gmnal_data_t *, gmnal_srxd_t *);
 454 void            gmnal_large_tx_ack_callback(gm_port_t *, void *, gm_status_t);
 455 void            gmnal_large_tx_ack_received(gmnal_data_t *, gmnal_srxd_t *);
 456
 457 #endif /*__INCLUDE_GMNAL_H__*/