2019-06-01 15:08:42 +07:00
|
|
|
// SPDX-License-Identifier: GPL-2.0-only
|
2008-01-30 19:32:51 +07:00
|
|
|
/*
|
|
|
|
* Architecture specific debugfs files
|
|
|
|
*
|
|
|
|
* Copyright (C) 2007, Intel Corp.
|
|
|
|
* Huang Ying <ying.huang@intel.com>
|
|
|
|
*/
|
|
|
|
#include <linux/debugfs.h>
|
2008-03-28 09:49:48 +07:00
|
|
|
#include <linux/uaccess.h>
|
2016-07-14 07:18:56 +07:00
|
|
|
#include <linux/export.h>
|
include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit slab.h inclusion from percpu.h
percpu.h is included by sched.h and module.h and thus ends up being
included when building most .c files. percpu.h includes slab.h which
in turn includes gfp.h making everything defined by the two files
universally available and complicating inclusion dependencies.
percpu.h -> slab.h dependency is about to be removed. Prepare for
this change by updating users of gfp and slab facilities include those
headers directly instead of assuming availability. As this conversion
needs to touch large number of source files, the following script is
used as the basis of conversion.
http://userweb.kernel.org/~tj/misc/slabh-sweep.py
The script does the followings.
* Scan files for gfp and slab usages and update includes such that
only the necessary includes are there. ie. if only gfp is used,
gfp.h, if slab is used, slab.h.
* When the script inserts a new include, it looks at the include
blocks and try to put the new include such that its order conforms
to its surrounding. It's put in the include block which contains
core kernel includes, in the same order that the rest are ordered -
alphabetical, Christmas tree, rev-Xmas-tree or at the end if there
doesn't seem to be any matching order.
* If the script can't find a place to put a new include (mostly
because the file doesn't have fitting include block), it prints out
an error message indicating which .h file needs to be added to the
file.
The conversion was done in the following steps.
1. The initial automatic conversion of all .c files updated slightly
over 4000 files, deleting around 700 includes and adding ~480 gfp.h
and ~3000 slab.h inclusions. The script emitted errors for ~400
files.
2. Each error was manually checked. Some didn't need the inclusion,
some needed manual addition while adding it to implementation .h or
embedding .c file was more appropriate for others. This step added
inclusions to around 150 files.
3. The script was run again and the output was compared to the edits
from #2 to make sure no file was left behind.
4. Several build tests were done and a couple of problems were fixed.
e.g. lib/decompress_*.c used malloc/free() wrappers around slab
APIs requiring slab.h to be added manually.
5. The script was run on all .h files but without automatically
editing them as sprinkling gfp.h and slab.h inclusions around .h
files could easily lead to inclusion dependency hell. Most gfp.h
inclusion directives were ignored as stuff from gfp.h was usually
wildly available and often used in preprocessor macros. Each
slab.h inclusion directive was examined and added manually as
necessary.
6. percpu.h was updated not to include slab.h.
7. Build test were done on the following configurations and failures
were fixed. CONFIG_GCOV_KERNEL was turned off for all tests (as my
distributed build env didn't work with gcov compiles) and a few
more options had to be turned off depending on archs to make things
build (like ipr on powerpc/64 which failed due to missing writeq).
* x86 and x86_64 UP and SMP allmodconfig and a custom test config.
* powerpc and powerpc64 SMP allmodconfig
* sparc and sparc64 SMP allmodconfig
* ia64 SMP allmodconfig
* s390 SMP allmodconfig
* alpha SMP allmodconfig
* um on x86_64 SMP allmodconfig
8. percpu.h modifications were reverted so that it could be applied as
a separate patch and serve as bisection point.
Given the fact that I had only a couple of failures from tests on step
6, I'm fairly confident about the coverage of this conversion patch.
If there is a breakage, it's likely to be something in one of the arch
headers which should be easily discoverable easily on most builds of
the specific arch.
Signed-off-by: Tejun Heo <tj@kernel.org>
Guess-its-ok-by: Christoph Lameter <cl@linux-foundation.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Lee Schermerhorn <Lee.Schermerhorn@hp.com>
2010-03-24 15:04:11 +07:00
|
|
|
#include <linux/slab.h>
|
2008-01-30 19:32:51 +07:00
|
|
|
#include <linux/init.h>
|
2009-03-21 18:25:45 +07:00
|
|
|
#include <linux/stat.h>
|
2008-03-28 09:49:48 +07:00
|
|
|
#include <linux/io.h>
|
|
|
|
#include <linux/mm.h>
|
2008-01-30 19:32:51 +07:00
|
|
|
|
|
|
|
#include <asm/setup.h>
|
|
|
|
|
2008-07-19 06:08:13 +07:00
|
|
|
struct dentry *arch_debugfs_dir;
|
|
|
|
EXPORT_SYMBOL(arch_debugfs_dir);
|
|
|
|
|
2008-01-30 19:32:51 +07:00
|
|
|
#ifdef CONFIG_DEBUG_BOOT_PARAMS
|
2008-03-28 09:49:48 +07:00
|
|
|
struct setup_data_node {
|
|
|
|
u64 paddr;
|
|
|
|
u32 type;
|
|
|
|
u32 len;
|
|
|
|
};
|
|
|
|
|
2009-03-21 18:25:45 +07:00
|
|
|
static ssize_t setup_data_read(struct file *file, char __user *user_buf,
|
|
|
|
size_t count, loff_t *ppos)
|
2008-03-28 09:49:48 +07:00
|
|
|
{
|
|
|
|
struct setup_data_node *node = file->private_data;
|
|
|
|
unsigned long remain;
|
|
|
|
loff_t pos = *ppos;
|
|
|
|
void *p;
|
|
|
|
u64 pa;
|
|
|
|
|
|
|
|
if (pos < 0)
|
|
|
|
return -EINVAL;
|
2009-03-21 18:25:45 +07:00
|
|
|
|
2008-03-28 09:49:48 +07:00
|
|
|
if (pos >= node->len)
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
if (count > node->len - pos)
|
|
|
|
count = node->len - pos;
|
2009-03-21 18:25:45 +07:00
|
|
|
|
2008-03-28 09:49:48 +07:00
|
|
|
pa = node->paddr + sizeof(struct setup_data) + pos;
|
2017-07-18 04:10:00 +07:00
|
|
|
p = memremap(pa, count, MEMREMAP_WB);
|
|
|
|
if (!p)
|
|
|
|
return -ENOMEM;
|
2008-03-28 09:49:48 +07:00
|
|
|
|
|
|
|
remain = copy_to_user(user_buf, p, count);
|
|
|
|
|
2017-07-18 04:10:00 +07:00
|
|
|
memunmap(p);
|
2008-03-28 09:49:48 +07:00
|
|
|
|
|
|
|
if (remain)
|
|
|
|
return -EFAULT;
|
|
|
|
|
|
|
|
*ppos = pos + count;
|
|
|
|
|
|
|
|
return count;
|
|
|
|
}
|
|
|
|
|
|
|
|
static const struct file_operations fops_setup_data = {
|
2009-03-21 18:25:45 +07:00
|
|
|
.read = setup_data_read,
|
2012-04-06 04:25:11 +07:00
|
|
|
.open = simple_open,
|
llseek: automatically add .llseek fop
All file_operations should get a .llseek operation so we can make
nonseekable_open the default for future file operations without a
.llseek pointer.
The three cases that we can automatically detect are no_llseek, seq_lseek
and default_llseek. For cases where we can we can automatically prove that
the file offset is always ignored, we use noop_llseek, which maintains
the current behavior of not returning an error from a seek.
New drivers should normally not use noop_llseek but instead use no_llseek
and call nonseekable_open at open time. Existing drivers can be converted
to do the same when the maintainer knows for certain that no user code
relies on calling seek on the device file.
The generated code is often incorrectly indented and right now contains
comments that clarify for each added line why a specific variant was
chosen. In the version that gets submitted upstream, the comments will
be gone and I will manually fix the indentation, because there does not
seem to be a way to do that using coccinelle.
Some amount of new code is currently sitting in linux-next that should get
the same modifications, which I will do at the end of the merge window.
Many thanks to Julia Lawall for helping me learn to write a semantic
patch that does all this.
===== begin semantic patch =====
// This adds an llseek= method to all file operations,
// as a preparation for making no_llseek the default.
//
// The rules are
// - use no_llseek explicitly if we do nonseekable_open
// - use seq_lseek for sequential files
// - use default_llseek if we know we access f_pos
// - use noop_llseek if we know we don't access f_pos,
// but we still want to allow users to call lseek
//
@ open1 exists @
identifier nested_open;
@@
nested_open(...)
{
<+...
nonseekable_open(...)
...+>
}
@ open exists@
identifier open_f;
identifier i, f;
identifier open1.nested_open;
@@
int open_f(struct inode *i, struct file *f)
{
<+...
(
nonseekable_open(...)
|
nested_open(...)
)
...+>
}
@ read disable optional_qualifier exists @
identifier read_f;
identifier f, p, s, off;
type ssize_t, size_t, loff_t;
expression E;
identifier func;
@@
ssize_t read_f(struct file *f, char *p, size_t s, loff_t *off)
{
<+...
(
*off = E
|
*off += E
|
func(..., off, ...)
|
E = *off
)
...+>
}
@ read_no_fpos disable optional_qualifier exists @
identifier read_f;
identifier f, p, s, off;
type ssize_t, size_t, loff_t;
@@
ssize_t read_f(struct file *f, char *p, size_t s, loff_t *off)
{
... when != off
}
@ write @
identifier write_f;
identifier f, p, s, off;
type ssize_t, size_t, loff_t;
expression E;
identifier func;
@@
ssize_t write_f(struct file *f, const char *p, size_t s, loff_t *off)
{
<+...
(
*off = E
|
*off += E
|
func(..., off, ...)
|
E = *off
)
...+>
}
@ write_no_fpos @
identifier write_f;
identifier f, p, s, off;
type ssize_t, size_t, loff_t;
@@
ssize_t write_f(struct file *f, const char *p, size_t s, loff_t *off)
{
... when != off
}
@ fops0 @
identifier fops;
@@
struct file_operations fops = {
...
};
@ has_llseek depends on fops0 @
identifier fops0.fops;
identifier llseek_f;
@@
struct file_operations fops = {
...
.llseek = llseek_f,
...
};
@ has_read depends on fops0 @
identifier fops0.fops;
identifier read_f;
@@
struct file_operations fops = {
...
.read = read_f,
...
};
@ has_write depends on fops0 @
identifier fops0.fops;
identifier write_f;
@@
struct file_operations fops = {
...
.write = write_f,
...
};
@ has_open depends on fops0 @
identifier fops0.fops;
identifier open_f;
@@
struct file_operations fops = {
...
.open = open_f,
...
};
// use no_llseek if we call nonseekable_open
////////////////////////////////////////////
@ nonseekable1 depends on !has_llseek && has_open @
identifier fops0.fops;
identifier nso ~= "nonseekable_open";
@@
struct file_operations fops = {
... .open = nso, ...
+.llseek = no_llseek, /* nonseekable */
};
@ nonseekable2 depends on !has_llseek @
identifier fops0.fops;
identifier open.open_f;
@@
struct file_operations fops = {
... .open = open_f, ...
+.llseek = no_llseek, /* open uses nonseekable */
};
// use seq_lseek for sequential files
/////////////////////////////////////
@ seq depends on !has_llseek @
identifier fops0.fops;
identifier sr ~= "seq_read";
@@
struct file_operations fops = {
... .read = sr, ...
+.llseek = seq_lseek, /* we have seq_read */
};
// use default_llseek if there is a readdir
///////////////////////////////////////////
@ fops1 depends on !has_llseek && !nonseekable1 && !nonseekable2 && !seq @
identifier fops0.fops;
identifier readdir_e;
@@
// any other fop is used that changes pos
struct file_operations fops = {
... .readdir = readdir_e, ...
+.llseek = default_llseek, /* readdir is present */
};
// use default_llseek if at least one of read/write touches f_pos
/////////////////////////////////////////////////////////////////
@ fops2 depends on !fops1 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @
identifier fops0.fops;
identifier read.read_f;
@@
// read fops use offset
struct file_operations fops = {
... .read = read_f, ...
+.llseek = default_llseek, /* read accesses f_pos */
};
@ fops3 depends on !fops1 && !fops2 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @
identifier fops0.fops;
identifier write.write_f;
@@
// write fops use offset
struct file_operations fops = {
... .write = write_f, ...
+ .llseek = default_llseek, /* write accesses f_pos */
};
// Use noop_llseek if neither read nor write accesses f_pos
///////////////////////////////////////////////////////////
@ fops4 depends on !fops1 && !fops2 && !fops3 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @
identifier fops0.fops;
identifier read_no_fpos.read_f;
identifier write_no_fpos.write_f;
@@
// write fops use offset
struct file_operations fops = {
...
.write = write_f,
.read = read_f,
...
+.llseek = noop_llseek, /* read and write both use no f_pos */
};
@ depends on has_write && !has_read && !fops1 && !fops2 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @
identifier fops0.fops;
identifier write_no_fpos.write_f;
@@
struct file_operations fops = {
... .write = write_f, ...
+.llseek = noop_llseek, /* write uses no f_pos */
};
@ depends on has_read && !has_write && !fops1 && !fops2 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @
identifier fops0.fops;
identifier read_no_fpos.read_f;
@@
struct file_operations fops = {
... .read = read_f, ...
+.llseek = noop_llseek, /* read uses no f_pos */
};
@ depends on !has_read && !has_write && !fops1 && !fops2 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @
identifier fops0.fops;
@@
struct file_operations fops = {
...
+.llseek = noop_llseek, /* no read or write fn */
};
===== End semantic patch =====
Signed-off-by: Arnd Bergmann <arnd@arndb.de>
Cc: Julia Lawall <julia@diku.dk>
Cc: Christoph Hellwig <hch@infradead.org>
2010-08-15 23:52:59 +07:00
|
|
|
.llseek = default_llseek,
|
2008-03-28 09:49:48 +07:00
|
|
|
};
|
|
|
|
|
|
|
|
static int __init
|
|
|
|
create_setup_data_node(struct dentry *parent, int no,
|
|
|
|
struct setup_data_node *node)
|
|
|
|
{
|
|
|
|
struct dentry *d, *type, *data;
|
|
|
|
char buf[16];
|
|
|
|
|
|
|
|
sprintf(buf, "%d", no);
|
|
|
|
d = debugfs_create_dir(buf, parent);
|
2009-03-21 18:25:45 +07:00
|
|
|
if (!d)
|
|
|
|
return -ENOMEM;
|
|
|
|
|
2008-03-28 09:49:48 +07:00
|
|
|
type = debugfs_create_x32("type", S_IRUGO, d, &node->type);
|
2009-03-21 18:25:45 +07:00
|
|
|
if (!type)
|
2008-03-28 09:49:48 +07:00
|
|
|
goto err_dir;
|
2009-03-21 18:25:45 +07:00
|
|
|
|
2008-03-28 09:49:48 +07:00
|
|
|
data = debugfs_create_file("data", S_IRUGO, d, node, &fops_setup_data);
|
2009-03-21 18:25:45 +07:00
|
|
|
if (!data)
|
2008-03-28 09:49:48 +07:00
|
|
|
goto err_type;
|
2009-03-21 18:25:45 +07:00
|
|
|
|
2008-03-28 09:49:48 +07:00
|
|
|
return 0;
|
|
|
|
|
|
|
|
err_type:
|
|
|
|
debugfs_remove(type);
|
|
|
|
err_dir:
|
|
|
|
debugfs_remove(d);
|
2009-03-21 18:25:45 +07:00
|
|
|
return -ENOMEM;
|
2008-03-28 09:49:48 +07:00
|
|
|
}
|
|
|
|
|
|
|
|
static int __init create_setup_data_nodes(struct dentry *parent)
|
|
|
|
{
|
|
|
|
struct setup_data_node *node;
|
|
|
|
struct setup_data *data;
|
2012-07-14 23:43:08 +07:00
|
|
|
int error;
|
2008-03-28 09:49:48 +07:00
|
|
|
struct dentry *d;
|
|
|
|
u64 pa_data;
|
2009-03-21 18:25:45 +07:00
|
|
|
int no = 0;
|
2008-03-28 09:49:48 +07:00
|
|
|
|
|
|
|
d = debugfs_create_dir("setup_data", parent);
|
2009-03-21 18:25:45 +07:00
|
|
|
if (!d)
|
|
|
|
return -ENOMEM;
|
2008-03-28 09:49:48 +07:00
|
|
|
|
|
|
|
pa_data = boot_params.hdr.setup_data;
|
|
|
|
|
|
|
|
while (pa_data) {
|
|
|
|
node = kmalloc(sizeof(*node), GFP_KERNEL);
|
2012-07-14 23:43:08 +07:00
|
|
|
if (!node) {
|
|
|
|
error = -ENOMEM;
|
2008-03-28 09:49:48 +07:00
|
|
|
goto err_dir;
|
2012-07-14 23:43:08 +07:00
|
|
|
}
|
2009-03-21 18:25:45 +07:00
|
|
|
|
2017-07-18 04:10:00 +07:00
|
|
|
data = memremap(pa_data, sizeof(*data), MEMREMAP_WB);
|
|
|
|
if (!data) {
|
|
|
|
kfree(node);
|
|
|
|
error = -ENOMEM;
|
|
|
|
goto err_dir;
|
|
|
|
}
|
2008-03-28 09:49:48 +07:00
|
|
|
|
|
|
|
node->paddr = pa_data;
|
|
|
|
node->type = data->type;
|
|
|
|
node->len = data->len;
|
|
|
|
error = create_setup_data_node(d, no, node);
|
|
|
|
pa_data = data->next;
|
|
|
|
|
2017-07-18 04:10:00 +07:00
|
|
|
memunmap(data);
|
2008-03-28 09:49:48 +07:00
|
|
|
if (error)
|
|
|
|
goto err_dir;
|
|
|
|
no++;
|
|
|
|
}
|
2009-03-21 18:25:45 +07:00
|
|
|
|
2008-03-28 09:49:48 +07:00
|
|
|
return 0;
|
|
|
|
|
|
|
|
err_dir:
|
|
|
|
debugfs_remove(d);
|
|
|
|
return error;
|
|
|
|
}
|
|
|
|
|
2008-01-30 19:32:51 +07:00
|
|
|
static struct debugfs_blob_wrapper boot_params_blob = {
|
2008-03-28 09:49:48 +07:00
|
|
|
.data = &boot_params,
|
|
|
|
.size = sizeof(boot_params),
|
2008-01-30 19:32:51 +07:00
|
|
|
};
|
|
|
|
|
|
|
|
static int __init boot_params_kdebugfs_init(void)
|
|
|
|
{
|
|
|
|
struct dentry *dbp, *version, *data;
|
2009-03-21 18:25:45 +07:00
|
|
|
int error = -ENOMEM;
|
2008-01-30 19:32:51 +07:00
|
|
|
|
2017-02-28 05:50:58 +07:00
|
|
|
dbp = debugfs_create_dir("boot_params", arch_debugfs_dir);
|
2009-03-21 18:25:45 +07:00
|
|
|
if (!dbp)
|
|
|
|
return -ENOMEM;
|
|
|
|
|
2008-01-30 19:32:51 +07:00
|
|
|
version = debugfs_create_x16("version", S_IRUGO, dbp,
|
|
|
|
&boot_params.hdr.version);
|
2009-03-21 18:25:45 +07:00
|
|
|
if (!version)
|
2008-01-30 19:32:51 +07:00
|
|
|
goto err_dir;
|
2009-03-21 18:25:45 +07:00
|
|
|
|
2008-01-30 19:32:51 +07:00
|
|
|
data = debugfs_create_blob("data", S_IRUGO, dbp,
|
|
|
|
&boot_params_blob);
|
2009-03-21 18:25:45 +07:00
|
|
|
if (!data)
|
2008-01-30 19:32:51 +07:00
|
|
|
goto err_version;
|
2009-03-21 18:25:45 +07:00
|
|
|
|
2008-03-28 09:49:48 +07:00
|
|
|
error = create_setup_data_nodes(dbp);
|
|
|
|
if (error)
|
|
|
|
goto err_data;
|
2009-03-21 18:25:45 +07:00
|
|
|
|
2008-01-30 19:32:51 +07:00
|
|
|
return 0;
|
2008-03-28 09:49:48 +07:00
|
|
|
|
|
|
|
err_data:
|
|
|
|
debugfs_remove(data);
|
2008-01-30 19:32:51 +07:00
|
|
|
err_version:
|
|
|
|
debugfs_remove(version);
|
|
|
|
err_dir:
|
|
|
|
debugfs_remove(dbp);
|
|
|
|
return error;
|
|
|
|
}
|
2009-03-21 18:25:45 +07:00
|
|
|
#endif /* CONFIG_DEBUG_BOOT_PARAMS */
|
2008-01-30 19:32:51 +07:00
|
|
|
|
|
|
|
static int __init arch_kdebugfs_init(void)
|
|
|
|
{
|
|
|
|
int error = 0;
|
|
|
|
|
2008-07-19 06:08:13 +07:00
|
|
|
arch_debugfs_dir = debugfs_create_dir("x86", NULL);
|
|
|
|
if (!arch_debugfs_dir)
|
|
|
|
return -ENOMEM;
|
|
|
|
|
2008-01-30 19:32:51 +07:00
|
|
|
#ifdef CONFIG_DEBUG_BOOT_PARAMS
|
|
|
|
error = boot_params_kdebugfs_init();
|
|
|
|
#endif
|
|
|
|
|
|
|
|
return error;
|
|
|
|
}
|
|
|
|
arch_initcall(arch_kdebugfs_init);
|