lnet/include/uapi/linux/lnet/lnet-dlc.h

   1 /*
   2  * LGPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but 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.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library.
  18  *
  19  * LGPL HEADER END
  20  *
  21  */
  22 /*
  23  * Copyright (c) 2014, 2017, Intel Corporation.
  24  */
  25 /*
  26  * Author: Amir Shehata <amir.shehata@intel.com>
  27  */
  28
  29 #ifndef __UAPI_LNET_DLC_H_
  30 #define __UAPI_LNET_DLC_H_
  31
  32 #include <linux/types.h>
  33 #include <linux/lnet/libcfs_ioctl.h>
  34 #include <linux/lnet/lnet-types.h>
  35
  36 #define MAX_NUM_SHOW_ENTRIES    32
  37 #define LNET_MAX_STR_LEN        128
  38 #define LNET_MAX_SHOW_NUM_CPT   128
  39 #define LNET_MAX_SHOW_NUM_NID   128
  40 #define LNET_UNDEFINED_HOPS     ((__u32) -1)
  41
  42 #define LNET_RT_ALIVE           (1 << 0)
  43 #define LNET_RT_MULTI_HOP       (1 << 1)
  44
  45 /*
  46  * sparse kernel source annotations
  47  */
  48 #ifndef __user
  49 #define __user
  50 #endif
  51
  52 #define LNET_GENL_NAME          "lnet"
  53 #define LNET_GENL_VERSION       0x05
  54
  55 /* enum lnet_commands         - Supported core LNet Netlink commands
  56  *
  57  * @LNET_CMD_UNSPEC:            unspecified command to catch errors
  58  *
  59  * @LNET_CMD_NETS:              command to manage the LNet networks
  60  * @LNET_CMD_ROUTES:            command to manage LNet routes
  61  * @LNET_CMD_PING:              command to send pings to LNet connections
  62  * @LNET_CMD_CPT_OF_NID:        command to calculate the CPT of specified NIDs
  63  */
  64 enum lnet_commands {
  65         LNET_CMD_UNSPEC         = 0,
  66
  67         LNET_CMD_CONFIGURE      = 1,
  68         LNET_CMD_NETS           = 2,
  69         LNET_CMD_PEERS          = 3,
  70         LNET_CMD_ROUTES         = 4,
  71         LNET_CMD_CONNS          = 5,
  72         LNET_CMD_PING           = 6,
  73         LNET_CMD_CPT_OF_NID     = 7,
  74         LNET_CMD_PEER_DIST      = 8,
  75
  76         __LNET_CMD_MAX_PLUS_ONE
  77 };
  78
  79 #define LNET_CMD_MAX (__LNET_CMD_MAX_PLUS_ONE - 1)
  80
  81 /*
  82  * To allow for future enhancements to extend the tunables
  83  * add a hdr to this structure, so that the version can be set
  84  * and checked for backwards compatibility. Newer versions of LNet
  85  * can still work with older versions of lnetctl. The restriction is
  86  * that the structure can be added to and not removed from in order
  87  * to not invalidate older lnetctl utilities. Moreover, the order of
  88  * fields must remain the same, and new fields appended to the structure
  89  *
  90  * That said all existing LND tunables will be added in this structure
  91  * to avoid future changes.
  92  */
  93 struct lnet_ioctl_config_lnd_cmn_tunables {
  94         __u32 lct_version;
  95         __s32 lct_peer_timeout;
  96         __s32 lct_peer_tx_credits;
  97         __s32 lct_peer_rtr_credits;
  98         __s32 lct_max_tx_credits;
  99 };
 100
 101 struct lnet_ioctl_config_o2iblnd_tunables {
 102         __u32 lnd_version;
 103         __u32 lnd_peercredits_hiw;
 104         __u32 lnd_map_on_demand;
 105         __u32 lnd_concurrent_sends;
 106         __u32 lnd_fmr_pool_size;
 107         __u32 lnd_fmr_flush_trigger;
 108         __u32 lnd_fmr_cache;
 109         __u16 lnd_conns_per_peer;
 110         __u16 lnd_ntx;
 111         __u32 lnd_timeout;
 112 };
 113
 114 struct lnet_ioctl_config_kfilnd_tunables {
 115         __u32 lnd_version;
 116         __u32 lnd_prov_major_version;
 117         __u32 lnd_prov_minor_version;
 118         __u32 lnd_auth_key;
 119         char lnd_traffic_class_str[LNET_MAX_STR_LEN];
 120         __u32 lnd_traffic_class;
 121 };
 122
 123 struct lnet_ioctl_config_socklnd_tunables {
 124         __u32 lnd_version;
 125         __u16 lnd_conns_per_peer;
 126         __u16 lnd_pad;
 127         __u32 lnd_timeout;
 128 };
 129
 130 struct lnet_ioctl_config_gnilnd_tunables {
 131         __u32 lnd_version;
 132         __u32 lnd_timeout;
 133 };
 134
 135 struct lnet_lnd_tunables {
 136         union {
 137                 struct lnet_ioctl_config_o2iblnd_tunables lnd_o2ib;
 138                 struct lnet_ioctl_config_socklnd_tunables lnd_sock;
 139                 struct lnet_ioctl_config_kfilnd_tunables lnd_kfi;
 140                 struct lnet_ioctl_config_gnilnd_tunables lnd_gni;
 141         } lnd_tun_u;
 142 };
 143
 144 struct lnet_ioctl_config_lnd_tunables {
 145         struct lnet_ioctl_config_lnd_cmn_tunables lt_cmn;
 146         struct lnet_lnd_tunables lt_tun;
 147 };
 148
 149 struct lnet_ioctl_net_config {
 150         char ni_interface[LNET_MAX_STR_LEN];
 151         __u32 ni_status;
 152         __u32 ni_cpts[LNET_MAX_SHOW_NUM_CPT];
 153         char cfg_bulk[0];
 154 };
 155
 156 #define LNET_TINY_BUF_IDX       0
 157 #define LNET_SMALL_BUF_IDX      1
 158 #define LNET_LARGE_BUF_IDX      2
 159
 160 /* # different router buffer pools */
 161 #define LNET_NRBPOOLS           (LNET_LARGE_BUF_IDX + 1)
 162
 163 struct lnet_ioctl_pool_cfg {
 164         struct {
 165                 __u32 pl_npages;
 166                 __u32 pl_nbuffers;
 167                 __u32 pl_credits;
 168                 __u32 pl_mincredits;
 169         } pl_pools[LNET_NRBPOOLS];
 170         __u32 pl_routing;
 171 };
 172
 173 struct lnet_ioctl_ping_data {
 174         struct libcfs_ioctl_hdr ping_hdr;
 175
 176         __u32 op_param;
 177         __u32 ping_count;
 178         __u32 ping_flags;
 179         __u32 mr_info;
 180         struct lnet_process_id ping_id;
 181         struct lnet_process_id __user *ping_buf;
 182         lnet_nid_t ping_src;
 183 };
 184
 185 struct lnet_ioctl_config_data {
 186         struct libcfs_ioctl_hdr cfg_hdr;
 187
 188         __u32 cfg_net;
 189         __u32 cfg_count;
 190         __u64 cfg_nid;
 191         __u32 cfg_ncpts;
 192
 193         union {
 194                 struct {
 195                         __u32 rtr_hop;
 196                         __u32 rtr_priority;
 197                         __u32 rtr_flags;
 198                         __u32 rtr_sensitivity;
 199                 } cfg_route;
 200                 struct {
 201                         char net_intf[LNET_MAX_STR_LEN];
 202                         __s32 net_peer_timeout;
 203                         __s32 net_peer_tx_credits;
 204                         __s32 net_peer_rtr_credits;
 205                         __s32 net_max_tx_credits;
 206                         __u32 net_cksum_algo;
 207                         __u32 net_interface_count;
 208                 } cfg_net;
 209                 struct {
 210                         __u32 buf_enable;
 211                         __s32 buf_tiny;
 212                         __s32 buf_small;
 213                         __s32 buf_large;
 214                 } cfg_buffers;
 215         } cfg_config_u;
 216
 217         char cfg_bulk[0];
 218 };
 219
 220 struct lnet_ioctl_comm_count {
 221         __u32 ico_get_count;
 222         __u32 ico_put_count;
 223         __u32 ico_reply_count;
 224         __u32 ico_ack_count;
 225         __u32 ico_hello_count;
 226 };
 227
 228 struct lnet_ioctl_element_stats {
 229         __u32 iel_send_count;
 230         __u32 iel_recv_count;
 231         __u32 iel_drop_count;
 232 };
 233
 234 enum lnet_health_type {
 235         LNET_HEALTH_TYPE_LOCAL_NI = 0,
 236         LNET_HEALTH_TYPE_PEER_NI,
 237 };
 238
 239 struct lnet_ioctl_local_ni_hstats {
 240         struct libcfs_ioctl_hdr hlni_hdr;
 241         lnet_nid_t hlni_nid;
 242         __u32 hlni_local_interrupt;
 243         __u32 hlni_local_dropped;
 244         __u32 hlni_local_aborted;
 245         __u32 hlni_local_no_route;
 246         __u32 hlni_local_timeout;
 247         __u32 hlni_local_error;
 248         __s32 hlni_fatal_error;
 249         __s32 hlni_health_value;
 250         __u32 hlni_ping_count;
 251         __u64 hlni_next_ping;
 252 };
 253
 254 struct lnet_ioctl_peer_ni_hstats {
 255         __u32 hlpni_remote_dropped;
 256         __u32 hlpni_remote_timeout;
 257         __u32 hlpni_remote_error;
 258         __u32 hlpni_network_timeout;
 259         __s32 hlpni_health_value;
 260         __u32 hlpni_ping_count;
 261         __u64 hlpni_next_ping;
 262 };
 263
 264 struct lnet_ioctl_element_msg_stats {
 265         struct libcfs_ioctl_hdr im_hdr;
 266         __u32 im_idx;
 267         struct lnet_ioctl_comm_count im_send_stats;
 268         struct lnet_ioctl_comm_count im_recv_stats;
 269         struct lnet_ioctl_comm_count im_drop_stats;
 270 };
 271
 272 /*
 273  * lnet_ioctl_config_ni
 274  *  This structure describes an NI configuration. There are multiple components
 275  *  when configuring an NI: Net, Interfaces, CPT list and LND tunables
 276  *  A network is passed as a string to the DLC and translated using
 277  *  libcfs_str2net()
 278  *  An interface is the name of the system configured interface
 279  *  (ex eth0, ib1)
 280  *  CPT is the list of CPTS LND tunables are passed in the lic_bulk area
 281  */
 282 struct lnet_ioctl_config_ni {
 283         struct libcfs_ioctl_hdr lic_cfg_hdr;
 284         lnet_nid_t              lic_nid;
 285         char                    lic_ni_intf[LNET_MAX_STR_LEN];
 286         char                    lic_legacy_ip2nets[LNET_MAX_STR_LEN];
 287         __u32                   lic_cpts[LNET_MAX_SHOW_NUM_CPT];
 288         __u32                   lic_ncpts;
 289         __u32                   lic_status;
 290         __u32                   lic_idx;
 291         __s32                   lic_dev_cpt;
 292         char                    pad[4];
 293         char                    lic_bulk[0];
 294 };
 295
 296 struct lnet_peer_ni_credit_info {
 297         char cr_aliveness[LNET_MAX_STR_LEN];
 298         __u32 cr_refcount;
 299         __s32 cr_ni_peer_tx_credits;
 300         __s32 cr_peer_tx_credits;
 301         __s32 cr_peer_min_tx_credits;
 302         __u32 cr_peer_tx_qnob;
 303         __s32 cr_peer_rtr_credits;
 304         __s32 cr_peer_min_rtr_credits;
 305         __u32 cr_ncpt;
 306 };
 307
 308 struct lnet_ioctl_peer {
 309         struct libcfs_ioctl_hdr pr_hdr;
 310         __u32 pr_count;
 311         __u32 pr_pad;
 312         lnet_nid_t pr_nid;
 313
 314         union {
 315                 struct lnet_peer_ni_credit_info  pr_peer_credits;
 316         } pr_lnd_u;
 317 };
 318
 319 struct lnet_ioctl_peer_cfg {
 320         struct libcfs_ioctl_hdr prcfg_hdr;
 321         lnet_nid_t prcfg_prim_nid;
 322         lnet_nid_t prcfg_cfg_nid;
 323         __u32 prcfg_count;      /* ADD_PEER_NI: used for 'lock_prim' option
 324                                  * DEL_PEER_NI: used for 'force' option
 325                                  */
 326         __u32 prcfg_mr;
 327         __u32 prcfg_state;
 328         __u32 prcfg_size;
 329         void __user *prcfg_bulk;
 330 };
 331
 332 struct lnet_ioctl_reset_health_cfg {
 333         struct libcfs_ioctl_hdr rh_hdr;
 334         enum lnet_health_type rh_type:32;
 335         __u16 rh_all:1;
 336         __s16 rh_value;
 337         lnet_nid_t rh_nid;
 338 };
 339
 340 struct lnet_ioctl_reset_conns_per_peer_cfg {
 341         struct libcfs_ioctl_hdr rcpp_hdr;
 342         __u16 rcpp_all:1;
 343         __s16 rcpp_value;
 344         lnet_nid_t rcpp_nid;
 345 };
 346
 347 struct lnet_ioctl_recovery_list {
 348         struct libcfs_ioctl_hdr rlst_hdr;
 349         enum lnet_health_type rlst_type:32;
 350         __u32 rlst_num_nids;
 351         lnet_nid_t rlst_nid_array[LNET_MAX_SHOW_NUM_NID];
 352 };
 353
 354 struct lnet_ioctl_set_value {
 355         struct libcfs_ioctl_hdr sv_hdr;
 356         __u32 sv_value;
 357 };
 358
 359 struct lnet_ioctl_lnet_stats {
 360         struct libcfs_ioctl_hdr st_hdr;
 361         struct lnet_counters st_cntrs;
 362 };
 363
 364 /* An IP, numeric NID or a Net number is composed of 1 or more of these
 365  * descriptor structures.
 366  */
 367 struct lnet_range_expr {
 368         __u32 re_lo;
 369         __u32 re_hi;
 370         __u32 re_stride;
 371 };
 372
 373 /* le_count identifies the number of lnet_range_expr in the bulk
 374  * which follows
 375  */
 376 struct lnet_expressions {
 377         __u32 le_count;
 378 };
 379
 380 /* A net descriptor has the net type, IE: O2IBLND, SOCKLND, etc and an
 381  * expression describing a net number range.
 382  */
 383 struct lnet_ioctl_udsp_net_descr {
 384         __u32 ud_net_type;
 385         struct lnet_expressions ud_net_num_expr;
 386 };
 387
 388 /* The UDSP descriptor header contains the type of matching criteria, SRC,
 389  * DST, RTE, etc and how many lnet_expressions compose the LNet portion of
 390  * the LNet NID. For example an IP can be
 391  * composed of 4 lnet_expressions , a gni can be composed of 1
 392  */
 393 struct lnet_ioctl_udsp_descr_hdr {
 394         /* The literals SRC, DST and RTE are encoded
 395          * here.
 396          */
 397         __u32 ud_descr_type;
 398         __u32 ud_descr_count;
 399 };
 400
 401 /* each matching expression in the UDSP is described with this.
 402  * The bulk format is as follows:
 403  *      1. 1x struct lnet_ioctl_udsp_net_descr
 404  *              -> the net part of the NID
 405  *      2. >=0 struct lnet_expressions
 406  *              -> the address part of the NID
 407  */
 408 struct lnet_ioctl_udsp_descr {
 409         struct lnet_ioctl_udsp_descr_hdr iud_src_hdr;
 410         struct lnet_ioctl_udsp_net_descr iud_net;
 411 };
 412
 413 /* The cumulative UDSP descriptor
 414  * The bulk format is as follows:
 415  *      1. >=1 struct lnet_ioctl_udsp_descr
 416  *
 417  * The size indicated in iou_hdr is the total size of the UDSP.
 418  *
 419  */
 420 struct lnet_ioctl_udsp {
 421         struct libcfs_ioctl_hdr iou_hdr;
 422         __s32 iou_idx;
 423         __u32 iou_action_type;
 424         __u32 iou_bulk_size;
 425         union {
 426                 __u32 priority;
 427         } iou_action;
 428         void __user *iou_bulk;
 429 };
 430
 431 /* structure used to request udsp instantiation information on the
 432  * specified construct.
 433  *   cud_nid: the NID of the local or remote NI to pull info on.
 434  *   cud_nid_priority: NID prio of the requested NID.
 435  *   cud_net_priority: net prio of network of the requested NID.
 436  *   cud_pref_nid: array of preferred NIDs if it exists.
 437  */
 438 struct lnet_ioctl_construct_udsp_info {
 439         struct libcfs_ioctl_hdr cud_hdr;
 440         __u32 cud_peer:1;
 441         lnet_nid_t cud_nid;
 442         __u32 cud_nid_priority;
 443         __u32 cud_net_priority;
 444         lnet_nid_t cud_pref_nid[LNET_MAX_SHOW_NUM_NID];
 445         lnet_nid_t cud_pref_rtr_nid[LNET_MAX_SHOW_NUM_NID];
 446 };
 447
 448 #endif /* _LNET_DLC_H_ */