tools/perf/util/strlist.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __PERF_STRLIST_H
   3 #define __PERF_STRLIST_H
   4
   5 #include <linux/rbtree.h>
   6 #include <stdbool.h>
   7
   8 #include "rblist.h"
   9
  10 struct str_node {
  11         struct rb_node rb_node;
  12         const char     *s;
  13 };
  14
  15 struct strlist {
  16         struct rblist rblist;
  17         bool          dupstr;
  18         bool          file_only;
  19 };
  20
  21 /*
  22  * @file_only: When dirname is present, only consider entries as filenames,
  23  *             that should not be added to the list if dirname/entry is not
  24  *             found
  25  */
  26 struct strlist_config {
  27         bool dont_dupstr;
  28         bool file_only;
  29         const char *dirname;
  30 };
  31
  32 struct strlist *strlist__new(const char *slist, const struct strlist_config *config);
  33 void strlist__delete(struct strlist *slist);
  34
  35 void strlist__remove(struct strlist *slist, struct str_node *sn);
  36 int strlist__load(struct strlist *slist, const char *filename);
  37 int strlist__add(struct strlist *slist, const char *str);
  38
  39 struct str_node *strlist__entry(const struct strlist *slist, unsigned int idx);
  40 struct str_node *strlist__find(struct strlist *slist, const char *entry);
  41
  42 static inline bool strlist__has_entry(struct strlist *slist, const char *entry)
  43 {
  44         return strlist__find(slist, entry) != NULL;
  45 }
  46
  47 static inline bool strlist__empty(const struct strlist *slist)
  48 {
  49         return rblist__empty(&slist->rblist);
  50 }
  51
  52 static inline unsigned int strlist__nr_entries(const struct strlist *slist)
  53 {
  54         return rblist__nr_entries(&slist->rblist);
  55 }
  56
  57 /* For strlist iteration */
  58 static inline struct str_node *strlist__first(struct strlist *slist)
  59 {
  60         struct rb_node *rn = rb_first_cached(&slist->rblist.entries);
  61         return rn ? rb_entry(rn, struct str_node, rb_node) : NULL;
  62 }
  63 static inline struct str_node *strlist__next(struct str_node *sn)
  64 {
  65         struct rb_node *rn;
  66         if (!sn)
  67                 return NULL;
  68         rn = rb_next(&sn->rb_node);
  69         return rn ? rb_entry(rn, struct str_node, rb_node) : NULL;
  70 }
  71
  72 /**
  73  * strlist_for_each      - iterate over a strlist
  74  * @pos:        the &struct str_node to use as a loop cursor.
  75  * @slist:      the &struct strlist for loop.
  76  */
  77 #define strlist__for_each_entry(pos, slist)     \
  78         for (pos = strlist__first(slist); pos; pos = strlist__next(pos))
  79
  80 /**
  81  * strlist_for_each_safe - iterate over a strlist safe against removal of
  82  *                         str_node
  83  * @pos:        the &struct str_node to use as a loop cursor.
  84  * @n:          another &struct str_node to use as temporary storage.
  85  * @slist:      the &struct strlist for loop.
  86  */
  87 #define strlist__for_each_entry_safe(pos, n, slist)     \
  88         for (pos = strlist__first(slist), n = strlist__next(pos); pos;\
  89              pos = n, n = strlist__next(n))
  90 #endif /* __PERF_STRLIST_H */