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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
/* $Id: sysfs.h $ */
/** @file
* IPRT - Linux sysfs access.
*/
/*
* Copyright (C) 2008-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___iprt_linux_sysfs_h
#define ___iprt_linux_sysfs_h
#include <iprt/cdefs.h>
#include <iprt/types.h>
#include <iprt/stdarg.h>
#include <sys/types.h> /* for dev_t */
RT_C_DECLS_BEGIN
/** @defgroup grp_rt_linux_sysfs RTLinuxSysfs - Linux sysfs
* @ingroup grp_rt
* @{
*/
/**
* Checks if a sysfs file (or directory, device, symlink, whatever) exists.
*
* @returns true / false, errno is preserved.
* @param pszFormat The name format, either absolute or relative to "/sys/".
* @param va The format args.
*/
RTDECL(bool) RTLinuxSysFsExistsV(const char *pszFormat, va_list va);
/**
* Checks if a sysfs file (or directory, device, symlink, whatever) exists.
*
* @returns true / false, errno is preserved.
* @param pszFormat The name format, either absolute or relative to "/sys/".
* @param ... The format args.
*/
RTDECL(bool) RTLinuxSysFsExists(const char *pszFormat, ...);
/**
* Opens a sysfs file.
*
* @returns The file descriptor. -1 and errno on failure.
* @param pszFormat The name format, either absolute or relative to "/sys/".
* @param va The format args.
*/
RTDECL(int) RTLinuxSysFsOpenV(const char *pszFormat, va_list va);
/**
* Opens a sysfs file.
*
* @returns The file descriptor. -1 and errno on failure.
* @param pszFormat The name format, either absolute or relative to "/sys/".
* @param ... The format args.
*/
RTDECL(int) RTLinuxSysFsOpen(const char *pszFormat, ...);
/**
* Closes a file opened with RTLinuxSysFsOpen or RTLinuxSysFsOpenV.
*
* @param fd File descriptor returned by RTLinuxSysFsOpen or
* RTLinuxSysFsOpenV.
*/
RTDECL(void) RTLinuxSysFsClose(int fd);
/**
* Reads a string from a file opened with RTLinuxSysFsOpen or RTLinuxSysFsOpenV.
*
* @returns The number of bytes read. -1 and errno on failure.
* @param fd The file descriptor returned by RTLinuxSysFsOpen or RTLinuxSysFsOpenV.
* @param pszBuf Where to store the string.
* @param cchBuf The size of the buffer. Must be at least 2 bytes.
*/
RTDECL(ssize_t) RTLinuxSysFsReadStr(int fd, char *pszBuf, size_t cchBuf);
/**
* Reads the remainder of a file opened with RTLinuxSysFsOpen or
* RTLinuxSysFsOpenV.
*
* @returns IPRT status code.
* @param fd The file descriptor returned by RTLinuxSysFsOpen or RTLinuxSysFsOpenV.
* @param pvBuf Where to store the bits from the file.
* @param cbBuf The size of the buffer.
* @param pcbRead Where to return the number of bytes read. Optional.
*/
RTDECL(int) RTLinuxSysFsReadFile(int fd, void *pvBuf, size_t cbBuf, size_t *pcbRead);
/**
* Reads a number from a sysfs file.
*
* @returns 64-bit signed value on success, -1 and errno on failure.
* @param uBase The number base, 0 for autodetect.
* @param pszFormat The filename format, either absolute or relative to "/sys/".
* @param va Format args.
*/
RTDECL(int64_t) RTLinuxSysFsReadIntFileV(unsigned uBase, const char *pszFormat, va_list va);
/**
* Reads a number from a sysfs file.
*
* @returns 64-bit signed value on success, -1 and errno on failure.
* @param uBase The number base, 0 for autodetect.
* @param pszFormat The filename format, either absolute or relative to "/sys/".
* @param ... Format args.
*/
RTDECL(int64_t) RTLinuxSysFsReadIntFile(unsigned uBase, const char *pszFormat, ...);
/**
* Reads a device number from a sysfs file.
*
* @returns device number on success, 0 and errno on failure.
* @param pszFormat The filename format, either absolute or relative to "/sys/".
* @param va Format args.
*/
RTDECL(dev_t) RTLinuxSysFsReadDevNumFileV(const char *pszFormat, va_list va);
/**
* Reads a device number from a sysfs file.
*
* @returns device number on success, 0 and errno on failure.
* @param pszFormat The filename format, either absolute or relative to "/sys/".
* @param ... Format args.
*/
RTDECL(dev_t) RTLinuxSysFsReadDevNumFile(const char *pszFormat, ...);
/**
* Reads a string from a sysfs file. If the file contains a newline, we only
* return the text up until there.
*
* @returns number of characters read on success, -1 and errno on failure.
* @param pszBuf Where to store the path element. Must be at least two
* characters, but a longer buffer would be advisable.
* @param cchBuf The size of the buffer pointed to by @a pszBuf.
* @param pszFormat The filename format, either absolute or relative to "/sys/".
* @param va Format args.
*/
RTDECL(ssize_t) RTLinuxSysFsReadStrFileV(char *pszBuf, size_t cchBuf, const char *pszFormat, va_list va);
/**
* Reads a string from a sysfs file. If the file contains a newline, we only
* return the text up until there.
*
* @returns number of characters read on success, -1 and errno on failure.
* @param pszBuf Where to store the path element. Must be at least two
* characters, but a longer buffer would be advisable.
* @param cchBuf The size of the buffer pointed to by @a pszBuf.
* @param pszFormat The filename format, either absolute or relative to "/sys/".
* @param ... Format args.
*/
RTDECL(ssize_t) RTLinuxSysFsReadStrFile(char *pszBuf, size_t cchBuf, const char *pszFormat, ...);
/**
* Reads the last element of the path of the file pointed to by the symbolic
* link specified.
*
* This is needed at least to get the name of the driver associated with a
* device, where pszFormat should be the "driver" link in the devices sysfs
* directory.
*
* @returns The length of the returned string on success, -1 and errno on
* failure.
* @param pszBuf Where to store the path element. Must be at least two
* characters, but a longer buffer would be advisable.
* @param cchBuf The size of the buffer pointed to by @a pszBuf.
* @param pszFormat The filename format, either absolute or relative to "/sys/".
* @param va Format args.
*/
RTDECL(ssize_t) RTLinuxSysFsGetLinkDestV(char *pszBuf, size_t cchBuf, const char *pszFormat, va_list va);
/**
* Reads the last element of the path of the file pointed to by the symbolic
* link specified.
*
* This is needed at least to get the name of the driver associated with a
* device, where pszFormat should be the "driver" link in the devices sysfs
* directory.
*
* @returns The length of the returned string on success, -1 and errno on
* failure.
* @param pszBuf Where to store the path element. Must be at least two
* characters, but a longer buffer would be advisable.
* @param cchBuf The size of the buffer pointed to by @a pszBuf.
* @param pszFormat The filename format, either absolute or relative to "/sys/".
* @param ... Format args.
*/
RTDECL(ssize_t) RTLinuxSysFsGetLinkDest(char *pszBuf, size_t cchBuf, const char *pszFormat, ...);
/**
* Find the path of a device node under /dev, given then device number.
*
* This function will recursively search under /dev until it finds a device node
* matching @a devnum, and store the path into @a pszBuf. The caller may
* provide an expected path in pszSuggestion, which will be tried before
* searching, but due to the variance in Linux systems it can be hard to always
* correctly predict the path.
*
* @returns The length of the returned string on success, -1 and errno on
* failure.
* @returns -1 and ENOENT if no matching device node could be found.
* @param DevNum The device number to search for.
* @param fMode The type of device - only RTFS_TYPE_DEV_CHAR and
* RTFS_TYPE_DEV_BLOCK are valid values.
* @param pszBuf Where to store the path.
* @param cchBuf The size of the buffer.
* @param pszSuggestion The expected path format of the device node, either
* absolute or relative to "/dev". (Optional)
* @param va Format args.
*/
RTDECL(ssize_t) RTLinuxFindDevicePathV(dev_t DevNum, RTFMODE fMode, char *pszBuf, size_t cchBuf,
const char *pszSuggestion, va_list va);
/**
* Find the path of a device node under /dev, given the device number.
*
* This function will recursively search under /dev until it finds a device node
* matching @a devnum, and store the path into @a pszBuf. The caller may
* provide an expected path in pszSuggestion, which will be tried before
* searching, but due to the variance in Linux systems it can be hard to always
* correctly predict the path.
*
* @returns The length of the returned string on success, -1 and errno on
* failure.
* @returns -1 and ENOENT if no matching device node could be found.
* @param DevNum The device number to search for
* @param fMode The type of device - only RTFS_TYPE_DEV_CHAR and
* RTFS_TYPE_DEV_BLOCK are valid values
* @param pszBuf Where to store the path.
* @param cchBuf The size of the buffer.
* @param pszSuggestion The expected path format of the device node, either
* absolute or relative to "/dev". (Optional)
* @param ... Format args.
*/
RTDECL(ssize_t) RTLinuxFindDevicePath(dev_t DevNum, RTFMODE fMode, char *pszBuf, size_t cchBuf,
const char *pszSuggestion, ...);
/** @} */
RT_C_DECLS_END
#endif
|
