4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lnet/klnds/o2iblnd/o2iblnd_modparams.c
34 * Author: Eric Barton <eric@bartonsoftware.com>
39 #define CURRENT_LND_VERSION 1
41 static int service = 987;
42 module_param(service, int, 0444);
43 MODULE_PARM_DESC(service, "service number (within RDMA_PS_TCP)");
46 module_param(cksum, int, 0644);
47 MODULE_PARM_DESC(cksum, "set non-zero to enable message (not RDMA) checksums");
49 static int timeout = 50;
50 module_param(timeout, int, 0644);
51 MODULE_PARM_DESC(timeout, "timeout (seconds)");
53 /* Number of threads in each scheduler pool which is percpt,
54 * we will estimate reasonable value based on CPUs if it's set to zero. */
56 module_param(nscheds, int, 0444);
57 MODULE_PARM_DESC(nscheds, "number of threads in each scheduler pool");
59 static unsigned int conns_per_peer = 1;
60 module_param(conns_per_peer, uint, 0444);
61 MODULE_PARM_DESC(conns_per_peer, "number of connections per peer");
63 /* NB: this value is shared by all CPTs, it can grow at runtime */
65 module_param(ntx, int, 0444);
66 MODULE_PARM_DESC(ntx, "# of message descriptors allocated for each pool");
68 /* NB: this value is shared by all CPTs */
69 static int credits = 256;
70 module_param(credits, int, 0444);
71 MODULE_PARM_DESC(credits, "# concurrent sends");
73 static int peer_credits = 8;
74 module_param(peer_credits, int, 0444);
75 MODULE_PARM_DESC(peer_credits, "# concurrent sends to 1 peer");
77 static int peer_credits_hiw = 0;
78 module_param(peer_credits_hiw, int, 0444);
79 MODULE_PARM_DESC(peer_credits_hiw, "when eagerly to return credits");
81 static int peer_buffer_credits = 0;
82 module_param(peer_buffer_credits, int, 0444);
83 MODULE_PARM_DESC(peer_buffer_credits, "# per-peer router buffer credits");
85 static int peer_timeout = DEFAULT_PEER_TIMEOUT;
86 module_param(peer_timeout, int, 0444);
87 MODULE_PARM_DESC(peer_timeout, "Seconds without aliveness news to declare peer dead (<=0 to disable)");
89 static char *ipif_name = "ib0";
90 module_param(ipif_name, charp, 0444);
91 MODULE_PARM_DESC(ipif_name, "IPoIB interface name");
93 static int retry_count = 5;
94 module_param(retry_count, int, 0644);
95 MODULE_PARM_DESC(retry_count, "Retransmissions when no ACK received");
97 static int rnr_retry_count = 6;
98 module_param(rnr_retry_count, int, 0644);
99 MODULE_PARM_DESC(rnr_retry_count, "RNR retransmissions");
101 static int keepalive = 100;
102 module_param(keepalive, int, 0644);
103 MODULE_PARM_DESC(keepalive, "Idle time in seconds before sending a keepalive");
106 module_param(ib_mtu, int, 0444);
107 MODULE_PARM_DESC(ib_mtu, "IB MTU 256/512/1024/2048/4096");
109 static int concurrent_sends;
110 module_param(concurrent_sends, int, 0444);
111 MODULE_PARM_DESC(concurrent_sends, "send work-queue sizing (obsolete)");
114 * map_on_demand is a flag used to determine if we can use FMR or FastReg.
115 * This is applicable for kernels which support global memory regions. For
116 * later kernels this flag is always enabled, since we will always either
118 * For kernels which support global memory regions map_on_demand defaults
119 * to 0 which means we will be using global memory regions exclusively.
120 * If it is set to a value other than 0, then we will behave as follows:
121 * 1. Always default the number of fragments to IBLND_MAX_RDMA_FRAGS
122 * 2. Create FMR/FastReg pools
123 * 3. Negotiate the supported number of fragments per connection
124 * 4. Attempt to transmit using global memory regions only if
125 * map-on-demand is not turned on, otherwise use FMR or FastReg
126 * 5. In case of transmitting tx with GAPS over FMR we will need to
127 * transmit it with multiple fragments. Look at the comments in
128 * kiblnd_fmr_map_tx() for an explanation of the behavior.
130 * For later kernels we default map_on_demand to 1 and not allow
131 * it to be set to 0, since there is no longer support for global memory
133 * 1. Default the number of fragments to IBLND_MAX_RDMA_FRAGS
134 * 2. Create FMR/FastReg pools
135 * 3. Negotiate the supported number of fragments per connection
136 * 4. Look at the comments in kiblnd_fmr_map_tx() for an explanation of
137 * the behavior when transmit with GAPS verses contiguous.
139 #ifdef HAVE_IB_GET_DMA_MR
140 #define IBLND_DEFAULT_MAP_ON_DEMAND 0
141 #define MOD_STR "map on demand"
143 #define IBLND_DEFAULT_MAP_ON_DEMAND 1
144 #define MOD_STR "map on demand (obsolete)"
146 static int map_on_demand = IBLND_DEFAULT_MAP_ON_DEMAND;
147 module_param(map_on_demand, int, 0444);
148 MODULE_PARM_DESC(map_on_demand, MOD_STR);
150 /* NB: this value is shared by all CPTs, it can grow at runtime */
151 static int fmr_pool_size = 512;
152 module_param(fmr_pool_size, int, 0444);
153 MODULE_PARM_DESC(fmr_pool_size, "size of fmr pool on each CPT (>= ntx / 4)");
155 /* NB: this value is shared by all CPTs, it can grow at runtime */
156 static int fmr_flush_trigger = 384;
157 module_param(fmr_flush_trigger, int, 0444);
158 MODULE_PARM_DESC(fmr_flush_trigger, "# dirty FMRs that triggers pool flush");
160 static int fmr_cache = 1;
161 module_param(fmr_cache, int, 0444);
162 MODULE_PARM_DESC(fmr_cache, "non-zero to enable FMR caching");
165 * 0: disable failover
166 * 1: enable failover if necessary
167 * 2: force to failover (for debug)
169 static int dev_failover = 0;
170 module_param(dev_failover, int, 0444);
171 MODULE_PARM_DESC(dev_failover, "HCA failover for bonding (0 off, 1 on, other values reserved)");
173 static int require_privileged_port;
174 module_param(require_privileged_port, int, 0644);
175 MODULE_PARM_DESC(require_privileged_port, "require privileged port when accepting connection");
177 static int use_privileged_port = 1;
178 module_param(use_privileged_port, int, 0644);
179 MODULE_PARM_DESC(use_privileged_port, "use privileged port when initiating connection");
181 static unsigned int wrq_sge = 2;
182 module_param(wrq_sge, uint, 0444);
183 MODULE_PARM_DESC(wrq_sge, "# scatter/gather element per work request");
185 kib_tunables_t kiblnd_tunables = {
186 .kib_dev_failover = &dev_failover,
187 .kib_service = &service,
189 .kib_timeout = &timeout,
190 .kib_keepalive = &keepalive,
191 .kib_default_ipif = &ipif_name,
192 .kib_retry_count = &retry_count,
193 .kib_rnr_retry_count = &rnr_retry_count,
194 .kib_ib_mtu = &ib_mtu,
195 .kib_require_priv_port = &require_privileged_port,
196 .kib_use_priv_port = &use_privileged_port,
197 .kib_nscheds = &nscheds,
198 .kib_wrq_sge = &wrq_sge,
201 static struct lnet_ioctl_config_o2iblnd_tunables default_tunables;
203 /* # messages/RDMAs in-flight */
205 kiblnd_msg_queue_size(int version, struct lnet_ni *ni)
207 if (version == IBLND_MSG_VERSION_1)
208 return IBLND_MSG_QUEUE_SIZE_V1;
210 return ni->ni_net->net_tunables.lct_peer_tx_credits;
216 kiblnd_tunables_setup(struct lnet_ni *ni)
218 struct lnet_ioctl_config_o2iblnd_tunables *tunables;
219 struct lnet_ioctl_config_lnd_cmn_tunables *net_tunables;
222 * if there was no tunables specified, setup the tunables to be
225 if (!ni->ni_lnd_tunables_set)
226 memcpy(&ni->ni_lnd_tunables.lnd_tun_u.lnd_o2ib,
227 &default_tunables, sizeof(*tunables));
229 tunables = &ni->ni_lnd_tunables.lnd_tun_u.lnd_o2ib;
231 /* Current API version */
232 tunables->lnd_version = CURRENT_LND_VERSION;
234 if (kiblnd_translate_mtu(*kiblnd_tunables.kib_ib_mtu) < 0) {
235 CERROR("Invalid ib_mtu %d, expected 256/512/1024/2048/4096\n",
236 *kiblnd_tunables.kib_ib_mtu);
240 net_tunables = &ni->ni_net->net_tunables;
242 if (net_tunables->lct_peer_timeout == -1)
243 net_tunables->lct_peer_timeout = peer_timeout;
245 if (net_tunables->lct_max_tx_credits == -1)
246 net_tunables->lct_max_tx_credits = credits;
248 if (net_tunables->lct_peer_tx_credits == -1)
249 net_tunables->lct_peer_tx_credits = peer_credits;
251 if (net_tunables->lct_peer_rtr_credits == -1)
252 net_tunables->lct_peer_rtr_credits = peer_buffer_credits;
254 if (net_tunables->lct_peer_tx_credits < IBLND_CREDITS_DEFAULT)
255 net_tunables->lct_peer_tx_credits = IBLND_CREDITS_DEFAULT;
257 if (net_tunables->lct_peer_tx_credits > IBLND_CREDITS_MAX)
258 net_tunables->lct_peer_tx_credits = IBLND_CREDITS_MAX;
260 if (net_tunables->lct_peer_tx_credits >
261 net_tunables->lct_max_tx_credits)
262 net_tunables->lct_peer_tx_credits =
263 net_tunables->lct_max_tx_credits;
265 #ifndef HAVE_IB_GET_DMA_MR
267 * For kernels which do not support global memory regions, always
268 * enable map_on_demand
270 if (tunables->lnd_map_on_demand == 0)
271 tunables->lnd_map_on_demand = 1;
274 if (!tunables->lnd_peercredits_hiw)
275 tunables->lnd_peercredits_hiw = peer_credits_hiw;
277 if (tunables->lnd_peercredits_hiw < net_tunables->lct_peer_tx_credits / 2)
278 tunables->lnd_peercredits_hiw = net_tunables->lct_peer_tx_credits / 2;
280 if (tunables->lnd_peercredits_hiw >= net_tunables->lct_peer_tx_credits)
281 tunables->lnd_peercredits_hiw = net_tunables->lct_peer_tx_credits - 1;
283 if (!tunables->lnd_fmr_pool_size)
284 tunables->lnd_fmr_pool_size = fmr_pool_size;
285 if (!tunables->lnd_fmr_flush_trigger)
286 tunables->lnd_fmr_flush_trigger = fmr_flush_trigger;
287 if (!tunables->lnd_fmr_cache)
288 tunables->lnd_fmr_cache = fmr_cache;
289 if (!tunables->lnd_ntx)
290 tunables->lnd_ntx = ntx;
291 if (!tunables->lnd_conns_per_peer) {
292 tunables->lnd_conns_per_peer = (conns_per_peer) ?
300 kiblnd_tunables_init(void)
302 default_tunables.lnd_version = CURRENT_LND_VERSION;
303 default_tunables.lnd_peercredits_hiw = peer_credits_hiw;
304 default_tunables.lnd_map_on_demand = map_on_demand;
305 default_tunables.lnd_fmr_pool_size = fmr_pool_size;
306 default_tunables.lnd_fmr_flush_trigger = fmr_flush_trigger;
307 default_tunables.lnd_fmr_cache = fmr_cache;
308 default_tunables.lnd_ntx = ntx;
309 default_tunables.lnd_conns_per_peer = conns_per_peer;