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 Lesser General Public License as
8 * published by the Free Software Foundation; either version 2.1 of the
9 * License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
21 * Copyright (c) 2014, 2017, Intel Corporation.
24 * Amir Shehata <amir.shehata@intel.com>
27 #ifndef LIB_LNET_CONFIG_API_H
28 #define LIB_LNET_CONFIG_API_H
31 #include <libcfs/util/string.h>
32 #include <linux/lnet/lnet-dlc.h>
33 #include <linux/lnet/nidstr.h>
35 #define LUSTRE_CFG_RC_NO_ERR 0
36 #define LUSTRE_CFG_RC_BAD_PARAM -1
37 #define LUSTRE_CFG_RC_MISSING_PARAM -2
38 #define LUSTRE_CFG_RC_OUT_OF_RANGE_PARAM -3
39 #define LUSTRE_CFG_RC_OUT_OF_MEM -4
40 #define LUSTRE_CFG_RC_GENERIC_ERR -5
41 #define LUSTRE_CFG_RC_NO_MATCH -6
42 #define LUSTRE_CFG_RC_MATCH -7
43 #define LUSTRE_CFG_RC_SKIP -8
44 #define LUSTRE_CFG_RC_LAST_ELEM -9
46 struct lnet_dlc_network_descr {
47 struct list_head network_on_rule;
49 struct list_head nw_intflist;
52 struct lnet_dlc_intf_descr {
53 struct list_head intf_on_network;
54 char intf_name[IFNAMSIZ];
55 struct cfs_expr_list *cpt_expr;
58 /* forward declaration of the cYAML structure. */
62 * lustre_lnet_config_lib_init()
63 * Initialize the Library to enable communication with the LNET kernel
64 * module. Returns the device ID or -EINVAL if there is an error
66 int lustre_lnet_config_lib_init();
69 * lustre_lnet_config_lib_uninit
70 * Uninitialize the DLC Library
72 void lustre_lnet_config_lib_uninit();
75 * lustre_lnet_config_ni_system
76 * Initialize/Uninitialize the lnet NI system.
78 * up - whehter to init or uninit the system
79 * load_ni_from_mod - load NI from mod params.
80 * seq_no - sequence number of the request
81 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
84 int lustre_lnet_config_ni_system(bool up, bool load_ni_from_mod,
85 int seq_no, struct cYAML **err_rc);
88 * lustre_lnet_config_route
89 * Send down an IOCTL to the kernel to configure the route
93 * hops - number of hops passed down by the user
94 * prio - priority of the route
95 * seq_no - sequence number of the request
96 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
98 int lustre_lnet_config_route(char *nw, char *gw, int hops, int prio,
99 int seq_no, struct cYAML **err_rc);
102 * lustre_lnet_del_route
103 * Send down an IOCTL to the kernel to delete a route
107 * seq_no - sequence number of the request
108 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
110 int lustre_lnet_del_route(char *nw, char *gw, int seq_no,
111 struct cYAML **err_rc);
114 * lustre_lnet_show_route
115 * Send down an IOCTL to the kernel to show routes
116 * This function will get one route at a time and filter according to
117 * provided parameters. If no routes are available then it will dump all
118 * routes that are in the system.
120 * nw - network. Optional. Used to filter output
121 * gw - gateway. Optional. Used to filter ouptut
122 * hops - number of hops passed down by the user
123 * Optional. Used to filter output.
124 * prio - priority of the route. Optional. Used to filter output.
125 * detail - flag to indicate whether detail output is required
126 * seq_no - sequence number of the request
127 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
128 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
129 * backup - true to output only what's necessary for reconfiguring
132 int lustre_lnet_show_route(char *nw, char *gw,
133 int hops, int prio, int detail,
134 int seq_no, struct cYAML **show_rc,
135 struct cYAML **err_rc, bool backup);
138 * lustre_lnet_config_ni
139 * Send down an IOCTL to configure a network interface. It implicitly
140 * creates a network if one doesn't exist..
142 * nw_descr - network and interface descriptor
143 * global_cpts - globally defined CPTs
144 * ip2net - this parameter allows configuring multiple networks.
145 * it takes precedence over the net and intf parameters
146 * tunables - LND tunables
147 * seq_no - sequence number of the request
148 * lnd_tunables - lnet specific tunable parameters
149 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
151 int lustre_lnet_config_ni(struct lnet_dlc_network_descr *nw_descr,
152 struct cfs_expr_list *global_cpts,
154 struct lnet_ioctl_config_lnd_tunables *tunables,
155 int seq_no, struct cYAML **err_rc);
159 * Send down an IOCTL to delete a network interface. It implicitly
160 * deletes a network if it becomes empty of nis
162 * nw - network and interface list
163 * seq_no - sequence number of the request
164 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
166 int lustre_lnet_del_ni(struct lnet_dlc_network_descr *nw,
167 int seq_no, struct cYAML **err_rc);
170 * lustre_lnet_show_net
171 * Send down an IOCTL to show networks.
172 * This function will use the nw paramter to filter the output. If it's
173 * not provided then all networks are listed.
175 * nw - network to show. Optional. Used to filter output.
176 * detail - flag to indicate if we require detail output.
177 * seq_no - sequence number of the request
178 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
179 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
180 * backup - true to output only what's necessary for reconfiguring
183 int lustre_lnet_show_net(char *nw, int detail, int seq_no,
184 struct cYAML **show_rc, struct cYAML **err_rc,
188 * lustre_lnet_enable_routing
189 * Send down an IOCTL to enable or diable routing
191 * enable - 1 to enable routing, 0 to disable routing
192 * seq_no - sequence number of the request
193 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
195 int lustre_lnet_enable_routing(int enable, int seq_no,
196 struct cYAML **err_rc);
199 * lustre_lnet_config_numa_range
200 * Set the NUMA range which impacts the NIs to be selected
201 * during sending. If the NUMA range is large the NUMA
202 * distance between the message memory and the NI becomes
203 * less significant. The NUMA range is a relative number
204 * with no other meaning besides allowing a wider breadth
205 * for picking an NI to send from.
207 * range - numa range value.
208 * seq_no - sequence number of the request
209 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
212 int lustre_lnet_config_numa_range(int range, int seq_no,
213 struct cYAML **err_rc);
216 * lustre_lnet_show_num_range
217 * Get the currently set NUMA range
219 * seq_no - sequence number of the request
220 * show_rc - [OUT] struct cYAML tree containing NUMA range info
221 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
224 int lustre_lnet_show_numa_range(int seq_no, struct cYAML **show_rc,
225 struct cYAML **err_rc);
228 * lustre_lnet_config_hsensitivity
229 * sets the health sensitivity; the value by which to decrement the
230 * health value of a local or peer NI. If 0 then health is turned off
232 * sen - sensitivity value to configure
233 * seq_no - sequence number of the request
234 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
237 int lustre_lnet_config_hsensitivity(int sen, int seq_no, struct cYAML **err_rc);
240 * lustre_lnet_show_hsensitivity
241 * show the health sensitivity in the system
243 * seq_no - sequence number of the request
244 * show_rc - [OUT] struct cYAML tree containing health sensitivity info
245 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
248 int lustre_lnet_show_hsensitivity(int seq_no, struct cYAML **show_rc,
249 struct cYAML **err_rc);
252 * lustre_lnet_config_transaction_to
253 * sets the timeout after which a message expires or a timeout event is
254 * propagated for an expired response.
256 * timeout - timeout value to configure
257 * seq_no - sequence number of the request
258 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
261 int lustre_lnet_config_transaction_to(int timeout, int seq_no, struct cYAML **err_rc);
264 * lustre_lnet_show_transaction_to
265 * show the transaction timeout in the system
267 * seq_no - sequence number of the request
268 * show_rc - [OUT] struct cYAML tree containing transaction timeout info
269 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
272 int lustre_lnet_show_transaction_to(int seq_no, struct cYAML **show_rc,
273 struct cYAML **err_rc);
276 * lustre_lnet_config_retry_count
277 * sets the maximum number of retries to resend a message
279 * count - maximum value to configure
280 * seq_no - sequence number of the request
281 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
284 int lustre_lnet_config_retry_count(int count, int seq_no, struct cYAML **err_rc);
287 * lustre_lnet_show_retry_count
288 * show current maximum number of retries in the system
290 * seq_no - sequence number of the request
291 * show_rc - [OUT] struct cYAML tree containing retry count info
292 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
295 int lustre_lnet_show_retry_count(int seq_no, struct cYAML **show_rc,
296 struct cYAML **err_rc);
299 * lustre_lnet_config_max_intf
300 * Sets the maximum number of interfaces per node. this tunable is
301 * primarily useful for sanity checks prior to allocating memory.
303 * max - maximum value to configure
304 * seq_no - sequence number of the request
305 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
308 int lustre_lnet_config_max_intf(int max, int seq_no, struct cYAML **err_rc);
311 * lustre_lnet_show_max_intf
312 * show current maximum interface setting
314 * seq_no - sequence number of the request
315 * show_rc - [OUT] struct cYAML tree containing NUMA range info
316 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
319 int lustre_lnet_show_max_intf(int seq_no, struct cYAML **show_rc,
320 struct cYAML **err_rc);
323 * lustre_lnet_config_discovery
324 * Enable or disable peer discovery. Peer discovery is enabled by default.
326 * enable - non-0 enables, 0 disables
327 * seq_no - sequence number of the request
328 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
331 int lustre_lnet_config_discovery(int enable, int seq_no, struct cYAML **err_rc);
334 * lustre_lnet_show_discovery
335 * show current peer discovery setting
337 * seq_no - sequence number of the request
338 * show_rc - [OUT] struct cYAML tree containing NUMA range info
339 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
342 int lustre_lnet_show_discovery(int seq_no, struct cYAML **show_rc,
343 struct cYAML **err_rc);
346 * lustre_lnet_config_buffers
347 * Send down an IOCTL to configure routing buffer sizes. A value of 0 means
348 * default that particular buffer to default size. A value of -1 means
349 * leave the value of the buffer un changed.
351 * tiny - tiny buffers
352 * small - small buffers
353 * large - large buffers.
354 * seq_no - sequence number of the request
355 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
357 int lustre_lnet_config_buffers(int tiny, int small, int large,
358 int seq_no, struct cYAML **err_rc);
361 * lustre_lnet_show_routing
362 * Send down an IOCTL to dump buffers and routing status
363 * This function is used to dump buffers for all CPU partitions.
365 * seq_no - sequence number of the request
366 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
367 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
368 * backup - true to output only what's necessary for reconfiguring
371 int lustre_lnet_show_routing(int seq_no, struct cYAML **show_rc,
372 struct cYAML **err_rc, bool backup);
375 * lustre_lnet_show_stats
376 * Shows internal LNET statistics. This is useful to display the
377 * current LNET activity, such as number of messages route, etc
379 * seq_no - sequence number of the command
380 * show_rc - YAML structure of the resultant show
381 * err_rc - YAML strucutre of the resultant return code.
383 int lustre_lnet_show_stats(int seq_no, struct cYAML **show_rc,
384 struct cYAML **err_rc);
387 * lustre_lnet_config_peer_nid
388 * Add a peer nid to a peer with primary nid pnid. If no pnid is given
389 * then the first nid in the nid list becomes the primary nid for
390 * a newly created peer.
391 * Otherwise if pnid is provided and it's unique then a new peer is
392 * created with pnid as the primary NID and the nids in the nid list as
394 * If any of the peers nids provided in with exception to the pnid is
395 * not unique the operation fails. Some peer nids might have already
396 * been added. It's the role of the caller of this API to remove the
397 * added NIDs if they wish.
399 * pnid - Primary NID of the peer
400 * nid - list of nids to add
401 * num_nids - number of nids in the nid array
402 * mr - true if this peer is MR capable.
403 * ip2nets - true if a list of nid expressions are given to configure
405 * seq_no - sequence number of the command
406 * err_rc - YAML strucutre of the resultant return code.
408 int lustre_lnet_config_peer_nid(char *pnid, char **nid, int num_nids,
409 bool mr, bool ip2nets, int seq_no,
410 struct cYAML **err_rc);
413 * lustre_lnet_del_peer_nid
414 * Delete the nids given in the nid list from the peer with primary NID
415 * pnid. If pnid is NULL or it doesn't identify a peer the operation
416 * fails and no change happens to the system.
417 * The operation is aborted on the first NID that fails to be deleted.
419 * pnid - Primary NID of the peer
420 * nid - list of nids to add
421 * num_nids - number of nids in the nid array
422 * ip2nets - used to specify a range of nids
423 * seq_no - sequence number of the command
424 * err_rc - YAML strucutre of the resultant return code.
426 int lustre_lnet_del_peer_nid(char *pnid, char **nid, int num_nids,
427 bool ip2nets, int seq_no, struct cYAML **err_rc);
430 * lustre_lnet_show_peer
431 * Show the peer identified by nid, knid. If knid is NULL all
432 * peers in the system are shown.
434 * knid - A NID of the peer
435 * detail - display detailed information
436 * seq_no - sequence number of the command
437 * show_rc - YAML structure of the resultant show
438 * err_rc - YAML strucutre of the resultant return code.
439 * backup - true to output only what's necessary for reconfiguring
443 int lustre_lnet_show_peer(char *knid, int detail, int seq_no,
444 struct cYAML **show_rc, struct cYAML **err_rc,
448 * lustre_lnet_list_peer
449 * List the known peers.
451 * seq_no - sequence number of the command
452 * show_rc - YAML structure of the resultant show
453 * err_rc - YAML strucutre of the resultant return code.
456 int lustre_lnet_list_peer(int seq_no,
457 struct cYAML **show_rc, struct cYAML **err_rc);
459 /* lustre_lnet_ping_nid
460 * Ping the nid list, pnids.
462 * pnids - NID list to ping.
463 * timeout - timeout(seconds) for ping.
464 * seq_no - sequence number of the command.
465 * show_rc - YAML structure of the resultant show.
466 * err_rc - YAML strucutre of the resultant return code.
469 int lustre_lnet_ping_nid(char *pnid, int timeout, int seq_no,
470 struct cYAML **show_rc, struct cYAML **err_rc);
472 /* lustre_lnet_discover_nid
473 * Discover the nid list, pnids.
475 * pnids - NID list to discover.
476 * force - force discovery.
477 * seq_no - sequence number of the command.
478 * show_rc - YAML structure of the resultant show.
479 * err_rc - YAML strucutre of the resultant return code.
482 int lustre_lnet_discover_nid(char *pnid, int force, int seq_no,
483 struct cYAML **show_rc, struct cYAML **err_rc);
487 * Parses the provided YAML file and then calls the specific APIs
488 * to configure the entities identified in the file
491 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
493 int lustre_yaml_config(char *f, struct cYAML **err_rc);
497 * Parses the provided YAML file and then calls the specific APIs
498 * to delete the entities identified in the file
501 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
503 int lustre_yaml_del(char *f, struct cYAML **err_rc);
507 * Parses the provided YAML file and then calls the specific APIs
508 * to show the entities identified in the file
511 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
512 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
514 int lustre_yaml_show(char *f, struct cYAML **show_rc,
515 struct cYAML **err_rc);
519 * Parses the provided YAML file and then calls the specific APIs
520 * to execute the entities identified in the file
523 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
524 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
526 int lustre_yaml_exec(char *f, struct cYAML **show_rc,
527 struct cYAML **err_rc);
530 * lustre_lnet_init_nw_descr
531 * initialize the network descriptor structure for use
533 void lustre_lnet_init_nw_descr(struct lnet_dlc_network_descr *nw_descr);
536 * lustre_lnet_parse_interfaces
537 * prase an interface string and populate descriptor structures
538 * intf_str - interface string of the format
539 * <intf>[<expr>], <intf>[<expr>],..
540 * nw_descr - network descriptor to populate
541 * init - True to initialize nw_descr
543 int lustre_lnet_parse_interfaces(char *intf_str,
544 struct lnet_dlc_network_descr *nw_descr);
547 * lustre_lnet_parse_nids
548 * Parse a set of nids into a locally allocated array and return the
549 * pointer of the array to the caller. The caller is responsible for
550 * freeing the array. If an initial array is provided then copy over
551 * the contents of that array into the new array and append to it the
553 * The nids can be of the form "nid [,nid, nid, nid]"
554 * nids: nids string to be parsed
555 * array: initial array of content
556 * size: num of elements in the array
557 * out_array: [OUT] new allocated array.
558 * Returns size of array
559 * sets the out_array to NULL on failure.
561 int lustre_lnet_parse_nids(char *nids, char **array, int size,
564 #endif /* LIB_LNET_CONFIG_API_H */