int32_t cfstore_flush3_read_file(const char *fileDir, size_t maxFilePathSize, const char *fileName, uint8_t *buff, size_t buffSize) { int32_t cfsStatus; int32_t status = ARM_DRIVER_OK; ARM_CFSTORE_DRIVER *cfstoreDriver = &cfstore_driver; ARM_CFSTORE_FMODE flags; ARM_CFSTORE_SIZE readCount = buffSize; ARM_CFSTORE_HANDLE_INIT(hkey); CFSTORE_DBGLOG("%s:IN. File name %s, buffer %p, buffsize %d\n", __func__, fileName, buff, buffSize); CFSTORE_UNUSED_PARAM(fileDir); CFSTORE_UNUSED_PARAM(maxFilePathSize); CFSTORE_TEST_UTEST_MESSAGE(cfstore_flush3_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Uninitialize Cfstore\n", __func__); TEST_ASSERT_MESSAGE(cfstoreDriver != NULL, cfstore_flush3_utest_msg_g); CFSTORE_TEST_UTEST_MESSAGE(cfstore_flush3_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Invalid file name\n", __func__); TEST_ASSERT_MESSAGE(fileName != NULL, cfstore_flush3_utest_msg_g); CFSTORE_TEST_UTEST_MESSAGE(cfstore_flush3_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Invalid buff\n", __func__); TEST_ASSERT_MESSAGE(buff != NULL, cfstore_flush3_utest_msg_g); memset(&flags, 0, sizeof(flags)); flags.read = true; cfsStatus = cfstoreDriver->Open(fileName, flags, hkey); if(cfsStatus == ARM_CFSTORE_DRIVER_ERROR_KEY_NOT_FOUND){ CFSTORE_DBGLOG("File (%s) not found (err %ld)\n", fileName, cfsStatus); return ARM_CFSTORE_DRIVER_ERROR_KEY_NOT_FOUND; } if(cfsStatus < ARM_DRIVER_OK){ CFSTORE_DBGLOG("Open failed (err %ld)\n", cfsStatus); return ARM_DRIVER_ERROR; } cfsStatus = cfstoreDriver->Read(hkey, buff, &readCount); if(cfsStatus < ARM_DRIVER_OK){ CFSTORE_DBGLOG("Read failed (err %ld)\n", cfsStatus); status = ARM_DRIVER_ERROR; goto out; } if(readCount < buffSize){ CFSTORE_DBGLOG("Read failed, amount is %zu while requested %zu\n", readCount, buffSize); status = ARM_DRIVER_ERROR; goto out; } out: cfsStatus = cfstoreDriver->Close(hkey); if(cfsStatus < ARM_DRIVER_OK){ CFSTORE_DBGLOG("Close failed (err %ld)\n", cfsStatus); return ARM_DRIVER_ERROR; } CFSTORE_DBGLOG("%s:OUT: status=%d\n", __func__, (int) status); return status; }
/** @brief test to write many times to an open KV to test data is appended * sequentially to the end of the value blob * * @return on success returns CaseNext to continue to next test case, otherwise will assert on errors. */ control_t cfstore_write_test_01_end(const size_t call_count) { char read_buf[CFSTORE_KEY_NAME_MAX_LENGTH+1]; uint32_t i = 0; int32_t ret = ARM_DRIVER_ERROR; ARM_CFSTORE_SIZE len = 0; ARM_CFSTORE_DRIVER* drv = &cfstore_driver; ARM_CFSTORE_KEYDESC kdesc; ARM_CFSTORE_HANDLE_INIT(hkey); ARM_CFSTORE_FMODE flags; CFSTORE_DBGLOG("%s:entered\n", __func__); (void) call_count; memset(read_buf, 0, CFSTORE_KEY_NAME_MAX_LENGTH+1); memset(&kdesc, 0, sizeof(kdesc)); memset(&flags, 0, sizeof(flags)); /* create an empty KV of the required length */ kdesc.drl = ARM_RETENTION_WHILE_DEVICE_ACTIVE; len = strlen(cfstore_write_test_01_kv_data[0].value); ret = cfstore_test_create(cfstore_write_test_01_kv_data[0].key_name, "one", &len, &kdesc); CFSTORE_TEST_UTEST_MESSAGE(cfstore_write_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: failed to create new KV (key_name=%s, ret=%d).\n", __func__, cfstore_write_test_01_kv_data[0].key_name, (int) ret); TEST_ASSERT_MESSAGE(ret >= ARM_DRIVER_OK, cfstore_write_utest_msg_g); /* now open the newly created key and write repeated to created the string */ flags.write = true; ret = drv->Open(cfstore_write_test_01_kv_data[0].key_name, flags, hkey); CFSTORE_TEST_UTEST_MESSAGE(cfstore_write_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: failed to open node (key_name=\"%s\", value=\"%s\")(ret=%d)\n", __func__, cfstore_write_test_01_kv_data[0].key_name, cfstore_write_test_01_kv_data[0].value, (int) ret); TEST_ASSERT_MESSAGE(ret >= ARM_DRIVER_OK, cfstore_write_utest_msg_g); for(i = 0; i < strlen(cfstore_write_test_01_kv_data[0].value); i++) { len = 1; ret = drv->Write(hkey, &cfstore_write_test_01_kv_data[0].value[i], &len); CFSTORE_TEST_UTEST_MESSAGE(cfstore_write_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: Write failed for char (\'%c\') (ret=%d)\n", __func__, cfstore_write_test_01_kv_data[0].value[i], (int) ret); TEST_ASSERT_MESSAGE(ret >= ARM_DRIVER_OK, cfstore_write_utest_msg_g); } /* check that the value created in the key is as expected*/ len = CFSTORE_KEY_NAME_MAX_LENGTH+1; ret = drv->Read(hkey, read_buf, &len); CFSTORE_TEST_UTEST_MESSAGE(cfstore_write_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: Read failed (ret=%d)\n", __func__, (int) ret); TEST_ASSERT_MESSAGE(ret >= ARM_DRIVER_OK, cfstore_write_utest_msg_g); /* check node key_names are identical */ CFSTORE_TEST_UTEST_MESSAGE(cfstore_write_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: KV value (%s) is not as expected (%s).\n", __func__, read_buf, cfstore_write_test_01_kv_data[0].value); TEST_ASSERT_MESSAGE(strncmp(read_buf, cfstore_write_test_01_kv_data[0].value, strlen(cfstore_write_test_01_kv_data[0].value)) == 0, cfstore_write_utest_msg_g); CFSTORE_TEST_UTEST_MESSAGE(cfstore_write_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: Close() call failed.\n", __func__); TEST_ASSERT_MESSAGE(drv->Close(hkey) >= ARM_DRIVER_OK, cfstore_write_utest_msg_g); cfstore_test_delete_all(); ret = drv->Uninitialize(); CFSTORE_TEST_UTEST_MESSAGE(cfstore_write_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: Uninitialize() call failed.\n", __func__); TEST_ASSERT_MESSAGE(ret >= ARM_DRIVER_OK, cfstore_write_utest_msg_g); return CaseNext; }
/* @brief test utility function to check a node appears correctly in the cfstore * @note this function expects cfstore to have been initialised with * a call to ARM_CFSTORE_DRIVER::Initialize() */ int32_t cfstore_test_check_node_correct(const cfstore_kv_data_t* node) { char* read_buf; int32_t ret = ARM_DRIVER_ERROR; ARM_CFSTORE_SIZE len = 0; ARM_CFSTORE_DRIVER* drv = &cfstore_driver; ARM_CFSTORE_HANDLE_INIT(hkey); ARM_CFSTORE_FMODE flags; CFSTORE_FENTRYLOG("%s:entered\r\n", __func__); memset(&flags, 0, sizeof(flags)); ret = drv->Open(node->key_name, flags, hkey); if(ret < ARM_DRIVER_OK){ CFSTORE_ERRLOG("%s:Error: failed to open node (key_name=\"%s\", value=\"%s\")(ret=%d)\r\n", __func__, node->key_name, node->value, (int) ret); goto out0; } len = strlen(node->value) + 1; read_buf = (char*) malloc(len); if(read_buf == NULL) { CFSTORE_ERRLOG("%s:Error: failed to allocated read buffer \r\n", __func__); goto out1; } memset(read_buf, 0, len); ret = drv->Read(hkey, read_buf, &len); if(ret < ARM_DRIVER_OK){ CFSTORE_ERRLOG("%s:Error: failed to write key (key_name=\"%s\", value=\"%s\")\r\n", __func__, node->key_name, node->value); goto out2; } /* check read data is as expected */ if(strncmp(read_buf, node->value, strlen(node->value)) != 0){ CFSTORE_ERRLOG("%s:Error: read value data (%s) != KV value data (key_name=\"%s\", value=\"%s\")\r\n", __func__, read_buf, node->key_name, node->value); ret = ARM_DRIVER_ERROR; } out2: if(read_buf) free(read_buf); out1: drv->Close(hkey); hkey = NULL; out0: return ret; }
/* @brief test utility function to read the value blob of a specified KV * @note this function expects cfstore to have been initialised with * a call to ARM_CFSTORE_DRIVER::Initialize() */ int32_t cfstore_test_read(const char* key_name, char* data, ARM_CFSTORE_SIZE* len) { int32_t ret = ARM_DRIVER_ERROR; ARM_CFSTORE_DRIVER* drv = &cfstore_driver; ARM_CFSTORE_HANDLE_INIT(hkey); ARM_CFSTORE_FMODE flags; CFSTORE_FENTRYLOG("%s:entered\r\n", __func__); memset(&flags, 0, sizeof(flags)); if(key_name == NULL) { CFSTORE_ERRLOG("%s:invalid key_name argument \r\n", __func__); goto out0; } if(data == NULL) { CFSTORE_ERRLOG("%s:invalid data argument \r\n", __func__); goto out0; } if(len == NULL) { CFSTORE_ERRLOG("%s:invalid len argument \r\n", __func__); goto out0; } ret = drv->Open(key_name, flags, hkey); if(ret < ARM_DRIVER_OK){ CFSTORE_ERRLOG("%s:Error: failed to open node (key_name=\"%s\")(ret=%d)\r\n", __func__, key_name, (int) ret); goto out1; } ret = drv->Read(hkey, data, len); if(ret < ARM_DRIVER_OK){ CFSTORE_ERRLOG("%s:Error: failed to read key (key_name=\"%s\"\r\n", __func__, key_name); goto out2; } out2: drv->Close(hkey); out1: out0: return ret; }
/** @brief * Basic open test which does the following: * - creates KV with default rw perms and writes some data to the value blob. * - closes the newly created KV. * - opens the KV with the default permissions (r-only) * - reads the KV data and checks its the same as the previously created data. * - closes the opened key * * @return on success returns CaseNext to continue to next test case, otherwise will assert on errors. */ control_t cfstore_open_test_01_end(const size_t call_count) { char* read_buf; int32_t ret = ARM_DRIVER_ERROR; ARM_CFSTORE_SIZE len = 0; ARM_CFSTORE_DRIVER* drv = &cfstore_driver; ARM_CFSTORE_KEYDESC kdesc; ARM_CFSTORE_HANDLE_INIT(hkey); cfstore_kv_data_t *node; ARM_CFSTORE_FMODE flags; CFSTORE_DBGLOG("%s:entered\n", __func__); (void) call_count; node = cfstore_open_test_01_kv_data; memset(&kdesc, 0, sizeof(kdesc)); memset(&flags, 0, sizeof(flags)); kdesc.drl = ARM_RETENTION_WHILE_DEVICE_ACTIVE; CFSTORE_DBGLOG("%s:About to create new node (key_name=\"%s\", value=\"%s\")\n", __func__, node->key_name, node->value); ret = drv->Create(node->key_name, strlen(node->value), &kdesc, hkey); CFSTORE_TEST_UTEST_MESSAGE(cfstore_open_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: failed to create node (key_name=\"%s\", value=\"%s\")(ret=%d)\n", __func__, node->key_name, node->value, (int) ret); TEST_ASSERT_MESSAGE(ret >= ARM_DRIVER_OK, cfstore_open_utest_msg_g); CFSTORE_DBGLOG("%s:length of KV=%d (key_name=\"%s\", value=\"%s\")\n", __func__, (int) len, node->key_name, node->value); len = strlen(node->value); ret = drv->Write(hkey, (char*) node->value, &len); CFSTORE_TEST_UTEST_MESSAGE(cfstore_open_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: failed to write key (key_name=\"%s\", value=\"%s\")(ret=%d)\n", __func__, node->key_name, node->value, (int) ret); TEST_ASSERT_MESSAGE(ret >= ARM_DRIVER_OK, cfstore_open_utest_msg_g); CFSTORE_TEST_UTEST_MESSAGE(cfstore_open_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: failed to write full value data (key_name=\"%s\", value=\"%s\"), len=%d, (ret=%d)\n", __func__, node->key_name, node->value, (int) len, (int) ret); TEST_ASSERT_MESSAGE(len == strlen(node->value), cfstore_open_utest_msg_g); CFSTORE_DBGLOG("Created KV successfully (key_name=\"%s\", value=\"%s\")\n", node->key_name, node->value); ret = drv->Close(hkey); CFSTORE_TEST_UTEST_MESSAGE(cfstore_open_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: failed to close handle (ret=%d)\n", __func__, (int) ret); TEST_ASSERT_MESSAGE(ret >= ARM_DRIVER_OK, cfstore_open_utest_msg_g); /* now open the newly created key */ ret = drv->Open(node->key_name, flags, hkey); CFSTORE_TEST_UTEST_MESSAGE(cfstore_open_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: failed to open node (key_name=\"%s\", value=\"%s\")(ret=%d)\n", __func__, node->key_name, node->value, (int) ret); TEST_ASSERT_MESSAGE(ret >= ARM_DRIVER_OK, cfstore_open_utest_msg_g); len = strlen(node->value) + 1; read_buf = (char*) malloc(len); CFSTORE_TEST_UTEST_MESSAGE(cfstore_open_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: failed to allocated read buffer \n", __func__); TEST_ASSERT_MESSAGE(read_buf != NULL, cfstore_open_utest_msg_g); CFSTORE_DBGLOG("Opened KV successfully (key_name=\"%s\", value=\"%s\")\n", node->key_name, node->value); memset(read_buf, 0, len); ret = drv->Read(hkey, read_buf, &len); CFSTORE_TEST_UTEST_MESSAGE(cfstore_open_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: failed to write key (key_name=\"%s\", value=\"%s\")\n", __func__, node->key_name, node->value); TEST_ASSERT_MESSAGE(ret >= ARM_DRIVER_OK, cfstore_open_utest_msg_g); /* check read data is as expected */ CFSTORE_TEST_UTEST_MESSAGE(cfstore_open_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: read value data (%s) != KV value data (key_name=\"%s\", value=\"%s\")\n", __func__, read_buf, node->key_name, node->value); TEST_ASSERT_MESSAGE(strncmp(read_buf, node->value, strlen(node->value)) == 0, cfstore_open_utest_msg_g); if(read_buf){ free(read_buf); } CFSTORE_TEST_UTEST_MESSAGE(cfstore_open_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: Close() call failed.\n", __func__); TEST_ASSERT_MESSAGE(drv->Close(hkey) >= ARM_DRIVER_OK, cfstore_open_utest_msg_g); ret = drv->Uninitialize(); CFSTORE_TEST_UTEST_MESSAGE(cfstore_open_utest_msg_g, CFSTORE_UTEST_MSG_BUF_SIZE, "%s:Error: Uninitialize() call failed.\n", __func__); TEST_ASSERT_MESSAGE(ret >= ARM_DRIVER_OK, cfstore_open_utest_msg_g); return CaseNext; }
/* @brief utility test function to initialise cfstore sram area with some * KV's to manipulate * @note this function expects cfstore to have been initialised with * a call to ARM_CFSTORE_DRIVER::Initialize() */ int32_t cfstore_test_init_1(void) { char* read_buf = NULL; const uint8_t key_name_max_len = CFSTORE_KEY_NAME_MAX_LENGTH+1; uint8_t key_name_len = 0; char key_name_buf[CFSTORE_KEY_NAME_MAX_LENGTH+1]; int32_t ret = ARM_DRIVER_ERROR; ARM_CFSTORE_SIZE len = 0; ARM_CFSTORE_SIZE max_len = 0; ARM_CFSTORE_DRIVER* drv = &cfstore_driver; cfstore_kv_data_t* node = NULL; ARM_CFSTORE_KEYDESC kdesc; ARM_CFSTORE_HANDLE_INIT(hkey); CFSTORE_FENTRYLOG("%s:entered\r\n", __func__); memset(&kdesc, 0, sizeof(kdesc)); memset(key_name_buf, 0, CFSTORE_KEY_NAME_MAX_LENGTH+1); /*scan for max length of value blob*/ node = cfstore_test_init_1_data; while(node->key_name != NULL) { len = strlen(node->value); if(len > max_len){ max_len = len; max_len++; } node++; } read_buf = (char*) malloc(max_len); if(read_buf == NULL) { CFSTORE_ERRLOG("%s:Error: failed to allocated read buffer \r\n", __func__); return ret; } kdesc.drl = ARM_RETENTION_WHILE_DEVICE_ACTIVE; node = cfstore_test_init_1_data; while(node->key_name != NULL) { CFSTORE_DBGLOG("%s:About to create new node (key_name=\"%s\", value=\"%s\")\r\n", __func__, node->key_name, node->value); ret = drv->Create(node->key_name, strlen(node->value), &kdesc, hkey); if(ret < ARM_DRIVER_OK){ CFSTORE_ERRLOG("%s:Error: failed to create node (key_name=\"%s\", value=\"%s\")\r\n", __func__, node->key_name, node->value); return ret; } CFSTORE_DBGLOG("%s:length of KV=%d (key_name=\"%s\", value=\"%s\")\r\n", __func__, (int) len, node->key_name, node->value); len = strlen(node->value); ret = drv->Write(hkey, (char*) node->value, &len); if(ret < ARM_DRIVER_OK){ CFSTORE_ERRLOG("%s:Error: failed to write key (key_name=\"%s\", value=\"%s\")\r\n", __func__, node->key_name, node->value); drv->Close(hkey); return ret; } if(len != strlen(node->value)){ CFSTORE_ERRLOG("%s:Error: failed to write full value data (key_name=\"%s\", value=\"%s\"), len=%d\r\n", __func__, node->key_name, node->value, (int) len); drv->Close(hkey); return ARM_DRIVER_ERROR; } /* read the data back*/ len = strlen(node->value); memset(read_buf, 0, max_len); ret = drv->Read(hkey, read_buf, &len); if(ret < ARM_DRIVER_OK){ CFSTORE_ERRLOG("%s:Error: failed to read key (key_name=\"%s\", value=\"%s\")\r\n", __func__, node->key_name, node->value); drv->Close(hkey); return ret; } if(len != strlen(node->value)){ CFSTORE_ERRLOG("%s:Error: failed to read full value data (key_name=\"%s\", value=\"%s\"), len=%d, ret=%d\r\n", __func__, node->key_name, node->value, (int) len, (int) ret); drv->Close(hkey); return ARM_DRIVER_ERROR; } key_name_len = key_name_max_len; memset(key_name_buf, 0, key_name_len); drv->GetKeyName(hkey, key_name_buf, &key_name_len); if(len != strlen(node->value)){ CFSTORE_ERRLOG("%s:Error: failed to GetKeyName() (key_name=\"%s\", value=\"%s\"), len=%d\r\n", __func__, node->key_name, node->value, (int) len); drv->Close(hkey); return ARM_DRIVER_ERROR; } /* revert CFSTORE_LOG for more trace */ CFSTORE_DBGLOG("Created KV successfully (key_name=\"%s\", value=\"%s\")\r\n", key_name_buf, read_buf); drv->Close(hkey); node++; } free(read_buf); return ret; }
/* @brief function to dump contents of cfstore */ int32_t cfstore_test_dump(void) { const char* key_name_query = "*"; char* read_buf = NULL; char key_name[CFSTORE_KEY_NAME_MAX_LENGTH+1]; uint8_t len = CFSTORE_KEY_NAME_MAX_LENGTH+1; ARM_CFSTORE_SIZE vlen = 0; int32_t ret = ARM_DRIVER_ERROR; ARM_CFSTORE_DRIVER* drv = &cfstore_driver; ARM_CFSTORE_HANDLE_INIT(next); ARM_CFSTORE_HANDLE_INIT(prev); ARM_CFSTORE_CAPABILITIES caps = cfstore_driver.GetCapabilities(); CFSTORE_FENTRYLOG("%s:entered\n", __func__); CFSTORE_LOG("CFSTORE Flash Entries%s", "\n"); CFSTORE_LOG("=====================%s", "\n\n"); while((ret = drv->Find(key_name_query, prev, next)) == ARM_DRIVER_OK) { len = CFSTORE_KEY_NAME_MAX_LENGTH+1; ret = drv->GetKeyName(next, key_name, &len); if(ret < ARM_DRIVER_OK){ CFSTORE_ERRLOG("Error: failed to get key name%s", "\n"); break; } ret = drv->GetValueLen(next, &vlen); if(ret < ARM_DRIVER_OK){ CFSTORE_ERRLOG("Error: failed to get value length%s", "\n"); break; } read_buf = (char*) malloc(vlen+1); if(read_buf == NULL){ CFSTORE_ERRLOG("Error: failed to malloc() read buffer%s", "\n"); break; } ret = drv->Read(next, read_buf, &vlen); if(ret < ARM_DRIVER_OK){ CFSTORE_ERRLOG("Error: failed to read key value%s", "\n"); free(read_buf); break; } CFSTORE_LOG(" keyname : %s\n", key_name); CFSTORE_LOG(" name len : %d\n", (int) len); CFSTORE_LOG(" value len : %d\n", (int) vlen); CFSTORE_LOG(" data :%s", "\n"); cfstore_test_dump_print_array((const char*) read_buf, vlen); CFSTORE_LOG("%s", ".\n"); free(read_buf); CFSTORE_HANDLE_SWAP(prev, next); } CFSTORE_LOG("%s", ".\n"); CFSTORE_LOG(" caps.asynchronous_ops : %d\n", (int) caps.asynchronous_ops); CFSTORE_LOG("%s", ".\n"); CFSTORE_LOG("== End ==============%s", "\n\n"); if(ret == ARM_CFSTORE_DRIVER_ERROR_KEY_NOT_FOUND) { /* As expected, no more keys have been found by the Find(). */ ret = ARM_DRIVER_OK; } return ret; }