lnet/include/uapi/linux/lnet/nidstr.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2015, 2017, Intel Corporation.
  27  */
  28 #ifndef _LNET_NIDSTRINGS_H
  29 #define _LNET_NIDSTRINGS_H
  30
  31 #include <linux/types.h>
  32 /*
  33  * This is due to us being out of kernel and the way the OpenSFS branch
  34  * handles CFLAGS.
  35  */
  36 #ifdef __KERNEL__
  37 # include <uapi/linux/lnet/lnet-types.h>
  38 #else
  39 # include <linux/lnet/lnet-types.h>
  40 #endif
  41
  42 /**
  43  *  Lustre Network Driver types.
  44  */
  45 enum {
  46         /* Only add to these values (i.e. don't ever change or redefine them):
  47          * network addresses depend on them... */
  48         /*QSWLND        = 1, removed v2_7_50                 */
  49         SOCKLND         = 2,
  50         /*GMLND         = 3, removed v2_0_0-rc1a-16-gc660aac */
  51         /*PTLLND        = 4, removed v2_7_50                 */
  52         O2IBLND         = 5,
  53         /*CIBLND        = 6, removed v2_0_0-rc1a-175-gd2b8a0e */
  54         /*OPENIBLND     = 7, removed v2_0_0-rc1a-175-gd2b8a0e */
  55         /*IIBLND        = 8, removed v2_0_0-rc1a-175-gd2b8a0e */
  56         LOLND           = 9,
  57         /*RALND         = 10, removed v2_7_50_0-34-g8be9e41    */
  58         /*VIBLND        = 11, removed v2_0_0-rc1a-175-gd2b8a0e */
  59         /*MXLND         = 12, removed v2_7_50_0-34-g8be9e41    */
  60         GNILND          = 13,
  61         GNIIPLND        = 14,
  62         PTL4LND         = 15,
  63 };
  64
  65 struct list_head;
  66
  67 #define LNET_NIDSTR_COUNT 1024  /* # of nidstrings */
  68 #define LNET_NIDSTR_SIZE  32    /* size of each one (see below for usage) */
  69
  70 /* support decl needed by both kernel and user space */
  71 char *libcfs_next_nidstring(void);
  72 int libcfs_isknown_lnd(__u32 lnd);
  73 char *libcfs_lnd2modname(__u32 lnd);
  74 char *libcfs_lnd2str_r(__u32 lnd, char *buf, size_t buf_size);
  75 static inline char *libcfs_lnd2str(__u32 lnd)
  76 {
  77         return libcfs_lnd2str_r(lnd, libcfs_next_nidstring(),
  78                                 LNET_NIDSTR_SIZE);
  79 }
  80 int libcfs_str2lnd(const char *str);
  81 char *libcfs_net2str_r(__u32 net, char *buf, size_t buf_size);
  82 static inline char *libcfs_net2str(__u32 net)
  83 {
  84         return libcfs_net2str_r(net, libcfs_next_nidstring(),
  85                                 LNET_NIDSTR_SIZE);
  86 }
  87 char *libcfs_nid2str_r(lnet_nid_t nid, char *buf, size_t buf_size);
  88 static inline char *libcfs_nid2str(lnet_nid_t nid)
  89 {
  90         return libcfs_nid2str_r(nid, libcfs_next_nidstring(),
  91                                 LNET_NIDSTR_SIZE);
  92 }
  93 __u32 libcfs_str2net(const char *str);
  94 lnet_nid_t libcfs_str2nid(const char *str);
  95 int libcfs_str2anynid(lnet_nid_t *nid, const char *str);
  96 char *libcfs_id2str(struct lnet_process_id id);
  97 void cfs_free_nidlist(struct list_head *list);
  98 int cfs_parse_nidlist(char *str, int len, struct list_head *list);
  99 int cfs_print_nidlist(char *buffer, int count, struct list_head *list);
 100 int cfs_match_nid(lnet_nid_t nid, struct list_head *list);
 101 int cfs_expand_nidlist(struct list_head *nidlist, lnet_nid_t *lnet_nidlist,
 102                        int max_nids);
 103 int cfs_ip_addr_parse(char *str, int len, struct list_head *list);
 104 int cfs_ip_addr_match(__u32 addr, struct list_head *list);
 105 int cfs_nidrange_find_min_max(struct list_head *nidlist, char *min_nid,
 106                                char *max_nid, size_t nidstr_length);
 107
 108 struct netstrfns {
 109         __u32   nf_type;
 110         char    *nf_name;
 111         char    *nf_modname;
 112         void    (*nf_addr2str)(__u32 addr, char *str, size_t size);
 113         int     (*nf_str2addr)(const char *str, int nob, __u32 *addr);
 114         int     (*nf_parse_addrlist)(char *str, int len,
 115                                      struct list_head *list);
 116         int     (*nf_print_addrlist)(char *buffer, int count,
 117                                      struct list_head *list);
 118         int     (*nf_match_addr)(__u32 addr, struct list_head *list);
 119         int     (*nf_min_max)(struct list_head *nidlist, __u32 *min_nid,
 120                               __u32 *max_nid);
 121         int     (*nf_expand_addrrange)(struct list_head *addrranges,
 122                                        __u32 *addrs, int max_addrs);
 123 };
 124
 125 #endif /* _LNET_NIDSTRINGS_H */