Skip to content

Commit 9df9595

Browse files
committed
tracing: Requirement templatification
This follows the example from [1]. [1] https://github.com/elisa-tech/linux/blob/linux_requirements_wip/kernel/trace/trace_events.c Signed-off-by: Tobias Deiminger <[email protected]>
1 parent 4a68af8 commit 9df9595

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

kernel/trace/trace_events.c

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -764,6 +764,8 @@ void trace_event_enable_tgid_record(bool enable)
764764
}
765765

766766
/**
767+
* SPDX-Req-ID: kernel/trace/trace_events.c:__ftrace_event_enable_disable
768+
* SPDX-Req-Text:
767769
* __ftrace_event_enable_disable - enable or disable a trace event
768770
* @file: trace event file associated with the event.
769771
* @enable: 0 or 1 respectively to disable/enable the event.
@@ -814,6 +816,8 @@ void trace_event_enable_tgid_record(bool enable)
814816
* Return:
815817
* * 0 on success
816818
* * any error returned by the event register or unregister callbacks
819+
*
820+
* SPDX-Req-End
817821
*/
818822
static int __ftrace_event_enable_disable(struct trace_event_file *file,
819823
int enable, int soft_disable)
@@ -1349,6 +1353,8 @@ static void remove_event_file_dir(struct trace_event_file *file)
13491353
}
13501354

13511355
/**
1356+
* SPDX-Req-ID: kernel/trace/trace_events.c:__ftrace_set_clr_event_nolock
1357+
* SPDX-Req-Text:
13521358
* __ftrace_set_clr_event_nolock - enable or disable an event within a system.
13531359
* @tr: target trace_array containing the events list.
13541360
* @match: target system or event name (NULL for any).
@@ -1388,6 +1394,8 @@ static void remove_event_file_dir(struct trace_event_file *file)
13881394
* * %-ENOMEM - memory allocation fails for the module pointer
13891395
* * any value returned by the first call to ftrace_event_enable_disable that
13901396
* returned an error
1397+
*
1398+
* SPDX-Req-End
13911399
*/
13921400
static int
13931401
__ftrace_set_clr_event_nolock(struct trace_array *tr, const char *match,
@@ -1530,6 +1538,8 @@ int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set)
15301538
}
15311539

15321540
/**
1541+
* SPDX-Req-ID: kernel/trace/trace_events.c:trace_set_clr_event
1542+
* SPDX-Req-Text:
15331543
* trace_set_clr_event - enable or disable an event within a system.
15341544
* @system: system name (NULL for any system).
15351545
* @event: event name (NULL for all events, within system).
@@ -1556,6 +1566,8 @@ int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set)
15561566
* * 0 on success
15571567
* * %-ENODEV - the global tracer cannot be retrieved
15581568
* * any other error condition returned by __ftrace_set_clr_event_nolock
1569+
*
1570+
* SPDX-Req-End
15591571
*/
15601572
int trace_set_clr_event(const char *system, const char *event, int set)
15611573
{
@@ -1569,6 +1581,8 @@ int trace_set_clr_event(const char *system, const char *event, int set)
15691581
EXPORT_SYMBOL_GPL(trace_set_clr_event);
15701582

15711583
/**
1584+
* SPDX-Req-ID: kernel/trace/trace_events.c:trace_array_set_clr_event
1585+
* SPDX-Req-Text:
15721586
* trace_array_set_clr_event - enable or disable an event within a system for
15731587
* a trace array.
15741588
* @tr: input trace array.
@@ -1590,6 +1604,8 @@ EXPORT_SYMBOL_GPL(trace_set_clr_event);
15901604
* * 0 on success
15911605
* * %-ENOENT - the input tr is NULL
15921606
* * any other error condition returned by __ftrace_set_clr_event_nolock
1607+
*
1608+
* SPDX-Req-End
15931609
*/
15941610
int trace_array_set_clr_event(struct trace_array *tr, const char *system,
15951611
const char *event, bool enable)
@@ -1888,6 +1904,8 @@ static void p_stop(struct seq_file *m, void *p)
18881904
}
18891905

18901906
/**
1907+
* SPDX-Req-ID: kernel/trace/trace_events.c:event_enable_read
1908+
* SPDX-Req-Text:
18911909
* event_enable_read - read from a trace event file to retrieve its status.
18921910
* @filp: file pointer associated with the target trace event.
18931911
* @ubuf: user space buffer where the event status is copied to.
@@ -1929,6 +1947,8 @@ static void p_stop(struct seq_file *m, void *p)
19291947
* * the number of copied bytes on success
19301948
* * %-ENODEV - the event file cannot be retrieved from the input filp
19311949
* * any error returned by simple_read_from_buffer
1950+
*
1951+
* SPDX-Req-End
19321952
*/
19331953
static ssize_t
19341954
event_enable_read(struct file *filp, char __user *ubuf, size_t cnt,
@@ -1960,6 +1980,8 @@ event_enable_read(struct file *filp, char __user *ubuf, size_t cnt,
19601980
}
19611981

19621982
/**
1983+
* SPDX-Req-ID: kernel/trace/trace_events.c:event_enable_write
1984+
* SPDX-Req-Text:
19631985
* event_enable_write - write to a trace event file to enable/disable it.
19641986
* @filp: file pointer associated with the target trace event.
19651987
* @ubuf: user space buffer where the enable/disable value is copied from.
@@ -1999,6 +2021,8 @@ event_enable_read(struct file *filp, char __user *ubuf, size_t cnt,
19992021
* * any error returned by ftrace_event_enable_disable
20002022
* * %-EINVAL - the value copied from the user space ubuf is different
20012023
* from 0 or 1
2024+
*
2025+
* SPDX-Req-End
20022026
*/
20032027
static ssize_t
20042028
event_enable_write(struct file *filp, const char __user *ubuf, size_t cnt,

0 commit comments

Comments
 (0)