Re: [PATCH v1 3/3] nitro_enclaves: Add fixes for checkpatch and docs reports

From: Vitaly Kuznetsov
Date: Thu Aug 26 2021 - 13:52:04 EST

Andra Paraschiv <andraprs@xxxxxxxxxx> writes:

> Fix the reported issues from checkpatch and kernel-doc scripts.
>
> Update the copyright statements to include 2021, where changes have been
> made over this year.
>
> Signed-off-by: Andra Paraschiv <andraprs@xxxxxxxxxx>
> ---
> drivers/virt/nitro_enclaves/ne_misc_dev.c | 17 +++++++++--------
> drivers/virt/nitro_enclaves/ne_pci_dev.c | 2 +-
> drivers/virt/nitro_enclaves/ne_pci_dev.h | 8 ++++++--
> include/uapi/linux/nitro_enclaves.h | 10 +++++-----
> samples/nitro_enclaves/ne_ioctl_sample.c | 7 +++----
> 5 files changed, 24 insertions(+), 20 deletions(-)
>
> diff --git a/drivers/virt/nitro_enclaves/ne_misc_dev.c b/drivers/virt/nitro_enclaves/ne_misc_dev.c
> index e21e1e86ad15f..8939612ee0e08 100644
> --- a/drivers/virt/nitro_enclaves/ne_misc_dev.c
> +++ b/drivers/virt/nitro_enclaves/ne_misc_dev.c
> @@ -1,6 +1,6 @@
> // SPDX-License-Identifier: GPL-2.0
> /*
> - * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
> + * Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
> */
>
> /**
> @@ -284,8 +284,8 @@ static int ne_setup_cpu_pool(const char *ne_cpu_list)
> ne_cpu_pool.nr_parent_vm_cores = nr_cpu_ids / ne_cpu_pool.nr_threads_per_core;
>
> ne_cpu_pool.avail_threads_per_core = kcalloc(ne_cpu_pool.nr_parent_vm_cores,
> - sizeof(*ne_cpu_pool.avail_threads_per_core),
> - GFP_KERNEL);
> + sizeof(*ne_cpu_pool.avail_threads_per_core),
> + GFP_KERNEL);
> if (!ne_cpu_pool.avail_threads_per_core) {
> rc = -ENOMEM;
>
> @@ -735,7 +735,7 @@ static int ne_add_vcpu_ioctl(struct ne_enclave *ne_enclave, u32 vcpu_id)
> * * Negative return value on failure.
> */
> static int ne_sanity_check_user_mem_region(struct ne_enclave *ne_enclave,
> - struct ne_user_memory_region mem_region)
> + struct ne_user_memory_region mem_region)
> {
> struct ne_mem_region *ne_mem_region = NULL;
>
> @@ -771,7 +771,7 @@ static int ne_sanity_check_user_mem_region(struct ne_enclave *ne_enclave,
> u64 userspace_addr = ne_mem_region->userspace_addr;
>
> if ((userspace_addr <= mem_region.userspace_addr &&
> - mem_region.userspace_addr < (userspace_addr + memory_size)) ||
> + mem_region.userspace_addr < (userspace_addr + memory_size)) ||
> (mem_region.userspace_addr <= userspace_addr &&
> (mem_region.userspace_addr + mem_region.memory_size) > userspace_addr)) {
> dev_err_ratelimited(ne_misc_dev.this_device,
> @@ -836,7 +836,7 @@ static int ne_sanity_check_user_mem_region_page(struct ne_enclave *ne_enclave,
> * * Negative return value on failure.
> */
> static int ne_set_user_memory_region_ioctl(struct ne_enclave *ne_enclave,
> - struct ne_user_memory_region mem_region)
> + struct ne_user_memory_region mem_region)
> {
> long gup_rc = 0;
> unsigned long i = 0;
> @@ -1014,7 +1014,7 @@ static int ne_set_user_memory_region_ioctl(struct ne_enclave *ne_enclave,
> * * Negative return value on failure.
> */
> static int ne_start_enclave_ioctl(struct ne_enclave *ne_enclave,
> - struct ne_enclave_start_info *enclave_start_info)
> + struct ne_enclave_start_info *enclave_start_info)
> {
> struct ne_pci_dev_cmd_reply cmd_reply = {};
> unsigned int cpu = 0;
> @@ -1574,7 +1574,8 @@ static int ne_create_vm_ioctl(struct ne_pci_dev *ne_pci_dev, u64 __user *slot_ui
> mutex_unlock(&ne_cpu_pool.mutex);
>
> ne_enclave->threads_per_core = kcalloc(ne_enclave->nr_parent_vm_cores,
> - sizeof(*ne_enclave->threads_per_core), GFP_KERNEL);
> + sizeof(*ne_enclave->threads_per_core),
> + GFP_KERNEL);
> if (!ne_enclave->threads_per_core) {
> rc = -ENOMEM;
>
> diff --git a/drivers/virt/nitro_enclaves/ne_pci_dev.c b/drivers/virt/nitro_enclaves/ne_pci_dev.c
> index 143207e9b9698..40b49ec8e30b1 100644
> --- a/drivers/virt/nitro_enclaves/ne_pci_dev.c
> +++ b/drivers/virt/nitro_enclaves/ne_pci_dev.c
> @@ -1,6 +1,6 @@
> // SPDX-License-Identifier: GPL-2.0
> /*
> - * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
> + * Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
> */
>
> /**
> diff --git a/drivers/virt/nitro_enclaves/ne_pci_dev.h b/drivers/virt/nitro_enclaves/ne_pci_dev.h
> index 8bfbc66078185..7bbfd39280fec 100644
> --- a/drivers/virt/nitro_enclaves/ne_pci_dev.h
> +++ b/drivers/virt/nitro_enclaves/ne_pci_dev.h
> @@ -1,6 +1,6 @@
> /* SPDX-License-Identifier: GPL-2.0 */
> /*
> - * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
> + * Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
> */
>
> #ifndef _NE_PCI_DEV_H_
> @@ -84,9 +84,13 @@
> */
>
> /**
> - * NE_SEND_DATA_SIZE / NE_RECV_DATA_SIZE - 240 bytes for send / recv buffer.
> + * NE_SEND_DATA_SIZE - 240 bytes for send buffer.
> */
> #define NE_SEND_DATA_SIZE (240)

Nitpicking: "240 bytes for send buffer" comment looks a bit weird, it
would probably be better to just state what 'NE_SEND_DATA_SIZE' defines:

/*
* NE_SEND_DATA_SIZE - size of the send buffer, in bytes
*/

> +
> +/**
> + * NE_RECV_DATA_SIZE - 240 bytes for recv buffer.
> + */
> #define NE_RECV_DATA_SIZE (240)

Ditto.

>
> /**
> diff --git a/include/uapi/linux/nitro_enclaves.h b/include/uapi/linux/nitro_enclaves.h
> index b945073fe544d..e808f5ba124d4 100644
> --- a/include/uapi/linux/nitro_enclaves.h
> +++ b/include/uapi/linux/nitro_enclaves.h
> @@ -1,6 +1,6 @@
> /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
> /*
> - * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
> + * Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
> */
>
> #ifndef _UAPI_LINUX_NITRO_ENCLAVES_H_
> @@ -60,7 +60,7 @@
> *
> * Context: Process context.
> * Return:
> - * * 0 - Logic succesfully completed.
> + * * 0 - Logic successfully completed.
> * * -1 - There was a failure in the ioctl logic.
> * On failure, errno is set to:
> * * EFAULT - copy_from_user() / copy_to_user() failure.
> @@ -95,7 +95,7 @@
> *
> * Context: Process context.
> * Return:
> - * * 0 - Logic succesfully completed.
> + * * 0 - Logic successfully completed.
> * * -1 - There was a failure in the ioctl logic.
> * On failure, errno is set to:
> * * EFAULT - copy_from_user() / copy_to_user() failure.
> @@ -118,7 +118,7 @@
> *
> * Context: Process context.
> * Return:
> - * * 0 - Logic succesfully completed.
> + * * 0 - Logic successfully completed.
> * * -1 - There was a failure in the ioctl logic.
> * On failure, errno is set to:
> * * EFAULT - copy_from_user() failure.
> @@ -161,7 +161,7 @@
> *
> * Context: Process context.
> * Return:
> - * * 0 - Logic succesfully completed.
> + * * 0 - Logic successfully completed.
> * * -1 - There was a failure in the ioctl logic.
> * On failure, errno is set to:
> * * EFAULT - copy_from_user() / copy_to_user() failure.
> diff --git a/samples/nitro_enclaves/ne_ioctl_sample.c b/samples/nitro_enclaves/ne_ioctl_sample.c
> index 480b763142b34..765b131c73190 100644
> --- a/samples/nitro_enclaves/ne_ioctl_sample.c
> +++ b/samples/nitro_enclaves/ne_ioctl_sample.c
> @@ -1,6 +1,6 @@
> // SPDX-License-Identifier: GPL-2.0
> /*
> - * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
> + * Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
> */
>
> /**
> @@ -185,7 +185,6 @@ static int ne_create_vm(int ne_dev_fd, unsigned long *slot_uid, int *enclave_fd)
> return 0;
> }
>
> -
> /**
> * ne_poll_enclave_fd() - Thread function for polling the enclave fd.
> * @data: Argument provided for the polling function.
> @@ -560,8 +559,8 @@ static int ne_add_vcpu(int enclave_fd, unsigned int *vcpu_id)
>
> default:
> printf("Error in add vcpu [%m]\n");
> -
> }
> +
> return rc;
> }
>
> @@ -638,7 +637,7 @@ static int ne_start_enclave(int enclave_fd, struct ne_enclave_start_info *encla
> }
>
> /**
> - * ne_start_enclave_check_booted() - Start the enclave and wait for a hearbeat
> + * ne_start_enclave_check_booted() - Start the enclave and wait for a heartbeat
> * from it, on a newly created vsock channel,
> * to check it has booted.
> * @enclave_fd : The file descriptor associated with the enclave.

--
Vitaly