[PATCH 12/13] staging/rdma/hfi1: Read EFI variable for device description

[Dan Carpenter]

On Wed, Nov 11, 2015 at 02:33:32AM -0500, Jubin John wrote:
> +static int read_efi_var(const char *name, unsigned long *size,
> +			void **return_data)
> +{
> +	int ret;
> +
> +	/* set failure return values */
> +	*size = 0;
> +	*return_data = NULL;
> +
> +	/*
> +	 * Use EFI run-time support to obtain an EFI variable.  Support may
> +	 * be compiled out, so declare all variables inside.
> +	 */
> +	if (efi_enabled(EFI_RUNTIME_SERVICES)) {


Flip this around:

	if (!efi_enabled(EFI_RUNTIME_SERVICES))
		return -ENOSYS;


> +		efi_status_t status;
> +		efi_char16_t *uni_name;
> +		efi_guid_t guid;
> +		unsigned long temp_size;
> +		void *temp_buffer;
> +		void *data;
> +		int i;
> +
> +		uni_name = kzalloc(sizeof(efi_char16_t) * (strlen(name) + 1),
> +				   GFP_KERNEL);
> +		temp_buffer = kzalloc(EFI_DATA_SIZE, GFP_KERNEL);
> +		data = NULL;

No need.

> +
> +		if (!uni_name || !temp_buffer) {
> +			ret = -ENOMEM;
> +			goto fail;
> +		}
> +
> +		/* input: the size of the buffer */
> +		temp_size = EFI_DATA_SIZE;
> +
> +		/* convert ASCII to unicode - it is a 1:1 mapping */
> +		for (i = 0; name[i]; i++)
> +			uni_name[i] = name[i];
> +
> +		/* need a variable for our GUID */
> +		guid = HFI1_EFIVAR_GUID;
> +
> +		/* call into EFI runtime services */
> +		status = efi.get_variable(
> +				uni_name,
> +				&guid,
> +				NULL,
> +				&temp_size,
> +				temp_buffer);
> +
> +		/*
> +		 * It would be nice to call efi_status_to_err() here, but that
> +		 * is in the EFIVAR_FS code and may not be compiled in.
> +		 * However, even that is insufficient since it does not cover
> +		 * EFI_BUFFER_TOO_SMALL which could be an important return.
> +		 * For now, just split out succces or not found.
> +		 */
> +		ret = status == EFI_SUCCESS   ? 0 :
> +		      status == EFI_NOT_FOUND ? -ENOENT :
> +						-EINVAL;
> +
> +		if (!ret) {
> +			/*
> +			 * We have successfully read the EFI variable into our
> +			 * temporary buffer.  Now allocate a correctly sized
> +			 * buffer.
> +			 */
> +			data = kmalloc(temp_size, GFP_KERNEL);
> +			if (data) {
> +				memcpy(data, temp_buffer, temp_size);
> +				*size = temp_size;
> +				*return_data = data;
> +			} else {
> +				ret = -ENOMEM;
> +			}
> +		}

People often change the last two conditions in the function from
error handling to success handling.  I have ranted about it before many
times so I should just paste a previous rant instead of commenting here.
:P

http://www.spinics.net/lists/arm-kernel/msg457849.html

Success handling makes this look more complicated than it really is.
This code is just a string of commands in a row with error handling.  No
need for if statements or indenting.  Here is how it looks when it's
pulled in one indent level and changed from success handling to error
handling.

	ret = status == EFI_SUCCESS   ? 0 :
	      status == EFI_NOT_FOUND ? -ENOENT : -EINVAL;
	if (ret)
		goto free;

	data = kmemdup(data, temp_size, GFP_KERNEL);
	if (!data) {
		ret = -ENOMEM;
		goto free;
	}

	*size = temp_size;
	*return_data = data;

free:
	kfree(uni_name);
	kfree(temp_buffer);

	return ret;

> +
> +fail:
> +		kfree(uni_name);
> +		kfree(temp_buffer);
> +	} else {
> +		ret = -ENOSYS;
> +	}
> +
> +	return ret;
> +}
> +
> +/*
> + * Read an HFI1 EFI variable of the form:
> + *	<PCIe address>-<kind>
> + * Return an kalloc'ed array and size of the data.
> + *
> + * Returns 0 on success, -errno on failure.
> + */
> +int read_hfi1_efi_var(struct hfi1_devdata *dd, const char *kind,
> +		      unsigned long *size, void **return_data)
> +{
> +	char name[64];
> +
> +	/* create a common prefix */
> +	snprintf(name, sizeof(name), "%04x:%02x:%02x.%x-%s",
> +		 pci_domain_nr(dd->pcidev->bus),
> +		 dd->pcidev->bus->number,
> +		 PCI_SLOT(dd->pcidev->devfn),
> +		 PCI_FUNC(dd->pcidev->devfn),
> +		 kind);
> +	name[sizeof(name) - 1] = 0; /* make sure the string is terminated */

No need.  snprintf() always puts a NUL terminator (technically it
doesn't if the sizeof(name) is zero, I suppose).

> +
> +	return read_efi_var(name, size, return_data);
> +}

regards,
dan carpenter