Skip to content

Commit 4682286

Browse files
committed
seccomp: Add missing kerndoc notations
The kerndoc for some struct member and function arguments were missing. Add them. Cc: Andy Lutomirski <[email protected]> Cc: Will Drewry <[email protected]> Reported-by: kernel test robot <[email protected]> Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/ Signed-off-by: Kees Cook <[email protected]>
1 parent 4697b58 commit 4682286

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

kernel/seccomp.c

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,13 @@ struct seccomp_knotif {
110110
* @flags: The flags for the new file descriptor. At the moment, only O_CLOEXEC
111111
* is allowed.
112112
* @ioctl_flags: The flags used for the seccomp_addfd ioctl.
113+
* @setfd: whether or not SECCOMP_ADDFD_FLAG_SETFD was set during notify_addfd
113114
* @ret: The return value of the installing process. It is set to the fd num
114115
* upon success (>= 0).
115116
* @completion: Indicates that the installing process has completed fd
116117
* installation, or gone away (either due to successful
117118
* reply, or signal)
119+
* @list: list_head for chaining seccomp_kaddfd together.
118120
*
119121
*/
120122
struct seccomp_kaddfd {
@@ -138,12 +140,12 @@ struct seccomp_kaddfd {
138140
* structure is fairly large, we store the notification-specific stuff in a
139141
* separate structure.
140142
*
141-
* @request: A semaphore that users of this notification can wait on for
142-
* changes. Actual reads and writes are still controlled with
143-
* filter->notify_lock.
143+
* @requests: A semaphore that users of this notification can wait on for
144+
* changes. Actual reads and writes are still controlled with
145+
* filter->notify_lock.
146+
* @flags: A set of SECCOMP_USER_NOTIF_FD_* flags.
144147
* @next_id: The id of the next request.
145148
* @notifications: A list of struct seccomp_knotif elements.
146-
* @flags: A set of SECCOMP_USER_NOTIF_FD_* flags.
147149
*/
148150

149151
struct notification {
@@ -558,6 +560,8 @@ static void __seccomp_filter_release(struct seccomp_filter *orig)
558560
* drop its reference count, and notify
559561
* about unused filters
560562
*
563+
* @tsk: task the filter should be released from.
564+
*
561565
* This function should only be called when the task is exiting as
562566
* it detaches it from its filter tree. As such, READ_ONCE() and
563567
* barriers are not needed here, as would normally be needed.
@@ -577,6 +581,8 @@ void seccomp_filter_release(struct task_struct *tsk)
577581
/**
578582
* seccomp_sync_threads: sets all threads to use current's filter
579583
*
584+
* @flags: SECCOMP_FILTER_FLAG_* flags to set during sync.
585+
*
580586
* Expects sighand and cred_guard_mutex locks to be held, and for
581587
* seccomp_can_sync_threads() to have returned success already
582588
* without dropping the locks.

0 commit comments

Comments
 (0)