efi: Add 'capsule' update support
Hello Matt Fleming,
The patch f0133f3c5b8b: "efi: Add 'capsule' update support" from Apr 25, 2016, leads to the following static checker warning:
drivers/firmware/efi/capsule.c:109 efi_capsule_supported()
warn: did you mean to pass the address of 'capsule'
drivers/firmware/efi/capsule.c
91 int efi_capsule_supported(efi_guid_t guid, u32 flags, size_t size, int *reset)
92 {
93 efi_capsule_header_t *capsule;
94 efi_status_t status;
95 u64 max_size;
96 int rv = 0;
97
98 if (flags & ~EFI_CAPSULE_SUPPORTED_FLAG_MASK)
99 return -EINVAL;
100
101 capsule = kmalloc(sizeof(*capsule), GFP_KERNEL);
102 if (!capsule)
103 return -ENOMEM;
104
105 capsule->headersize = capsule->imagesize = sizeof(*capsule);
106 memcpy(&capsule->guid, &guid, sizeof(efi_guid_t));
107 capsule->flags = flags;
108
109 status = efi.query_capsule_caps(&capsule, 1, &max_size, reset);
^^^^^^^^If we modify capsule inside this function call then at the end of the function we aren't freeing the original pointer that we allocated.
110 if (status != EFI_SUCCESS) {
111 rv = efi_status_to_err(status);
112 goto out;
113 }
114
115 if (size > max_size)
116 rv = -ENOSPC;
117 out:
118 kfree(capsule);
119 return rv;
120 }regards,
dan carpenter
Quoted 32 lines · Dan Carpenter
Hello Matt Fleming,
The patch
f0133f3c5b8b: "efi: Add 'capsule' update support" from Apr 25, 2016, leads to the following static checker warning:
drivers/firmware/efi/capsule.c:109efi_capsule_supported()
warn: did you mean to pass the address of 'capsule'
drivers/firmware/efi/capsule.c91 int efi_capsule_supported(efi_guid_t guid, u32 flags, size_t size, int *reset) 92 { 93 efi_capsule_header_t *capsule; 94 efi_status_t status; 95 u64 max_size; 96 int rv = 0; 97 98 if (flags & ~EFI_CAPSULE_SUPPORTED_FLAG_MASK) 99 return -EINVAL; 100 101 capsule = kmalloc(sizeof(*capsule), GFP_KERNEL); 102 if (!capsule) 103 return -ENOMEM; 104 105 capsule->headersize = capsule->imagesize = sizeof(*capsule); 106 memcpy(&capsule->guid, &guid, sizeof(efi_guid_t)); 107 capsule->flags = flags; 108 109 status = efi.query_capsule_caps(&capsule, 1, &max_size, reset); ^^^^^^^^If we modify capsule inside this function call then at the end of the function we aren't freeing the original pointer that we allocated.
Quoted 11 lines
110 if (status != EFI_SUCCESS) {
111 rv = efi_status_to_err(status);
112 goto out;
113 }
114
115 if (size > max_size)
116 rv = -ENOSPC;
117 out:
118 kfree(capsule);
119 return rv;
120 }We should be fine here, the firmware should not modify the argument that we pass since we're simply querying whether or not the capsule is supported.
Is there a cleanup that you'd suggest making to silence the static checker warning?
A message that is not in the archive (sent off-list or not yet received): 20160503145050.GY2839-mF/unelCI9GS6iBeEJttW/[email protected]
Quoted 45 lines · Matt Fleming
Quoted 32 lines · Dan Carpenter
Hello Matt Fleming,
The patch
f0133f3c5b8b: "efi: Add 'capsule' update support" from Apr 25, 2016, leads to the following static checker warning:
drivers/firmware/efi/capsule.c:109efi_capsule_supported()
warn: did you mean to pass the address of 'capsule'
drivers/firmware/efi/capsule.c91 int efi_capsule_supported(efi_guid_t guid, u32 flags, size_t size, int *reset) 92 { 93 efi_capsule_header_t *capsule; 94 efi_status_t status; 95 u64 max_size; 96 int rv = 0; 97 98 if (flags & ~EFI_CAPSULE_SUPPORTED_FLAG_MASK) 99 return -EINVAL; 100 101 capsule = kmalloc(sizeof(*capsule), GFP_KERNEL); 102 if (!capsule) 103 return -ENOMEM; 104 105 capsule->headersize = capsule->imagesize = sizeof(*capsule); 106 memcpy(&capsule->guid, &guid, sizeof(efi_guid_t)); 107 capsule->flags = flags; 108 109 status = efi.query_capsule_caps(&capsule, 1, &max_size, reset); ^^^^^^^^If we modify capsule inside this function call then at the end of the function we aren't freeing the original pointer that we allocated.
Quoted 11 lines
110 if (status != EFI_SUCCESS) { 111 rv = efi_status_to_err(status); 112 goto out; 113 } 114 115 if (size > max_size) 116 rv = -ENOSPC; 117 out: 118 kfree(capsule); 119 return rv; 120 }
Quoted 6 lines
We should be fine here, the firmware should not modify the argument that we pass since we're simply querying whether or not the capsule is supported.
Is there a cleanup that you'd suggest making to silence the static checker warning?
Well, I suppose we could simply allocate the pointer array and the single member statically, i.e.,
efi_capsule_header_t capsule1;efi_capsule_header_t *capsule[] = { &capsule1 };
That way, we can get rid of the heap allocation entirely, and we take the address of the array, i.e., without the &
A message that is not in the archive (sent off-list or not yet received): CAKv+Gu-CBymL85xJnmC9d9nuUOuMU3kBAONWtj1-_ck4hEzxiQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org
Quoted 9 lines · Ard Biesheuvel
Well, I suppose we could simply allocate the pointer array and the single member statically, i.e.,
efi_capsule_header_tcapsule1;efi_capsule_header_t*capsule[] = { &capsule1 };That way, we can get rid of the heap allocation entirely, and we take the address of the array, i.e., without the &
This?
---
Quoted 1 line
From
cc80265af2073e99627933d9a2192a175dddaca0Mon Sep 17 00:00:00 2001
From: Matt Fleming <matt-mF/unelCI9GS6iBeEJttW/[email protected]>
Date: Wed, 4 May 2016 12:52:06 +0100
Subject: [PATCH] efi/capsule: Move 'capsule' to the stack in
efi_capsule_supported()
Dan reports that passing the address of the pointer to the kmalloc()'d memory for 'capsule' is dangerous,
"drivers/firmware/efi/capsule.c:109 efi_capsule_supported()
warn: did you mean to pass the address of 'capsule'
108
109 status = efi.query_capsule_caps(&capsule, 1, &max_size, reset);
^^^^^^^^If we modify capsule inside this function call then at the end of the function we aren't freeing the original pointer that we allocated."
Ard noted that we don't even need to call kmalloc() since the object we allocate isn't very big and doesn't need to persist after the function returns.
Place 'capsule' on the stack instead.
--- drivers/firmware/efi/capsule.c | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-)
drivers/firmware/efi/capsule.c +11 -18
@@ -86,33 +86,26 @@ bool efi_capsule_pending(int *reset_type)*/ int efi_capsule_supported (efi_guid_t guid,u32 flags,size_t size,int *reset) { -efi_capsule_header_t *capsule; +efi_capsule_header_t capsule; +efi_capsule_header_t *cap_list[] = { &capsule };efi_status_t status;u64 max_size; -int rv =0 ;if (flags & ~EFI_CAPSULE_SUPPORTED_FLAG_MASK )return -EINVAL ; - capsule =kmalloc (sizeof (*capsule),GFP_KERNEL ); -if (!capsule) -return -ENOMEM ; - - capsule->headersize = capsule->imagesize =sizeof (*capsule); -memcpy (&capsule->guid, &guid,sizeof (efi_guid_t)); - capsule->flags = flags; + capsule.headersize = capsule.imagesize =sizeof (capsule); +memcpy (&capsule.guid, &guid,sizeof (efi_guid_t)); + capsule.flags = flags; - status = efi.query_capsule_caps (&capsule,1 , &max_size, reset); -if (status !=EFI_SUCCESS ) { - rv =efi_status_to_err (status); - goto out; - } + status = efi.query_capsule_caps (cap_list,1 , &max_size, reset); +if (status !=EFI_SUCCESS ) +return efi_status_to_err (status);if (size > max_size) - rv = -ENOSPC ; -out: -kfree (capsule); -return rv; +return -ENOSPC ; + +return 0 ; }EXPORT_SYMBOL_GPL (efi_capsule_supported);
Signature · 1 line
2.7.3
A message that is not in the archive (sent off-list or not yet received): 20160504121241.GI2839-mF/unelCI9GS6iBeEJttW/[email protected]
Ard Biesheuvel
Acked-byQuoted 5 lines · Matt Fleming
Quoted 4 lines · Ard Biesheuvel
Well, I suppose we could simply allocate the pointer array and the single member statically, i.e.,
Quoted 8 lines
Quoted 5 lines
efi_capsule_header_tcapsule1;efi_capsule_header_t*capsule[] = { &capsule1 };That way, we can get rid of the heap allocation entirely, and we take the address of the array, i.e., without the &
This?
Yes, that looks correct to me, although I haven't tried to compile it.
Quoted 89 lines
---
From
cc80265af2073e99627933d9a2192a175dddaca0Mon Sep 17 00:00:00 2001
From: Matt Fleming <matt-mF/unelCI9GS6iBeEJttW/[email protected]>
Date: Wed, 4 May 2016 12:52:06 +0100
Subject: [PATCH] efi/capsule: Move 'capsule' to the stack in
efi_capsule_supported()Dan reports that passing the address of the pointer to the kmalloc()'d memory for 'capsule' is dangerous,
"
drivers/firmware/efi/capsule.c:109efi_capsule_supported()
warn: did you mean to pass the address of 'capsule'108 109 status = efi.query_capsule_caps(&capsule, 1, &max_size, reset); ^^^^^^^^If we modify capsule inside this function call then at the end of the function we aren't freeing the original pointer that we allocated."
Ard noted that we don't even need to call
kmalloc()since the object we allocate isn't very big and doesn't need to persist after the function returns.Place 'capsule' on the stack instead.
Suggested-by Ard Biesheuvel <[email protected]>Reported-by Dan Carpenter <[email protected]>Cc Borislav Petkov <[email protected]>Cc Kweh Hock Leong <[email protected]>Cc Bryan O'Donoghue <[email protected]>Cc joeyli <jlee-IBi9RG/[email protected]>--- drivers/firmware/efi/capsule.c | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-)drivers/firmware/efi/capsule.c +11
-19@@ -86,33 +86,26 @@ bool efi_capsule_pending(int *reset_type)*/ int efi_capsule_supported (efi_guid_t guid,u32 flags,size_t size,int *reset) { -efi_capsule_header_t *capsule; +efi_capsule_header_t capsule; +efi_capsule_header_t *cap_list[] = { &capsule };efi_status_t status;u64 max_size; -int rv =0 ;if (flags & ~EFI_CAPSULE_SUPPORTED_FLAG_MASK )return -EINVAL ; - capsule =kmalloc (sizeof (*capsule),GFP_KERNEL ); -if (!capsule) -return -ENOMEM ; - - capsule->headersize = capsule->imagesize =sizeof (*capsule); -memcpy (&capsule->guid, &guid,sizeof (efi_guid_t)); - capsule->flags = flags; + capsule.headersize = capsule.imagesize =sizeof (capsule); +memcpy (&capsule.guid, &guid,sizeof (efi_guid_t)); + capsule.flags = flags; - status = efi.query_capsule_caps (&capsule,1 , &max_size, reset); -if (status !=EFI_SUCCESS ) { - rv =efi_status_to_err (status); - goto out; - } + status = efi.query_capsule_caps (cap_list,1 , &max_size, reset); +if (status !=EFI_SUCCESS ) +return efi_status_to_err (status);if (size > max_size) - rv = -ENOSPC ; -out: -kfree (capsule); -return rv; +return -ENOSPC ; + +return 0 ; }EXPORT_SYMBOL_GPL (efi_capsule_supported); --2.7.3