lnet/klnds/gmlnd/gmlnd.h

   1 /*
   2  * -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   3  * vim:expandtab:shiftwidth=8:tabstop=8:
   4  *
   5  * GPL HEADER START
   6  *
   7  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 only,
  11  * as published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License version 2 for more details (a copy is included
  17  * in the LICENSE file that accompanied this code).
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * version 2 along with this program; If not, see [sun.com URL with a
  21  * copy of GPLv2].
  22  *
  23  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  24  * CA 95054 USA or visit www.sun.com if you need additional information or
  25  * have any questions.
  26  *
  27  * GPL HEADER END
  28  */
  29 /*
  30  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  31  * Use is subject to license terms.
  32  *
  33  * Copyright (c) 2003 Los Alamos National Laboratory (LANL)
  34  */
  35 /*
  36  * This file is part of Lustre, http://www.lustre.org/
  37  * Lustre is a trademark of Sun Microsystems, Inc.
  38  */
  39
  40 /*
  41  *      Portals GM kernel NAL header file
  42  *      This file makes all declaration and prototypes
  43  *      for the API side and CB side of the NAL
  44  */
  45 #ifndef __INCLUDE_GMNAL_H__
  46 #define __INCLUDE_GMNAL_H__
  47
  48 /* XXX Lustre as of V1.2.2 drop defines VERSION, which causes problems
  49  * when including <GM>/include/gm_lanai.h which defines a structure field
  50  * with the name VERSION XXX */
  51 #ifdef VERSION
  52 # undef VERSION
  53 #endif
  54
  55 #ifndef EXPORT_SYMTAB
  56 # define EXPORT_SYMTAB
  57 #endif
  58 #ifndef AUTOCONF_INCLUDED
  59 #include <linux/config.h>
  60 #endif
  61 #include "linux/module.h"
  62 #include "linux/tty.h"
  63 #include "linux/kernel.h"
  64 #include "linux/mm.h"
  65 #include "linux/string.h"
  66 #include "linux/stat.h"
  67 #include "linux/errno.h"
  68 #include "linux/version.h"
  69 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,0)
  70 #include "linux/buffer_head.h"
  71 #include "linux/fs.h"
  72 #else
  73 #include "linux/locks.h"
  74 #endif
  75 #include "linux/unistd.h"
  76 #include "linux/init.h"
  77 #include "linux/sem.h"
  78 #include "linux/vmalloc.h"
  79 #include "linux/sysctl.h"
  80
  81 #define DEBUG_SUBSYSTEM S_LND
  82
  83 #include "libcfs/libcfs.h"
  84 #include "lnet/lnet.h"
  85 #include "lnet/lib-lnet.h"
  86
  87 /* undefine these before including the GM headers which clash */
  88 #undef PACKAGE_BUGREPORT
  89 #undef PACKAGE_NAME
  90 #undef PACKAGE_STRING
  91 #undef PACKAGE_TARNAME
  92 #undef PACKAGE_VERSION
  93
  94 #define GM_STRONG_TYPES 1
  95 #ifdef VERSION
  96 #undef VERSION
  97 #endif
  98 #include "gm.h"
  99 #include "gm_internal.h"
 100
 101 /* Fixed tunables */
 102 #define GMNAL_RESCHED              100          /* # busy loops to force scheduler to yield */
 103 #define GMNAL_NETADDR_BASE         0x10000000   /* where we start in network VM */
 104 #define GMNAL_LARGE_PRIORITY       GM_LOW_PRIORITY /* large message GM priority */
 105 #define GMNAL_SMALL_PRIORITY       GM_LOW_PRIORITY /* small message GM priority */
 106
 107 /* Wire protocol */
 108 typedef struct {
 109         lnet_hdr_t      gmim_hdr;               /* portals header */
 110         char            gmim_payload[0];        /* payload */
 111 } gmnal_immediate_msg_t;
 112
 113 typedef struct {
 114         /* First 2 fields fixed FOR ALL TIME */
 115         __u32           gmm_magic;              /* I'm a GM message */
 116         __u16           gmm_version;            /* this is my version number */
 117
 118         __u16           gmm_type;               /* msg type */
 119         __u64           gmm_srcnid;             /* sender's NID */
 120         __u64           gmm_dstnid;             /* destination's NID */
 121         union {
 122                 gmnal_immediate_msg_t   immediate;
 123         }               gmm_u;
 124 } WIRE_ATTR gmnal_msg_t;
 125
 126 #define GMNAL_MSG_MAGIC                 LNET_PROTO_GM_MAGIC
 127 #define GMNAL_MSG_VERSION               1
 128 #define GMNAL_MSG_IMMEDIATE             1
 129
 130 typedef struct netbuf {
 131         __u64                    nb_netaddr;    /* network VM address */
 132         lnet_kiov_t              nb_kiov[1];    /* the pages (at least 1) */
 133 } gmnal_netbuf_t;
 134
 135 #define GMNAL_NETBUF_MSG(nb)            ((gmnal_msg_t *)page_address((nb)->nb_kiov[0].kiov_page))
 136 #define GMNAL_NETBUF_LOCAL_NETADDR(nb)  ((void *)((unsigned long)(nb)->nb_netaddr))
 137
 138 typedef struct gmnal_txbuf {
 139         struct list_head         txb_list;      /* queue on gmni_idle_ltxbs */
 140         struct gmnal_txbuf      *txb_next;      /* stash on gmni_ltxs */
 141         gmnal_netbuf_t           txb_buf;       /* space */
 142 } gmnal_txbuf_t;
 143
 144 typedef struct gmnal_tx {
 145         struct list_head         tx_list;       /* queue */
 146         int                      tx_credit:1;   /* consumed a credit? */
 147         int                      tx_large_iskiov:1; /* large is in kiovs? */
 148         struct gmnal_ni         *tx_gmni;       /* owning NI */
 149         lnet_nid_t               tx_nid;        /* destination NID */
 150         int                      tx_gmlid;      /* destination GM local ID */
 151         lnet_msg_t              *tx_lntmsg;     /* lntmsg to finalize on completion */
 152
 153         gmnal_netbuf_t           tx_buf;        /* small tx buffer */
 154         gmnal_txbuf_t           *tx_ltxb;       /* large buffer (to free on completion) */
 155         int                      tx_msgnob;     /* message size (so far) */
 156
 157         int                      tx_large_nob;  /* # bytes large buffer payload */
 158         int                      tx_large_offset; /* offset within frags */
 159         int                      tx_large_niov; /* # VM frags */
 160         union {
 161                 struct iovec    *iov;           /* mapped frags */
 162                 lnet_kiov_t     *kiov;          /* page frags */
 163         }                        tx_large_frags;
 164         cfs_time_t               tx_launchtime; /* when (in jiffies) the
 165                                                  * transmit was launched */
 166         struct gmnal_tx         *tx_next;       /* stash on gmni_txs */
 167 } gmnal_tx_t;
 168
 169 typedef struct gmnal_rx {
 170         struct list_head         rx_list;       /* enqueue on gmni_rxq for handling */
 171         int                      rx_islarge:1;  /* large receive buffer? */
 172         unsigned int             rx_recv_nob;   /* bytes received */
 173         __u16                    rx_recv_gmid;  /* sender */
 174         __u8                     rx_recv_port;  /* sender's port */
 175         __u8                     rx_recv_type;  /* ?? */
 176         struct gmnal_rx         *rx_next;       /* stash on gmni_rxs */
 177         gmnal_netbuf_t           rx_buf;        /* the buffer */
 178 } gmnal_rx_t;
 179
 180 typedef struct gmnal_ni {
 181         lnet_ni_t        *gmni_ni;              /* generic NI */
 182         struct gm_port   *gmni_port;            /* GM port */
 183         spinlock_t        gmni_gm_lock;         /* serialise GM calls */
 184         int               gmni_large_pages;     /* # pages in a large message buffer */
 185         int               gmni_large_msgsize;   /* nob in large message buffers */
 186         int               gmni_large_gmsize;    /* large message GM bucket */
 187         int               gmni_small_msgsize;   /* nob in small message buffers */
 188         int               gmni_small_gmsize;    /* small message GM bucket */
 189         __u64             gmni_netaddr_base;    /* base of mapped network VM */
 190         int               gmni_netaddr_size;    /* # bytes of mapped network VM */
 191
 192         gmnal_tx_t       *gmni_txs;             /* all txs */
 193         gmnal_rx_t       *gmni_rxs;             /* all rx descs */
 194         gmnal_txbuf_t    *gmni_ltxbs;           /* all large tx bufs */
 195
 196         atomic_t          gmni_nthreads;        /* total # threads */
 197         gm_alarm_t        gmni_alarm;           /* alarm to wake caretaker */
 198         int               gmni_shutdown;        /* tell all threads to exit */
 199
 200         struct list_head  gmni_idle_txs;        /* idle tx's */
 201         int               gmni_tx_credits;      /* # transmits still possible */
 202         struct list_head  gmni_idle_ltxbs;      /* idle large tx buffers */
 203         struct list_head  gmni_buf_txq;         /* tx's waiting for buffers */
 204         struct list_head  gmni_cred_txq;        /* tx's waiting for credits */
 205         spinlock_t        gmni_tx_lock;         /* serialise */
 206
 207         struct gm_hash   *gmni_rx_hash;         /* buffer->rx lookup */
 208         struct semaphore  gmni_rx_mutex;        /* serialise blocking on GM */
 209 } gmnal_ni_t;
 210
 211 typedef struct {
 212         int              *gm_port;
 213         int              *gm_ntx;
 214         int              *gm_credits;
 215         int              *gm_peer_credits;
 216         int              *gm_nlarge_tx_bufs;
 217         int              *gm_nrx_small;
 218         int              *gm_nrx_large;
 219
 220 #if defined(CONFIG_SYSCTL) && !CFS_SYSFS_MODULE_PARM
 221         cfs_sysctl_table_header_t *gm_sysctl;   /* sysctl interface */
 222 #endif
 223 } gmnal_tunables_t;
 224
 225
 226 /* gmnal_api.c */
 227 int gmnal_init(void);
 228 void gmnal_fini(void);
 229 int gmnal_ctl(lnet_ni_t *ni, unsigned int cmd, void *arg);
 230 int gmnal_startup(lnet_ni_t *ni);
 231 void gmnal_shutdown(lnet_ni_t *ni);
 232
 233 /* gmnal_cb.c */
 234 int gmnal_recv(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg,
 235                int delayed, unsigned int niov,
 236                struct iovec *iov, lnet_kiov_t *kiov,
 237                unsigned int offset, unsigned int mlen, unsigned int rlen);
 238 int gmnal_send(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg);
 239
 240 /* gmnal_util.c */
 241 void gmnal_free_ltxbufs(gmnal_ni_t *gmni);
 242 int gmnal_alloc_ltxbufs(gmnal_ni_t *gmni);
 243 void gmnal_free_txs(gmnal_ni_t *gmni);
 244 int gmnal_alloc_txs(gmnal_ni_t *gmni);
 245 void gmnal_free_rxs(gmnal_ni_t *gmni);
 246 int gmnal_alloc_rxs(gmnal_ni_t *gmni);
 247 char *gmnal_gmstatus2str(gm_status_t status);
 248 char *gmnal_rxevent2str(gm_recv_event_t *ev);
 249 void gmnal_yield(int delay);
 250
 251 /* gmnal_comm.c */
 252 void gmnal_post_rx(gmnal_ni_t *gmni, gmnal_rx_t *rx);
 253 gmnal_tx_t *gmnal_get_tx(gmnal_ni_t *gmni);
 254 void gmnal_tx_done(gmnal_tx_t *tx, int rc);
 255 void gmnal_pack_msg(gmnal_ni_t *gmni, gmnal_msg_t *msg,
 256                     lnet_nid_t dstnid, int type);
 257 void gmnal_stop_threads(gmnal_ni_t *gmni);
 258 int gmnal_start_threads(gmnal_ni_t *gmni);
 259 void gmnal_check_txqueues_locked (gmnal_ni_t *gmni);
 260
 261 /* Module Parameters */
 262 extern gmnal_tunables_t gmnal_tunables;
 263
 264 #endif /*__INCLUDE_GMNAL_H__*/