libcfs/include/libcfs/util/string.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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * libcfs/include/libcfs/libcfs_string.h
  33  *
  34  * Generic string manipulation functions.
  35  *
  36  * Author: Nathan Rutman <nathan.rutman@sun.com>
  37  */
  38
  39 #ifndef __LIBCFS_UTIL_STRING_H__
  40 #define __LIBCFS_UTIL_STRING_H__
  41
  42 #include <stddef.h>
  43 #include <stdarg.h>
  44
  45 #include <linux/types.h>
  46 #include <linux/lnet/lnet-types.h>
  47 #include <libcfs/util/list.h>
  48
  49 static inline
  50 int vscnprintf(char *buf, size_t bufsz, const char *format, va_list args)
  51 {
  52         int ret;
  53
  54         if (!bufsz)
  55                 return 0;
  56
  57         ret = vsnprintf(buf, bufsz, format, args);
  58         return (bufsz > ret) ? ret : bufsz - 1;
  59 }
  60
  61 /* __printf from linux kernel */
  62 #ifndef __printf
  63 #define __printf(a, b)          __attribute__((__format__(printf, a, b)))
  64 #endif
  65
  66 __printf(3, 4)
  67 static inline int scnprintf(char *buf, size_t bufsz, const char *format, ...)
  68 {
  69         int ret;
  70         va_list args;
  71
  72         va_start(args, format);
  73         ret = vscnprintf(buf, bufsz, format, args);
  74         va_end(args);
  75
  76         return ret;
  77 }
  78
  79 struct netstrfns {
  80         __u32   nf_type;
  81         char    *nf_name;
  82         char    *nf_modname;
  83         void    (*nf_addr2str)(__u32 addr, char *str, size_t size);
  84         int     (*nf_str2addr)(const char *str, int nob, __u32 *addr);
  85         int     (*nf_parse_addrlist)(char *str, int len,
  86                                      struct list_head *list);
  87         int     (*nf_print_addrlist)(char *buffer, int count,
  88                                      struct list_head *list);
  89         int     (*nf_match_addr)(__u32 addr, struct list_head *list);
  90         int     (*nf_min_max)(struct list_head *nidlist, __u32 *min_nid,
  91                               __u32 *max_nid);
  92         int     (*nf_expand_addrrange)(struct list_head *addrranges,
  93                                        __u32 *addrs, int max_addrs);
  94 };
  95
  96 /**
  97  * Structure to represent NULL-less strings.
  98  */
  99 struct cfs_lstr {
 100         char            *ls_str;
 101         int             ls_len;
 102 };
 103
 104 /*
 105  * Structure to represent \<range_expr\> token of the syntax.
 106  */
 107 struct cfs_range_expr {
 108         /*
 109          * Link to cfs_expr_list::el_exprs.
 110          */
 111         struct list_head        re_link;
 112         __u32                   re_lo;
 113         __u32                   re_hi;
 114         __u32                   re_stride;
 115 };
 116
 117 struct cfs_expr_list {
 118         struct list_head        el_link;
 119         struct list_head        el_exprs;
 120 };
 121
 122 int cfs_expr_list_values(struct cfs_expr_list *expr_list, int max, __u32 **valpp);
 123 int cfs_gettok(struct cfs_lstr *next, char delim, struct cfs_lstr *res);
 124 int cfs_str2num_check(char *str, int nob, unsigned *num,
 125                       unsigned min, unsigned max);
 126 int cfs_expr2str(struct list_head *list, char *str, size_t size);
 127 int cfs_expr_list_match(__u32 value, struct cfs_expr_list *expr_list);
 128 int cfs_expr_list_print(char *buffer, int count,
 129                         struct cfs_expr_list *expr_list);
 130 int cfs_expr_list_parse(char *str, int len, unsigned min, unsigned max,
 131                         struct cfs_expr_list **elpp);
 132 void cfs_expr_list_free(struct cfs_expr_list *expr_list);
 133 void cfs_expr_list_free_list(struct list_head *list);
 134 int cfs_ip_addr_parse(char *str, int len, struct list_head *list);
 135 int cfs_ip_addr_range_gen(__u32 *ip_list, int count,
 136                           struct list_head *ip_addr_expr);
 137 int cfs_ip_addr_match(__u32 addr, struct list_head *list);
 138 int cfs_expand_nidlist(struct list_head *nidlist, lnet_nid_t *lnet_nidlist,
 139                        int max_nids);
 140 int cfs_parse_nid_parts(char *str, struct list_head *addr,
 141                         struct list_head *net_num, __u32 *net_type);
 142 int cfs_abs_path(const char *request_path, char **resolved_path);
 143
 144 #endif