scottk/OpenCellular
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/OpenCellular.git synced 2025-11-25 18:55:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

vboot: remove unused stateful_util

Browse Source 
Now that the vboot1 cryptolib code is gone, nothing uses stateful_util.
Remove it and its unit tests.

BUG=chromium:611535
BRANCH=none
TEST=make runtests; emerge-kevin coreboot depthcharge

Change-Id: I75b6014be00c5266545db10e87c1d9485fd1444b
Signed-off-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/400904
Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
This commit is contained in:
Randall Spangler
2016-10-18 14:23:01 -07:00
parent 13c0776aab
commit 47eeaa6e4a
4 changed files with 0 additions and 453 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile
View File

@@ -323,7 +323,6 @@ VBINIT_SRCS = \
# Additional firmware library sources needed by VbSelectFirmware() call
VBSF_SRCS = \
firmware/lib/stateful_util.c \
firmware/lib/vboot_common.c \
firmware/lib/region-fw.c \
@@ -722,7 +721,6 @@ TEST_NAMES = \
tests/cgptlib_test \
tests/rollback_index3_tests \
tests/sha_benchmark \
tests/stateful_util_tests \
tests/utility_string_tests \
tests/utility_tests \
tests/vboot_api_devmode_tests \
@@ -1416,7 +1414,6 @@ ifeq (${TPM2_MODE},)
${RUNTEST} ${BUILD_RUN}/tests/rollback_index2_tests
endif
${RUNTEST} ${BUILD_RUN}/tests/rollback_index3_tests
${RUNTEST} ${BUILD_RUN}/tests/stateful_util_tests
${RUNTEST} ${BUILD_RUN}/tests/utility_string_tests
${RUNTEST} ${BUILD_RUN}/tests/utility_tests
${RUNTEST} ${BUILD_RUN}/tests/vboot_api_devmode_tests

76
firmware/lib/include/stateful_util.h
View File

@@ -1,76 +0,0 @@
/* Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/*
* Helper functions/wrappers for memory allocations, manipulation and
* comparison.
*/
#ifndef VBOOT_FIRMWARE_LIB_STATEFUL_UTIL_H_
#define VBOOT_FIRMWARE_LIB_STATEFUL_UTIL_H_
#include "sysincludes.h"
/* Track remaining data to be read in a buffer. */
typedef struct MemcpyState {
uint8_t *remaining_buf;
uint64_t remaining_len; /* Remaining length of the buffer. */
uint8_t overrun; /* Flag set to 1 when an overrun occurs. */
} MemcpyState;
/**
* Initialize a stateful buffer struct to point to the buffer, with the
* specified remaining length in bytes.
*/
void StatefulInit(MemcpyState *state, void *buf, uint64_t len);
/**
* Skip [len] bytes only if there's enough data to skip according to [state].
*
* On success, return a meaningless but non-NULL pointer and updates [state].
* On failure, return NULL, set state->overrun to 1.
*
* Useful for iterating through a binary blob to populate a struct. After the
* first failure (buffer overrun), successive calls will always fail.
*/
void *StatefulSkip(MemcpyState *state, uint64_t len);
/**
* Copy [len] bytes into [dst] only if there's enough data to read according
* to [state].
*
* On success, return [dst] and update [state].
* On failure, return NULL, set state->overrun to 1.
*
* Useful for iterating through a binary blob to populate a struct. After the
* first failure (buffer overrun), successive calls will always fail.
*/
void *StatefulMemcpy(MemcpyState *state, void *dst, uint64_t len);
/**
* Like StatefulMemcpy() but copies in the opposite direction, populating
* data from [src] into the buffer encapsulated in state [state].
*
* On success, return [src] and update [state].
* On failure, return NULL, set state->overrun to 1.
*
* Useful for iterating through a structure to populate a binary blob. After the
* first failure (buffer overrun), successive calls will always fail.
*/
const void *StatefulMemcpy_r(MemcpyState *state, const void *src, uint64_t len);
/**
* Like StatefulMemcpy_r() but fills a portion of the encapsulated buffer with
* a constant value.
*
* On success, return a meaningless but non-NULL pointer and updates [state].
* On failure, return NULL, set state->overrun to 1.
*
* After the first failure (buffer overrun), successive calls will always fail.
*/
const void *StatefulMemset_r(MemcpyState *state, const uint8_t val,
uint64_t len);
#endif

74
firmware/lib/stateful_util.c
View File

@@ -1,74 +0,0 @@
/* Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*
* Implementations of stateful memory operations.
*/
#include "sysincludes.h"
#include "stateful_util.h"
#include "utility.h"
void StatefulInit(MemcpyState *state, void *buf, uint64_t len)
{
state->remaining_buf = buf;
state->remaining_len = len;
state->overrun = 0;
}
void *StatefulSkip(MemcpyState *state, uint64_t len)
{
if (state->overrun)
return NULL;
if (len > state->remaining_len) {
state->overrun = 1;
return NULL;
}
state->remaining_buf += len;
state->remaining_len -= len;
return state; /* Must return something non-NULL. */
}
void *StatefulMemcpy(MemcpyState *state, void *dst, uint64_t len)
{
if (state->overrun)
return NULL;
if (len > state->remaining_len) {
state->overrun = 1;
return NULL;
}
memcpy(dst, state->remaining_buf, len);
state->remaining_buf += len;
state->remaining_len -= len;
return dst;
}
const void *StatefulMemcpy_r(MemcpyState *state, const void *src, uint64_t len)
{
if (state->overrun)
return NULL;
if (len > state->remaining_len) {
state->overrun = 1;
return NULL;
}
memcpy(state->remaining_buf, src, len);
state->remaining_buf += len;
state->remaining_len -= len;
return src;
}
const void *StatefulMemset_r(MemcpyState *state, const uint8_t val,
uint64_t len)
{
if (state->overrun)
return NULL;
if (len > state->remaining_len) {
state->overrun = 1;
return NULL;
}
memset(state->remaining_buf, val, len);
state->remaining_buf += len;
state->remaining_len -= len;
return state; /* Must return something non-NULL. */
}

300
tests/stateful_util_tests.c
View File

@@ -1,300 +0,0 @@
/* Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*
* Tests for statful_util functions.
*/
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#define _STUB_IMPLEMENTATION_ /* So we can use memset() ourselves */
#include "stateful_util.h"
#include "test_common.h"
#include "utility.h"
#include "vboot_common.h"
/* Test StatefulInit */
static void StatefulInitTest(void) {
MemcpyState s;
char buf[128];
memset(&s, 0, sizeof(s));
s.overrun = 1;
StatefulInit(&s, buf, 128);
TEST_EQ(0, s.overrun, "StatefulInit() overrun");
TEST_EQ(128, s.remaining_len, "StatefulInit() len");
TEST_PTR_EQ(buf, s.remaining_buf, "StatefulInit() buf");
}
/* Test StatefulSkip */
static void StatefulSkipTest(void) {
MemcpyState s;
char buf[128];
/* Small skip */
StatefulInit(&s, buf, 128);
TEST_PTR_EQ(&s, StatefulSkip(&s, 5), "StatefulSkip(5) retval");
TEST_EQ(128 - 5, s.remaining_len, "StatefulSkip(5) len");
TEST_PTR_EQ(buf + 5, s.remaining_buf, "StatefulSkip(5) buf");
TEST_EQ(0, s.overrun, "StatefulSkip(5) overrun");
/* Use entire buffer */
StatefulInit(&s, buf, 128);
TEST_PTR_EQ(&s, StatefulSkip(&s, 128), "StatefulSkip(all) retval");
TEST_EQ(0, s.remaining_len, "StatefulSkip(all) len");
TEST_PTR_EQ(buf + 128, s.remaining_buf, "StatefulSkip(all) buf");
TEST_EQ(0, s.overrun, "StatefulSkip(all) overrun");
/* Zero-length skip is ok (but meaningless) */
TEST_PTR_EQ(&s, StatefulSkip(&s, 0), "StatefulSkip(0) retval");
TEST_EQ(0, s.remaining_len, "StatefulSkip(0) len");
TEST_PTR_EQ(buf + 128, s.remaining_buf, "StatefulSkip(0) buf");
TEST_EQ(0, s.overrun, "StatefulSkip(0) overrun");
/* Can't use even one byte past that */
TEST_PTR_EQ(NULL, StatefulSkip(&s, 1), "StatefulSkip(+1) retval");
TEST_EQ(0, s.remaining_len, "StatefulSkip(+1) len");
TEST_EQ(1, s.overrun, "StatefulSkip(+1) overrun");
/* Overrun */
StatefulInit(&s, buf, 128);
TEST_PTR_EQ(NULL, StatefulSkip(&s, 256), "StatefulSkip(256) retval");
TEST_EQ(1, s.overrun, "StatefulSkip(256) overrun");
/* Once overrun, always overrun, even if we now ask for a small skip */
TEST_PTR_EQ(NULL, StatefulSkip(&s, 1), "StatefulSkip(256+1) retval");
TEST_EQ(1, s.overrun, "StatefulSkip(256+1) overrun");
/* Overrun with potential wraparound */
StatefulInit(&s, buf, 128);
TEST_PTR_EQ(NULL, StatefulSkip(&s, -1), "StatefulSkip(-1) retval");
TEST_EQ(1, s.overrun, "StatefulSkip(-1) overrun");
}
/* Test StatefulMemset_r */
static void StatefulMemset_rTest(void) {
MemcpyState s;
char buf[129];
char want[129];
memset(want, 0, sizeof(want));
memset(buf, 0, sizeof(buf));
/* Small sets */
StatefulInit(&s, buf, 128);
TEST_PTR_EQ(&s, StatefulMemset_r(&s, 'A', 5), "StatefulMemset_r(5) retval");
TEST_EQ(128 - 5, s.remaining_len, "StatefulMemset_r(5) len");
TEST_PTR_EQ(buf + 5, s.remaining_buf, "StatefulMemset_r(5) buf");
/* Using strcmp() is a convenient way to check that we didn't
* overwrite the 0-byte following what we expected to set. */
TEST_EQ(0, strcmp("AAAAA", buf), "StatefulMemset_r(5) contents");
TEST_EQ(0, s.overrun, "StatefulMemset_r(5) overrun");
TEST_PTR_EQ(&s, StatefulMemset_r(&s, 'B', 3), "StatefulMemset_r(3) retval");
TEST_EQ(0, strcmp("AAAAABBB", buf), "StatefulMemset_r(3) contents");
/* Use entire buffer */
StatefulInit(&s, buf, 128);
TEST_PTR_EQ(&s, StatefulMemset_r(&s, 'C', 128),
"StatefulMemset_r(all) retval");
TEST_EQ(0, s.remaining_len, "StatefulMemset_r(all) len");
TEST_PTR_EQ(buf + 128, s.remaining_buf, "StatefulMemset_r(all) buf");
TEST_EQ(0, s.overrun, "StatefulMemset_r(all) overrun");
memset(want, 'C', 128);
TEST_EQ(0, memcmp(want, buf, sizeof(want)), "StatefulMemset_r(all) contents");
/* Zero-length set is ok (but meaningless) */
TEST_PTR_EQ(&s, StatefulMemset_r(&s, 'D', 0), "StatefulMemset_r(0) retval");
TEST_EQ(0, s.remaining_len, "StatefulMemset_r(0) len");
TEST_PTR_EQ(buf + 128, s.remaining_buf, "StatefulMemset_r(0) buf");
TEST_EQ(0, s.overrun, "StatefulMemset_r(0) overrun");
TEST_EQ(0, memcmp(want, buf, sizeof(want)), "StatefulMemset_r(0) contents");
/* Can't use even one byte past that */
TEST_PTR_EQ(NULL, StatefulMemset_r(&s, 'E', 1),
"StatefulMemset_r(+1) retval");
TEST_EQ(0, s.remaining_len, "StatefulMemset_r(+1) len");
TEST_EQ(1, s.overrun, "StatefulMemset_r(+1) overrun");
TEST_EQ(0, memcmp(want, buf, sizeof(want)), "StatefulMemset_r(+1) contents");
/* Overrun */
StatefulInit(&s, buf, 128);
TEST_PTR_EQ(NULL, StatefulMemset_r(&s, 'F', 256),
"StatefulMemset_r(256) retval");
TEST_EQ(1, s.overrun, "StatefulMemset_r(256) overrun");
/* Once overrun, always overrun, even if we now ask for a small skip */
TEST_PTR_EQ(NULL, StatefulMemset_r(&s, 'G', 1),
"StatefulMemset_r(256+1) retval");
TEST_EQ(1, s.overrun, "StatefulMemset_r(256+1) overrun");
TEST_EQ(0, memcmp(want, buf, sizeof(want)), "StatefulMemset_r(+1) contents");
/* Overrun with potential wraparound */
StatefulInit(&s, buf, 128);
TEST_PTR_EQ(NULL, StatefulMemset_r(&s, 'H', -1),
"StatefulMemset_r(-1) retval");
TEST_EQ(1, s.overrun, "StatefulMemset_r(-1) overrun");
TEST_EQ(0, memcmp(want, buf, sizeof(want)), "StatefulMemset_r(+1) contents");
}
/* Test StatefulMemcpy_r */
static void StatefulMemcpy_rTest(void) {
MemcpyState s;
char buf[129];
char want[129];
char* src1 = "Doogie";
char* src2 = "Howserrr";
char* src3 = "WholeBuffr";
memset(want, 0, sizeof(want));
memset(buf, 0, sizeof(buf));
/* Small copies */
StatefulInit(&s, buf, 128);
TEST_PTR_EQ(src1, StatefulMemcpy_r(&s, src1, 6),
"StatefulMemcpy_r(6) retval");
TEST_EQ(128 - 6, s.remaining_len, "StatefulMemcpy_r(6) len");
TEST_PTR_EQ(buf + 6, s.remaining_buf, "StatefulMemcpy_r(6) buf");
/* Using strcmp() is a convenient way to check that we didn't
* overwrite the 0-byte following what we expected to copy. */
TEST_EQ(0, strcmp("Doogie", buf), "StatefulMemcpy_r(6) contents");
TEST_EQ(0, s.overrun, "StatefulMemcpy_r(6) overrun");
TEST_PTR_EQ(src2, StatefulMemcpy_r(&s, src2, 8),
"StatefulMemcpy_r(8) retval");
TEST_EQ(0, strcmp("DoogieHowserrr", buf), "StatefulMemcpy_r(8) contents");
/* Use entire buffer */
memset(buf, 42, sizeof(buf));
StatefulInit(&s, buf, 10);
TEST_PTR_EQ(src3, StatefulMemcpy_r(&s, src3, 10),
"StatefulMemcpy_r(all) retval");
TEST_EQ(0, s.remaining_len, "StatefulMemcpy_r(all) len");
TEST_PTR_EQ(buf + 10, s.remaining_buf, "StatefulMemcpy_r(all) buf");
TEST_EQ(0, s.overrun, "StatefulMemcpy_r(all) overrun");
TEST_EQ(0, memcmp(src3, buf, 10), "StatefulMemcpy_r(all) contents");
TEST_EQ(42, buf[10], "StatefulMemcpy_r(all) contents+1");
/* Zero-length copy is ok (but meaningless) */
TEST_PTR_EQ(src1, StatefulMemcpy_r(&s, src1, 0),
"StatefulMemcpy_r(0) retval");
TEST_EQ(0, s.remaining_len, "StatefulMemcpy_r(0) len");
TEST_PTR_EQ(buf + 10, s.remaining_buf, "StatefulMemcpy_r(0) buf");
TEST_EQ(0, s.overrun, "StatefulMemcpy_r(0) overrun");
TEST_EQ(42, buf[10], "StatefulMemcpy_r(0) contents+1");
/* Can't use even one byte past that */
TEST_PTR_EQ(NULL, StatefulMemcpy_r(&s, src1, 1),
"StatefulMemcpy_r(+1) retval");
TEST_EQ(0, s.remaining_len, "StatefulMemcpy_r(+1) len");
TEST_EQ(1, s.overrun, "StatefulMemcpy_r(+1) overrun");
TEST_EQ(42, buf[10], "StatefulMemcpy_r(+1) contents");
/* Overrun */
memset(buf, 0, sizeof(buf));
StatefulInit(&s, buf, 8);
TEST_PTR_EQ(NULL, StatefulMemcpy_r(&s, "MoreThan8", 9),
"StatefulMemcpy_r(9) retval");
TEST_EQ(1, s.overrun, "StatefulMemcpy_r(9) overrun");
/* Once overrun, always overrun, even if we now ask for a small skip */
TEST_PTR_EQ(NULL, StatefulMemcpy_r(&s, "Less", 4),
"StatefulMemcpy_r(9+1) retval");
TEST_EQ(1, s.overrun, "StatefulMemcpy_r(9+1) overrun");
TEST_EQ(0, memcmp(want, buf, sizeof(want)), "StatefulMemcpy_r(+1) contents");
/* Overrun with potential wraparound */
StatefulInit(&s, buf, 128);
TEST_PTR_EQ(NULL, StatefulMemcpy_r(&s, "FOO", -1),
"StatefulMemcpy_r(-1) retval");
TEST_EQ(1, s.overrun, "StatefulMemcpy_r(-1) overrun");
TEST_EQ(0, memcmp(want, buf, sizeof(want)), "StatefulMemcpy_r(+1) contents");
}
/* Test StatefulMemcpy */
static void StatefulMemcpyTest(void) {
MemcpyState s;
char buf[129];
char want[129];
char* src1 = "ThisIsATest";
char* src2 = "ThisIsOnlyATest";
memset(want, 0, sizeof(want));
memset(buf, 0, sizeof(buf));
/* Small copies */
StatefulInit(&s, src1, 12);
TEST_PTR_EQ(buf, StatefulMemcpy(&s, buf, 6), "StatefulMemcpy(6) retval");
TEST_EQ(6, s.remaining_len, "StatefulMemcpy(6) len");
TEST_PTR_EQ(src1 + 6, s.remaining_buf, "StatefulMemcpy(6) buf");
/* Using strcmp() is a convenient way to check that we didn't
* overwrite the 0-byte following what we expected to copy. */
TEST_EQ(0, strcmp("ThisIs", buf), "StatefulMemcpy(6) contents");
TEST_EQ(0, s.overrun, "StatefulMemcpy(6) overrun");
TEST_PTR_EQ(buf, StatefulMemcpy(&s, buf, 5), "StatefulMemcpy(5) retval");
/* Note that we shouldn't have copied the last byte out of the
* stateful buffer, so we don't overwrite the last character of the
* string that was in buf. */
TEST_EQ(0, strcmp("ATests", buf), "StatefulMemcpy(5) contents");
/* Use entire buffer */
memset(buf, 1, sizeof(buf));
StatefulInit(&s, src2, 16);
TEST_PTR_EQ(buf, StatefulMemcpy(&s, buf, 16), "StatefulMemcpy(all) retval");
TEST_EQ(0, s.remaining_len, "StatefulMemcpy(all) len");
TEST_PTR_EQ(src2 + 16, s.remaining_buf, "StatefulMemcpy(all) buf");
TEST_EQ(0, s.overrun, "StatefulMemcpy(all) overrun");
TEST_EQ(0, strcmp(src2, buf), "StatefulMemcpy(all) contents");
/* Zero-length copy is ok (but meaningless) */
TEST_PTR_EQ(buf, StatefulMemcpy(&s, buf, 0),
"StatefulMemcpy(0) retval");
TEST_EQ(0, s.remaining_len, "StatefulMemcpy(0) len");
TEST_PTR_EQ(src2 + 16, s.remaining_buf, "StatefulMemcpy(0) buf");
TEST_EQ(0, s.overrun, "StatefulMemcpy(0) overrun");
TEST_EQ(0, strcmp(src2, buf), "StatefulMemcpy(0) contents");
/* Can't use even one byte past that */
TEST_PTR_EQ(NULL, StatefulMemcpy(&s, buf, 1),
"StatefulMemcpy(+1) retval");
TEST_EQ(0, s.remaining_len, "StatefulMemcpy(+1) len");
TEST_EQ(1, s.overrun, "StatefulMemcpy(+1) overrun");
TEST_EQ(0, strcmp(src2, buf), "StatefulMemcpy(+1) contents");
/* Overrun */
memset(buf, 0, sizeof(buf));
StatefulInit(&s, "Small", 5);
TEST_PTR_EQ(NULL, StatefulMemcpy(&s, buf, 9), "StatefulMemcpy(9) retval");
TEST_EQ(1, s.overrun, "StatefulMemcpy(9) overrun");
/* Once overrun, always overrun, even if we now ask for a small skip */
TEST_PTR_EQ(NULL, StatefulMemcpy(&s, buf, 4),
"StatefulMemcpy(9+1) retval");
TEST_EQ(1, s.overrun, "StatefulMemcpy(9+1) overrun");
TEST_EQ(0, memcmp(want, buf, sizeof(want)), "StatefulMemcpy(+1) contents");
/* Overrun with potential wraparound */
StatefulInit(&s, "Larger", 6);
TEST_PTR_EQ(NULL, StatefulMemcpy(&s, buf, -1), "StatefulMemcpy(-1) retval");
TEST_EQ(1, s.overrun, "StatefulMemcpy(-1) overrun");
TEST_EQ(0, memcmp(want, buf, sizeof(want)), "StatefulMemcpy(+1) contents");
}
int main(int argc, char* argv[]) {
int error_code = 0;
StatefulInitTest();
StatefulSkipTest();
StatefulMemset_rTest();
StatefulMemcpy_rTest();
StatefulMemcpyTest();
if (!gTestSuccess)
error_code = 255;
return error_code;
}