Files
filex/test/regression_test/filex_fault_tolerant_file_delete_test.c
T
Frédéric DesbiensandCopilot 30e1d491a9 Added copyright headers to files missing them
Applied the standard MIT license header to all project-owned C, header,
assembly, shell, and Python files that were missing a copyright notice.
Third-party, toolchain startup, and auto-generated files were excluded.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-06 21:48:17 +02:00

440 lines
14 KiB
C

/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation */
/* Copyright (c) 2026 Eclipse ThreadX contributors */
/* */
/* This program and the accompanying materials are made available under */
/* the terms of the MIT License which is available at */
/* https://opensource.org/licenses/MIT. */
/* */
/* SPDX-License-Identifier: MIT */
/***************************************************************************/
/* This FileX test is determined to cover filex_fault_tolerant_file_delete */
#ifndef FX_STANDALONE_ENABLE
#include "tx_api.h"
#else
#define _GNU_SOURCE
#define _DEFAULT_SOURCE
#include <pthread.h>
#include <unistd.h>
#endif
#include "fx_api.h"
#include "fx_system.h"
#include "fx_fault_tolerant.h"
#include <stdio.h>
#include "fx_ram_driver_test.h"
extern void test_control_return(UINT status);
void filex_fault_tolerant_file_delete_test_application_define(void *first_unused_memory);
#if defined (FX_ENABLE_FAULT_TOLERANT) && defined (FX_FAULT_TOLERANT) && defined (FX_FAULT_TOLERANT_DATA)
#define DEMO_STACK_SIZE 4096
#define CACHE_SIZE 2048
#define FAULT_TOLERANT_SIZE FX_FAULT_TOLERANT_MINIMAL_BUFFER_SIZE
/* Define the ThreadX and FileX object control blocks... */
#ifndef FX_STANDALONE_ENABLE
static TX_THREAD ftest_0;
static TX_THREAD ftest_1;
#else
static pthread_t ptid1;
#endif
static FX_MEDIA ram_disk;
static FX_FILE my_file;
static UCHAR *pointer;
/* Define the counters used in the test application... */
#ifndef FX_STANDALONE_ENABLE
static UCHAR *cache_buffer;
static UCHAR *fault_tolerant_buffer;
static UCHAR *thread_buffer;
#else
static UCHAR cache_buffer[CACHE_SIZE];
static UCHAR fault_tolerant_buffer[FAULT_TOLERANT_SIZE];
#endif
static UINT fat_write_interrupt = FX_FALSE;
static CHAR read_buffer[1024];
static UINT read_buffer_size = 1024;
#define TEST_COUNT 3
/* Define thread prototypes. */
static void ftest_0_entry(ULONG thread_input);
#ifndef FX_STANDALONE_ENABLE
static void ftest_1_entry(ULONG thread_input);
#else
static void * ftest_1_entry(void * thread_input);
#endif
extern void _fx_ram_driver(FX_MEDIA *media_ptr);
extern void test_control_return(UINT status);
extern UINT _filex_fault_tolerant_log_check(FX_MEDIA *media_ptr);
extern UINT(*driver_write_callback)(FX_MEDIA *media_ptr, UINT sector_type, UCHAR *block_ptr, UINT *operation_ptr);
static UINT my_driver_write(FX_MEDIA *media_ptr, UINT sector_type, UCHAR *block_ptr, UINT *operation_ptr);
/* Create a terrible driver. */
static UINT driver_called_counter = 0;
static void _fx_terrible_driver(FX_MEDIA *media_ptr)
{
driver_called_counter++;
// printf("\n_fx_terrible_driver has been called %d times.", driver_called_counter);
if (driver_called_counter == 1)
{
media_ptr->fx_media_driver_status = FX_IO_ERROR;
return;
}
(*_fx_ram_driver)(media_ptr);
}
/* Define what the initial system looks like. */
#ifdef CTEST
void test_application_define(void *first_unused_memory)
#else
void filex_fault_tolerant_file_delete_test_application_define(void *first_unused_memory)
#endif
{
#ifndef FX_STANDALONE_ENABLE
/* Setup the working pointer. */
pointer = (UCHAR *)first_unused_memory;
/* Create the main thread. */
tx_thread_create(&ftest_0, "thread 0", ftest_0_entry, 0,
pointer, DEMO_STACK_SIZE,
4, 4, TX_NO_TIME_SLICE, TX_AUTO_START);
pointer = pointer + DEMO_STACK_SIZE;
/* Setup memory for the RAM disk and the sector cache. */
cache_buffer = pointer;
pointer += CACHE_SIZE;
fault_tolerant_buffer = pointer;
pointer += FAULT_TOLERANT_SIZE;
thread_buffer = pointer;
pointer += DEMO_STACK_SIZE;
#endif
/* Initialize the FileX system. */
fx_system_initialize();
#ifdef FX_STANDALONE_ENABLE
ftest_0_entry(0);
#endif
}
/* Define the test threads. */
static void ftest_0_entry(ULONG thread_input)
{
UINT status;
ULONG actual;
UINT i;
FX_PARAMETER_NOT_USED(thread_input);
/* Print out some test information banners. */
printf("FileX Test: Fault Tolerant File Delete Test........................");
/* Loop to test FAT 12, 16, 32. */
for (i = 0; i < TEST_COUNT; i++)
{
if (i == 0)
{
/* Format the media with FAT12. This needs to be done before opening it! */
status = fx_media_format(&ram_disk,
_fx_ram_driver, // Driver entry
ram_disk_memory_large, // RAM disk memory pointer
cache_buffer, // Media buffer pointer
CACHE_SIZE, // Media buffer size
"MY_RAM_DISK", // Volume Name
1, // Number of FATs
32, // Directory Entries
0, // Hidden sectors
256, // Total sectors
256, // Sector size
8, // Sectors per cluster
1, // Heads
1); // Sectors per track
}
else if (i == 1)
{
/* Format the media with FAT16. This needs to be done before opening it! */
status = fx_media_format(&ram_disk,
_fx_ram_driver, // Driver entry
ram_disk_memory_large, // RAM disk memory pointer
cache_buffer, // Media buffer pointer
CACHE_SIZE, // Media buffer size
"MY_RAM_DISK", // Volume Name
1, // Number of FATs
32, // Directory Entries
0, // Hidden sectors
4200 * 8, // Total sectors
256, // Sector size
8, // Sectors per cluster
1, // Heads
1); // Sectors per track
}
else if (i == 2)
{
/* Format the media with FAT32. This needs to be done before opening it! */
status = fx_media_format(&ram_disk,
_fx_ram_driver, // Driver entry
ram_disk_memory_large, // RAM disk memory pointer
cache_buffer, // Media buffer pointer
CACHE_SIZE, // Media buffer size
"MY_RAM_DISK", // Volume Name
1, // Number of FATs
32, // Directory Entries
0, // Hidden sectors
70000 * 8, // Total sectors
256, // Sector size
8, // Sectors per cluster
1, // Heads
1); // Sectors per track
}
/* Determine if the format had an error. */
if (status)
{
printf("ERROR!\n");
test_control_return(1);
}
/* Open the ram_disk. */
status = fx_media_open(&ram_disk, "RAM DISK", _fx_ram_driver, ram_disk_memory_large, cache_buffer, CACHE_SIZE);
/* Check the status. */
if (status != FX_SUCCESS)
{
/* Output successful. */
printf("SUCCESS!\n");
test_control_return(0);
}
/* Enable the Fault-tolerant feature. */
status = fx_fault_tolerant_enable(&ram_disk, fault_tolerant_buffer, FAULT_TOLERANT_SIZE);
/* Check status. */
if (status)
{
printf("ERROR!\n");
test_control_return(3);
}
/* Create a file called TEST2.TXT in the root directory. */
status = fx_file_create(&ram_disk, "TEST2.TXT");
/* Check the create status. */
if (status != FX_SUCCESS)
{
printf("ERROR!\n");
test_control_return(16);
}
/* Open the test file. */
status = fx_file_open(&ram_disk, &my_file, "TEST2.TXT", FX_OPEN_FOR_WRITE);
/* Check the file open status. */
if (status != FX_SUCCESS)
{
printf("ERROR!\n");
test_control_return(17);
}
/* Write a string to the test file. */
status = fx_file_write(&my_file, " EXPRESSLOGIC_TEST\n", 19);
/* Check the file write status. */
if (status != FX_SUCCESS)
{
printf("ERROR!\n");
test_control_return(18);
}
/* Seek to the beginning of the test file. */
status = fx_file_seek(&my_file, 0);
/* Check the file seek status. */
if (status != FX_SUCCESS)
{
printf("ERROR!\n");
test_control_return(19);
}
/* Read the bytes of the test file. */
status = fx_file_read(&my_file, read_buffer, read_buffer_size, &actual);
/* Check the file read status. */
if ((status != FX_SUCCESS) || (actual != 19))
{
printf("ERROR!\n");
test_control_return(20);
}
/* Close the test file. */
status = fx_file_close(&my_file);
/* Check the file close status. */
if (status != FX_SUCCESS)
{
printf("ERROR!\n");
test_control_return(21);
}
#ifndef FX_STANDALONE_ENABLE
/* Create the main thread. */
tx_thread_create(&ftest_1, "thread 1", ftest_1_entry, 0,
thread_buffer, DEMO_STACK_SIZE,
4, 4, TX_NO_TIME_SLICE, TX_AUTO_START);
#endif
/* directory_write_interrupt */
fat_write_interrupt = FX_FALSE;
/* Let the other thread run. */
#ifndef FX_STANDALONE_ENABLE
tx_thread_relinquish();
#else
pthread_create(&ptid1, NULL, &ftest_1_entry, NULL);
usleep(10);
pthread_join(ptid1,NULL);
#endif
/* Delete the thread. */
#ifndef FX_STANDALONE_ENABLE
tx_thread_delete(&ftest_1);
#else
pthread_cancel(ptid1);
#endif
}
/* Output successful. */
printf("SUCCESS!\n");
test_control_return(0);
}
/* Define the test threads. */
#ifndef FX_STANDALONE_ENABLE
static void ftest_1_entry(ULONG thread_input)
#else
void * ftest_1_entry(void * thread_input)
#endif
{
#ifdef FX_STANDALONE_ENABLE
UINT oldtype;
pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldtype);
#endif
UINT status;
FX_PARAMETER_NOT_USED(thread_input);
/* Set the callback function to simulate poweoff operation when write FAT entry. */
driver_write_callback = my_driver_write;
/* Register our terrible dirver to make IO ERROR at a particular time. */
ram_disk.fx_media_driver_entry = _fx_terrible_driver;
/* Create a file called TEST2.TXT in the root directory. */
status=fx_file_delete(&ram_disk, "TEST2.TXT");
return_value_if_fail(status == FX_IO_ERROR, 6);
/* Unregister our terrible driver. */
ram_disk.fx_media_driver_entry = _fx_ram_driver;
}
static UINT my_driver_write(FX_MEDIA *media_ptr, UINT sector_type, UCHAR *block_ptr, UINT *operation_ptr)
{
FX_PARAMETER_NOT_USED(block_ptr);
/* Interrupt the FAT write operation after record the redo log. */
if ((sector_type == FX_FAT_SECTOR) && (_filex_fault_tolerant_log_check(media_ptr) & FX_FAULT_TOLERANT_LOG_REDO_DONE))
{
/* Set the write interrupt operation. */
*operation_ptr = FX_OP_WRITE_INTERRUPT;
/* Update the flag. */
fat_write_interrupt = FX_TRUE;
/* Clean the callback function. */
driver_write_callback = FX_NULL;
/* Delete the media protection structure if FX_SINGLE_THREAD is not
defined. */
#ifndef FX_SINGLE_THREAD
#ifndef FX_DONT_CREATE_MUTEX
/* Note that the protection is never released. The mutex delete
service will handle all threads waiting access to this media
control block. */
tx_mutex_delete(&(media_ptr->fx_media_protect));
#endif
#endif
/* Clean the media data. */
_fx_system_media_opened_ptr = FX_NULL;
_fx_system_media_opened_count = 0;
/* Clean the media. */
memset(media_ptr, 0, sizeof(FX_MEDIA));
/* Simulate poweroff. */
/* First terminate the thread to ensure it is ready for deletion. */
#ifndef FX_STANDALONE_ENABLE
tx_thread_terminate(&ftest_1);
#else
pthread_cancel(ptid1);
#endif
}
/* Return. */
return FX_SUCCESS;
}
#else
#ifdef CTEST
void test_application_define(void *first_unused_memory)
#else
void filex_fault_tolerant_file_delete_test_application_define(void *first_unused_memory)
#endif
{
FX_PARAMETER_NOT_USED(first_unused_memory);
/* Print out some test information banners. */
printf("FileX Test: Fault Tolerant File Delete Test........................N/A\n");
test_control_return(255);
}
#endif