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
33 #include <sys/socket.h>
35 #include <netlink/netlink.h>
36 #include <netlink/genl/genl.h>
37 #include <netlink/genl/ctrl.h>
39 #include <libcfs/util/ioctl.h>
40 #include <libcfs/util/string.h>
41 #include <linux/lnet/lnet-dlc.h>
42 #include <linux/lnet/nidstr.h>
44 #define LUSTRE_CFG_RC_NO_ERR 0
45 #define LUSTRE_CFG_RC_BAD_PARAM -1
46 #define LUSTRE_CFG_RC_MISSING_PARAM -2
47 #define LUSTRE_CFG_RC_OUT_OF_RANGE_PARAM -3
48 #define LUSTRE_CFG_RC_OUT_OF_MEM -4
49 #define LUSTRE_CFG_RC_GENERIC_ERR -5
50 #define LUSTRE_CFG_RC_NO_MATCH -6
51 #define LUSTRE_CFG_RC_MATCH -7
52 #define LUSTRE_CFG_RC_SKIP -8
53 #define LUSTRE_CFG_RC_LAST_ELEM -9
54 #define LUSTRE_CFG_RC_MARSHAL_FAIL -10
56 #define CONFIG_CMD "configure"
57 #define UNCONFIG_CMD "unconfigure"
60 #define SHOW_CMD "show"
62 #define MANAGE_CMD "manage"
64 #define MAX_NUM_IPS 128
66 #define modparam_path "/sys/module/lnet/parameters/"
67 #define o2ib_modparam_path "/sys/module/ko2iblnd/parameters/"
68 #define gni_nid_path "/proc/cray_xt/"
71 LNETCTL_CONFIG_CMD = 1,
72 LNETCTL_UNCONFIG_CMD = 2,
77 LNETCTL_MANAGE_CMD = 7,
82 * Max number of nids we'll configure for a single peer via a single DLC
85 #define LNET_MAX_NIDS_PER_PEER 128
87 struct lnet_dlc_network_descr {
88 struct list_head network_on_rule;
90 struct list_head nw_intflist;
93 struct lnet_dlc_intf_descr {
94 struct list_head intf_on_network;
95 char intf_name[IFNAMSIZ];
96 struct cfs_expr_list *cpt_expr;
99 /* This UDSP structures need to match the kernel space structures
100 * in order for the marshall and unmarshall functions to be the same.
103 /* Net is described as a
107 struct lnet_ud_net_descr {
109 struct list_head udn_net_num_range;
112 /* each NID range is defined as
114 * 2. address range descriptor
116 struct lnet_ud_nid_descr {
117 struct lnet_ud_net_descr ud_net_id;
118 struct list_head ud_addr_range;
121 /* a UDSP rule can have up to three user defined NID descriptors
122 * - src: defines the local NID range for the rule
123 * - dst: defines the peer NID range for the rule
124 * - rte: defines the router NID range for the rule
126 * An action union defines the action to take when the rule
130 struct list_head udsp_on_list;
132 struct lnet_ud_nid_descr udsp_src;
133 struct lnet_ud_nid_descr udsp_dst;
134 struct lnet_ud_nid_descr udsp_rte;
135 enum lnet_udsp_action_type udsp_action_type;
141 /* This union is passed from lnetctl to fill the action union in udsp
143 * TODO: The idea here is if we add extra actions, ex: drop, it can be
146 union lnet_udsp_action {
150 /* forward declaration of the cYAML structure. */
154 * lustre_lnet_config_lib_init()
155 * Initialize the Library to enable communication with the LNET kernel
156 * module. Returns the device ID or -EINVAL if there is an error
158 int lustre_lnet_config_lib_init();
161 * lustre_lnet_config_lib_uninit
162 * Uninitialize the DLC Library
164 void lustre_lnet_config_lib_uninit();
167 * lustre_lnet_config_ni_system
168 * Initialize/Uninitialize the lnet NI system.
170 * up - whehter to init or uninit the system
171 * load_ni_from_mod - load NI from mod params.
172 * seq_no - sequence number of the request
173 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
176 int lustre_lnet_config_ni_system(bool up, bool load_ni_from_mod,
177 int seq_no, struct cYAML **err_rc);
180 * lustre_lnet_config_route
181 * Send down an IOCTL to the kernel to configure the route
185 * hops - number of hops passed down by the user
186 * prio - priority of the route
187 * sen - health sensitivity value for the gateway
188 * seq_no - sequence number of the request
189 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
191 int lustre_lnet_config_route(char *nw, char *gw, int hops, int prio,
192 int sen, int seq_no, struct cYAML **err_rc);
195 * lustre_lnet_del_route
196 * Send down an IOCTL to the kernel to delete a route
200 * seq_no - sequence number of the request
201 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
203 int lustre_lnet_del_route(char *nw, char *gw, int seq_no,
204 struct cYAML **err_rc);
207 * lustre_lnet_show_route
208 * Send down an IOCTL to the kernel to show routes
209 * This function will get one route at a time and filter according to
210 * provided parameters. If no routes are available then it will dump all
211 * routes that are in the system.
213 * nw - network. Optional. Used to filter output
214 * gw - gateway. Optional. Used to filter ouptut
215 * hops - number of hops passed down by the user
216 * Optional. Used to filter output.
217 * prio - priority of the route. Optional. Used to filter output.
218 * detail - flag to indicate whether detail output is required
219 * seq_no - sequence number of the request
220 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
221 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
222 * backup - true to output only what's necessary for reconfiguring
225 int lustre_lnet_show_route(char *nw, char *gw,
226 int hops, int prio, int detail,
227 int seq_no, struct cYAML **show_rc,
228 struct cYAML **err_rc, bool backup);
231 * lustre_lnet_config_ni
232 * Send down an IOCTL to configure a network interface. It implicitly
233 * creates a network if one doesn't exist..
235 * nw_descr - network and interface descriptor
236 * global_cpts - globally defined CPTs
237 * ip2net - this parameter allows configuring multiple networks.
238 * it takes precedence over the net and intf parameters
239 * tunables - LND tunables
240 * seq_no - sequence number of the request
241 * lnd_tunables - lnet specific tunable parameters
242 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
244 int lustre_lnet_config_ni(struct lnet_dlc_network_descr *nw_descr,
245 struct cfs_expr_list *global_cpts,
247 struct lnet_ioctl_config_lnd_tunables *tunables,
248 long int cpp, int seq_no, struct cYAML **err_rc);
252 * Send down an IOCTL to delete a network interface. It implicitly
253 * deletes a network if it becomes empty of nis
255 * nw - network and interface list
256 * seq_no - sequence number of the request
257 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
259 int lustre_lnet_del_ni(struct lnet_dlc_network_descr *nw,
260 int seq_no, struct cYAML **err_rc);
263 * lustre_lnet_show_net
264 * Send down an IOCTL to show networks.
265 * This function will use the nw paramter to filter the output. If it's
266 * not provided then all networks are listed.
268 * nw - network to show. Optional. Used to filter output.
269 * detail - flag to indicate if we require detail output.
270 * seq_no - sequence number of the request
271 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
272 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
273 * backup - true to output only what's necessary for reconfiguring
276 int lustre_lnet_show_net(char *nw, int detail, int seq_no,
277 struct cYAML **show_rc, struct cYAML **err_rc,
281 * lustre_lnet_enable_routing
282 * Send down an IOCTL to enable or diable routing
284 * enable - 1 to enable routing, 0 to disable routing
285 * seq_no - sequence number of the request
286 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
288 int lustre_lnet_enable_routing(int enable, int seq_no,
289 struct cYAML **err_rc);
292 * lustre_lnet_config_numa_range
293 * Set the NUMA range which impacts the NIs to be selected
294 * during sending. If the NUMA range is large the NUMA
295 * distance between the message memory and the NI becomes
296 * less significant. The NUMA range is a relative number
297 * with no other meaning besides allowing a wider breadth
298 * for picking an NI to send from.
300 * range - numa range value.
301 * seq_no - sequence number of the request
302 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
305 int lustre_lnet_config_numa_range(int range, int seq_no,
306 struct cYAML **err_rc);
309 * lustre_lnet_show_num_range
310 * Get the currently set NUMA range
312 * seq_no - sequence number of the request
313 * show_rc - [OUT] struct cYAML tree containing NUMA range info
314 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
317 int lustre_lnet_show_numa_range(int seq_no, struct cYAML **show_rc,
318 struct cYAML **err_rc);
321 * lustre_lnet_config_ni_healthv
322 * set the health value of the NI. -1 resets the value to maximum.
324 * value: health value to set.
325 * all: true to set all local NIs to that value.
326 * ni_nid: NI NID to set its health value. all parameter always takes
328 * seq_no - sequence number of the request
329 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
332 int lustre_lnet_config_ni_healthv(int value, bool all, char *ni_nid,
333 int seq_no, struct cYAML **err_rc);
336 /* lustre_lnet_config_ni_conns_per_peer
337 * set the conns_per_peer value of the NI. Valid range is specific to
340 * value: conns_per_peer value to set.
341 * all: true to set all local NIs to that value.
342 * ni_nid: NI NID to set its conns_per_peer value. 'all' parameter always
344 * seq_no - sequence number of the request
345 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
348 int lustre_lnet_config_ni_conns_per_peer(int value, bool all, char *ni_nid,
349 int seq_no, struct cYAML **err_rc);
352 * lustre_lnet_config_peer_ni_healthv
353 * set the health value of the peer NI. -1 resets the value to maximum.
355 * value: health value to set.
356 * all: true to set all local NIs to that value.
357 * pni_nid: Peer NI NID to set its health value. all parameter always takes
359 * seq_no - sequence number of the request
360 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
363 int lustre_lnet_config_peer_ni_healthv(int value, bool all, char *pni_nid,
364 int seq_no, struct cYAML **err_rc);
367 * lustre_lnet_config_recov_intrv
368 * set the recovery interval in seconds. That's the interval to ping an
369 * unhealthy interface.
371 * intrv - recovery interval value to configure
372 * seq_no - sequence number of the request
373 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
376 int lustre_lnet_config_recov_intrv(int intrv, int seq_no, struct cYAML **err_rc);
379 * lustre_lnet_show_recov_intrv
380 * show the recovery interval set in the system
382 * seq_no - sequence number of the request
383 * show_rc - [OUT] struct cYAML tree containing health sensitivity info
384 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
387 int lustre_lnet_show_recov_intrv(int seq_no, struct cYAML **show_rc,
388 struct cYAML **err_rc);
391 * lustre_lnet_config_rtr_sensitivity
392 * sets the router sensitivity percentage. If the percentage health
393 * of a router interface drops below that it's considered failed
395 * sen - sensitivity value to configure
396 * seq_no - sequence number of the request
397 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
400 int lustre_lnet_config_rtr_sensitivity(int sen, int seq_no, struct cYAML **err_rc);
403 * lustre_lnet_config_hsensitivity
404 * sets the health sensitivity; the value by which to decrement the
405 * health value of a local or peer NI. If 0 then health is turned off
407 * sen - sensitivity value to configure
408 * seq_no - sequence number of the request
409 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
412 int lustre_lnet_config_hsensitivity(int sen, int seq_no, struct cYAML **err_rc);
415 * lustre_lnet_show_hsensitivity
416 * show the health sensitivity in the system
418 * seq_no - sequence number of the request
419 * show_rc - [OUT] struct cYAML tree containing health sensitivity info
420 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
423 int lustre_lnet_show_hsensitivity(int seq_no, struct cYAML **show_rc,
424 struct cYAML **err_rc);
427 * lustre_lnet_show_rtr_sensitivity
428 * show the router sensitivity percentage in the system
430 * seq_no - sequence number of the request
431 * show_rc - [OUT] struct cYAML tree containing health sensitivity info
432 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
435 int lustre_lnet_show_rtr_sensitivity(int seq_no, struct cYAML **show_rc,
436 struct cYAML **err_rc);
439 * lustre_lnet_config_transaction_to
440 * sets the timeout after which a message expires or a timeout event is
441 * propagated for an expired response.
443 * timeout - timeout value to configure
444 * seq_no - sequence number of the request
445 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
448 int lustre_lnet_config_transaction_to(int timeout, int seq_no, struct cYAML **err_rc);
451 * lustre_lnet_show_transaction_to
452 * show the transaction timeout in the system
454 * seq_no - sequence number of the request
455 * show_rc - [OUT] struct cYAML tree containing transaction timeout info
456 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
459 int lustre_lnet_show_transaction_to(int seq_no, struct cYAML **show_rc,
460 struct cYAML **err_rc);
463 * lustre_lnet_config_retry_count
464 * sets the maximum number of retries to resend a message
466 * count - maximum value to configure
467 * seq_no - sequence number of the request
468 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
471 int lustre_lnet_config_retry_count(int count, int seq_no, struct cYAML **err_rc);
474 * lustre_lnet_show_retry_count
475 * show current maximum number of retries in the system
477 * seq_no - sequence number of the request
478 * show_rc - [OUT] struct cYAML tree containing retry count info
479 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
482 int lustre_lnet_show_retry_count(int seq_no, struct cYAML **show_rc,
483 struct cYAML **err_rc);
485 int lustre_lnet_show_lnd_timeout(int seq_no, struct cYAML **show_rc,
486 struct cYAML **err_rc);
488 int lustre_lnet_show_local_ni_recovq(int seq_no, struct cYAML **show_rc,
489 struct cYAML **err_rc);
491 int lustre_lnet_show_peer_ni_recovq(int seq_no, struct cYAML **show_rc,
492 struct cYAML **err_rc);
493 int lustre_lnet_config_response_tracking(int count, int seq_no,
494 struct cYAML **err_rc);
495 int lustre_lnet_show_response_tracking(int seq_no, struct cYAML **show_rc,
496 struct cYAML **err_rc);
497 int lustre_lnet_config_recovery_limit(int val, int seq_no,
498 struct cYAML **err_rc);
499 int lustre_lnet_show_recovery_limit(int seq_no, struct cYAML **show_rc,
500 struct cYAML **err_rc);
503 * lustre_lnet_config_max_intf
504 * Sets the maximum number of interfaces per node. this tunable is
505 * primarily useful for sanity checks prior to allocating memory.
507 * max - maximum value to configure
508 * seq_no - sequence number of the request
509 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
512 int lustre_lnet_config_max_intf(int max, int seq_no, struct cYAML **err_rc);
515 * lustre_lnet_show_max_intf
516 * show current maximum interface setting
518 * seq_no - sequence number of the request
519 * show_rc - [OUT] struct cYAML tree containing NUMA range info
520 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
523 int lustre_lnet_show_max_intf(int seq_no, struct cYAML **show_rc,
524 struct cYAML **err_rc);
527 * lustre_lnet_calc_service_id
528 * Calculate the lustre service id to be used for qos
530 int lustre_lnet_calc_service_id(__u64 *service_id);
533 * lustre_lnet_setup_mrrouting
534 * configure linux routing tables for tcp interfaces
536 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
539 int lustre_lnet_setup_mrrouting(struct cYAML **err_rc);
542 * lustre_lnet_config_discovery
543 * Enable or disable peer discovery. Peer discovery is enabled by default.
545 * enable - non-0 enables, 0 disables
546 * seq_no - sequence number of the request
547 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
550 int lustre_lnet_config_discovery(int enable, int seq_no, struct cYAML **err_rc);
553 * lustre_lnet_show_discovery
554 * show current peer discovery setting
556 * seq_no - sequence number of the request
557 * show_rc - [OUT] struct cYAML tree containing NUMA range info
558 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
561 int lustre_lnet_show_discovery(int seq_no, struct cYAML **show_rc,
562 struct cYAML **err_rc);
565 * lustre_lnet_config_drop_asym_route
566 * Drop or accept asymmetrical route messages. Accept by default.
568 * drop - non-0 drops, 0 accepts
569 * seq_no - sequence number of the request
570 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
573 int lustre_lnet_config_drop_asym_route(int drop, int seq_no,
574 struct cYAML **err_rc);
577 * lustre_lnet_show_drop_asym_route
578 * show current drop asym route setting
580 * seq_no - sequence number of the request
581 * show_rc - [OUT] struct cYAML tree containing NUMA range info
582 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
585 int lustre_lnet_show_drop_asym_route(int seq_no, struct cYAML **show_rc,
586 struct cYAML **err_rc);
589 * lustre_lnet_config_buffers
590 * Send down an IOCTL to configure routing buffer sizes. A value of 0 means
591 * default that particular buffer to default size. A value of -1 means
592 * leave the value of the buffer un changed.
594 * tiny - tiny buffers
595 * small - small buffers
596 * large - large buffers.
597 * seq_no - sequence number of the request
598 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
600 int lustre_lnet_config_buffers(int tiny, int small, int large,
601 int seq_no, struct cYAML **err_rc);
604 * lustre_lnet_show_routing
605 * Send down an IOCTL to dump buffers and routing status
606 * This function is used to dump buffers for all CPU partitions.
608 * seq_no - sequence number of the request
609 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
610 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
611 * backup - true to output only what's necessary for reconfiguring
614 int lustre_lnet_show_routing(int seq_no, struct cYAML **show_rc,
615 struct cYAML **err_rc, bool backup);
618 * lustre_lnet_show_stats
619 * Shows internal LNET statistics. This is useful to display the
620 * current LNET activity, such as number of messages route, etc
622 * seq_no - sequence number of the command
623 * show_rc - YAML structure of the resultant show
624 * err_rc - YAML strucutre of the resultant return code.
626 int lustre_lnet_show_stats(int seq_no, struct cYAML **show_rc,
627 struct cYAML **err_rc);
630 * lustre_lnet_reset_stats
631 * Resets internal LNET statistics.
633 * err_rc - YAML strucutre of the resultant return code.
635 int lustre_lnet_reset_stats(int seq_no, struct cYAML **err_rc);
638 * lustre_lnet_modify_peer
639 * Handle a peer config or delete operation.
642 * Add a peer NID to a peer with primary NID pnid.
643 * If the provided primary NID is unique, then a new peer is
644 * created with this primary NID, and the NIDs in the NID list are added as
645 * secondary NIDs to this new peer.
646 * If any of the NIDs in the NID list are not unique then the operation
647 * fails. Some peer NIDs might have already been added. It's the responsibility
648 * of the caller of this API to remove the added NIDs if so desired.
651 * Delete the NIDs given in the NID list from the peer with the primary NID
652 * pnid. If pnid is NULL, or it doesn't identify a peer, the operation fails,
653 * and no change happens to the system.
654 * The operation is aborted on the first NID that fails to be deleted.
656 * prim_nid - The desired primary NID of a new peer, or the primary NID of
658 * nids - a comma separated string of nids
659 * is_mr - Specifies whether this peer is MR capable.
660 * cmd - CONFIG or DELETE
661 * seq_no - sequence number of the command
662 * err_rc - YAML structure of the resultant return code
664 int lustre_lnet_modify_peer(char *prim_nid, char *nids, bool is_mr,
665 int cmd, int seq_no, struct cYAML **err_rc);
668 * lustre_lnet_show_peer
669 * Show the peer identified by nid, knid. If knid is NULL all
670 * peers in the system are shown.
672 * knid - A NID of the peer
673 * detail - display detailed information
674 * seq_no - sequence number of the command
675 * show_rc - YAML structure of the resultant show
676 * err_rc - YAML strucutre of the resultant return code.
677 * backup - true to output only what's necessary for reconfiguring
681 int lustre_lnet_show_peer(char *knid, int detail, int seq_no,
682 struct cYAML **show_rc, struct cYAML **err_rc,
686 * lustre_lnet_list_peer
687 * List the known peers.
689 * seq_no - sequence number of the command
690 * show_rc - YAML structure of the resultant show
691 * err_rc - YAML strucutre of the resultant return code.
694 int lustre_lnet_list_peer(int seq_no,
695 struct cYAML **show_rc, struct cYAML **err_rc);
697 /* lustre_lnet_ping_nid
698 * Ping the nid list, pnids.
700 * pnids - NID list to ping.
701 * src_nidstr - source NID
702 * timeout - timeout(seconds) for ping.
703 * seq_no - sequence number of the command.
704 * show_rc - YAML structure of the resultant show.
705 * err_rc - YAML strucutre of the resultant return code.
708 int lustre_lnet_ping_nid(char *pnid, char *src_nidstr, int timeout, int seq_no,
709 struct cYAML **show_rc, struct cYAML **err_rc);
711 /* lustre_lnet_discover_nid
712 * Discover the nid list, pnids.
714 * pnids - NID list to discover.
715 * force - force discovery.
716 * seq_no - sequence number of the command.
717 * show_rc - YAML structure of the resultant show.
718 * err_rc - YAML strucutre of the resultant return code.
721 int lustre_lnet_discover_nid(char *pnid, int force, int seq_no,
722 struct cYAML **show_rc, struct cYAML **err_rc);
726 * Parses the provided YAML file and then calls the specific APIs
727 * to configure the entities identified in the file
730 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
732 int lustre_yaml_config(char *f, struct cYAML **err_rc);
736 * Parses the provided YAML file and then calls the specific APIs
737 * to delete the entities identified in the file
740 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
742 int lustre_yaml_del(char *f, struct cYAML **err_rc);
746 * Parses the provided YAML file and then calls the specific APIs
747 * to show the entities identified in the file
750 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
751 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
753 int lustre_yaml_show(char *f, struct cYAML **show_rc,
754 struct cYAML **err_rc);
758 * Parses the provided YAML file and then calls the specific APIs
759 * to execute the entities identified in the file
762 * show_rc - [OUT] The show output in YAML. Must be freed by caller.
763 * err_rc - [OUT] struct cYAML tree describing the error. Freed by caller
765 int lustre_yaml_exec(char *f, struct cYAML **show_rc,
766 struct cYAML **err_rc);
769 * yaml_emitter_set_output_netlink
771 * Special handling to integrate LNet handling into libyaml.
772 * This function sets up the ability to take the data stored in @emitter
773 * and formats into a netlink packet to send to the kernel.
775 * emitter - YAML emitter containing what the user specified
776 * nl - Netlink socket to be used by libyaml
777 * family - Netlink family
778 * version - notify kernel what version user land supports
779 * cmd - Netlink command to execute
780 * flags - Netlink flags
782 int yaml_emitter_set_output_netlink(yaml_emitter_t *emitter, struct nl_sock *nl,
783 char *family, int version, int cmd,
787 * yaml_parser_set_input_netlink
789 * Special handling to LNet handling into libyaml.
790 * This function sets up the ability to receive the Netlink data
791 * from the Linux kernel. That data is formated into a YAML document.
793 * parser - YAML parser that is used to present the data received
794 * from the kernel in Netlink format.
795 * nl - should be the Netlink socket receiving data from
797 * stream - Handle the case of continuous data coming in.
799 int yaml_parser_set_input_netlink(yaml_parser_t *parser, struct nl_sock *nl,
803 * yaml_parser_get_reader_error
805 * By default libyaml reports a generic write error. We need a way
806 * to report better parser errors so we can track down problems.
808 * parser - YAML parser that has reported an error.
810 const char *yaml_parser_get_reader_error(yaml_parser_t *parser);
813 * yaml_parser_log_error
815 * Helper function to report the parser error to @log.
817 * parser - YAML parser that has reported an error.
818 * log - file descriptor to write the error message out to.
819 * errmsg - Special extra string to append to error message.
821 void yaml_parser_log_error(yaml_parser_t *parser, FILE *log,
825 * yaml_emitter_log_error
827 * Helper function to report the emitter error to @log.
829 * emitter - YAML emitter that has reported an error.
830 * log - file descriptor to write the error message out to.
832 void yaml_emitter_log_error(yaml_emitter_t *emitter, FILE *log);
836 * lustre_lnet_init_nw_descr
837 * initialize the network descriptor structure for use
839 void lustre_lnet_init_nw_descr(struct lnet_dlc_network_descr *nw_descr);
842 * lustre_lnet_parse_interfaces
843 * prase an interface string and populate descriptor structures
844 * intf_str - interface string of the format
845 * <intf>[<expr>], <intf>[<expr>],..
846 * nw_descr - network descriptor to populate
847 * init - True to initialize nw_descr
849 int lustre_lnet_parse_interfaces(char *intf_str,
850 struct lnet_dlc_network_descr *nw_descr);
853 * lustre_lnet_parse_nidstr
854 * This is a small wrapper around cfs_parse_nidlist.
855 * nidstr - A string parseable by cfs_parse_nidlist
856 * lnet_nidlist - An array of lnet_nid_t to hold the nids specified
858 * max_nids - Size of the lnet_nidlist array, and the maximum number of
859 * nids that can be expressed by the nidstring. If the
860 * nidstring expands to a larger number of nids than max_nids
861 * then an error is returned.
862 * err_str - char pointer where we store an informative error
863 * message when an error is encountered
865 * The number (> 0) of lnet_nid_t stored in the supplied array, or
866 * LUSTRE_CFG_RC_BAD_PARAM if:
868 * - nidstr contains an asterisk. This character is not allowed
869 * because it would cause the size of the expanded nidlist to exceed
870 * the maximum number of nids that is supported by expected callers
872 * - cfs_parse_nidlist fails to parse the nidstring
873 * - The nidlist populated by cfs_parse_nidlist is empty
874 * - The nidstring expands to a larger number of nids than max_nids
875 * - The nidstring expands to zero nids
876 * LUSTRE_CFG_RC_OUT_OF_MEM if:
877 * - cfs_expand_nidlist can return ENOMEM. We return out of mem in
880 int lustre_lnet_parse_nidstr(char *nidstr, lnet_nid_t *lnet_nidlist,
881 int max_nids, char *err_str);
883 /* lustre_lnet_add_udsp
884 * Add a selection policy.
885 * src - source NID descriptor
886 * dst - destination NID descriptor
887 * rte - router NID descriptor
889 * action - union of the action
890 * idx - the index to delete
891 * seq_no - sequence number of the request
892 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
895 int lustre_lnet_add_udsp(char *src, char *dst, char *rte, char *type,
896 union lnet_udsp_action *action, int idx,
897 int seq_no, struct cYAML **err_rc);
899 /* lustre_lnet_del_udsp
900 * Delete a net selection policy.
901 * idx - the index to delete
902 * seq_no - sequence number of the request
903 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
906 int lustre_lnet_del_udsp(unsigned int idx, int seq_no, struct cYAML **err_rc);
908 /* lustre_lnet_show_udsp
909 * show selection policy.
910 * idx - the index to show. -1 to show all policies
911 * seq_no - sequence number of the request
912 * err_rc - [IN/OUT] struct cYAML tree containing udsp info
913 * err_rc - [OUT] struct cYAML tree describing the error. Freed by
916 int lustre_lnet_show_udsp(int idx, int seq_no, struct cYAML **show_rc,
917 struct cYAML **err_rc);
919 #endif /* LIB_LNET_CONFIG_API_H */