License cleanup: add SPDX GPL-2.0 license identifier to files with no license
Many source files in the tree are missing licensing information, which
makes it harder for compliance tools to determine the correct license.
By default all files without license information are under the default
license of the kernel, which is GPL version 2.
Update the files which contain no license information with the 'GPL-2.0'
SPDX license identifier. The SPDX identifier is a legally binding
shorthand, which can be used instead of the full boiler plate text.
This patch is based on work done by Thomas Gleixner and Kate Stewart and
Philippe Ombredanne.
How this work was done:
Patches were generated and checked against linux-4.14-rc6 for a subset of
the use cases:
- file had no licensing information it it.
- file was a */uapi/* one with no licensing information in it,
- file was a */uapi/* one with existing licensing information,
Further patches will be generated in subsequent months to fix up cases
where non-standard license headers were used, and references to license
had to be inferred by heuristics based on keywords.
The analysis to determine which SPDX License Identifier to be applied to
a file was done in a spreadsheet of side by side results from of the
output of two independent scanners (ScanCode & Windriver) producing SPDX
tag:value files created by Philippe Ombredanne. Philippe prepared the
base worksheet, and did an initial spot review of a few 1000 files.
The 4.13 kernel was the starting point of the analysis with 60,537 files
assessed. Kate Stewart did a file by file comparison of the scanner
results in the spreadsheet to determine which SPDX license identifier(s)
to be applied to the file. She confirmed any determination that was not
immediately clear with lawyers working with the Linux Foundation.
Criteria used to select files for SPDX license identifier tagging was:
- Files considered eligible had to be source code files.
- Make and config files were included as candidates if they contained >5
lines of source
- File already had some variant of a license header in it (even if <5
lines).
All documentation files were explicitly excluded.
The following heuristics were used to determine which SPDX license
identifiers to apply.
- when both scanners couldn't find any license traces, file was
considered to have no license information in it, and the top level
COPYING file license applied.
For non */uapi/* files that summary was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 11139
and resulted in the first patch in this series.
If that file was a */uapi/* path one, it was "GPL-2.0 WITH
Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 WITH Linux-syscall-note 930
and resulted in the second patch in this series.
- if a file had some form of licensing information in it, and was one
of the */uapi/* ones, it was denoted with the Linux-syscall-note if
any GPL family license was found in the file or had no licensing in
it (per prior point). Results summary:
SPDX license identifier # files
---------------------------------------------------|------
GPL-2.0 WITH Linux-syscall-note 270
GPL-2.0+ WITH Linux-syscall-note 169
((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21
((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17
LGPL-2.1+ WITH Linux-syscall-note 15
GPL-1.0+ WITH Linux-syscall-note 14
((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5
LGPL-2.0+ WITH Linux-syscall-note 4
LGPL-2.1 WITH Linux-syscall-note 3
((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3
((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1
and that resulted in the third patch in this series.
- when the two scanners agreed on the detected license(s), that became
the concluded license(s).
- when there was disagreement between the two scanners (one detected a
license but the other didn't, or they both detected different
licenses) a manual inspection of the file occurred.
- In most cases a manual inspection of the information in the file
resulted in a clear resolution of the license that should apply (and
which scanner probably needed to revisit its heuristics).
- When it was not immediately clear, the license identifier was
confirmed with lawyers working with the Linux Foundation.
- If there was any question as to the appropriate license identifier,
the file was flagged for further research and to be revisited later
in time.
In total, over 70 hours of logged manual review was done on the
spreadsheet to determine the SPDX license identifiers to apply to the
source files by Kate, Philippe, Thomas and, in some cases, confirmation
by lawyers working with the Linux Foundation.
Kate also obtained a third independent scan of the 4.13 code base from
FOSSology, and compared selected files where the other two scanners
disagreed against that SPDX file, to see if there was new insights. The
Windriver scanner is based on an older version of FOSSology in part, so
they are related.
Thomas did random spot checks in about 500 files from the spreadsheets
for the uapi headers and agreed with SPDX license identifier in the
files he inspected. For the non-uapi files Thomas did random spot checks
in about 15000 files.
In initial set of patches against 4.14-rc6, 3 files were found to have
copy/paste license identifier errors, and have been fixed to reflect the
correct identifier.
Additionally Philippe spent 10 hours this week doing a detailed manual
inspection and review of the 12,461 patched files from the initial patch
version early this week with:
- a full scancode scan run, collecting the matched texts, detected
license ids and scores
- reviewing anything where there was a license detected (about 500+
files) to ensure that the applied SPDX license was correct
- reviewing anything where there was no detection but the patch license
was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied
SPDX license was correct
This produced a worksheet with 20 files needing minor correction. This
worksheet was then exported into 3 different .csv files for the
different types of files to be modified.
These .csv files were then reviewed by Greg. Thomas wrote a script to
parse the csv files and add the proper SPDX tag to the file, in the
format that the file expected. This script was further refined by Greg
based on the output to detect more types of files automatically and to
distinguish between header and source .c files (which need different
comment types.) Finally Greg ran the script using the .csv files to
generate the patches.
Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org>
Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2017-11-01 17:07:57 +03:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2015-12-15 18:39:40 +03:00
|
|
|
#ifndef __SUBCMD_PARSE_OPTIONS_H
|
|
|
|
#define __SUBCMD_PARSE_OPTIONS_H
|
2009-04-20 17:00:56 +04:00
|
|
|
|
2017-01-05 18:44:05 +03:00
|
|
|
#include <linux/kernel.h>
|
2010-05-17 22:51:10 +04:00
|
|
|
#include <stdbool.h>
|
2015-12-15 18:39:38 +03:00
|
|
|
#include <stdint.h>
|
2010-05-17 22:39:16 +04:00
|
|
|
|
2015-12-18 15:39:17 +03:00
|
|
|
#ifndef NORETURN
|
|
|
|
#define NORETURN __attribute__((__noreturn__))
|
|
|
|
#endif
|
|
|
|
|
2009-04-20 17:00:56 +04:00
|
|
|
enum parse_opt_type {
|
|
|
|
/* special types */
|
|
|
|
OPTION_END,
|
|
|
|
OPTION_ARGUMENT,
|
|
|
|
OPTION_GROUP,
|
|
|
|
/* options with no arguments */
|
|
|
|
OPTION_BIT,
|
2010-04-13 12:37:33 +04:00
|
|
|
OPTION_BOOLEAN,
|
|
|
|
OPTION_INCR,
|
2010-05-17 23:22:41 +04:00
|
|
|
OPTION_SET_UINT,
|
2009-04-20 17:00:56 +04:00
|
|
|
OPTION_SET_PTR,
|
|
|
|
/* options with arguments (usually) */
|
|
|
|
OPTION_STRING,
|
|
|
|
OPTION_INTEGER,
|
2009-06-03 13:24:33 +04:00
|
|
|
OPTION_LONG,
|
2009-04-20 17:00:56 +04:00
|
|
|
OPTION_CALLBACK,
|
2010-05-17 19:16:48 +04:00
|
|
|
OPTION_U64,
|
2010-05-17 22:30:00 +04:00
|
|
|
OPTION_UINTEGER,
|
2009-04-20 17:00:56 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
enum parse_opt_flags {
|
|
|
|
PARSE_OPT_KEEP_DASHDASH = 1,
|
|
|
|
PARSE_OPT_STOP_AT_NON_OPTION = 2,
|
|
|
|
PARSE_OPT_KEEP_ARGV0 = 4,
|
|
|
|
PARSE_OPT_KEEP_UNKNOWN = 8,
|
|
|
|
PARSE_OPT_NO_INTERNAL_HELP = 16,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum parse_opt_option_flags {
|
|
|
|
PARSE_OPT_OPTARG = 1,
|
|
|
|
PARSE_OPT_NOARG = 2,
|
|
|
|
PARSE_OPT_NONEG = 4,
|
|
|
|
PARSE_OPT_HIDDEN = 8,
|
|
|
|
PARSE_OPT_LASTARG_DEFAULT = 16,
|
2014-10-22 19:15:45 +04:00
|
|
|
PARSE_OPT_DISABLED = 32,
|
2014-10-22 19:15:48 +04:00
|
|
|
PARSE_OPT_EXCLUSIVE = 64,
|
2015-03-13 15:51:54 +03:00
|
|
|
PARSE_OPT_NOEMPTY = 128,
|
perf tools: Make options always available, even if required libs not linked
This patch keeps options of perf builtins same in all conditions. If
one option is disabled because of compiling options, users should be
notified.
Masami suggested another implementation in [1] that, by adding a
OPTION_NEXT_DEPENDS option before those options in the 'struct option'
array, options parser knows an option is disabled. However, in some
cases this array is reordered (options__order()). In addition, in
parse-option.c that array is const, so we can't simply merge
information in decorator option into the affacted option.
This patch chooses a simpler implementation that, introducing a
set_option_nobuild() function and two option parsing flags. Builtins
with such options should call set_option_nobuild() before option
parsing. The complexity of this patch is because we want some of options
can be skipped safely. In this case their arguments should also be
consumed.
Options in 'perf record' and 'perf probe' are fixed in this patch.
[1] http://lkml.kernel.org/g/50399556C9727B4D88A595C8584AAB3752627CD4@GSjpTKYDCembx32.service.hitachi.net
Test result:
Normal case:
# ./perf probe --vmlinux /tmp/vmlinux sys_write
Added new event:
probe:sys_write (on sys_write)
You can now use it in all perf tools, such as:
perf record -e probe:sys_write -aR sleep 1
Build with NO_DWARF=1:
# ./perf probe -L sys_write
Error: switch `L' is not available because NO_DWARF=1
Usage: perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]
or: perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]
or: perf probe [<options>] --del '[GROUP:]EVENT' ...
or: perf probe --list [GROUP:]EVENT ...
or: perf probe [<options>] --funcs
-L, --line <FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]>
Show source code lines.
(not built-in because NO_DWARF=1)
# ./perf probe -k /tmp/vmlinux sys_write
Warning: switch `k' is being ignored because NO_DWARF=1
Added new event:
probe:sys_write (on sys_write)
You can now use it in all perf tools, such as:
perf record -e probe:sys_write -aR sleep 1
# ./perf probe --vmlinux /tmp/vmlinux sys_write
Warning: option `vmlinux' is being ignored because NO_DWARF=1
Added new event:
[SNIP]
# ./perf probe -l
Usage: perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]
or: perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]
...
-k, --vmlinux <file> vmlinux pathname
(not built-in because NO_DWARF=1)
-L, --line <FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]>
Show source code lines.
(not built-in because NO_DWARF=1)
...
-V, --vars <FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT>
Show accessible variables on PROBEDEF
(not built-in because NO_DWARF=1)
--externs Show external variables too (with --vars only)
(not built-in because NO_DWARF=1)
--no-inlines Don't search inlined functions
(not built-in because NO_DWARF=1)
--range Show variables location range in scope (with --vars only)
(not built-in because NO_DWARF=1)
Signed-off-by: Wang Nan <wangnan0@huawei.com>
Tested-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Cc: Alexei Starovoitov <ast@kernel.org>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Zefan Li <lizefan@huawei.com>
Cc: pi3orama@163.com
Link: http://lkml.kernel.org/r/1450089563-122430-14-git-send-email-wangnan0@huawei.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
2015-12-14 13:39:22 +03:00
|
|
|
PARSE_OPT_NOBUILD = 256,
|
|
|
|
PARSE_OPT_CANSKIP = 512,
|
2009-04-20 17:00:56 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
struct option;
|
|
|
|
typedef int parse_opt_cb(const struct option *, const char *arg, int unset);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* `type`::
|
|
|
|
* holds the type of the option, you must have an OPTION_END last in your
|
|
|
|
* array.
|
|
|
|
*
|
|
|
|
* `short_name`::
|
|
|
|
* the character to use as a short option name, '\0' if none.
|
|
|
|
*
|
|
|
|
* `long_name`::
|
|
|
|
* the long option name, without the leading dashes, NULL if none.
|
|
|
|
*
|
|
|
|
* `value`::
|
|
|
|
* stores pointers to the values to be filled.
|
|
|
|
*
|
|
|
|
* `argh`::
|
|
|
|
* token to explain the kind of argument this option wants. Keep it
|
|
|
|
* homogenous across the repository.
|
|
|
|
*
|
|
|
|
* `help`::
|
|
|
|
* the short help associated to what the option does.
|
|
|
|
* Must never be NULL (except for OPTION_END).
|
|
|
|
* OPTION_GROUP uses this pointer to store the group header.
|
|
|
|
*
|
|
|
|
* `flags`::
|
|
|
|
* mask of parse_opt_option_flags.
|
|
|
|
* PARSE_OPT_OPTARG: says that the argument is optionnal (not for BOOLEANs)
|
|
|
|
* PARSE_OPT_NOARG: says that this option takes no argument, for CALLBACKs
|
|
|
|
* PARSE_OPT_NONEG: says that this option cannot be negated
|
|
|
|
* PARSE_OPT_HIDDEN this option is skipped in the default usage, showed in
|
|
|
|
* the long one.
|
|
|
|
*
|
|
|
|
* `callback`::
|
|
|
|
* pointer to the callback to use for OPTION_CALLBACK.
|
|
|
|
*
|
|
|
|
* `defval`::
|
|
|
|
* default value to fill (*->value) with for PARSE_OPT_OPTARG.
|
2010-05-17 23:22:41 +04:00
|
|
|
* OPTION_{BIT,SET_UINT,SET_PTR} store the {mask,integer,pointer} to put in
|
2009-04-20 17:00:56 +04:00
|
|
|
* the value when met.
|
|
|
|
* CALLBACKS can use it like they want.
|
2013-11-18 13:55:56 +04:00
|
|
|
*
|
|
|
|
* `set`::
|
|
|
|
* whether an option was set by the user
|
2009-04-20 17:00:56 +04:00
|
|
|
*/
|
|
|
|
struct option {
|
|
|
|
enum parse_opt_type type;
|
|
|
|
int short_name;
|
|
|
|
const char *long_name;
|
|
|
|
void *value;
|
|
|
|
const char *argh;
|
|
|
|
const char *help;
|
perf tools: Make options always available, even if required libs not linked
This patch keeps options of perf builtins same in all conditions. If
one option is disabled because of compiling options, users should be
notified.
Masami suggested another implementation in [1] that, by adding a
OPTION_NEXT_DEPENDS option before those options in the 'struct option'
array, options parser knows an option is disabled. However, in some
cases this array is reordered (options__order()). In addition, in
parse-option.c that array is const, so we can't simply merge
information in decorator option into the affacted option.
This patch chooses a simpler implementation that, introducing a
set_option_nobuild() function and two option parsing flags. Builtins
with such options should call set_option_nobuild() before option
parsing. The complexity of this patch is because we want some of options
can be skipped safely. In this case their arguments should also be
consumed.
Options in 'perf record' and 'perf probe' are fixed in this patch.
[1] http://lkml.kernel.org/g/50399556C9727B4D88A595C8584AAB3752627CD4@GSjpTKYDCembx32.service.hitachi.net
Test result:
Normal case:
# ./perf probe --vmlinux /tmp/vmlinux sys_write
Added new event:
probe:sys_write (on sys_write)
You can now use it in all perf tools, such as:
perf record -e probe:sys_write -aR sleep 1
Build with NO_DWARF=1:
# ./perf probe -L sys_write
Error: switch `L' is not available because NO_DWARF=1
Usage: perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]
or: perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]
or: perf probe [<options>] --del '[GROUP:]EVENT' ...
or: perf probe --list [GROUP:]EVENT ...
or: perf probe [<options>] --funcs
-L, --line <FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]>
Show source code lines.
(not built-in because NO_DWARF=1)
# ./perf probe -k /tmp/vmlinux sys_write
Warning: switch `k' is being ignored because NO_DWARF=1
Added new event:
probe:sys_write (on sys_write)
You can now use it in all perf tools, such as:
perf record -e probe:sys_write -aR sleep 1
# ./perf probe --vmlinux /tmp/vmlinux sys_write
Warning: option `vmlinux' is being ignored because NO_DWARF=1
Added new event:
[SNIP]
# ./perf probe -l
Usage: perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]
or: perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]
...
-k, --vmlinux <file> vmlinux pathname
(not built-in because NO_DWARF=1)
-L, --line <FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]>
Show source code lines.
(not built-in because NO_DWARF=1)
...
-V, --vars <FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT>
Show accessible variables on PROBEDEF
(not built-in because NO_DWARF=1)
--externs Show external variables too (with --vars only)
(not built-in because NO_DWARF=1)
--no-inlines Don't search inlined functions
(not built-in because NO_DWARF=1)
--range Show variables location range in scope (with --vars only)
(not built-in because NO_DWARF=1)
Signed-off-by: Wang Nan <wangnan0@huawei.com>
Tested-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Cc: Alexei Starovoitov <ast@kernel.org>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Zefan Li <lizefan@huawei.com>
Cc: pi3orama@163.com
Link: http://lkml.kernel.org/r/1450089563-122430-14-git-send-email-wangnan0@huawei.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
2015-12-14 13:39:22 +03:00
|
|
|
const char *build_opt;
|
2009-04-20 17:00:56 +04:00
|
|
|
|
|
|
|
int flags;
|
|
|
|
parse_opt_cb *callback;
|
|
|
|
intptr_t defval;
|
2013-11-18 13:55:56 +04:00
|
|
|
bool *set;
|
2014-07-14 14:02:54 +04:00
|
|
|
void *data;
|
2016-10-24 06:00:02 +03:00
|
|
|
const struct option *parent;
|
2009-04-20 17:00:56 +04:00
|
|
|
};
|
|
|
|
|
2010-05-17 22:39:16 +04:00
|
|
|
#define check_vtype(v, type) ( BUILD_BUG_ON_ZERO(!__builtin_types_compatible_p(typeof(v), type)) + v )
|
|
|
|
|
2009-07-01 14:37:06 +04:00
|
|
|
#define OPT_END() { .type = OPTION_END }
|
2016-10-24 06:00:02 +03:00
|
|
|
#define OPT_PARENT(p) { .type = OPTION_END, .parent = (p) }
|
2009-07-01 14:37:06 +04:00
|
|
|
#define OPT_ARGUMENT(l, h) { .type = OPTION_ARGUMENT, .long_name = (l), .help = (h) }
|
|
|
|
#define OPT_GROUP(h) { .type = OPTION_GROUP, .help = (h) }
|
2010-05-17 23:22:41 +04:00
|
|
|
#define OPT_BIT(s, l, v, h, b) { .type = OPTION_BIT, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h), .defval = (b) }
|
2010-05-17 22:51:10 +04:00
|
|
|
#define OPT_BOOLEAN(s, l, v, h) { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h) }
|
2015-10-24 18:49:25 +03:00
|
|
|
#define OPT_BOOLEAN_FLAG(s, l, v, h, f) { .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), .value = check_vtype(v, bool *), .help = (h), .flags = (f) }
|
2013-11-18 13:55:56 +04:00
|
|
|
#define OPT_BOOLEAN_SET(s, l, v, os, h) \
|
|
|
|
{ .type = OPTION_BOOLEAN, .short_name = (s), .long_name = (l), \
|
|
|
|
.value = check_vtype(v, bool *), .help = (h), \
|
|
|
|
.set = check_vtype(os, bool *)}
|
2010-05-17 23:22:41 +04:00
|
|
|
#define OPT_INCR(s, l, v, h) { .type = OPTION_INCR, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
|
|
|
|
#define OPT_SET_UINT(s, l, v, h, i) { .type = OPTION_SET_UINT, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h), .defval = (i) }
|
2009-07-01 14:37:06 +04:00
|
|
|
#define OPT_SET_PTR(s, l, v, h, p) { .type = OPTION_SET_PTR, .short_name = (s), .long_name = (l), .value = (v), .help = (h), .defval = (p) }
|
2010-05-17 22:39:16 +04:00
|
|
|
#define OPT_INTEGER(s, l, v, h) { .type = OPTION_INTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, int *), .help = (h) }
|
|
|
|
#define OPT_UINTEGER(s, l, v, h) { .type = OPTION_UINTEGER, .short_name = (s), .long_name = (l), .value = check_vtype(v, unsigned int *), .help = (h) }
|
2010-05-17 23:22:41 +04:00
|
|
|
#define OPT_LONG(s, l, v, h) { .type = OPTION_LONG, .short_name = (s), .long_name = (l), .value = check_vtype(v, long *), .help = (h) }
|
|
|
|
#define OPT_U64(s, l, v, h) { .type = OPTION_U64, .short_name = (s), .long_name = (l), .value = check_vtype(v, u64 *), .help = (h) }
|
2017-01-13 15:56:23 +03:00
|
|
|
#define OPT_STRING(s, l, v, a, h) { .type = OPTION_STRING, .short_name = (s), .long_name = (l), .value = check_vtype(v, const char **), .argh = (a), .help = (h) }
|
2015-04-30 17:37:32 +03:00
|
|
|
#define OPT_STRING_OPTARG(s, l, v, a, h, d) \
|
|
|
|
{ .type = OPTION_STRING, .short_name = (s), .long_name = (l), \
|
2017-01-13 15:56:23 +03:00
|
|
|
.value = check_vtype(v, const char **), .argh =(a), .help = (h), \
|
2015-04-30 17:37:32 +03:00
|
|
|
.flags = PARSE_OPT_OPTARG, .defval = (intptr_t)(d) }
|
2017-01-03 11:19:54 +03:00
|
|
|
#define OPT_STRING_OPTARG_SET(s, l, v, os, a, h, d) \
|
|
|
|
{ .type = OPTION_STRING, .short_name = (s), .long_name = (l), \
|
2017-01-13 15:56:23 +03:00
|
|
|
.value = check_vtype(v, const char **), .argh = (a), .help = (h), \
|
2017-01-03 11:19:54 +03:00
|
|
|
.flags = PARSE_OPT_OPTARG, .defval = (intptr_t)(d), \
|
|
|
|
.set = check_vtype(os, bool *)}
|
2017-01-13 15:56:23 +03:00
|
|
|
#define OPT_STRING_NOEMPTY(s, l, v, a, h) { .type = OPTION_STRING, .short_name = (s), .long_name = (l), .value = check_vtype(v, const char **), .argh = (a), .help = (h), .flags = PARSE_OPT_NOEMPTY}
|
2009-04-20 17:00:56 +04:00
|
|
|
#define OPT_DATE(s, l, v, h) \
|
2009-07-01 14:37:06 +04:00
|
|
|
{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = "time", .help = (h), .callback = parse_opt_approxidate_cb }
|
2009-04-20 17:00:56 +04:00
|
|
|
#define OPT_CALLBACK(s, l, v, a, h, f) \
|
2017-01-13 15:56:23 +03:00
|
|
|
{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f) }
|
2009-09-12 09:52:54 +04:00
|
|
|
#define OPT_CALLBACK_NOOPT(s, l, v, a, h, f) \
|
2017-01-13 15:56:23 +03:00
|
|
|
{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f), .flags = PARSE_OPT_NOARG }
|
2009-07-02 19:58:20 +04:00
|
|
|
#define OPT_CALLBACK_DEFAULT(s, l, v, a, h, f, d) \
|
2017-01-13 15:56:23 +03:00
|
|
|
{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), .value = (v), .argh = (a), .help = (h), .callback = (f), .defval = (intptr_t)d, .flags = PARSE_OPT_LASTARG_DEFAULT }
|
2010-12-03 06:58:53 +03:00
|
|
|
#define OPT_CALLBACK_DEFAULT_NOOPT(s, l, v, a, h, f, d) \
|
|
|
|
{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l),\
|
2017-01-13 15:56:23 +03:00
|
|
|
.value = (v), .arg = (a), .help = (h), .callback = (f), .defval = (intptr_t)d,\
|
2010-12-03 06:58:53 +03:00
|
|
|
.flags = PARSE_OPT_LASTARG_DEFAULT | PARSE_OPT_NOARG}
|
2014-07-14 14:02:54 +04:00
|
|
|
#define OPT_CALLBACK_OPTARG(s, l, v, d, a, h, f) \
|
|
|
|
{ .type = OPTION_CALLBACK, .short_name = (s), .long_name = (l), \
|
2017-01-13 15:56:23 +03:00
|
|
|
.value = (v), .argh = (a), .help = (h), .callback = (f), \
|
2014-07-14 14:02:54 +04:00
|
|
|
.flags = PARSE_OPT_OPTARG, .data = (d) }
|
2009-04-20 17:00:56 +04:00
|
|
|
|
|
|
|
/* parse_options() will filter out the processed options and leave the
|
|
|
|
* non-option argments in argv[].
|
|
|
|
* Returns the number of arguments left in argv[].
|
2015-12-15 18:39:34 +03:00
|
|
|
*
|
|
|
|
* NOTE: parse_options() and parse_options_subcommand() may call exit() in the
|
|
|
|
* case of an error (or for 'special' options like --list-cmds or --list-opts).
|
2009-04-20 17:00:56 +04:00
|
|
|
*/
|
|
|
|
extern int parse_options(int argc, const char **argv,
|
|
|
|
const struct option *options,
|
|
|
|
const char * const usagestr[], int flags);
|
|
|
|
|
2014-03-04 05:26:36 +04:00
|
|
|
extern int parse_options_subcommand(int argc, const char **argv,
|
|
|
|
const struct option *options,
|
|
|
|
const char *const subcommands[],
|
|
|
|
const char *usagestr[], int flags);
|
|
|
|
|
2009-04-20 17:00:56 +04:00
|
|
|
extern NORETURN void usage_with_options(const char * const *usagestr,
|
|
|
|
const struct option *options);
|
2015-10-24 18:49:27 +03:00
|
|
|
extern NORETURN __attribute__((format(printf,3,4)))
|
|
|
|
void usage_with_options_msg(const char * const *usagestr,
|
|
|
|
const struct option *options,
|
|
|
|
const char *fmt, ...);
|
2009-04-20 17:00:56 +04:00
|
|
|
|
|
|
|
/*----- incremantal advanced APIs -----*/
|
|
|
|
|
|
|
|
enum {
|
|
|
|
PARSE_OPT_HELP = -1,
|
|
|
|
PARSE_OPT_DONE,
|
2014-03-04 05:26:36 +04:00
|
|
|
PARSE_OPT_LIST_OPTS,
|
|
|
|
PARSE_OPT_LIST_SUBCMDS,
|
2009-04-20 17:00:56 +04:00
|
|
|
PARSE_OPT_UNKNOWN,
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* It's okay for the caller to consume argv/argc in the usual way.
|
|
|
|
* Other fields of that structure are private to parse-options and should not
|
|
|
|
* be modified in any way.
|
|
|
|
*/
|
|
|
|
struct parse_opt_ctx_t {
|
|
|
|
const char **argv;
|
|
|
|
const char **out;
|
|
|
|
int argc, cpidx;
|
|
|
|
const char *opt;
|
2014-10-22 19:15:48 +04:00
|
|
|
const struct option *excl_opt;
|
2009-04-20 17:00:56 +04:00
|
|
|
int flags;
|
|
|
|
};
|
|
|
|
|
|
|
|
extern int parse_options_usage(const char * const *usagestr,
|
2013-11-01 11:33:11 +04:00
|
|
|
const struct option *opts,
|
|
|
|
const char *optstr,
|
|
|
|
bool short_opt);
|
2009-04-20 17:00:56 +04:00
|
|
|
|
|
|
|
|
|
|
|
/*----- some often used options -----*/
|
|
|
|
extern int parse_opt_abbrev_cb(const struct option *, const char *, int);
|
|
|
|
extern int parse_opt_approxidate_cb(const struct option *, const char *, int);
|
|
|
|
extern int parse_opt_verbosity_cb(const struct option *, const char *, int);
|
|
|
|
|
|
|
|
#define OPT__VERBOSE(var) OPT_BOOLEAN('v', "verbose", (var), "be verbose")
|
|
|
|
#define OPT__QUIET(var) OPT_BOOLEAN('q', "quiet", (var), "be quiet")
|
|
|
|
#define OPT__VERBOSITY(var) \
|
|
|
|
{ OPTION_CALLBACK, 'v', "verbose", (var), NULL, "be more verbose", \
|
|
|
|
PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
|
|
|
|
{ OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
|
|
|
|
PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
|
|
|
|
#define OPT__DRY_RUN(var) OPT_BOOLEAN('n', "dry-run", (var), "dry run")
|
|
|
|
#define OPT__ABBREV(var) \
|
|
|
|
{ OPTION_CALLBACK, 0, "abbrev", (var), "n", \
|
|
|
|
"use <n> digits to display SHA-1s", \
|
|
|
|
PARSE_OPT_OPTARG, &parse_opt_abbrev_cb, 0 }
|
|
|
|
|
|
|
|
extern const char *parse_options_fix_filename(const char *prefix, const char *file);
|
|
|
|
|
2014-10-22 19:15:45 +04:00
|
|
|
void set_option_flag(struct option *opts, int sopt, const char *lopt, int flag);
|
perf tools: Make options always available, even if required libs not linked
This patch keeps options of perf builtins same in all conditions. If
one option is disabled because of compiling options, users should be
notified.
Masami suggested another implementation in [1] that, by adding a
OPTION_NEXT_DEPENDS option before those options in the 'struct option'
array, options parser knows an option is disabled. However, in some
cases this array is reordered (options__order()). In addition, in
parse-option.c that array is const, so we can't simply merge
information in decorator option into the affacted option.
This patch chooses a simpler implementation that, introducing a
set_option_nobuild() function and two option parsing flags. Builtins
with such options should call set_option_nobuild() before option
parsing. The complexity of this patch is because we want some of options
can be skipped safely. In this case their arguments should also be
consumed.
Options in 'perf record' and 'perf probe' are fixed in this patch.
[1] http://lkml.kernel.org/g/50399556C9727B4D88A595C8584AAB3752627CD4@GSjpTKYDCembx32.service.hitachi.net
Test result:
Normal case:
# ./perf probe --vmlinux /tmp/vmlinux sys_write
Added new event:
probe:sys_write (on sys_write)
You can now use it in all perf tools, such as:
perf record -e probe:sys_write -aR sleep 1
Build with NO_DWARF=1:
# ./perf probe -L sys_write
Error: switch `L' is not available because NO_DWARF=1
Usage: perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]
or: perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]
or: perf probe [<options>] --del '[GROUP:]EVENT' ...
or: perf probe --list [GROUP:]EVENT ...
or: perf probe [<options>] --funcs
-L, --line <FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]>
Show source code lines.
(not built-in because NO_DWARF=1)
# ./perf probe -k /tmp/vmlinux sys_write
Warning: switch `k' is being ignored because NO_DWARF=1
Added new event:
probe:sys_write (on sys_write)
You can now use it in all perf tools, such as:
perf record -e probe:sys_write -aR sleep 1
# ./perf probe --vmlinux /tmp/vmlinux sys_write
Warning: option `vmlinux' is being ignored because NO_DWARF=1
Added new event:
[SNIP]
# ./perf probe -l
Usage: perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]
or: perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]
...
-k, --vmlinux <file> vmlinux pathname
(not built-in because NO_DWARF=1)
-L, --line <FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]>
Show source code lines.
(not built-in because NO_DWARF=1)
...
-V, --vars <FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT>
Show accessible variables on PROBEDEF
(not built-in because NO_DWARF=1)
--externs Show external variables too (with --vars only)
(not built-in because NO_DWARF=1)
--no-inlines Don't search inlined functions
(not built-in because NO_DWARF=1)
--range Show variables location range in scope (with --vars only)
(not built-in because NO_DWARF=1)
Signed-off-by: Wang Nan <wangnan0@huawei.com>
Tested-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Cc: Alexei Starovoitov <ast@kernel.org>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Zefan Li <lizefan@huawei.com>
Cc: pi3orama@163.com
Link: http://lkml.kernel.org/r/1450089563-122430-14-git-send-email-wangnan0@huawei.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
2015-12-14 13:39:22 +03:00
|
|
|
void set_option_nobuild(struct option *opts, int shortopt, const char *longopt,
|
|
|
|
const char *build_opt, bool can_skip);
|
2015-12-15 18:39:40 +03:00
|
|
|
|
|
|
|
#endif /* __SUBCMD_PARSE_OPTIONS_H */
|