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