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_ni_healthv
229 * set the health value of the NI. -1 resets the value to maximum.
231 * value: health value to set.
232 * all: true to set all local NIs to that value.
233 * ni_nid: NI NID to set its health value. all parameter always takes
235 * seq_no - sequence number of the request
236 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
239 int lustre_lnet_config_ni_healthv(int value, bool all, char *ni_nid,
240 int seq_no, struct cYAML **err_rc);
243 * lustre_lnet_config_peer_ni_healthv
244 * set the health value of the peer NI. -1 resets the value to maximum.
246 * value: health value to set.
247 * all: true to set all local NIs to that value.
248 * pni_nid: Peer NI NID to set its health value. all parameter always takes
250 * seq_no - sequence number of the request
251 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
254 int lustre_lnet_config_peer_ni_healthv(int value, bool all, char *pni_nid,
255 int seq_no, struct cYAML **err_rc);
258 * lustre_lnet_config_hsensitivity
259 * sets the health sensitivity; the value by which to decrement the
260 * health value of a local or peer NI. If 0 then health is turned off
262 * sen - sensitivity value to configure
263 * seq_no - sequence number of the request
264 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
267 int lustre_lnet_config_hsensitivity(int sen, int seq_no, struct cYAML **err_rc);
270 * lustre_lnet_show_hsensitivity
271 * show the health sensitivity in the system
273 * seq_no - sequence number of the request
274 * show_rc - [OUT] struct cYAML tree containing health sensitivity info
275 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
278 int lustre_lnet_show_hsensitivity(int seq_no, struct cYAML **show_rc,
279 struct cYAML **err_rc);
282 * lustre_lnet_config_transaction_to
283 * sets the timeout after which a message expires or a timeout event is
284 * propagated for an expired response.
286 * timeout - timeout value to configure
287 * seq_no - sequence number of the request
288 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
291 int lustre_lnet_config_transaction_to(int timeout, int seq_no, struct cYAML **err_rc);
294 * lustre_lnet_show_transaction_to
295 * show the transaction timeout in the system
297 * seq_no - sequence number of the request
298 * show_rc - [OUT] struct cYAML tree containing transaction timeout info
299 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
302 int lustre_lnet_show_transaction_to(int seq_no, struct cYAML **show_rc,
303 struct cYAML **err_rc);
306 * lustre_lnet_config_retry_count
307 * sets the maximum number of retries to resend a message
309 * count - maximum value to configure
310 * seq_no - sequence number of the request
311 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
314 int lustre_lnet_config_retry_count(int count, int seq_no, struct cYAML **err_rc);
317 * lustre_lnet_show_retry_count
318 * show current maximum number of retries in the system
320 * seq_no - sequence number of the request
321 * show_rc - [OUT] struct cYAML tree containing retry count info
322 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
325 int lustre_lnet_show_retry_count(int seq_no, struct cYAML **show_rc,
326 struct cYAML **err_rc);
328 int lustre_lnet_show_local_ni_recovq(int seq_no, struct cYAML **show_rc,
329 struct cYAML **err_rc);
331 int lustre_lnet_show_peer_ni_recovq(int seq_no, struct cYAML **show_rc,
332 struct cYAML **err_rc);
335 * lustre_lnet_config_max_intf
336 * Sets the maximum number of interfaces per node. this tunable is
337 * primarily useful for sanity checks prior to allocating memory.
339 * max - maximum value to configure
340 * seq_no - sequence number of the request
341 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
344 int lustre_lnet_config_max_intf(int max, int seq_no, struct cYAML **err_rc);
347 * lustre_lnet_show_max_intf
348 * show current maximum interface setting
350 * seq_no - sequence number of the request
351 * show_rc - [OUT] struct cYAML tree containing NUMA range info
352 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
355 int lustre_lnet_show_max_intf(int seq_no, struct cYAML **show_rc,
356 struct cYAML **err_rc);
359 * lustre_lnet_config_discovery
360 * Enable or disable peer discovery. Peer discovery is enabled by default.
362 * enable - non-0 enables, 0 disables
363 * seq_no - sequence number of the request
364 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
367 int lustre_lnet_config_discovery(int enable, int seq_no, struct cYAML **err_rc);
370 * lustre_lnet_show_discovery
371 * show current peer discovery setting
373 * seq_no - sequence number of the request
374 * show_rc - [OUT] struct cYAML tree containing NUMA range info
375 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
378 int lustre_lnet_show_discovery(int seq_no, struct cYAML **show_rc,
379 struct cYAML **err_rc);
382 * lustre_lnet_config_buffers
383 * Send down an IOCTL to configure routing buffer sizes. A value of 0 means
384 * default that particular buffer to default size. A value of -1 means
385 * leave the value of the buffer un changed.
387 * tiny - tiny buffers
388 * small - small buffers
389 * large - large buffers.
390 * seq_no - sequence number of the request
391 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
393 int lustre_lnet_config_buffers(int tiny, int small, int large,
394 int seq_no, struct cYAML **err_rc);
397 * lustre_lnet_show_routing
398 * Send down an IOCTL to dump buffers and routing status
399 * This function is used to dump buffers for all CPU partitions.
401 * seq_no - sequence number of the request
402 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
403 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
404 * backup - true to output only what's necessary for reconfiguring
407 int lustre_lnet_show_routing(int seq_no, struct cYAML **show_rc,
408 struct cYAML **err_rc, bool backup);
411 * lustre_lnet_show_stats
412 * Shows internal LNET statistics. This is useful to display the
413 * current LNET activity, such as number of messages route, etc
415 * seq_no - sequence number of the command
416 * show_rc - YAML structure of the resultant show
417 * err_rc - YAML strucutre of the resultant return code.
419 int lustre_lnet_show_stats(int seq_no, struct cYAML **show_rc,
420 struct cYAML **err_rc);
423 * lustre_lnet_config_peer_nid
424 * Add a peer nid to a peer with primary nid pnid. If no pnid is given
425 * then the first nid in the nid list becomes the primary nid for
426 * a newly created peer.
427 * Otherwise if pnid is provided and it's unique then a new peer is
428 * created with pnid as the primary NID and the nids in the nid list as
430 * If any of the peers nids provided in with exception to the pnid is
431 * not unique the operation fails. Some peer nids might have already
432 * been added. It's the role of the caller of this API to remove the
433 * added NIDs if they wish.
435 * pnid - Primary NID of the peer
436 * nid - list of nids to add
437 * num_nids - number of nids in the nid array
438 * mr - true if this peer is MR capable.
439 * ip2nets - true if a list of nid expressions are given to configure
441 * seq_no - sequence number of the command
442 * err_rc - YAML strucutre of the resultant return code.
444 int lustre_lnet_config_peer_nid(char *pnid, char **nid, int num_nids,
445 bool mr, bool ip2nets, int seq_no,
446 struct cYAML **err_rc);
449 * lustre_lnet_del_peer_nid
450 * Delete the nids given in the nid list from the peer with primary NID
451 * pnid. If pnid is NULL or it doesn't identify a peer the operation
452 * fails and no change happens to the system.
453 * The operation is aborted on the first NID that fails to be deleted.
455 * pnid - Primary NID of the peer
456 * nid - list of nids to add
457 * num_nids - number of nids in the nid array
458 * ip2nets - used to specify a range of nids
459 * seq_no - sequence number of the command
460 * err_rc - YAML strucutre of the resultant return code.
462 int lustre_lnet_del_peer_nid(char *pnid, char **nid, int num_nids,
463 bool ip2nets, int seq_no, struct cYAML **err_rc);
466 * lustre_lnet_show_peer
467 * Show the peer identified by nid, knid. If knid is NULL all
468 * peers in the system are shown.
470 * knid - A NID of the peer
471 * detail - display detailed information
472 * seq_no - sequence number of the command
473 * show_rc - YAML structure of the resultant show
474 * err_rc - YAML strucutre of the resultant return code.
475 * backup - true to output only what's necessary for reconfiguring
479 int lustre_lnet_show_peer(char *knid, int detail, int seq_no,
480 struct cYAML **show_rc, struct cYAML **err_rc,
484 * lustre_lnet_list_peer
485 * List the known peers.
487 * seq_no - sequence number of the command
488 * show_rc - YAML structure of the resultant show
489 * err_rc - YAML strucutre of the resultant return code.
492 int lustre_lnet_list_peer(int seq_no,
493 struct cYAML **show_rc, struct cYAML **err_rc);
495 /* lustre_lnet_ping_nid
496 * Ping the nid list, pnids.
498 * pnids - NID list to ping.
499 * timeout - timeout(seconds) for ping.
500 * seq_no - sequence number of the command.
501 * show_rc - YAML structure of the resultant show.
502 * err_rc - YAML strucutre of the resultant return code.
505 int lustre_lnet_ping_nid(char *pnid, int timeout, int seq_no,
506 struct cYAML **show_rc, struct cYAML **err_rc);
508 /* lustre_lnet_discover_nid
509 * Discover the nid list, pnids.
511 * pnids - NID list to discover.
512 * force - force discovery.
513 * seq_no - sequence number of the command.
514 * show_rc - YAML structure of the resultant show.
515 * err_rc - YAML strucutre of the resultant return code.
518 int lustre_lnet_discover_nid(char *pnid, int force, int seq_no,
519 struct cYAML **show_rc, struct cYAML **err_rc);
523 * Parses the provided YAML file and then calls the specific APIs
524 * to configure the entities identified in the file
527 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
529 int lustre_yaml_config(char *f, struct cYAML **err_rc);
533 * Parses the provided YAML file and then calls the specific APIs
534 * to delete the entities identified in the file
537 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
539 int lustre_yaml_del(char *f, struct cYAML **err_rc);
543 * Parses the provided YAML file and then calls the specific APIs
544 * to show the entities identified in the file
547 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
548 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
550 int lustre_yaml_show(char *f, struct cYAML **show_rc,
551 struct cYAML **err_rc);
555 * Parses the provided YAML file and then calls the specific APIs
556 * to execute the entities identified in the file
559 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
560 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
562 int lustre_yaml_exec(char *f, struct cYAML **show_rc,
563 struct cYAML **err_rc);
566 * lustre_lnet_init_nw_descr
567 * initialize the network descriptor structure for use
569 void lustre_lnet_init_nw_descr(struct lnet_dlc_network_descr *nw_descr);
572 * lustre_lnet_parse_interfaces
573 * prase an interface string and populate descriptor structures
574 * intf_str - interface string of the format
575 * <intf>[<expr>], <intf>[<expr>],..
576 * nw_descr - network descriptor to populate
577 * init - True to initialize nw_descr
579 int lustre_lnet_parse_interfaces(char *intf_str,
580 struct lnet_dlc_network_descr *nw_descr);
583 * lustre_lnet_parse_nids
584 * Parse a set of nids into a locally allocated array and return the
585 * pointer of the array to the caller. The caller is responsible for
586 * freeing the array. If an initial array is provided then copy over
587 * the contents of that array into the new array and append to it the
589 * The nids can be of the form "nid [,nid, nid, nid]"
590 * nids: nids string to be parsed
591 * array: initial array of content
592 * size: num of elements in the array
593 * out_array: [OUT] new allocated array.
594 * Returns size of array
595 * sets the out_array to NULL on failure.
597 int lustre_lnet_parse_nids(char *nids, char **array, int size,
600 #endif /* LIB_LNET_CONFIG_API_H */