Move some storage functions to internal/utils.cpp

Author: Seppo Takalo

UNITTESTS/moduletests/storage/kvstore/TDBStore/unittest.cmake

@@ -14,6 +14,7 @@ set(unittest-sources
   ../features/storage/blockdevice/HeapBlockDevice.cpp
   ../features/storage/blockdevice/BufferedBlockDevice.cpp
   ../features/storage/kvstore/tdbstore/TDBStore.cpp
+  ../features/storage/internal/utils.cpp
   ../features/frameworks/mbed-trace/source/mbed_trace.c
   stubs/mbed_atomic_stub.c
   stubs/mbed_assert_stub.cpp

features/storage/TESTS/blockdevice/general_block_device/main.cpp

@@ -27,6 +27,7 @@
 #include "BufferedBlockDevice.h"
 #include "BlockDevice.h"
 #include <algorithm>
+#include "features/storage/internal/utils.h"
 
 #if COMPONENT_SPIF
 #include "SPIFBlockDevice.h"
@@ -96,13 +97,6 @@ static SingletonPtr<PlatformMutex> _mutex;
 
 BlockDevice *block_device = NULL;
 
-#if COMPONENT_FLASHIAP
-static inline uint32_t align_up(uint32_t val, uint32_t size)
-{
-    return (((val - 1) / size) + 1) * size;
-}
-#endif
-
 static BlockDevice *get_bd_instance(uint8_t bd_type)
 {
     switch (bd_arr[bd_type]) {

features/storage/TESTS/kvstore/direct_access_devicekey_test/main.cpp

@@ -31,6 +31,7 @@
 #include "FlashIAPBlockDevice.h"
 #include "DirectAccessDevicekey.h"
 #include "greentea-client/test_env.h"
+#include "features/storage/internal/utils.h"
 #include "unity.h"
 #include "utest.h"
 #include <stdlib.h>
@@ -40,16 +41,6 @@ using namespace mbed;
 
 #define TEST_DEVICEKEY_LENGTH 32
 
-static inline uint32_t align_up(uint64_t val, uint64_t size)
-{
-    return (((val - 1) / size) + 1) * size;
-}
-
-static inline uint32_t align_down(uint64_t val, uint64_t size)
-{
-    return (((val) / size)) * size;
-}
-
 int  get_virtual_TDBStore_position(uint32_t conf_start_address, uint32_t conf_size,
                                    uint32_t *tdb_start_address, uint32_t *tdb_end_address)
 {

features/storage/blockdevice/FlashSimBlockDevice.cpp

@@ -17,6 +17,7 @@
 #include "FlashSimBlockDevice.h"
 #include "platform/mbed_assert.h"
 #include "platform/mbed_atomic.h"
+#include "features/storage/internal/utils.h"
 #include <algorithm>
 #include <stdlib.h>
 #include <string.h>
@@ -25,11 +26,6 @@ namespace mbed {
 
 static const bd_size_t min_blank_buf_size = 32;
 
-static inline uint32_t align_up(bd_size_t val, bd_size_t size)
-{
-    return (((val - 1) / size) + 1) * size;
-}
-
 FlashSimBlockDevice::FlashSimBlockDevice(BlockDevice *bd, uint8_t erase_value) :
     _erase_value(erase_value), _blank_buf_size(0),
     _blank_buf(0), _bd(bd), _init_ref_count(0), _is_initialized(false)
@@ -222,4 +218,3 @@ const char *FlashSimBlockDevice::get_type() const
 }
 
 } // namespace mbed
-

features/storage/internal/utils.cpp

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2018 ARM Limited. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ * Licensed under the Apache License, Version 2.0 (the License); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "utils.h"
+#include "MbedCRC.h"
+
+using namespace mbed;
+
+uint32_t align_up(uint64_t val, uint64_t size)
+{
+    return (((val - 1) / size) + 1) * size;
+}
+
+uint32_t align_down(uint64_t val, uint64_t size)
+{
+    return (((val) / size)) * size;
+}
+
+uint32_t calc_crc(uint32_t init_crc, uint32_t data_size, const void *data_buf)
+{
+    uint32_t crc;
+    MbedCRC<POLY_32BIT_ANSI, 32> ct(init_crc, 0x0, true, false);
+    ct.compute(data_buf, data_size, &crc);
+    return crc;
+}

features/storage/internal/utils.h

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2019 ARM Limited. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ * Licensed under the Apache License, Version 2.0 (the License); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef STORAGE_UTILS_H
+#define STORAGE_UTILS_H
+
+#include <stdint.h>
+
+/** \defgroup storage-internal-api Storage-internal
+ * @{
+ * \ingroup mbed-os-internal
+ */
+
+/** Align an address to next border of given block size.
+ * @param val   unaligned value.
+ * @param size  block size to align for.
+ * @return Aligned value
+ */
+uint32_t align_up(uint64_t val, uint64_t size);
+
+/** Align an address to previous border of given block size.
+ * @param val   unaligned value.
+ * @param size  block size to align for.
+ * @return Aligned value
+ */
+uint32_t align_down(uint64_t val, uint64_t size);
+
+/** Calculate CRC32 of given buffer.
+ * @param init_crc  Initial CRC or zero.
+ * @param data_size Size of given buffer
+ * @param data_buf  Pointer to buffer
+ * @return value of calculated CRC32
+ */
+uint32_t calc_crc(uint32_t init_crc, uint32_t data_size, const void *data_buf);
+
+/** @}*/
+
+#endif

features/storage/kvstore/conf/kv_config.cpp

@@ -27,8 +27,9 @@
 #include "mbed_error.h"
 #include "drivers/FlashIAP.h"
 #include "features/storage/blockdevice/FlashSimBlockDevice.h"
-#include "mbed_trace.h"
 #include "features/storage/kvstore/securestore/SecureStore.h"
+#include "features/storage/internal/utils.h"
+#include "mbed_trace.h"
 #define TRACE_GROUP "KVCFG"
 
 #if COMPONENT_FLASHIAP
@@ -162,16 +163,6 @@ static kvstore_config_t kvstore_config;
 #define _GET_BLOCKDEVICE_concat(dev, ...) _get_blockdevice_##dev(__VA_ARGS__)
 #define GET_BLOCKDEVICE(dev, ...) _GET_BLOCKDEVICE_concat(dev, __VA_ARGS__)
 
-static inline uint32_t align_up(uint64_t val, uint64_t size)
-{
-    return (((val - 1) / size) + 1) * size;
-}
-
-static inline uint32_t align_down(uint64_t val, uint64_t size)
-{
-    return (((val) / size)) * size;
-}
-
 int _calculate_blocksize_match_tdbstore(BlockDevice *bd)
 {
     bd_size_t size = bd->size();

features/storage/kvstore/direct_access_devicekey/DirectAccessDevicekey.cpp

@@ -22,6 +22,7 @@
 #include <stdio.h>
 #include "mbed_error.h"
 #include "MbedCRC.h"
+#include "features/storage/internal/utils.h"
 #include "mbed_trace.h"
 #define TRACE_GROUP "DADK"
 
@@ -51,9 +52,6 @@ static int calc_area_params(FlashIAP *flash, uint32_t out_tdb_start_offset, uint
                             tdbstore_area_data_t *area_params);
 static int reserved_data_get(FlashIAP *flash, tdbstore_area_data_t *area_params, void *reserved_data_buf,
                              size_t reserved_data_buf_size, size_t *actual_data_size_ptr);
-static inline uint32_t align_up(uint64_t val, uint64_t size);
-static inline uint32_t align_down(uint64_t val, uint64_t size);
-static uint32_t calc_crc(uint32_t init_crc, uint32_t data_size, const void *data_buf);
 
 // -------------------------------------------------- API Functions Implementation ----------------------------------------------------
 int direct_access_to_devicekey(uint32_t tdb_start_offset, uint32_t tdb_end_offset, void *data_buf,
@@ -295,21 +293,4 @@ static int reserved_data_get(FlashIAP *flash, tdbstore_area_data_t *area_params,
     return status;
 }
 
-static inline uint32_t align_up(uint64_t val, uint64_t size)
-{
-    return (((val - 1) / size) + 1) * size;
-}
-
-static inline uint32_t align_down(uint64_t val, uint64_t size)
-{
-    return (((val) / size)) * size;
-}
-
-static uint32_t calc_crc(uint32_t init_crc, uint32_t data_size, const void *data_buf)
-{
-    uint32_t crc;
-    MbedCRC<POLY_32BIT_ANSI, 32> ct(init_crc, 0x0, true, false);
-    ct.compute(data_buf, data_size, &crc);
-    return crc;
-}
 #endif // DEVICE_FLASH

features/storage/kvstore/direct_access_devicekey/DirectAccessDevicekey.h

@@ -24,7 +24,7 @@
  *
  * @param[in]  tdb_start_offset     FlashIAP Start address offset of tdb store
  * @param[in]  tdb_end_offset       FlashIAP End address offset of tdb store
- * @param[in]  data_buf             Buffer to store devicekey data
+ * @param[out] data_buf             Buffer to store devicekey data
  * @param[in]  data_buf_size        Max expected size of buffer to store the devicekey data
  * @param[out] actual_data_size_ptr Actual retrieved devicekey size
  *

features/storage/kvstore/tdbstore/TDBStore.cpp

@@ -23,11 +23,11 @@
 #include <stdio.h>
 #include "mbed_error.h"
 #include "mbed_wait_api.h"
-#include "MbedCRC.h"
 //Bypass the check of NVStore co existance if compiled for TARGET_TFM
 #if !(BYPASS_NVSTORE_CHECK)
 #include "features/storage/system_storage/SystemStorage.h"
 #endif
+#include "features/storage/internal/utils.h"
 
 using namespace mbed;
 
@@ -103,25 +103,6 @@ typedef struct {
 
 } // anonymous namespace
 
-
-// -------------------------------------------------- Local Functions Declaration ----------------------------------------------------
-
-// -------------------------------------------------- Functions Implementation ----------------------------------------------------
-
-static inline uint32_t align_up(uint32_t val, uint32_t size)
-{
-    return (((val - 1) / size) + 1) * size;
-}
-
-
-static uint32_t calc_crc(uint32_t init_crc, uint32_t data_size, const void *data_buf)
-{
-    uint32_t crc;
-    MbedCRC<POLY_32BIT_ANSI, 32> ct(init_crc, 0x0, true, false);
-    ct.compute(data_buf, data_size, &crc);
-    return crc;
-}
-
 // Class member functions
 
 TDBStore::TDBStore(BlockDevice *bd) : _ram_table(0), _max_keys(0),
@@ -861,7 +842,6 @@ int TDBStore::garbage_collection()
 {
     ram_table_entry_t *ram_table = (ram_table_entry_t *) _ram_table;
     uint32_t to_offset, to_next_offset;
-    uint32_t chunk_size, reserved_size;
     int ret;
     size_t ind;
 
@@ -997,7 +977,7 @@ int TDBStore::init()
     uint32_t next_offset;
     uint32_t flags, hash;
     uint32_t actual_data_size;
-    int os_ret, ret = MBED_SUCCESS;
+    int ret;
     uint16_t versions[_num_areas];
 
     _mutex.lock();

features/storage/nvstore/source/nvstore.cpp

@@ -26,6 +26,7 @@
 #include "mbed_assert.h"
 #include "mbed_error.h"
 #include "ThisThread.h"
+#include "features/storage/internal/utils.h"
 #include <algorithm>
 #include <string.h>
 #include <stdio.h>
@@ -112,38 +113,6 @@ NVStore::nvstore_area_data_t NVStore::initial_area_params[] = {{0, 0},
 
 // -------------------------------------------------- Functions Implementation ----------------------------------------------------
 
-// Align a value to a specified size.
-// Parameters :
-// val           - [IN]   Value.
-// size          - [IN]   Size.
-// Return        : Aligned value.
-static inline uint32_t align_up(uint32_t val, uint32_t size)
-{
-    return (((val - 1) / size) + 1) * size;
-}
-
-// CRC32 calculation. Supports "rolling" calculation (using the initial value).
-// Parameters :
-// init_crc      - [IN]   Initial CRC.
-// data_size      - [IN]   Buffer's data size.
-// data_buf      - [IN]   Data buffer.
-// Return        : CRC.
-static uint32_t crc32(uint32_t init_crc, uint32_t data_size, uint8_t *data_buf)
-{
-    uint32_t i, j;
-    uint32_t crc, mask;
-
-    crc = init_crc;
-    for (i = 0; i < data_size; i++) {
-        crc = crc ^ (uint32_t)(data_buf[i]);
-        for (j = 0; j < 8; j++) {
-            mask = -(crc & 1);
-            crc = (crc >> 1) ^ (0xEDB88320 & mask);
-        }
-    }
-    return crc;
-}
-
 NVStore::NVStore() : _init_done(0), _init_attempts(0), _active_area(0), _max_keys(NVSTORE_MAX_KEYS),
     _active_area_version(0), _free_space_offset(0), _size(0), _mutex(0), _offset_by_key(0), _flash_area_params{},
     _flash(0), _min_prog_size(0), _page_buf(0)
@@ -359,7 +328,7 @@ int NVStore::read_record(uint8_t area, uint32_t offset, uint16_t buf_size, void
         return NVSTORE_READ_ERROR;
     }
 
-    crc = crc32(crc, sizeof(header) - sizeof(header.crc), (uint8_t *) &header);
+    crc = calc_crc(crc, sizeof(header) - sizeof(header.crc), (uint8_t *) &header);
 
     actual_size = 0;
     key   = header.key_and_flags & ~header_flag_mask;
@@ -396,7 +365,7 @@ int NVStore::read_record(uint8_t area, uint32_t offset, uint16_t buf_size, void
         if (os_ret) {
             return NVSTORE_READ_ERROR;
         }
-        crc = crc32(crc, chunk_size, (uint8_t *) buf_ptr);
+        crc = calc_crc(crc, chunk_size, (uint8_t *) buf_ptr);
         data_size -= chunk_size;
         offset += chunk_size;
     }
@@ -423,9 +392,9 @@ int NVStore::write_record(uint8_t area, uint32_t offset, uint16_t key, uint16_t
     header.key_and_flags = key | flags;
     header.size_and_owner = data_size | (owner << owner_bit_pos);
     header.crc = 0; // Satisfy compiler
-    crc = crc32(crc, sizeof(header) - sizeof(header.crc), (uint8_t *) &header);
+    crc = calc_crc(crc, sizeof(header) - sizeof(header.crc), (uint8_t *) &header);
     if (data_size) {
-        crc = crc32(crc, data_size, (uint8_t *) data_buf);
+        crc = calc_crc(crc, data_size, (uint8_t *) data_buf);
     }
     header.crc = crc;