file.c 15.2 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11
/*
 *  file.c - part of debugfs, a tiny little debug file system
 *
 *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
 *  Copyright (C) 2004 IBM Inc.
 *
 *	This program is free software; you can redistribute it and/or
 *	modify it under the terms of the GNU General Public License version
 *	2 as published by the Free Software Foundation.
 *
 *  debugfs is for people to use instead of /proc or /sys.
12
 *  See Documentation/DocBook/filesystems for more details.
Linus Torvalds's avatar
Linus Torvalds committed
13 14 15 16 17 18
 *
 */

#include <linux/module.h>
#include <linux/fs.h>
#include <linux/pagemap.h>
19
#include <linux/namei.h>
Linus Torvalds's avatar
Linus Torvalds committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
#include <linux/debugfs.h>

static ssize_t default_read_file(struct file *file, char __user *buf,
				 size_t count, loff_t *ppos)
{
	return 0;
}

static ssize_t default_write_file(struct file *file, const char __user *buf,
				   size_t count, loff_t *ppos)
{
	return count;
}

static int default_open(struct inode *inode, struct file *file)
{
36 37
	if (inode->i_private)
		file->private_data = inode->i_private;
Linus Torvalds's avatar
Linus Torvalds committed
38 39 40 41

	return 0;
}

42
const struct file_operations debugfs_file_operations = {
Linus Torvalds's avatar
Linus Torvalds committed
43 44 45 46 47
	.read =		default_read_file,
	.write =	default_write_file,
	.open =		default_open,
};

48 49 50 51 52 53 54 55 56 57 58
static void *debugfs_follow_link(struct dentry *dentry, struct nameidata *nd)
{
	nd_set_link(nd, dentry->d_inode->i_private);
	return NULL;
}

const struct inode_operations debugfs_link_operations = {
	.readlink       = generic_readlink,
	.follow_link    = debugfs_follow_link,
};

59
static int debugfs_u8_set(void *data, u64 val)
60 61
{
	*(u8 *)data = val;
62
	return 0;
63
}
64
static int debugfs_u8_get(void *data, u64 *val)
65
{
66 67
	*val = *(u8 *)data;
	return 0;
68 69
}
DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n");
Linus Torvalds's avatar
Linus Torvalds committed
70 71

/**
72
 * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value
Linus Torvalds's avatar
Linus Torvalds committed
73 74 75
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
76
 *          directory dentry if set.  If this parameter is %NULL, then the
Linus Torvalds's avatar
Linus Torvalds committed
77 78 79 80 81 82 83 84 85 86 87
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 *
 * This function creates a file in debugfs with the given name that
 * contains the value of the variable @value.  If the @mode variable is so
 * set, it can be read from, and written to.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
88
 * you are responsible here.)  If an error occurs, %NULL will be returned.
Linus Torvalds's avatar
Linus Torvalds committed
89
 *
90
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds's avatar
Linus Torvalds committed
91
 * returned.  It is not wise to check for this value, but rather, check for
92
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds's avatar
Linus Torvalds committed
93 94 95 96 97 98 99 100 101
 * code.
 */
struct dentry *debugfs_create_u8(const char *name, mode_t mode,
				 struct dentry *parent, u8 *value)
{
	return debugfs_create_file(name, mode, parent, value, &fops_u8);
}
EXPORT_SYMBOL_GPL(debugfs_create_u8);

102
static int debugfs_u16_set(void *data, u64 val)
103 104
{
	*(u16 *)data = val;
105
	return 0;
106
}
107
static int debugfs_u16_get(void *data, u64 *val)
108
{
109 110
	*val = *(u16 *)data;
	return 0;
111 112 113
}
DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n");

Linus Torvalds's avatar
Linus Torvalds committed
114
/**
115
 * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value
Linus Torvalds's avatar
Linus Torvalds committed
116 117 118
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
119
 *          directory dentry if set.  If this parameter is %NULL, then the
Linus Torvalds's avatar
Linus Torvalds committed
120 121 122 123 124 125 126 127 128 129 130
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 *
 * This function creates a file in debugfs with the given name that
 * contains the value of the variable @value.  If the @mode variable is so
 * set, it can be read from, and written to.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
131
 * you are responsible here.)  If an error occurs, %NULL will be returned.
Linus Torvalds's avatar
Linus Torvalds committed
132
 *
133
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds's avatar
Linus Torvalds committed
134
 * returned.  It is not wise to check for this value, but rather, check for
135
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds's avatar
Linus Torvalds committed
136 137 138 139 140 141 142 143 144
 * code.
 */
struct dentry *debugfs_create_u16(const char *name, mode_t mode,
				  struct dentry *parent, u16 *value)
{
	return debugfs_create_file(name, mode, parent, value, &fops_u16);
}
EXPORT_SYMBOL_GPL(debugfs_create_u16);

145
static int debugfs_u32_set(void *data, u64 val)
146 147
{
	*(u32 *)data = val;
148
	return 0;
149
}
150
static int debugfs_u32_get(void *data, u64 *val)
151
{
152 153
	*val = *(u32 *)data;
	return 0;
154 155 156
}
DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n");

Linus Torvalds's avatar
Linus Torvalds committed
157
/**
158
 * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value
Linus Torvalds's avatar
Linus Torvalds committed
159 160 161
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
162
 *          directory dentry if set.  If this parameter is %NULL, then the
Linus Torvalds's avatar
Linus Torvalds committed
163 164 165 166 167 168 169 170 171 172 173
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 *
 * This function creates a file in debugfs with the given name that
 * contains the value of the variable @value.  If the @mode variable is so
 * set, it can be read from, and written to.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
174
 * you are responsible here.)  If an error occurs, %NULL will be returned.
Linus Torvalds's avatar
Linus Torvalds committed
175
 *
176
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds's avatar
Linus Torvalds committed
177
 * returned.  It is not wise to check for this value, but rather, check for
178
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds's avatar
Linus Torvalds committed
179 180 181 182 183 184 185 186 187
 * code.
 */
struct dentry *debugfs_create_u32(const char *name, mode_t mode,
				 struct dentry *parent, u32 *value)
{
	return debugfs_create_file(name, mode, parent, value, &fops_u32);
}
EXPORT_SYMBOL_GPL(debugfs_create_u32);

188
static int debugfs_u64_set(void *data, u64 val)
189 190
{
	*(u64 *)data = val;
191
	return 0;
192 193
}

194
static int debugfs_u64_get(void *data, u64 *val)
195
{
196 197
	*val = *(u64 *)data;
	return 0;
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
}
DEFINE_SIMPLE_ATTRIBUTE(fops_u64, debugfs_u64_get, debugfs_u64_set, "%llu\n");

/**
 * debugfs_create_u64 - create a debugfs file that is used to read and write an unsigned 64-bit value
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is %NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 *
 * This function creates a file in debugfs with the given name that
 * contains the value of the variable @value.  If the @mode variable is so
 * set, it can be read from, and written to.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
 * you are responsible here.)  If an error occurs, %NULL will be returned.
 *
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 * returned.  It is not wise to check for this value, but rather, check for
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
 * code.
 */
struct dentry *debugfs_create_u64(const char *name, mode_t mode,
				 struct dentry *parent, u64 *value)
{
	return debugfs_create_file(name, mode, parent, value, &fops_u64);
}
EXPORT_SYMBOL_GPL(debugfs_create_u64);

232 233 234 235 236 237
DEFINE_SIMPLE_ATTRIBUTE(fops_x8, debugfs_u8_get, debugfs_u8_set, "0x%02llx\n");

DEFINE_SIMPLE_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, "0x%04llx\n");

DEFINE_SIMPLE_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, "0x%08llx\n");

238 239
/*
 * debugfs_create_x{8,16,32} - create a debugfs file that is used to read and write an unsigned {8,16,32}-bit value
240
 *
241 242
 * These functions are exactly the same as the above functions (but use a hex
 * output for the decimal challenged). For details look at the above unsigned
243 244
 * decimal functions.
 */
245 246 247 248 249 250 251 252 253 254 255

/**
 * debugfs_create_x8 - create a debugfs file that is used to read and write an unsigned 8-bit value
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is %NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 */
256 257 258 259 260 261 262
struct dentry *debugfs_create_x8(const char *name, mode_t mode,
				 struct dentry *parent, u8 *value)
{
	return debugfs_create_file(name, mode, parent, value, &fops_x8);
}
EXPORT_SYMBOL_GPL(debugfs_create_x8);

263 264 265 266 267 268 269 270 271 272
/**
 * debugfs_create_x16 - create a debugfs file that is used to read and write an unsigned 16-bit value
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is %NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 */
273 274 275 276 277 278 279
struct dentry *debugfs_create_x16(const char *name, mode_t mode,
				 struct dentry *parent, u16 *value)
{
	return debugfs_create_file(name, mode, parent, value, &fops_x16);
}
EXPORT_SYMBOL_GPL(debugfs_create_x16);

280 281 282 283 284 285 286 287 288 289
/**
 * debugfs_create_x32 - create a debugfs file that is used to read and write an unsigned 32-bit value
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
 *          directory dentry if set.  If this parameter is %NULL, then the
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 */
290 291 292 293 294 295 296
struct dentry *debugfs_create_x32(const char *name, mode_t mode,
				 struct dentry *parent, u32 *value)
{
	return debugfs_create_file(name, mode, parent, value, &fops_x32);
}
EXPORT_SYMBOL_GPL(debugfs_create_x32);

Linus Torvalds's avatar
Linus Torvalds committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
static ssize_t read_file_bool(struct file *file, char __user *user_buf,
			      size_t count, loff_t *ppos)
{
	char buf[3];
	u32 *val = file->private_data;
	
	if (*val)
		buf[0] = 'Y';
	else
		buf[0] = 'N';
	buf[1] = '\n';
	buf[2] = 0x00;
	return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
}

static ssize_t write_file_bool(struct file *file, const char __user *user_buf,
			       size_t count, loff_t *ppos)
{
	char buf[32];
	int buf_size;
	u32 *val = file->private_data;

	buf_size = min(count, (sizeof(buf)-1));
	if (copy_from_user(buf, user_buf, buf_size))
		return -EFAULT;

	switch (buf[0]) {
	case 'y':
	case 'Y':
	case '1':
		*val = 1;
		break;
	case 'n':
	case 'N':
	case '0':
		*val = 0;
		break;
	}
	
	return count;
}

339
static const struct file_operations fops_bool = {
Linus Torvalds's avatar
Linus Torvalds committed
340 341 342 343 344 345
	.read =		read_file_bool,
	.write =	write_file_bool,
	.open =		default_open,
};

/**
346
 * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value
Linus Torvalds's avatar
Linus Torvalds committed
347 348 349
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
350
 *          directory dentry if set.  If this parameter is %NULL, then the
Linus Torvalds's avatar
Linus Torvalds committed
351 352 353 354 355 356 357 358 359 360 361
 *          file will be created in the root of the debugfs filesystem.
 * @value: a pointer to the variable that the file should read to and write
 *         from.
 *
 * This function creates a file in debugfs with the given name that
 * contains the value of the variable @value.  If the @mode variable is so
 * set, it can be read from, and written to.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
362
 * you are responsible here.)  If an error occurs, %NULL will be returned.
Linus Torvalds's avatar
Linus Torvalds committed
363
 *
364
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Linus Torvalds's avatar
Linus Torvalds committed
365
 * returned.  It is not wise to check for this value, but rather, check for
366
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
Linus Torvalds's avatar
Linus Torvalds committed
367 368 369 370 371 372 373 374 375
 * code.
 */
struct dentry *debugfs_create_bool(const char *name, mode_t mode,
				   struct dentry *parent, u32 *value)
{
	return debugfs_create_file(name, mode, parent, value, &fops_bool);
}
EXPORT_SYMBOL_GPL(debugfs_create_bool);

376 377 378 379 380 381 382 383
static ssize_t read_file_blob(struct file *file, char __user *user_buf,
			      size_t count, loff_t *ppos)
{
	struct debugfs_blob_wrapper *blob = file->private_data;
	return simple_read_from_buffer(user_buf, count, ppos, blob->data,
			blob->size);
}

384
static const struct file_operations fops_blob = {
385 386 387 388 389
	.read =		read_file_blob,
	.open =		default_open,
};

/**
390
 * debugfs_create_blob - create a debugfs file that is used to read and write a binary blob
391 392 393
 * @name: a pointer to a string containing the name of the file to create.
 * @mode: the permission that the file should have
 * @parent: a pointer to the parent dentry for this file.  This should be a
394
 *          directory dentry if set.  If this parameter is %NULL, then the
395 396 397 398 399 400 401 402 403 404 405
 *          file will be created in the root of the debugfs filesystem.
 * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer
 *        to the blob data and the size of the data.
 *
 * This function creates a file in debugfs with the given name that exports
 * @blob->data as a binary blob. If the @mode variable is so set it can be
 * read from. Writing is not supported.
 *
 * This function will return a pointer to a dentry if it succeeds.  This
 * pointer must be passed to the debugfs_remove() function when the file is
 * to be removed (no automatic cleanup happens if your module is unloaded,
406
 * you are responsible here.)  If an error occurs, %NULL will be returned.
407
 *
408
 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
409
 * returned.  It is not wise to check for this value, but rather, check for
410
 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling
411 412 413 414 415 416 417 418 419
 * code.
 */
struct dentry *debugfs_create_blob(const char *name, mode_t mode,
				   struct dentry *parent,
				   struct debugfs_blob_wrapper *blob)
{
	return debugfs_create_file(name, mode, parent, blob, &fops_blob);
}
EXPORT_SYMBOL_GPL(debugfs_create_blob);