bertos/kern/kfile_test.c

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Test suite for virtual KFile I/O interface.
  34  *
  35  * This module implements a test for some generic I/O interfaces for kfile.
  36  *
  37  * \version $Id$
  38  * \author Francesco Sacchi <batt@develer.com>
  39  * \author Daniele Basile <asterix@develer.com>
  40  */
  41
  42
  43 #include "kfile.h"
  44
  45 #include "cfg/cfg_kfile.h"
  46 #include <cfg/debug.h>
  47 #include <cfg/test.h>
  48 #include <cfg/module.h>
  49
  50 // Define logging setting (for cfg/log.h module).
  51 #define LOG_LEVEL   KFILE_LOG_LEVEL
  52 #define LOG_FORMAT  KFILE_LOG_FORMAT
  53 #include <cfg/log.h>
  54
  55 #include <mware/formatwr.h>
  56
  57 #include <string.h>
  58
  59 MOD_DEFINE(kfile_test);
  60
  61 // Size of the "virtual" disk that
  62 // we want to test.
  63 #define BUF_TEST_LEN     3209
  64
  65 // Buffer for test
  66 typedef uint8_t fake_t;
  67 fake_t test_buf[BUF_TEST_LEN];
  68 fake_t test_buf_save[BUF_TEST_LEN];
  69 fake_t test_disk[BUF_TEST_LEN];
  70
  71 KFile fd;
  72
  73 /*
  74  * Beckend to use kfile structure on pc.
  75  */
  76 static int fake_close(KFile *fd)
  77 {
  78         (void)fd;
  79         return 0;
  80 }
  81
  82 static size_t fake_read(KFile *fd, void *buf, size_t size)
  83 {
  84         fake_t *dest = (fake_t *)buf;
  85         size_t rd_len;
  86
  87         rd_len = MIN((kfile_off_t)size, fd->size - fd->seek_pos);
  88
  89         memcpy(dest, test_disk, size);
  90         fd->seek_pos += rd_len;
  91
  92         LOG_INFO("Read: real[%ld] expected[%ld]\n", rd_len, size);
  93
  94         return rd_len;
  95 }
  96
  97 static size_t fake_write(KFile *fd, const void *buf, size_t size)
  98 {
  99         fake_t *src = (fake_t *)buf;
 100         size_t wr_len;
 101
 102         wr_len = MIN((kfile_off_t)size, fd->size - fd->seek_pos);
 103
 104         memcpy(test_disk, src, wr_len);
 105         fd->seek_pos += wr_len;
 106
 107         LOG_INFO("Write: real[%ld] expected[%ld]\n", wr_len, size);
 108
 109         return wr_len;
 110 }
 111
 112 int fake_flush(KFile *fd)
 113 {
 114         (void)fd;
 115
 116         return 0;
 117 }
 118
 119 void fake_kfileInit(void)
 120 {
 121         // Setup data flash programming functions.
 122         fd.reopen = kfile_genericReopen;
 123         fd.close = fake_close;
 124         fd.read = fake_read;
 125         fd.write = fake_write;
 126         fd.seek = kfile_genericSeek;
 127         fd.flush = fake_flush;
 128
 129         fd.seek_pos = 0;
 130         fd.size = BUF_TEST_LEN;
 131
 132 }
 133
 134 /*
 135  * Help function to init disk and the buffers.
 136  */
 137 static void init_testBuf(void)
 138 {
 139         #include <stdlib.h>
 140
 141         kprintf("Init fake buffer..\n");
 142         for (int i = 0; i < BUF_TEST_LEN; i++)
 143         {
 144                 test_disk[i] = random();
 145                 kprintf("%d ", test_disk[i]);
 146         }
 147         kprintf("\nend\n");
 148
 149         memset(test_buf, 0, sizeof(test_buf));
 150         memset(test_buf_save, 0, sizeof(test_buf_save));
 151 }
 152
 153 /**
 154  * KFile read/write subtest.
 155  * Try to write/read in the same \a f file location \a size bytes.
 156  * \return true if all is ok, false otherwise
 157  * \note Restore file position at exit (if no error)
 158  * \note Test buffer \a buf must be filled with
 159  * the following statement:
 160  * <pre>
 161  * buf[i] = i & 0xff
 162  * </pre>
 163  */
 164 static bool kfile_rwTest(KFile *f, uint8_t *buf, size_t size)
 165 {
 166         /*
 167          * Write test buffer
 168          */
 169         if (kfile_write(f, buf, size) != size)
 170                 return false;
 171
 172         kfile_seek(f, -(kfile_off_t)size, KSM_SEEK_CUR);
 173
 174         /*
 175          * Reset test buffer
 176          */
 177         memset(buf, 0, size);
 178
 179         /*
 180          * Read file in test buffer
 181          */
 182         if (kfile_read(f, buf, size) != size)
 183                 return false;
 184
 185         kfile_seek(f, -(kfile_off_t)size, KSM_SEEK_CUR);
 186
 187         /*
 188          * Check test result
 189          */
 190         for (size_t i = 0; i < size; i++)
 191                 if (buf[i] != (i & 0xff))
 192                         return false;
 193
 194         return true;
 195 }
 196
 197 /**
 198  * KFile read/write test.
 199  * This function write and read \a test_buf long \a size
 200  * on \a fd handler.
 201  * \a save_buf can be NULL or a buffer where to save previous file content.
 202  */
 203 int kfile_testRunGeneric(KFile *fd, uint8_t *test_buf, uint8_t *save_buf, size_t size)
 204 {
 205
 206         /*
 207          * Part of test buf size that you would write.
 208          * This var is used in test 3 to check kfile_write
 209          * when writing beyond filesize limit.
 210          */
 211         kfile_off_t len = size / 2;
 212
 213
 214         /* Fill test buffer */
 215         for (size_t i = 0; i < size; i++)
 216                 test_buf[i] = (i & 0xff);
 217
 218         /*
 219          * If necessary, user can save content,
 220          * for later restore.
 221          */
 222         if (save_buf)
 223         {
 224                 LOG_INFO("Saved content..form [%d] to [%ld]\n", fd->seek_pos, fd->seek_pos + size);
 225                 kfile_read(fd, save_buf, size);
 226         }
 227
 228         /* TEST 1 BEGIN. */
 229         LOG_INFO("Test 1: write from pos 0 to [%ld]\n", (long)size);
 230
 231         /*
 232          * Seek to addr 0.
 233          */
 234         if (kfile_seek(fd, 0, KSM_SEEK_SET) != 0)
 235                 goto kfile_test_end;
 236
 237         /*
 238          * Test read/write to address 0..size
 239          */
 240         if (!kfile_rwTest(fd, test_buf, size))
 241                 goto kfile_test_end;
 242
 243         LOG_INFO("Test 1: ok!\n");
 244
 245         /*
 246          * Restore previous read content.
 247          */
 248         if (save_buf)
 249         {
 250                 kfile_seek(fd, 0, KSM_SEEK_SET);
 251
 252                 if (kfile_write(fd, save_buf, size) != size)
 253                         goto kfile_test_end;
 254
 255                 LOG_INFO("Restore content..form [%d] to [%ld]\n", fd->seek_pos, fd->seek_pos + size);
 256         }
 257         /* TEST 1 END. */
 258
 259         /* TEST 2 BEGIN. */
 260         LOG_INFO("Test 2: write from pos [%d] to [%ld]\n", fd->size/2 , fd->size/2 + size);
 261
 262         /*
 263          * Go to half test size.
 264          */
 265         kfile_seek(fd, (fd->size / 2), KSM_SEEK_SET);
 266
 267         /*
 268          * If necessary, user can save content
 269          * for later restore.
 270          */
 271         if (save_buf)
 272         {
 273                 kfile_read(fd, save_buf, size);
 274                 kfile_seek(fd, -(kfile_off_t)size, KSM_SEEK_CUR);
 275                 LOG_INFO("Saved content..form [%d] to [%ld]\n", fd->seek_pos, fd->seek_pos + size);
 276         }
 277
 278         /*
 279          * Test read/write to address filesize/2 ... filesize/2 + size
 280          */
 281         if (!kfile_rwTest(fd, test_buf, size))
 282                 goto kfile_test_end;
 283
 284         LOG_INFO("Test 2: ok!\n");
 285
 286         /*
 287          * Restore previous content.
 288          */
 289         if (save_buf)
 290         {
 291                 kfile_seek(fd, -(kfile_off_t)size, KSM_SEEK_CUR);
 292
 293                 if (kfile_write(fd, save_buf, size) != size)
 294                         goto kfile_test_end;
 295
 296                 LOG_INFO("Restore content..form [%d] to [%ld]\n", fd->seek_pos, fd->seek_pos + size);
 297         }
 298
 299         /* TEST 2 END. */
 300
 301         /* TEST 3 BEGIN. */
 302         LOG_INFO("Test 3: write outside of fd->size limit [%d]\n", fd->size);
 303         LOG_INFO("This test should FAIL!, you must see an assertion fail message.\n");
 304
 305         /*
 306          * Go to the Flash end
 307          */
 308         kfile_seek(fd, -len, KSM_SEEK_END);
 309
 310         /*
 311          * If necessary, user can save content,
 312          * for later restore.
 313          */
 314         if (save_buf)
 315         {
 316                 kfile_read(fd, save_buf, len);
 317                 kfile_seek(fd, -len, KSM_SEEK_CUR);
 318                 LOG_INFO("Saved content..form [%d] to [%d]\n", fd->seek_pos, fd->seek_pos + len);
 319         }
 320
 321         /*
 322          * Test read/write to address (filesize - size) ... filesize
 323          */
 324         if (kfile_rwTest(fd, test_buf, size))
 325                 goto kfile_test_end;
 326
 327         kprintf("Test 3: ok!\n");
 328
 329         /*
 330          * Restore previous read content
 331          */
 332         if (save_buf)
 333         {
 334                 kfile_seek(fd, -len, KSM_SEEK_END);
 335
 336                 if ((kfile_off_t)kfile_write(fd, save_buf, len) != len)
 337                         goto kfile_test_end;
 338
 339                 LOG_INFO("Restore content..form [%d] to [%d]\n", fd->seek_pos, fd->seek_pos + len);
 340         }
 341
 342         /* TEST 3 END. */
 343
 344         kfile_close(fd);
 345         return 0;
 346
 347 kfile_test_end:
 348         kfile_close(fd);
 349         LOG_ERR("One kfile_test failed!\n");
 350         return EOF;
 351 }
 352
 353
 354
 355
 356 /**
 357  * Setup all needed for kfile test
 358  */
 359 int kfile_testSetup(void)
 360 {
 361         MOD_INIT(kfile_test);
 362         LOG_INFO("Mod init..ok\n");
 363
 364                 // Init our backend and the buffers
 365                 fake_kfileInit();
 366                 init_testBuf();
 367
 368         return 0;
 369 }
 370
 371 int kfile_testRun(void)
 372 {
 373         return kfile_testRunGeneric(&fd, test_buf, test_buf_save, BUF_TEST_LEN);
 374 }
 375
 376 /**
 377  * End a dataflash Test.
 378  * (Unused)
 379  */
 380 int kfile_testTearDown(void)
 381 {
 382         return 0;
 383 }
 384
 385 TEST_MAIN(kfile);
 386