summaryrefslogtreecommitdiffstats
path: root/doc/rst/filters.rst
blob: 3e8c9979d5817a87817e2d9dbedf9eb08f027a83 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
.. _filters.h:

**filters.h**


libnvme directory filter

.. c:function:: int nvme_namespace_filter (const struct dirent *d)

   Filter for namespaces

**Parameters**

``const struct dirent *d``
  dirent to check

**Return**

1 if **d** matches, 0 otherwise


.. c:function:: int nvme_paths_filter (const struct dirent *d)

   Filter for paths

**Parameters**

``const struct dirent *d``
  dirent to check

**Return**

1 if **d** matches, 0 otherwise


.. c:function:: int nvme_ctrls_filter (const struct dirent *d)

   Filter for controllers

**Parameters**

``const struct dirent *d``
  dirent to check

**Return**

1 if **d** matches, 0 otherwise


.. c:function:: int nvme_subsys_filter (const struct dirent *d)

   Filter for subsystems

**Parameters**

``const struct dirent *d``
  dirent to check

**Return**

1 if **d** matches, 0 otherwise


.. c:function:: int nvme_scan_subsystems (struct dirent ***subsys)

   Scan for subsystems

**Parameters**

``struct dirent ***subsys``
  Pointer to array of dirents

**Return**

number of entries in **subsys**


.. c:function:: int nvme_scan_subsystem_namespaces (nvme_subsystem_t s, struct dirent ***ns)

   Scan for namespaces in a subsystem

**Parameters**

``nvme_subsystem_t s``
  Subsystem to scan

``struct dirent ***ns``
  Pointer to array of dirents

**Return**

number of entries in **ns**


.. c:function:: int nvme_scan_ctrls (struct dirent ***ctrls)

   Scan for controllers

**Parameters**

``struct dirent ***ctrls``
  Pointer to array of dirents

**Return**

number of entries in **ctrls**


.. c:function:: int nvme_scan_ctrl_namespace_paths (nvme_ctrl_t c, struct dirent ***paths)

   Scan for namespace paths in a controller

**Parameters**

``nvme_ctrl_t c``
  Controller to scan

``struct dirent ***paths``
  Pointer to array of dirents

**Return**

number of entries in **paths**


.. c:function:: int nvme_scan_ctrl_namespaces (nvme_ctrl_t c, struct dirent ***ns)

   Scan for namespaces in a controller

**Parameters**

``nvme_ctrl_t c``
  Controller to scan

``struct dirent ***ns``
  Pointer to array of dirents

**Return**

number of entries in **ns**