added formatting function and made code style compliant

This commit is contained in:
nvt-se 2008-07-02 11:11:13 +00:00
parent 28331191b3
commit 26716fe7a1
2 changed files with 227 additions and 198 deletions

View file

@ -37,14 +37,16 @@
* Nicolas Tsiftes <nvt@sics.se>
*/
#include "contiki-conf.h"
#include "cfs/cfs.h"
#include "cfs-coffee-arch.h"
#include "cfs/cfs-coffee.h"
#include "dev/watchdog.h"
#include <stdio.h>
#include <string.h>
#define DEBUG 0
#define DEBUG 1
#if DEBUG
#include <stdio.h>
#define PRINTF(...) printf(__VA_ARGS__)
@ -52,12 +54,77 @@
#define PRINTF(...)
#endif
#define kb * 1024UL
#define Mb * (1024 kb)
#define COFFEE_FD_READ 0x1
#define COFFEE_FD_WRITE 0x2
#define COFFEE_FD_APPEND 0x4
#define COFFEE_FD_FREE 0x0
struct file_desc {
uint32_t offset;
uint32_t end;
uint16_t file_page;
uint8_t flags;
uint16_t max_pages;
uint16_t next_log_entry;
};
#define COFFEE_FLAG_ALLOCATED 0x1
#define COFFEE_FLAG_OBSOLETE 0x2
#define COFFEE_FLAG_MODIFIED 0x4
#define COFFEE_FLAG_LOG 0x8
#define LOG_CMD_MAGIC 0x7a
#define COFFEE_PAGE_ALLOCATED(hdr) ((hdr).flags & COFFEE_FLAG_ALLOCATED)
#define COFFEE_PAGE_FREE(hdr) !COFFEE_PAGE_ALLOCATED(hdr)
#define COFFEE_PAGE_OBSOLETE(hdr) ((hdr).flags & COFFEE_FLAG_OBSOLETE)
#define COFFEE_PAGE_ACTIVE(hdr) \
(COFFEE_PAGE_ALLOCATED(hdr) && !COFFEE_PAGE_OBSOLETE(hdr))
#define COFFEE_PAGE_LOG(hdr) ((hdr).flags & COFFEE_FLAG_LOG)
#define COFFEE_PAGE_MODIFIED(hdr) ((hdr).flags & COFFEE_FLAG_MODIFIED)
#define FD_VALID(fd) \
((fd) < COFFEE_FD_SET_SIZE && fd_set[(fd)].flags != COFFEE_FD_FREE)
#define FD_READABLE(fd) (fd_set[(fd)].flags & CFS_READ)
#define FD_WRITABLE(fd) (fd_set[(fd)].flags & CFS_WRITE)
#define FD_APPENDABLE(fd) (fd_set[(fd)].flags & CFS_APPEND)
struct dir_cache {
char filename_start;
int32_t page;
};
struct file_header {
unsigned flags:4;
unsigned max_pages:12;
unsigned log_page:16;
unsigned eof_locator:16;
unsigned log_entries:16;
unsigned log_entry_size:16;
char name[COFFEE_NAME_LENGTH];
} __attribute__((packed));
/* This is needed because of a buggy compiler. */
struct log_param {
uint32_t offset;
const char *buf;
uint16_t size;
};
#define ABS_OFFSET(file_page, file_offset) \
((file_page) * COFFEE_PAGE_SIZE + \
sizeof (struct file_header) + (file_offset))
static struct dir_cache dir_cache[COFFEE_DIR_CACHE_ENTRIES];
static struct file_desc fd_set[COFFEE_FD_SET_SIZE];
/*---------------------------------------------------------------------------*/
static void
get_sector_status(uint16_t sector, uint16_t *active, uint16_t *free, uint16_t *obsolete) {
get_sector_status(uint16_t sector, uint16_t *active,
uint16_t *free, uint16_t *obsolete) {
uint32_t offset;
uint32_t end;
struct file_header hdr;
@ -88,15 +155,15 @@ get_sector_status(uint16_t sector, uint16_t *active, uint16_t *free, uint16_t *o
while(offset < end) {
COFFEE_READ(&hdr, sizeof (hdr), offset);
if (CFS_PAGE_ACTIVE(hdr)) {
if(COFFEE_PAGE_ACTIVE(hdr)) {
offset += hdr.max_pages * COFFEE_PAGE_SIZE;
last_pages_are_active = 1;
*active += hdr.max_pages;
} else if (CFS_PAGE_OBSOLETE(hdr)) {
} else if(COFFEE_PAGE_OBSOLETE(hdr)) {
last_pages_are_active = 0;
offset += hdr.max_pages * COFFEE_PAGE_SIZE;
*obsolete += hdr.max_pages;
} else if (CFS_PAGE_FREE(hdr)) {
} else if(COFFEE_PAGE_FREE(hdr)) {
++*free;
offset += COFFEE_PAGE_SIZE;
}
@ -148,7 +215,7 @@ dir_cache_find(const char *name)
for(i = 0; i < COFFEE_DIR_CACHE_ENTRIES; i++) {
if(*name == dir_cache[i].filename_start) {
READ_HEADER(&hdr, dir_cache[i].page);
if (!CFS_PAGE_ACTIVE(hdr)) {
if(!COFFEE_PAGE_ACTIVE(hdr)) {
dir_cache[i].filename_start = '\0';
} else if(strcmp(hdr.name, name) == 0) {
return dir_cache[i].page;
@ -174,14 +241,14 @@ find_file(const char *name)
offset = COFFEE_START;
do {
COFFEE_READ(&hdr, sizeof (hdr), offset);
if (CFS_PAGE_ACTIVE(hdr)) {
if(COFFEE_PAGE_ACTIVE(hdr)) {
if(strcmp(name, hdr.name) == 0) {
page = offset / COFFEE_PAGE_SIZE;
dir_cache_add(name[0], page);
return page;
}
offset += hdr.max_pages * COFFEE_PAGE_SIZE;
} else if (CFS_PAGE_OBSOLETE(hdr)) {
} else if(COFFEE_PAGE_OBSOLETE(hdr)) {
offset += hdr.max_pages * COFFEE_PAGE_SIZE;
} else {
offset += COFFEE_PAGE_SIZE;
@ -237,7 +304,7 @@ find_contiguous_pages(unsigned wanted)
start = -1;
for(page = 0; page < COFFEE_PAGE_COUNT;) {
READ_HEADER(&hdr, page);
if (CFS_PAGE_FREE(hdr)) {
if(COFFEE_PAGE_FREE(hdr)) {
if(start == -1) {
start = page;
} else {
@ -263,7 +330,7 @@ cfs_garbage_collect(void)
watchdog_stop();
PRINTF("CFS: Running the file system garbage collector...\n");
PRINTF("Coffee: Running the file system garbage collector...\n");
sectors_in_row = longest_row = 0;
/*
@ -272,11 +339,11 @@ cfs_garbage_collect(void)
*/
for(sector = 0; sector < COFFEE_SIZE / COFFEE_SECTOR_SIZE; sector++) {
get_sector_status(sector, &active_pages, &free_pages, &obsolete_pages);
PRINTF("CFS: Sector %u has %u active pages, %u free pages, and %u obsolete pages.\n",
PRINTF("Coffee: Sector %u has %u active, %u free, and %u obsolete pages.\n",
sector, active_pages, free_pages, obsolete_pages);
if(active_pages == 0 && obsolete_pages > 0) {
COFFEE_ERASE(sector);
PRINTF("CFS: Erased sector %d!\n", sector);
PRINTF("Coffee: Erased sector %d!\n", sector);
++sectors_in_row;
} else {
if(sectors_in_row > longest_row) {
@ -307,14 +374,14 @@ remove_by_page(uint16_t page, int remove_log, int close_fds)
}
READ_HEADER(&hdr, page);
if (!CFS_PAGE_ACTIVE(hdr)) {
if(!COFFEE_PAGE_ACTIVE(hdr)) {
return -1;
}
dir_cache_del(page);
hdr.flags |= COFFEE_FLAG_OBSOLETE;
WRITE_HEADER(&hdr, page);
if (remove_log && CFS_PAGE_MODIFIED(hdr)) {
if(remove_log && COFFEE_PAGE_MODIFIED(hdr)) {
log_page = hdr.log_page;
dir_cache_del(log_page);
READ_HEADER(&hdr, log_page);
@ -427,12 +494,14 @@ create_log(int16_t file_page, struct file_header *hdr)
uint16_t log_entry_size, log_entries;
uint32_t size;
log_entry_size = hdr->log_entry_size = 0 ? COFFEE_PAGE_SIZE : hdr->log_entry_size;
log_entries = hdr->log_entries == 0 ? COFFEE_LOG_SIZE / log_entry_size : hdr->log_entries;
log_entry_size = hdr->log_entry_size = 0 ?
COFFEE_PAGE_SIZE : hdr->log_entry_size;
log_entries = hdr->log_entries == 0 ?
COFFEE_LOG_SIZE / log_entry_size : hdr->log_entries;
size = log_entries * sizeof (uint16_t);
size += log_entries * log_entry_size;
log_page = cfs_reserve(create_log_name(log_name, sizeof (log_name), hdr->name),
log_page = cfs_coffee_reserve(create_log_name(log_name, sizeof (log_name), hdr->name),
size);
if(log_page < 0) {
return -1;
@ -462,7 +531,8 @@ flush_log(uint16_t file_page)
return -1;
}
new_file_page = cfs_reserve(hdr.name, hdr.max_pages * COFFEE_PAGE_SIZE);
new_file_page = cfs_coffee_reserve(hdr.name,
hdr.max_pages * COFFEE_PAGE_SIZE);
if(new_file_page < 0) {
return -1;
}
@ -521,8 +591,10 @@ write_log_page(struct file_desc *fdp, struct log_param *lp)
READ_HEADER(&hdr, fdp->file_page);
log_entry_size = hdr.log_entry_size == 0 ? COFFEE_PAGE_SIZE : hdr.log_entry_size;
log_entries = hdr.log_entries == 0 ? COFFEE_LOG_SIZE / COFFEE_PAGE_SIZE : hdr.log_entries;
log_entry_size = hdr.log_entry_size == 0 ?
COFFEE_PAGE_SIZE : hdr.log_entry_size;
log_entries = hdr.log_entries == 0 ?
COFFEE_LOG_SIZE / COFFEE_PAGE_SIZE : hdr.log_entries;
page = lp->offset / log_entry_size;
lp->offset %= log_entry_size;
@ -532,7 +604,7 @@ write_log_page(struct file_desc *fdp, struct log_param *lp)
log_page = 0;
if (CFS_PAGE_MODIFIED(hdr)) {
if(COFFEE_PAGE_MODIFIED(hdr)) {
/* A log structure has already been created. */
entry_count = log_entries > COFFEE_LOG_TABLE_LIMIT ?
COFFEE_LOG_TABLE_LIMIT : log_entries;
@ -564,7 +636,7 @@ write_log_page(struct file_desc *fdp, struct log_param *lp)
if(log_entry >= log_entries) {
/* The log is full. The new file should be written out. */
PRINTF("CFS: The log for file %s is full\n", hdr.name);
PRINTF("Coffee: The log for file %s is full\n", hdr.name);
fdp->next_log_entry = 0;
return flush_log(fdp->file_page);
}
@ -574,7 +646,7 @@ write_log_page(struct file_desc *fdp, struct log_param *lp)
if(log_page < 0) {
return -1;
}
PRINTF("CFS: Created a log structure for file %s at page %u\n",
PRINTF("Coffee: Created a log structure for file %s at page %u\n",
hdr.name, log_page);
hdr.log_page = log_page;
log_entry = 0;
@ -640,7 +712,7 @@ cfs_open(const char *name, int flags)
if((flags & (CFS_READ | CFS_WRITE)) == CFS_READ) {
return -1;
}
if ((page = cfs_reserve(name, COFFEE_DYN_SIZE)) < 0) {
if((page = cfs_coffee_reserve(name, COFFEE_DYN_SIZE)) < 0) {
return -1;
}
fd_set[fd].max_pages = COFFEE_DYN_SIZE / COFFEE_PAGE_SIZE;
@ -689,7 +761,7 @@ cfs_seek(int fd, unsigned offset)
}
/*---------------------------------------------------------------------------*/
int
cfs_remove(const char *name)
cfs_coffee_remove(const char *name)
{
int page;
@ -731,11 +803,12 @@ cfs_read(int fd, void *buf, unsigned size)
*/
while(remains) {
r = -1;
if (CFS_PAGE_MODIFIED(hdr)) {
if(COFFEE_PAGE_MODIFIED(hdr)) {
lp.offset = base + offset;
lp.buf = (char *)buf + offset;
lp.size = remains;
r = read_log_page(&hdr, fdp->next_log_entry > 0 ? fdp->next_log_entry - 1 : -1, &lp);
r = read_log_page(&hdr,
fdp->next_log_entry > 0 ? fdp->next_log_entry - 1 : -1, &lp);
if(r >= 0) {
offset += r;
break;
@ -766,8 +839,10 @@ cfs_write(int fd, const void *buf, unsigned size)
fdp = &fd_set[fd];
if (size + fdp->offset + sizeof (struct file_header) > fdp->max_pages * COFFEE_PAGE_SIZE) {
size = fdp->max_pages * COFFEE_PAGE_SIZE - fdp->offset - sizeof (struct file_header);
if(size + fdp->offset + sizeof (struct file_header) >
fdp->max_pages * COFFEE_PAGE_SIZE) {
size = fdp->max_pages * COFFEE_PAGE_SIZE -
fdp->offset - sizeof (struct file_header);
}
if(fdp->offset < fdp->end) {
@ -825,7 +900,7 @@ cfs_readdir(struct cfs_dir *dir, struct cfs_dirent *entry)
for(page = *(uint16_t *)dir->dummy_space; page < COFFEE_PAGE_COUNT;) {
watchdog_periodic();
READ_HEADER(&hdr, page);
if (CFS_PAGE_ACTIVE(hdr)) {
if(COFFEE_PAGE_ACTIVE(hdr)) {
memcpy(entry->name, hdr.name, sizeof (entry->name));
entry->name[sizeof (entry->name) - 1] = '\0';
entry->size = find_offset_in_file(page);
@ -833,7 +908,7 @@ cfs_readdir(struct cfs_dir *dir, struct cfs_dirent *entry)
*(uint16_t *)dir->dummy_space = page;
return 0;
}
page += CFS_PAGE_OBSOLETE(hdr) ? hdr.max_pages : 1;
page += COFFEE_PAGE_OBSOLETE(hdr) ? hdr.max_pages : 1;
}
return -1;
@ -846,7 +921,7 @@ cfs_closedir(struct cfs_dir *dir)
}
/*---------------------------------------------------------------------------*/
int
cfs_reserve(const char *name, uint32_t size)
cfs_coffee_reserve(const char *name, uint32_t size)
{
struct file_header hdr;
unsigned need_pages;
@ -876,7 +951,8 @@ cfs_reserve(const char *name, uint32_t size)
hdr.log_entries = 0;
hdr.log_entry_size = 0;
WRITE_HEADER(&hdr, page);
PRINTF("CFS: Reserved %u pages starting from %u for file %s\n",
PRINTF("Coffee: Reserved %u pages starting from %u for file %s\n",
need_pages, page, name);
dir_cache_add(name[0], page);
@ -884,7 +960,7 @@ cfs_reserve(const char *name, uint32_t size)
}
/*---------------------------------------------------------------------------*/
int
cfs_configure_log(const char *file, unsigned log_size, unsigned log_entry_size)
cfs_coffee_configure_log(const char *file, unsigned log_size, unsigned log_entry_size)
{
int16_t page;
struct file_header hdr;
@ -895,7 +971,7 @@ cfs_configure_log(const char *file, unsigned log_size, unsigned log_entry_size)
}
READ_HEADER(&hdr, page);
if (CFS_PAGE_MODIFIED(hdr)) {
if(COFFEE_PAGE_MODIFIED(hdr)) {
/*
* Too late to customize the log.
* TODO: Flush the log and create a new log.
@ -909,3 +985,28 @@ cfs_configure_log(const char *file, unsigned log_size, unsigned log_entry_size)
return 0;
}
/*---------------------------------------------------------------------------*/
int
cfs_coffee_format(void)
{
int nsectors, i;
nsectors = COFFEE_SIZE / COFFEE_SECTOR_SIZE;
/* Reject format requests when the configuration is incorrect. */
if (nsectors < 1 || (COFFEE_START & (COFFEE_SECTOR_SIZE - 1))) {
return -1;
}
PRINTF("Coffee: Formatting %d sectors", nsectors);
watchdog_stop();
for (i = 0; i < nsectors; i++) {
COFFEE_ERASE(i);
PRINTF(".");
}
watchdog_start();
PRINTF("done!\n");
return 0;
}

View file

@ -1,6 +1,3 @@
#ifndef CFS_COFFEE_H
#define CFS_COFFEE_H
/*
* Copyright (c) 2008, Swedish Institute of Computer Science
* All rights reserved.
@ -40,82 +37,13 @@
* Nicolas Tsiftes <nvt@sics.se>
*/
#include "contiki-conf.h"
#include "cfs-coffee-arch.h"
#ifndef CFS_COFFEE_H
#define CFS_COFFEE_H
#define kb * 1024UL
#define COFFEE_FD_READ 0x1
#define COFFEE_FD_WRITE 0x2
#define COFFEE_FD_APPEND 0x4
#define COFFEE_FD_FREE 0x0
struct file_desc {
uint32_t offset;
uint32_t end;
uint16_t file_page;
uint8_t flags;
uint16_t max_pages;
uint16_t next_log_entry;
};
#define COFFEE_FLAG_ALLOCATED 0x1
#define COFFEE_FLAG_OBSOLETE 0x2
#define COFFEE_FLAG_MODIFIED 0x4
#define COFFEE_FLAG_LOG 0x8
#define CFS_PAGE_ALLOCATED(hdr) \
((hdr).flags & COFFEE_FLAG_ALLOCATED)
#define CFS_PAGE_FREE(hdr) \
!CFS_PAGE_ALLOCATED(hdr)
#define CFS_PAGE_OBSOLETE(hdr) \
((hdr).flags & COFFEE_FLAG_OBSOLETE)
#define CFS_PAGE_ACTIVE(hdr) \
(CFS_PAGE_ALLOCATED(hdr) && !CFS_PAGE_OBSOLETE(hdr))
#define CFS_PAGE_LOG(hdr) \
((hdr).flags & COFFEE_FLAG_LOG)
#define CFS_PAGE_MODIFIED(hdr) \
((hdr).flags & COFFEE_FLAG_MODIFIED)
#define FD_VALID(fd) \
((fd) < COFFEE_FD_SET_SIZE && fd_set[(fd)].flags != COFFEE_FD_FREE)
#define FD_READABLE(fd) \
(fd_set[(fd)].flags & CFS_READ)
#define FD_WRITABLE(fd) \
(fd_set[(fd)].flags & CFS_WRITE)
#define FD_APPENDABLE(fd) \
(fd_set[(fd)].flags & CFS_APPEND)
#define LOG_CMD_MAGIC 0x7a
struct dir_cache {
char filename_start;
int32_t page;
};
struct file_header {
unsigned flags:4;
unsigned max_pages:12;
unsigned log_page:16;
unsigned eof_locator:16;
unsigned log_entries:16;
unsigned log_entry_size:16;
char name[COFFEE_NAME_LENGTH];
} __attribute__((packed));
/* This is needed because of a buggy compiler. */
struct log_param {
uint32_t offset;
const char *buf;
uint16_t size;
};
#define ABS_OFFSET(file_page, file_offset) \
((file_page) * COFFEE_PAGE_SIZE + sizeof (struct file_header) + (file_offset))
int cfs_remove(const char *name);
int cfs_reserve(const char *name, uint32_t size);
int cfs_configure_log(const char *file, unsigned log_size,
int cfs_coffee_remove(const char *name);
int cfs_coffee_reserve(const char *name, uint32_t size);
int cfs_coffee_configure_log(const char *file, unsigned log_size,
unsigned log_entry_size);
int cfs_coffee_format(void);
#endif /* !COFFEE_H */