1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (c) 2003 Los Alamos National Laboratory (LANL)
6 * This file is part of Lustre, http://www.lustre.org/
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.
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.
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.
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
28 #ifndef __INCLUDE_GMNAL_H__
29 #define __INCLUDE_GMNAL_H__
31 /* XXX Lustre as of V1.2.2 drop defines VERSION, which causes problems
32 * when including <GM>/include/gm_lanai.h which defines a structure field
33 * with the name VERSION XXX */
39 # define EXPORT_SYMTAB
41 #ifdef HAVE_KERNEL_CONFIG_H
42 #include <linux/config.h>
44 #include "linux/module.h"
45 #include "linux/tty.h"
46 #include "linux/kernel.h"
48 #include "linux/string.h"
49 #include "linux/stat.h"
50 #include "linux/errno.h"
51 #include "linux/version.h"
52 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,0)
53 #include "linux/buffer_head.h"
56 #include "linux/locks.h"
58 #include "linux/unistd.h"
59 #include "linux/init.h"
60 #include "linux/sem.h"
61 #include "linux/vmalloc.h"
62 #include "linux/sysctl.h"
64 #define DEBUG_SUBSYSTEM S_LND
66 #include "libcfs/kp30.h"
67 #include "lnet/lnet.h"
68 #include "lnet/lib-lnet.h"
70 /* undefine these before including the GM headers which clash */
71 #undef PACKAGE_BUGREPORT
74 #undef PACKAGE_TARNAME
75 #undef PACKAGE_VERSION
77 #define GM_STRONG_TYPES 1
82 #include "gm_internal.h"
85 #define GMNAL_RESCHED 100 /* # busy loops to force scheduler to yield */
86 #define GMNAL_NETADDR_BASE 0x10000000 /* where we start in network VM */
87 #define GMNAL_LARGE_PRIORITY GM_LOW_PRIORITY /* large message GM priority */
88 #define GMNAL_SMALL_PRIORITY GM_LOW_PRIORITY /* small message GM priority */
92 lnet_hdr_t gmim_hdr; /* portals header */
93 char gmim_payload[0]; /* payload */
94 } gmnal_immediate_msg_t;
97 /* First 2 fields fixed FOR ALL TIME */
98 __u32 gmm_magic; /* I'm a GM message */
99 __u16 gmm_version; /* this is my version number */
101 __u16 gmm_type; /* msg type */
102 __u64 gmm_srcnid; /* sender's NID */
103 __u64 gmm_dstnid; /* destination's NID */
105 gmnal_immediate_msg_t immediate;
107 } WIRE_ATTR gmnal_msg_t;
109 #define GMNAL_MSG_MAGIC LNET_PROTO_GM_MAGIC
110 #define GMNAL_MSG_VERSION 1
111 #define GMNAL_MSG_IMMEDIATE 1
113 typedef struct netbuf {
114 __u64 nb_netaddr; /* network VM address */
115 lnet_kiov_t nb_kiov[1]; /* the pages (at least 1) */
118 #define GMNAL_NETBUF_MSG(nb) ((gmnal_msg_t *)page_address((nb)->nb_kiov[0].kiov_page))
119 #define GMNAL_NETBUF_LOCAL_NETADDR(nb) ((void *)((unsigned long)(nb)->nb_netaddr))
121 typedef struct gmnal_txbuf {
122 struct list_head txb_list; /* queue on gmni_idle_ltxbs */
123 struct gmnal_txbuf *txb_next; /* stash on gmni_ltxs */
124 gmnal_netbuf_t txb_buf; /* space */
127 typedef struct gmnal_tx {
128 struct list_head tx_list; /* queue */
129 int tx_credit:1; /* consumed a credit? */
130 int tx_large_iskiov:1; /* large is in kiovs? */
131 struct gmnal_ni *tx_gmni; /* owning NI */
132 lnet_nid_t tx_nid; /* destination NID */
133 int tx_gmlid; /* destination GM local ID */
134 lnet_msg_t *tx_lntmsg; /* lntmsg to finalize on completion */
136 gmnal_netbuf_t tx_buf; /* small tx buffer */
137 gmnal_txbuf_t *tx_ltxb; /* large buffer (to free on completion) */
138 int tx_msgnob; /* message size (so far) */
140 int tx_large_nob; /* # bytes large buffer payload */
141 int tx_large_offset; /* offset within frags */
142 int tx_large_niov; /* # VM frags */
144 struct iovec *iov; /* mapped frags */
145 lnet_kiov_t *kiov; /* page frags */
147 unsigned long tx_launchtime; /* when (in jiffies) the transmit was launched */
148 struct gmnal_tx *tx_next; /* stash on gmni_txs */
151 typedef struct gmnal_rx {
152 struct list_head rx_list; /* enqueue on gmni_rxq for handling */
153 int rx_islarge:1; /* large receive buffer? */
154 unsigned int rx_recv_nob; /* bytes received */
155 __u16 rx_recv_gmid; /* sender */
156 __u8 rx_recv_port; /* sender's port */
157 __u8 rx_recv_type; /* ?? */
158 struct gmnal_rx *rx_next; /* stash on gmni_rxs */
159 gmnal_netbuf_t rx_buf; /* the buffer */
162 typedef struct gmnal_ni {
163 lnet_ni_t *gmni_ni; /* generic NI */
164 struct gm_port *gmni_port; /* GM port */
165 spinlock_t gmni_gm_lock; /* serialise GM calls */
166 int gmni_large_pages; /* # pages in a large message buffer */
167 int gmni_large_msgsize; /* nob in large message buffers */
168 int gmni_large_gmsize; /* large message GM bucket */
169 int gmni_small_msgsize; /* nob in small message buffers */
170 int gmni_small_gmsize; /* small message GM bucket */
171 __u64 gmni_netaddr_base; /* base of mapped network VM */
172 int gmni_netaddr_size; /* # bytes of mapped network VM */
174 gmnal_tx_t *gmni_txs; /* all txs */
175 gmnal_rx_t *gmni_rxs; /* all rx descs */
176 gmnal_txbuf_t *gmni_ltxbs; /* all large tx bufs */
178 atomic_t gmni_nthreads; /* total # threads */
179 gm_alarm_t gmni_alarm; /* alarm to wake caretaker */
180 int gmni_shutdown; /* tell all threads to exit */
182 struct list_head gmni_idle_txs; /* idle tx's */
183 int gmni_tx_credits; /* # transmits still possible */
184 struct list_head gmni_idle_ltxbs; /* idle large tx buffers */
185 struct list_head gmni_buf_txq; /* tx's waiting for buffers */
186 struct list_head gmni_cred_txq; /* tx's waiting for credits */
187 spinlock_t gmni_tx_lock; /* serialise */
189 struct gm_hash *gmni_rx_hash; /* buffer->rx lookup */
190 struct semaphore gmni_rx_mutex; /* serialise blocking on GM */
197 int *gm_peer_credits;
198 int *gm_nlarge_tx_bufs;
202 #if CONFIG_SYSCTL && !CFS_SYSFS_MODULE_PARM
203 struct ctl_table_header *gm_sysctl; /* sysctl interface */
209 int gmnal_init(void);
210 void gmnal_fini(void);
211 int gmnal_ctl(lnet_ni_t *ni, unsigned int cmd, void *arg);
212 int gmnal_startup(lnet_ni_t *ni);
213 void gmnal_shutdown(lnet_ni_t *ni);
216 int gmnal_recv(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg,
217 int delayed, unsigned int niov,
218 struct iovec *iov, lnet_kiov_t *kiov,
219 unsigned int offset, unsigned int mlen, unsigned int rlen);
220 int gmnal_send(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg);
223 void gmnal_free_ltxbufs(gmnal_ni_t *gmni);
224 int gmnal_alloc_ltxbufs(gmnal_ni_t *gmni);
225 void gmnal_free_txs(gmnal_ni_t *gmni);
226 int gmnal_alloc_txs(gmnal_ni_t *gmni);
227 void gmnal_free_rxs(gmnal_ni_t *gmni);
228 int gmnal_alloc_rxs(gmnal_ni_t *gmni);
229 char *gmnal_gmstatus2str(gm_status_t status);
230 char *gmnal_rxevent2str(gm_recv_event_t *ev);
231 void gmnal_yield(int delay);
234 void gmnal_post_rx(gmnal_ni_t *gmni, gmnal_rx_t *rx);
235 gmnal_tx_t *gmnal_get_tx(gmnal_ni_t *gmni);
236 void gmnal_tx_done(gmnal_tx_t *tx, int rc);
237 void gmnal_pack_msg(gmnal_ni_t *gmni, gmnal_msg_t *msg,
238 lnet_nid_t dstnid, int type);
239 void gmnal_stop_threads(gmnal_ni_t *gmni);
240 int gmnal_start_threads(gmnal_ni_t *gmni);
241 void gmnal_check_txqueues_locked (gmnal_ni_t *gmni);
243 /* Module Parameters */
244 extern gmnal_tunables_t gmnal_tunables;
246 #endif /*__INCLUDE_GMNAL_H__*/