1 // SPDX-License-Identifier: LGPL-2.0
3 /* Copyright (c) 2014, 2017, Intel Corporation. */
5 /* Author: Amir Shehata <amir.shehata@intel.com> */
7 #ifndef __UAPI_LNET_DLC_H_
8 #define __UAPI_LNET_DLC_H_
10 #include <linux/types.h>
11 #include <linux/lnet/libcfs_ioctl.h>
12 #include <linux/lnet/lnet-types.h>
14 #define MAX_NUM_SHOW_ENTRIES 32
15 #define LNET_MAX_STR_LEN 128
16 #define LNET_MAX_SHOW_NUM_CPT 128
17 #define LNET_MAX_SHOW_NUM_NID 128
18 #define LNET_UNDEFINED_HOPS ((__u32) -1)
20 #define LNET_RT_ALIVE (1 << 0)
21 #define LNET_RT_MULTI_HOP (1 << 1)
24 * sparse kernel source annotations
30 #define LNET_GENL_NAME "lnet"
31 #define LNET_GENL_VERSION 0x05
33 /* enum lnet_commands - Supported core LNet Netlink commands
35 * @LNET_CMD_UNSPEC: unspecified command to catch errors
37 * @LNET_CMD_CONFIGURE: command to setup LNet stack
38 * @LNET_CMD_NETS: command to manage the LNet networks
39 * @LNET_CMD_ROUTES: command to manage LNet routes
40 * @LNET_CMD_PING: command to send pings to LNet connections
41 * @LNET_CMD_CPT_OF_NID: command to calculate the CPT of specified NIDs
46 LNET_CMD_CONFIGURE = 1,
52 LNET_CMD_CPT_OF_NID = 7,
53 LNET_CMD_PEER_DIST = 8,
55 __LNET_CMD_MAX_PLUS_ONE
58 #define LNET_CMD_MAX (__LNET_CMD_MAX_PLUS_ONE - 1)
61 * To allow for future enhancements to extend the tunables
62 * add a hdr to this structure, so that the version can be set
63 * and checked for backwards compatibility. Newer versions of LNet
64 * can still work with older versions of lnetctl. The restriction is
65 * that the structure can be added to and not removed from in order
66 * to not invalidate older lnetctl utilities. Moreover, the order of
67 * fields must remain the same, and new fields appended to the structure
69 * That said all existing LND tunables will be added in this structure
70 * to avoid future changes.
72 struct lnet_ioctl_config_lnd_cmn_tunables {
74 __s32 lct_peer_timeout;
75 __s32 lct_peer_tx_credits;
76 __s32 lct_peer_rtr_credits;
77 __s32 lct_max_tx_credits;
80 struct lnet_ioctl_config_o2iblnd_tunables {
82 __u32 lnd_peercredits_hiw;
83 __u32 lnd_map_on_demand;
84 __u32 lnd_concurrent_sends;
85 __u32 lnd_fmr_pool_size;
86 __u32 lnd_fmr_flush_trigger;
88 __u16 lnd_conns_per_peer;
94 struct lnet_ioctl_config_kfilnd_tunables {
96 __u32 lnd_prov_major_version;
97 __u32 lnd_prov_minor_version;
99 char lnd_traffic_class_str[LNET_MAX_STR_LEN];
100 __u32 lnd_traffic_class;
103 struct lnet_ioctl_config_socklnd_tunables {
105 __u16 lnd_conns_per_peer;
111 struct lnet_ioctl_config_gnilnd_tunables {
116 struct lnet_lnd_tunables {
118 struct lnet_ioctl_config_o2iblnd_tunables lnd_o2ib;
119 struct lnet_ioctl_config_socklnd_tunables lnd_sock;
120 struct lnet_ioctl_config_kfilnd_tunables lnd_kfi;
121 struct lnet_ioctl_config_gnilnd_tunables lnd_gni;
125 struct lnet_ioctl_config_lnd_tunables {
126 struct lnet_ioctl_config_lnd_cmn_tunables lt_cmn;
127 struct lnet_lnd_tunables lt_tun;
130 struct lnet_ioctl_net_config {
131 char ni_interface[LNET_MAX_STR_LEN];
133 __u32 ni_cpts[LNET_MAX_SHOW_NUM_CPT];
137 #define LNET_TINY_BUF_IDX 0
138 #define LNET_SMALL_BUF_IDX 1
139 #define LNET_LARGE_BUF_IDX 2
141 /* # different router buffer pools */
142 #define LNET_NRBPOOLS (LNET_LARGE_BUF_IDX + 1)
144 struct lnet_ioctl_pool_cfg {
150 } pl_pools[LNET_NRBPOOLS];
154 struct lnet_ioctl_ping_data {
155 struct libcfs_ioctl_hdr ping_hdr;
161 struct lnet_process_id ping_id;
162 struct lnet_process_id __user *ping_buf;
166 struct lnet_ioctl_config_data {
167 struct libcfs_ioctl_hdr cfg_hdr;
179 __u32 rtr_sensitivity;
182 char net_intf[LNET_MAX_STR_LEN];
183 __s32 net_peer_timeout;
184 __s32 net_peer_tx_credits;
185 __s32 net_peer_rtr_credits;
186 __s32 net_max_tx_credits;
187 __u32 net_cksum_algo;
188 __u32 net_interface_count;
201 struct lnet_ioctl_comm_count {
204 __u32 ico_reply_count;
206 __u32 ico_hello_count;
209 struct lnet_ioctl_element_stats {
210 __u32 iel_send_count;
211 __u32 iel_recv_count;
212 __u32 iel_drop_count;
215 enum lnet_health_type {
216 LNET_HEALTH_TYPE_LOCAL_NI = 0,
217 LNET_HEALTH_TYPE_PEER_NI,
220 struct lnet_ioctl_local_ni_hstats {
221 struct libcfs_ioctl_hdr hlni_hdr;
223 __u32 hlni_local_interrupt;
224 __u32 hlni_local_dropped;
225 __u32 hlni_local_aborted;
226 __u32 hlni_local_no_route;
227 __u32 hlni_local_timeout;
228 __u32 hlni_local_error;
229 __s32 hlni_fatal_error;
230 __s32 hlni_health_value;
231 __u32 hlni_ping_count;
232 __u64 hlni_next_ping;
235 struct lnet_ioctl_peer_ni_hstats {
236 __u32 hlpni_remote_dropped;
237 __u32 hlpni_remote_timeout;
238 __u32 hlpni_remote_error;
239 __u32 hlpni_network_timeout;
240 __s32 hlpni_health_value;
241 __u32 hlpni_ping_count;
242 __u64 hlpni_next_ping;
245 struct lnet_ioctl_element_msg_stats {
246 struct libcfs_ioctl_hdr im_hdr;
248 struct lnet_ioctl_comm_count im_send_stats;
249 struct lnet_ioctl_comm_count im_recv_stats;
250 struct lnet_ioctl_comm_count im_drop_stats;
254 * lnet_ioctl_config_ni
255 * This structure describes an NI configuration. There are multiple components
256 * when configuring an NI: Net, Interfaces, CPT list and LND tunables
257 * A network is passed as a string to the DLC and translated using
259 * An interface is the name of the system configured interface
261 * CPT is the list of CPTS LND tunables are passed in the lic_bulk area
263 struct lnet_ioctl_config_ni {
264 struct libcfs_ioctl_hdr lic_cfg_hdr;
266 char lic_ni_intf[LNET_MAX_STR_LEN];
267 char lic_legacy_ip2nets[LNET_MAX_STR_LEN];
268 __u32 lic_cpts[LNET_MAX_SHOW_NUM_CPT];
277 struct lnet_peer_ni_credit_info {
278 char cr_aliveness[LNET_MAX_STR_LEN];
280 __s32 cr_ni_peer_tx_credits;
281 __s32 cr_peer_tx_credits;
282 __s32 cr_peer_min_tx_credits;
283 __u32 cr_peer_tx_qnob;
284 __s32 cr_peer_rtr_credits;
285 __s32 cr_peer_min_rtr_credits;
289 struct lnet_ioctl_peer {
290 struct libcfs_ioctl_hdr pr_hdr;
296 struct lnet_peer_ni_credit_info pr_peer_credits;
300 struct lnet_ioctl_peer_cfg {
301 struct libcfs_ioctl_hdr prcfg_hdr;
302 lnet_nid_t prcfg_prim_nid;
303 lnet_nid_t prcfg_cfg_nid;
304 __u32 prcfg_count; /* ADD_PEER_NI: used for 'lock_prim' option
305 * DEL_PEER_NI: used for 'force' option
310 void __user *prcfg_bulk;
313 struct lnet_ioctl_reset_health_cfg {
314 struct libcfs_ioctl_hdr rh_hdr;
315 enum lnet_health_type rh_type:32;
321 struct lnet_ioctl_reset_conns_per_peer_cfg {
322 struct libcfs_ioctl_hdr rcpp_hdr;
328 struct lnet_ioctl_recovery_list {
329 struct libcfs_ioctl_hdr rlst_hdr;
330 enum lnet_health_type rlst_type:32;
332 lnet_nid_t rlst_nid_array[LNET_MAX_SHOW_NUM_NID];
335 struct lnet_ioctl_set_value {
336 struct libcfs_ioctl_hdr sv_hdr;
340 struct lnet_ioctl_lnet_stats {
341 struct libcfs_ioctl_hdr st_hdr;
342 struct lnet_counters st_cntrs;
345 /* An IP, numeric NID or a Net number is composed of 1 or more of these
346 * descriptor structures.
348 struct lnet_range_expr {
354 /* le_count identifies the number of lnet_range_expr in the bulk
357 struct lnet_expressions {
361 /* A net descriptor has the net type, IE: O2IBLND, SOCKLND, etc and an
362 * expression describing a net number range.
364 struct lnet_ioctl_udsp_net_descr {
366 struct lnet_expressions ud_net_num_expr;
369 /* The UDSP descriptor header contains the type of matching criteria, SRC,
370 * DST, RTE, etc and how many lnet_expressions compose the LNet portion of
371 * the LNet NID. For example an IP can be
372 * composed of 4 lnet_expressions , a gni can be composed of 1
374 struct lnet_ioctl_udsp_descr_hdr {
375 /* The literals SRC, DST and RTE are encoded
379 __u32 ud_descr_count;
382 /* each matching expression in the UDSP is described with this.
383 * The bulk format is as follows:
384 * 1. 1x struct lnet_ioctl_udsp_net_descr
385 * -> the net part of the NID
386 * 2. >=0 struct lnet_expressions
387 * -> the address part of the NID
389 struct lnet_ioctl_udsp_descr {
390 struct lnet_ioctl_udsp_descr_hdr iud_src_hdr;
391 struct lnet_ioctl_udsp_net_descr iud_net;
394 /* The cumulative UDSP descriptor
395 * The bulk format is as follows:
396 * 1. >=1 struct lnet_ioctl_udsp_descr
398 * The size indicated in iou_hdr is the total size of the UDSP.
401 struct lnet_ioctl_udsp {
402 struct libcfs_ioctl_hdr iou_hdr;
404 __u32 iou_action_type;
409 void __user *iou_bulk;
412 /* structure used to request udsp instantiation information on the
413 * specified construct.
414 * cud_nid: the NID of the local or remote NI to pull info on.
415 * cud_nid_priority: NID prio of the requested NID.
416 * cud_net_priority: net prio of network of the requested NID.
417 * cud_pref_nid: array of preferred NIDs if it exists.
419 struct lnet_ioctl_construct_udsp_info {
420 struct libcfs_ioctl_hdr cud_hdr;
423 __u32 cud_nid_priority;
424 __u32 cud_net_priority;
425 lnet_nid_t cud_pref_nid[LNET_MAX_SHOW_NUM_NID];
426 lnet_nid_t cud_pref_rtr_nid[LNET_MAX_SHOW_NUM_NID];
429 #endif /* _LNET_DLC_H_ */