Whamcloud - gitweb
LU-8648 all: remove all Sun license and URL references
[fs/lustre-release.git] / lnet / klnds / o2iblnd / o2iblnd_modparams.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) 2012, 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  * lnet/klnds/o2iblnd/o2iblnd_modparams.c
33  *
34  * Author: Eric Barton <eric@bartonsoftware.com>
35  */
36
37 #include "o2iblnd.h"
38
39 static int service = 987;
40 module_param(service, int, 0444);
41 MODULE_PARM_DESC(service, "service number (within RDMA_PS_TCP)");
42
43 static int cksum = 0;
44 module_param(cksum, int, 0644);
45 MODULE_PARM_DESC(cksum, "set non-zero to enable message (not RDMA) checksums");
46
47 static int timeout = 50;
48 module_param(timeout, int, 0644);
49 MODULE_PARM_DESC(timeout, "timeout (seconds)");
50
51 /* Number of threads in each scheduler pool which is percpt,
52  * we will estimate reasonable value based on CPUs if it's set to zero. */
53 static int nscheds;
54 module_param(nscheds, int, 0444);
55 MODULE_PARM_DESC(nscheds, "number of threads in each scheduler pool");
56
57 /* NB: this value is shared by all CPTs, it can grow at runtime */
58 static int ntx = 512;
59 module_param(ntx, int, 0444);
60 MODULE_PARM_DESC(ntx, "# of message descriptors allocated for each pool");
61
62 /* NB: this value is shared by all CPTs */
63 static int credits = 256;
64 module_param(credits, int, 0444);
65 MODULE_PARM_DESC(credits, "# concurrent sends");
66
67 static int peer_credits = 8;
68 module_param(peer_credits, int, 0444);
69 MODULE_PARM_DESC(peer_credits, "# concurrent sends to 1 peer");
70
71 static int peer_credits_hiw = 0;
72 module_param(peer_credits_hiw, int, 0444);
73 MODULE_PARM_DESC(peer_credits_hiw, "when eagerly to return credits");
74
75 static int peer_buffer_credits = 0;
76 module_param(peer_buffer_credits, int, 0444);
77 MODULE_PARM_DESC(peer_buffer_credits, "# per-peer router buffer credits");
78
79 static int peer_timeout = 180;
80 module_param(peer_timeout, int, 0444);
81 MODULE_PARM_DESC(peer_timeout, "Seconds without aliveness news to declare peer dead (<=0 to disable)");
82
83 static char *ipif_name = "ib0";
84 module_param(ipif_name, charp, 0444);
85 MODULE_PARM_DESC(ipif_name, "IPoIB interface name");
86
87 static int retry_count = 5;
88 module_param(retry_count, int, 0644);
89 MODULE_PARM_DESC(retry_count, "Retransmissions when no ACK received");
90
91 static int rnr_retry_count = 6;
92 module_param(rnr_retry_count, int, 0644);
93 MODULE_PARM_DESC(rnr_retry_count, "RNR retransmissions");
94
95 static int keepalive = 100;
96 module_param(keepalive, int, 0644);
97 MODULE_PARM_DESC(keepalive, "Idle time in seconds before sending a keepalive");
98
99 static int ib_mtu;
100 module_param(ib_mtu, int, 0444);
101 MODULE_PARM_DESC(ib_mtu, "IB MTU 256/512/1024/2048/4096");
102
103 static int concurrent_sends;
104 module_param(concurrent_sends, int, 0444);
105 MODULE_PARM_DESC(concurrent_sends, "send work-queue sizing");
106
107 static int map_on_demand;
108 module_param(map_on_demand, int, 0444);
109 MODULE_PARM_DESC(map_on_demand, "map on demand");
110
111 /* NB: this value is shared by all CPTs, it can grow at runtime */
112 static int fmr_pool_size = 512;
113 module_param(fmr_pool_size, int, 0444);
114 MODULE_PARM_DESC(fmr_pool_size, "size of fmr pool on each CPT (>= ntx / 4)");
115
116 /* NB: this value is shared by all CPTs, it can grow at runtime */
117 static int fmr_flush_trigger = 384;
118 module_param(fmr_flush_trigger, int, 0444);
119 MODULE_PARM_DESC(fmr_flush_trigger, "# dirty FMRs that triggers pool flush");
120
121 static int fmr_cache = 1;
122 module_param(fmr_cache, int, 0444);
123 MODULE_PARM_DESC(fmr_cache, "non-zero to enable FMR caching");
124
125 /*
126  * 0: disable failover
127  * 1: enable failover if necessary
128  * 2: force to failover (for debug)
129  */
130 static int dev_failover = 0;
131 module_param(dev_failover, int, 0444);
132 MODULE_PARM_DESC(dev_failover, "HCA failover for bonding (0 off, 1 on, other values reserved)");
133
134 static int require_privileged_port;
135 module_param(require_privileged_port, int, 0644);
136 MODULE_PARM_DESC(require_privileged_port, "require privileged port when accepting connection");
137
138 static int use_privileged_port = 1;
139 module_param(use_privileged_port, int, 0644);
140 MODULE_PARM_DESC(use_privileged_port, "use privileged port when initiating connection");
141
142 kib_tunables_t kiblnd_tunables = {
143         .kib_dev_failover           = &dev_failover,
144         .kib_service                = &service,
145         .kib_cksum                  = &cksum,
146         .kib_timeout                = &timeout,
147         .kib_keepalive              = &keepalive,
148         .kib_ntx                    = &ntx,
149         .kib_default_ipif           = &ipif_name,
150         .kib_retry_count            = &retry_count,
151         .kib_rnr_retry_count        = &rnr_retry_count,
152         .kib_ib_mtu                 = &ib_mtu,
153         .kib_require_priv_port      = &require_privileged_port,
154         .kib_use_priv_port          = &use_privileged_port,
155         .kib_nscheds                = &nscheds
156 };
157
158 static struct lnet_ioctl_config_o2iblnd_tunables default_tunables;
159
160 /* # messages/RDMAs in-flight */
161 int
162 kiblnd_msg_queue_size(int version, lnet_ni_t *ni)
163 {
164         if (version == IBLND_MSG_VERSION_1)
165                 return IBLND_MSG_QUEUE_SIZE_V1;
166         else if (ni)
167                 return ni->ni_peertxcredits;
168         else
169                 return peer_credits;
170 }
171
172 int
173 kiblnd_tunables_setup(lnet_ni_t *ni)
174 {
175         struct lnet_ioctl_config_o2iblnd_tunables *tunables;
176
177         /*
178          * if there was no tunables specified, setup the tunables to be
179          * defaulted
180          */
181         if (!ni->ni_lnd_tunables) {
182                 LIBCFS_ALLOC(ni->ni_lnd_tunables,
183                              sizeof(*ni->ni_lnd_tunables));
184                 if (!ni->ni_lnd_tunables)
185                         return -ENOMEM;
186
187                 memcpy(&ni->ni_lnd_tunables->lt_tun_u.lt_o2ib,
188                        &default_tunables, sizeof(*tunables));
189         }
190         tunables = &ni->ni_lnd_tunables->lt_tun_u.lt_o2ib;
191
192         /* Current API version */
193         tunables->lnd_version = 0;
194
195         if (kiblnd_translate_mtu(*kiblnd_tunables.kib_ib_mtu) < 0) {
196                 CERROR("Invalid ib_mtu %d, expected 256/512/1024/2048/4096\n",
197                        *kiblnd_tunables.kib_ib_mtu);
198                 return -EINVAL;
199         }
200
201         if (!ni->ni_peertimeout)
202                 ni->ni_peertimeout = peer_timeout;
203
204         if (!ni->ni_maxtxcredits)
205                 ni->ni_maxtxcredits = credits;
206
207         if (!ni->ni_peertxcredits)
208                 ni->ni_peertxcredits = peer_credits;
209
210         if (!ni->ni_peerrtrcredits)
211                 ni->ni_peerrtrcredits = peer_buffer_credits;
212
213         if (ni->ni_peertxcredits < IBLND_CREDITS_DEFAULT)
214                 ni->ni_peertxcredits = IBLND_CREDITS_DEFAULT;
215
216         if (ni->ni_peertxcredits > IBLND_CREDITS_MAX)
217                 ni->ni_peertxcredits = IBLND_CREDITS_MAX;
218
219         if (ni->ni_peertxcredits > credits)
220                 ni->ni_peertxcredits = credits;
221
222         if (!tunables->lnd_peercredits_hiw)
223                 tunables->lnd_peercredits_hiw = peer_credits_hiw;
224
225         if (tunables->lnd_peercredits_hiw < ni->ni_peertxcredits / 2)
226                 tunables->lnd_peercredits_hiw = ni->ni_peertxcredits / 2;
227
228         if (tunables->lnd_peercredits_hiw >= ni->ni_peertxcredits)
229                 tunables->lnd_peercredits_hiw = ni->ni_peertxcredits - 1;
230
231         if (tunables->lnd_map_on_demand < 0 ||
232             tunables->lnd_map_on_demand > IBLND_MAX_RDMA_FRAGS) {
233                 /* disable map-on-demand */
234                 tunables->lnd_map_on_demand = 0;
235         }
236
237         if (tunables->lnd_map_on_demand == 1) {
238                 /* don't make sense to create map if only one fragment */
239                 tunables->lnd_map_on_demand = 2;
240         }
241
242         if (tunables->lnd_concurrent_sends == 0) {
243                 if (tunables->lnd_map_on_demand > 0 &&
244                     tunables->lnd_map_on_demand <= IBLND_MAX_RDMA_FRAGS / 8) {
245                         tunables->lnd_concurrent_sends =
246                                                 ni->ni_peertxcredits * 2;
247                 } else {
248                         tunables->lnd_concurrent_sends = ni->ni_peertxcredits;
249                 }
250         }
251
252         if (tunables->lnd_concurrent_sends > ni->ni_peertxcredits * 2)
253                 tunables->lnd_concurrent_sends = ni->ni_peertxcredits * 2;
254
255         if (tunables->lnd_concurrent_sends < ni->ni_peertxcredits / 2)
256                 tunables->lnd_concurrent_sends = ni->ni_peertxcredits / 2;
257
258         if (tunables->lnd_concurrent_sends < ni->ni_peertxcredits) {
259                 CWARN("Concurrent sends %d is lower than message "
260                       "queue size: %d, performance may drop slightly.\n",
261                       tunables->lnd_concurrent_sends, ni->ni_peertxcredits);
262         }
263
264         if (!tunables->lnd_fmr_pool_size)
265                 tunables->lnd_fmr_pool_size = fmr_pool_size;
266         if (!tunables->lnd_fmr_flush_trigger)
267                 tunables->lnd_fmr_flush_trigger = fmr_flush_trigger;
268         if (!tunables->lnd_fmr_cache)
269                 tunables->lnd_fmr_cache = fmr_cache;
270
271         return 0;
272 }
273
274 int
275 kiblnd_tunables_init(void)
276 {
277         default_tunables.lnd_version = 0;
278         default_tunables.lnd_peercredits_hiw = peer_credits_hiw,
279         default_tunables.lnd_map_on_demand = map_on_demand;
280         default_tunables.lnd_concurrent_sends = concurrent_sends;
281         default_tunables.lnd_fmr_pool_size = fmr_pool_size;
282         default_tunables.lnd_fmr_flush_trigger = fmr_flush_trigger;
283         default_tunables.lnd_fmr_cache = fmr_cache;
284         return 0;
285 }