Commit c561d110 authored by Tom Rix's avatar Tom Rix Committed by Andrii Nakryiko

bpf: Cleanup comments

Add leading space to spdx tag
Use // for spdx c file comment

Replacements
resereved to reserved
inbetween to in between
everytime to every time
intutivie to intuitive
currenct to current
encontered to encountered
referenceing to referencing
upto to up to
exectuted to executed
Signed-off-by: default avatarTom Rix <trix@redhat.com>
Signed-off-by: default avatarAndrii Nakryiko <andrii@kernel.org>
Acked-by: default avatarSong Liu <songliubraving@fb.com>
Link: https://lore.kernel.org/bpf/20220220184055.3608317-1-trix@redhat.com
parent 08894d9c
...@@ -136,7 +136,7 @@ bool bpf_selem_unlink_storage_nolock(struct bpf_local_storage *local_storage, ...@@ -136,7 +136,7 @@ bool bpf_selem_unlink_storage_nolock(struct bpf_local_storage *local_storage,
* will be done by the caller. * will be done by the caller.
* *
* Although the unlock will be done under * Although the unlock will be done under
* rcu_read_lock(), it is more intutivie to * rcu_read_lock(), it is more intuitive to
* read if the freeing of the storage is done * read if the freeing of the storage is done
* after the raw_spin_unlock_bh(&local_storage->lock). * after the raw_spin_unlock_bh(&local_storage->lock).
* *
......
/* SPDX-License-Identifier: GPL-2.0 */ // SPDX-License-Identifier: GPL-2.0
/* Copyright (c) 2018 Facebook */ /* Copyright (c) 2018 Facebook */
#include <uapi/linux/btf.h> #include <uapi/linux/btf.h>
...@@ -2547,7 +2547,7 @@ static int btf_ptr_resolve(struct btf_verifier_env *env, ...@@ -2547,7 +2547,7 @@ static int btf_ptr_resolve(struct btf_verifier_env *env,
* *
* We now need to continue from the last-resolved-ptr to * We now need to continue from the last-resolved-ptr to
* ensure the last-resolved-ptr will not referring back to * ensure the last-resolved-ptr will not referring back to
* the currenct ptr (t). * the current ptr (t).
*/ */
if (btf_type_is_modifier(next_type)) { if (btf_type_is_modifier(next_type)) {
const struct btf_type *resolved_type; const struct btf_type *resolved_type;
...@@ -6148,7 +6148,7 @@ int btf_type_snprintf_show(const struct btf *btf, u32 type_id, void *obj, ...@@ -6148,7 +6148,7 @@ int btf_type_snprintf_show(const struct btf *btf, u32 type_id, void *obj,
btf_type_show(btf, type_id, obj, (struct btf_show *)&ssnprintf); btf_type_show(btf, type_id, obj, (struct btf_show *)&ssnprintf);
/* If we encontered an error, return it. */ /* If we encountered an error, return it. */
if (ssnprintf.show.state.status) if (ssnprintf.show.state.status)
return ssnprintf.show.state.status; return ssnprintf.show.state.status;
......
...@@ -1031,7 +1031,7 @@ int cgroup_bpf_prog_query(const union bpf_attr *attr, ...@@ -1031,7 +1031,7 @@ int cgroup_bpf_prog_query(const union bpf_attr *attr,
* __cgroup_bpf_run_filter_skb() - Run a program for packet filtering * __cgroup_bpf_run_filter_skb() - Run a program for packet filtering
* @sk: The socket sending or receiving traffic * @sk: The socket sending or receiving traffic
* @skb: The skb that is being sent or received * @skb: The skb that is being sent or received
* @type: The type of program to be exectuted * @type: The type of program to be executed
* *
* If no socket is passed, or the socket is not of type INET or INET6, * If no socket is passed, or the socket is not of type INET or INET6,
* this function does nothing and returns 0. * this function does nothing and returns 0.
...@@ -1094,7 +1094,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_skb); ...@@ -1094,7 +1094,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_skb);
/** /**
* __cgroup_bpf_run_filter_sk() - Run a program on a sock * __cgroup_bpf_run_filter_sk() - Run a program on a sock
* @sk: sock structure to manipulate * @sk: sock structure to manipulate
* @type: The type of program to be exectuted * @type: The type of program to be executed
* *
* socket is passed is expected to be of type INET or INET6. * socket is passed is expected to be of type INET or INET6.
* *
...@@ -1119,7 +1119,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_sk); ...@@ -1119,7 +1119,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_sk);
* provided by user sockaddr * provided by user sockaddr
* @sk: sock struct that will use sockaddr * @sk: sock struct that will use sockaddr
* @uaddr: sockaddr struct provided by user * @uaddr: sockaddr struct provided by user
* @type: The type of program to be exectuted * @type: The type of program to be executed
* @t_ctx: Pointer to attach type specific context * @t_ctx: Pointer to attach type specific context
* @flags: Pointer to u32 which contains higher bits of BPF program * @flags: Pointer to u32 which contains higher bits of BPF program
* return value (OR'ed together). * return value (OR'ed together).
...@@ -1166,7 +1166,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_sock_addr); ...@@ -1166,7 +1166,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_sock_addr);
* @sock_ops: bpf_sock_ops_kern struct to pass to program. Contains * @sock_ops: bpf_sock_ops_kern struct to pass to program. Contains
* sk with connection information (IP addresses, etc.) May not contain * sk with connection information (IP addresses, etc.) May not contain
* cgroup info if it is a req sock. * cgroup info if it is a req sock.
* @type: The type of program to be exectuted * @type: The type of program to be executed
* *
* socket passed is expected to be of type INET or INET6. * socket passed is expected to be of type INET or INET6.
* *
......
...@@ -1636,7 +1636,7 @@ __htab_map_lookup_and_delete_batch(struct bpf_map *map, ...@@ -1636,7 +1636,7 @@ __htab_map_lookup_and_delete_batch(struct bpf_map *map,
value_size = size * num_possible_cpus(); value_size = size * num_possible_cpus();
total = 0; total = 0;
/* while experimenting with hash tables with sizes ranging from 10 to /* while experimenting with hash tables with sizes ranging from 10 to
* 1000, it was observed that a bucket can have upto 5 entries. * 1000, it was observed that a bucket can have up to 5 entries.
*/ */
bucket_size = 5; bucket_size = 5;
......
...@@ -1093,7 +1093,7 @@ struct bpf_hrtimer { ...@@ -1093,7 +1093,7 @@ struct bpf_hrtimer {
struct bpf_timer_kern { struct bpf_timer_kern {
struct bpf_hrtimer *timer; struct bpf_hrtimer *timer;
/* bpf_spin_lock is used here instead of spinlock_t to make /* bpf_spin_lock is used here instead of spinlock_t to make
* sure that it always fits into space resereved by struct bpf_timer * sure that it always fits into space reserved by struct bpf_timer
* regardless of LOCKDEP and spinlock debug flags. * regardless of LOCKDEP and spinlock debug flags.
*/ */
struct bpf_spin_lock lock; struct bpf_spin_lock lock;
......
//SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
#include <linux/bpf-cgroup.h> #include <linux/bpf-cgroup.h>
#include <linux/bpf.h> #include <linux/bpf.h>
#include <linux/bpf_local_storage.h> #include <linux/bpf_local_storage.h>
......
...@@ -143,7 +143,7 @@ static void reuseport_array_free(struct bpf_map *map) ...@@ -143,7 +143,7 @@ static void reuseport_array_free(struct bpf_map *map)
/* /*
* Once reaching here, all sk->sk_user_data is not * Once reaching here, all sk->sk_user_data is not
* referenceing this "array". "array" can be freed now. * referencing this "array". "array" can be freed now.
*/ */
bpf_map_area_free(array); bpf_map_area_free(array);
} }
......
...@@ -2566,7 +2566,7 @@ static int bpf_link_alloc_id(struct bpf_link *link) ...@@ -2566,7 +2566,7 @@ static int bpf_link_alloc_id(struct bpf_link *link)
* pre-allocated resources are to be freed with bpf_cleanup() call. All the * pre-allocated resources are to be freed with bpf_cleanup() call. All the
* transient state is passed around in struct bpf_link_primer. * transient state is passed around in struct bpf_link_primer.
* This is preferred way to create and initialize bpf_link, especially when * This is preferred way to create and initialize bpf_link, especially when
* there are complicated and expensive operations inbetween creating bpf_link * there are complicated and expensive operations in between creating bpf_link
* itself and attaching it to BPF hook. By using bpf_link_prime() and * itself and attaching it to BPF hook. By using bpf_link_prime() and
* bpf_link_settle() kernel code using bpf_link doesn't have to perform * bpf_link_settle() kernel code using bpf_link doesn't have to perform
* expensive (and potentially failing) roll back operations in a rare case * expensive (and potentially failing) roll back operations in a rare case
......
...@@ -45,7 +45,7 @@ void *bpf_jit_alloc_exec_page(void) ...@@ -45,7 +45,7 @@ void *bpf_jit_alloc_exec_page(void)
set_vm_flush_reset_perms(image); set_vm_flush_reset_perms(image);
/* Keep image as writeable. The alternative is to keep flipping ro/rw /* Keep image as writeable. The alternative is to keep flipping ro/rw
* everytime new program is attached or detached. * every time new program is attached or detached.
*/ */
set_memory_x((long)image, 1); set_memory_x((long)image, 1);
return image; return image;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment