Skip to content

Commit 68d9bf1

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 <tobias.deiminger@linutronix.de>
1 parent a876ef7 commit 68d9bf1

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

kernel/trace/trace_events.c

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -764,6 +764,9 @@ 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-HKey: TBD
769+
* SPDX-Req-Text:
767770
* __ftrace_event_enable_disable - enable or disable a trace event
768771
* @file: trace event file associated with the event.
769772
* @enable: 0 or 1 respectively to disable/enable the event.
@@ -814,6 +817,8 @@ void trace_event_enable_tgid_record(bool enable)
814817
* Return:
815818
* * 0 on success
816819
* * any error returned by the event register or unregister callbacks
820+
*
821+
* SPDX-Req-End
817822
*/
818823
static int __ftrace_event_enable_disable(struct trace_event_file *file,
819824
int enable, int soft_disable)
@@ -1349,6 +1354,9 @@ static void remove_event_file_dir(struct trace_event_file *file)
13491354
}
13501355

13511356
/**
1357+
* SPDX-Req-ID: kernel/trace/trace_events.c:__ftrace_set_clr_event_nolock
1358+
* SPDX-Req-HKey: TBD
1359+
* SPDX-Req-Text:
13521360
* __ftrace_set_clr_event_nolock - enable or disable an event within a system.
13531361
* @tr: target trace_array containing the events list.
13541362
* @match: target system or event name (NULL for any).
@@ -1388,6 +1396,8 @@ static void remove_event_file_dir(struct trace_event_file *file)
13881396
* * %-ENOMEM - memory allocation fails for the module pointer
13891397
* * any value returned by the first call to ftrace_event_enable_disable that
13901398
* returned an error
1399+
*
1400+
* SPDX-Req-End
13911401
*/
13921402
static int
13931403
__ftrace_set_clr_event_nolock(struct trace_array *tr, const char *match,
@@ -1530,6 +1540,9 @@ int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set)
15301540
}
15311541

15321542
/**
1543+
* SPDX-Req-ID: kernel/trace/trace_events.c:trace_set_clr_event
1544+
* SPDX-Req-HKey: TBD
1545+
* SPDX-Req-Text:
15331546
* trace_set_clr_event - enable or disable an event within a system.
15341547
* @system: system name (NULL for any system).
15351548
* @event: event name (NULL for all events, within system).
@@ -1556,6 +1569,8 @@ int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set)
15561569
* * 0 on success
15571570
* * %-ENODEV - the global tracer cannot be retrieved
15581571
* * any other error condition returned by __ftrace_set_clr_event_nolock
1572+
*
1573+
* SPDX-Req-End
15591574
*/
15601575
int trace_set_clr_event(const char *system, const char *event, int set)
15611576
{
@@ -1569,6 +1584,9 @@ int trace_set_clr_event(const char *system, const char *event, int set)
15691584
EXPORT_SYMBOL_GPL(trace_set_clr_event);
15701585

15711586
/**
1587+
* SPDX-Req-ID: kernel/trace/trace_events.c:trace_array_set_clr_event
1588+
* SPDX-Req-HKey: TBD
1589+
* SPDX-Req-Text:
15721590
* trace_array_set_clr_event - enable or disable an event within a system for
15731591
* a trace array.
15741592
* @tr: input trace array.
@@ -1590,6 +1608,8 @@ EXPORT_SYMBOL_GPL(trace_set_clr_event);
15901608
* * 0 on success
15911609
* * %-ENOENT - the input tr is NULL
15921610
* * any other error condition returned by __ftrace_set_clr_event_nolock
1611+
*
1612+
* SPDX-Req-End
15931613
*/
15941614
int trace_array_set_clr_event(struct trace_array *tr, const char *system,
15951615
const char *event, bool enable)
@@ -1888,6 +1908,9 @@ static void p_stop(struct seq_file *m, void *p)
18881908
}
18891909

18901910
/**
1911+
* SPDX-Req-ID: kernel/trace/trace_events.c:event_enable_read
1912+
* SPDX-Req-HKey: TBD
1913+
* SPDX-Req-Text:
18911914
* event_enable_read - read from a trace event file to retrieve its status.
18921915
* @filp: file pointer associated with the target trace event.
18931916
* @ubuf: user space buffer where the event status is copied to.
@@ -1929,6 +1952,8 @@ static void p_stop(struct seq_file *m, void *p)
19291952
* * the number of copied bytes on success
19301953
* * %-ENODEV - the event file cannot be retrieved from the input filp
19311954
* * any error returned by simple_read_from_buffer
1955+
*
1956+
* SPDX-Req-End
19321957
*/
19331958
static ssize_t
19341959
event_enable_read(struct file *filp, char __user *ubuf, size_t cnt,
@@ -1960,6 +1985,9 @@ event_enable_read(struct file *filp, char __user *ubuf, size_t cnt,
19601985
}
19611986

19621987
/**
1988+
* SPDX-Req-ID: kernel/trace/trace_events.c:event_enable_write
1989+
* SPDX-Req-HKey: TBD
1990+
* SPDX-Req-Text:
19631991
* event_enable_write - write to a trace event file to enable/disable it.
19641992
* @filp: file pointer associated with the target trace event.
19651993
* @ubuf: user space buffer where the enable/disable value is copied from.
@@ -1999,6 +2027,8 @@ event_enable_read(struct file *filp, char __user *ubuf, size_t cnt,
19992027
* * any error returned by ftrace_event_enable_disable
20002028
* * %-EINVAL - the value copied from the user space ubuf is different
20012029
* from 0 or 1
2030+
*
2031+
* SPDX-Req-End
20022032
*/
20032033
static ssize_t
20042034
event_enable_write(struct file *filp, const char __user *ubuf, size_t cnt,

0 commit comments

Comments
 (0)