1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018 |
- /*
- * spiffs_hydrogen.c
- *
- * Created on: Jun 16, 2013
- * Author: petera
- */
- #include "spiffs.h"
- #include "spiffs_nucleus.h"
- static s32_t spiffs_fflush_cache(spiffs *fs, spiffs_file fh);
- #if SPIFFS_BUFFER_HELP
- u32_t SPIFFS_buffer_bytes_for_filedescs(spiffs *fs, u32_t num_descs) {
- return num_descs * sizeof(spiffs_fd);
- }
- #if SPIFFS_CACHE
- u32_t SPIFFS_buffer_bytes_for_cache(spiffs *fs, u32_t num_pages) {
- return sizeof(spiffs_cache) + num_pages * (sizeof(spiffs_cache_page) + SPIFFS_CFG_LOG_PAGE_SZ(fs));
- }
- #endif
- #endif
- u8_t SPIFFS_mounted(spiffs *fs) {
- return SPIFFS_CHECK_MOUNT(fs);
- }
- s32_t SPIFFS_format(spiffs *fs) {
- SPIFFS_API_CHECK_CFG(fs);
- if (SPIFFS_CHECK_MOUNT(fs)) {
- fs->err_code = SPIFFS_ERR_MOUNTED;
- return -1;
- }
- s32_t res;
- SPIFFS_LOCK(fs);
- spiffs_block_ix bix = 0;
- while (bix < fs->block_count) {
- fs->max_erase_count = 0;
- res = spiffs_erase_block(fs, bix);
- if (res != SPIFFS_OK) {
- res = SPIFFS_ERR_ERASE_FAIL;
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- bix++;
- }
- SPIFFS_UNLOCK(fs);
- return 0;
- }
- s32_t SPIFFS_mount(spiffs *fs, spiffs_config *config, u8_t *work,
- u8_t *fd_space, u32_t fd_space_size,
- void *cache, u32_t cache_size,
- spiffs_check_callback check_cb_f) {
- SPIFFS_LOCK(fs);
- c_memset(fs, 0, sizeof(spiffs));
- c_memcpy(&fs->cfg, config, sizeof(spiffs_config));
- fs->block_count = SPIFFS_CFG_PHYS_SZ(fs) / SPIFFS_CFG_LOG_BLOCK_SZ(fs);
- fs->work = &work[0];
- fs->lu_work = &work[SPIFFS_CFG_LOG_PAGE_SZ(fs)];
- c_memset(fd_space, 0, fd_space_size);
- // align fd_space pointer to pointer size byte boundary, below is safe
- u8_t ptr_size = sizeof(void*);
- #pragma GCC diagnostic push
- #pragma GCC diagnostic ignored "-Wpointer-to-int-cast"
- u8_t addr_lsb = ((u8_t)fd_space) & (ptr_size-1);
- #pragma GCC diagnostic pop
- if (addr_lsb) {
- fd_space += (ptr_size-addr_lsb);
- fd_space_size -= (ptr_size-addr_lsb);
- }
- fs->fd_space = fd_space;
- fs->fd_count = (fd_space_size/sizeof(spiffs_fd));
- // align cache pointer to 4 byte boundary, below is safe
- #pragma GCC diagnostic push
- #pragma GCC diagnostic ignored "-Wpointer-to-int-cast"
- addr_lsb = ((u8_t)cache) & (ptr_size-1);
- #pragma GCC diagnostic pop
- if (addr_lsb) {
- u8_t *cache_8 = (u8_t *)cache;
- cache_8 += (ptr_size-addr_lsb);
- cache = cache_8;
- cache_size -= (ptr_size-addr_lsb);
- }
- if (cache_size & (ptr_size-1)) {
- cache_size -= (cache_size & (ptr_size-1));
- }
- #if SPIFFS_CACHE
- fs->cache = cache;
- fs->cache_size = (cache_size > (config->log_page_size*32)) ? config->log_page_size*32 : cache_size;
- spiffs_cache_init(fs);
- #endif
- s32_t res;
- #if SPIFFS_USE_MAGIC
- res = SPIFFS_CHECK_MAGIC_POSSIBLE(fs) ? SPIFFS_OK : SPIFFS_ERR_MAGIC_NOT_POSSIBLE;
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- #endif
- fs->config_magic = SPIFFS_CONFIG_MAGIC;
- res = spiffs_obj_lu_scan(fs);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- SPIFFS_DBG("page index byte len: %i\n", SPIFFS_CFG_LOG_PAGE_SZ(fs));
- SPIFFS_DBG("object lookup pages: %i\n", SPIFFS_OBJ_LOOKUP_PAGES(fs));
- SPIFFS_DBG("page pages per block: %i\n", SPIFFS_PAGES_PER_BLOCK(fs));
- SPIFFS_DBG("page header length: %i\n", sizeof(spiffs_page_header));
- SPIFFS_DBG("object header index entries: %i\n", SPIFFS_OBJ_HDR_IX_LEN(fs));
- SPIFFS_DBG("object index entries: %i\n", SPIFFS_OBJ_IX_LEN(fs));
- SPIFFS_DBG("available file descriptors: %i\n", fs->fd_count);
- SPIFFS_DBG("free blocks: %i\n", fs->free_blocks);
- fs->check_cb_f = check_cb_f;
- fs->mounted = 1;
- SPIFFS_UNLOCK(fs);
- return 0;
- }
- void SPIFFS_unmount(spiffs *fs) {
- if (!SPIFFS_CHECK_CFG(fs) || !SPIFFS_CHECK_MOUNT(fs)) return;
- SPIFFS_LOCK(fs);
- u32_t i;
- spiffs_fd *fds = (spiffs_fd *)fs->fd_space;
- for (i = 0; i < fs->fd_count; i++) {
- spiffs_fd *cur_fd = &fds[i];
- if (cur_fd->file_nbr != 0) {
- #if SPIFFS_CACHE
- (void)spiffs_fflush_cache(fs, cur_fd->file_nbr);
- #endif
- spiffs_fd_return(fs, cur_fd->file_nbr);
- }
- }
- fs->mounted = 0;
- SPIFFS_UNLOCK(fs);
- }
- s32_t SPIFFS_errno(spiffs *fs) {
- return fs->err_code;
- }
- void SPIFFS_clearerr(spiffs *fs) {
- fs->err_code = SPIFFS_OK;
- }
- s32_t SPIFFS_creat(spiffs *fs, char *path, spiffs_mode mode) {
- (void)mode;
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_obj_id obj_id;
- s32_t res;
- res = spiffs_obj_lu_find_free_obj_id(fs, &obj_id, (u8_t *)path);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_object_create(fs, obj_id, (u8_t *)path, SPIFFS_TYPE_FILE, 0);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- SPIFFS_UNLOCK(fs);
- return 0;
- }
- spiffs_file SPIFFS_open(spiffs *fs, char *path, spiffs_flags flags, spiffs_mode mode) {
- (void)mode;
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_fd *fd;
- spiffs_page_ix pix;
- s32_t res = spiffs_fd_find_new(fs, &fd);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_object_find_object_index_header_by_name(fs, (u8_t*)path, &pix);
- if ((flags & SPIFFS_CREAT) == 0) {
- if (res < SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- }
- if ((flags & SPIFFS_CREAT) && res == SPIFFS_ERR_NOT_FOUND) {
- spiffs_obj_id obj_id;
- // no need to enter conflicting name here, already looked for it above
- res = spiffs_obj_lu_find_free_obj_id(fs, &obj_id, 0);
- if (res < SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_object_create(fs, obj_id, (u8_t*)path, SPIFFS_TYPE_FILE, &pix);
- if (res < SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- flags &= ~SPIFFS_TRUNC;
- } else {
- if (res < SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- }
- res = spiffs_object_open_by_page(fs, pix, fd, flags, mode);
- if (res < SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- if (flags & SPIFFS_TRUNC) {
- res = spiffs_object_truncate(fd, 0, 0);
- if (res < SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- }
- fd->fdoffset = 0;
- SPIFFS_UNLOCK(fs);
- return fd->file_nbr;
- }
- spiffs_file SPIFFS_open_by_dirent(spiffs *fs, struct spiffs_dirent *e, spiffs_flags flags, spiffs_mode mode) {
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_fd *fd;
- s32_t res = spiffs_fd_find_new(fs, &fd);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_object_open_by_page(fs, e->pix, fd, flags, mode);
- if (res < SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- if (flags & SPIFFS_TRUNC) {
- res = spiffs_object_truncate(fd, 0, 0);
- if (res < SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- }
- fd->fdoffset = 0;
- SPIFFS_UNLOCK(fs);
- return fd->file_nbr;
- }
- s32_t SPIFFS_read(spiffs *fs, spiffs_file fh, void *buf, s32_t len) {
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_fd *fd;
- s32_t res;
- res = spiffs_fd_get(fs, fh, &fd);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- if ((fd->flags & SPIFFS_RDONLY) == 0) {
- res = SPIFFS_ERR_NOT_READABLE;
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- }
- #if SPIFFS_CACHE_WR
- spiffs_fflush_cache(fs, fh);
- #endif
- if (fd->fdoffset + len >= fd->size) {
- // reading beyond file size
- s32_t avail = fd->size - fd->fdoffset;
- if (avail <= 0) {
- SPIFFS_API_CHECK_RES_UNLOCK(fs, SPIFFS_ERR_END_OF_OBJECT);
- }
- res = spiffs_object_read(fd, fd->fdoffset, avail, (u8_t*)buf);
- if (res == SPIFFS_ERR_END_OF_OBJECT) {
- fd->fdoffset += avail;
- SPIFFS_UNLOCK(fs);
- return avail;
- } else {
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- len = avail;
- }
- } else {
- // reading within file size
- res = spiffs_object_read(fd, fd->fdoffset, len, (u8_t*)buf);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- }
- fd->fdoffset += len;
- SPIFFS_UNLOCK(fs);
- return len;
- }
- static s32_t spiffs_hydro_write(spiffs *fs, spiffs_fd *fd, void *buf, u32_t offset, s32_t len) {
- (void)fs;
- s32_t res = SPIFFS_OK;
- s32_t remaining = len;
- if (fd->size != SPIFFS_UNDEFINED_LEN && offset < fd->size) {
- s32_t m_len = MIN((s32_t)(fd->size - offset), len);
- res = spiffs_object_modify(fd, offset, (u8_t *)buf, m_len);
- SPIFFS_CHECK_RES(res);
- remaining -= m_len;
- u8_t *buf_8 = (u8_t *)buf;
- buf_8 += m_len;
- buf = buf_8;
- offset += m_len;
- }
- if (remaining > 0) {
- res = spiffs_object_append(fd, offset, (u8_t *)buf, remaining);
- SPIFFS_CHECK_RES(res);
- }
- return len;
- }
- s32_t SPIFFS_write(spiffs *fs, spiffs_file fh, void *buf, s32_t len) {
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_fd *fd;
- s32_t res;
- u32_t offset;
- res = spiffs_fd_get(fs, fh, &fd);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- if ((fd->flags & SPIFFS_WRONLY) == 0) {
- res = SPIFFS_ERR_NOT_WRITABLE;
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- }
- offset = fd->fdoffset;
- #if SPIFFS_CACHE_WR
- if (fd->cache_page == 0) {
- // see if object id is associated with cache already
- fd->cache_page = spiffs_cache_page_get_by_fd(fs, fd);
- }
- #endif
- if (fd->flags & SPIFFS_APPEND) {
- if (fd->size == SPIFFS_UNDEFINED_LEN) {
- offset = 0;
- } else {
- offset = fd->size;
- }
- #if SPIFFS_CACHE_WR
- if (fd->cache_page) {
- offset = MAX(offset, fd->cache_page->offset + fd->cache_page->size);
- }
- #endif
- }
- #if SPIFFS_CACHE_WR
- if ((fd->flags & SPIFFS_DIRECT) == 0) {
- if (len < (s32_t)SPIFFS_CFG_LOG_PAGE_SZ(fs)) {
- // small write, try to cache it
- u8_t alloc_cpage = 1;
- if (fd->cache_page) {
- // have a cached page for this fd already, check cache page boundaries
- if (offset < fd->cache_page->offset || // writing before cache
- offset > fd->cache_page->offset + fd->cache_page->size || // writing after cache
- offset + len > fd->cache_page->offset + SPIFFS_CFG_LOG_PAGE_SZ(fs)) // writing beyond cache page
- {
- // boundary violation, write back cache first and allocate new
- SPIFFS_CACHE_DBG("CACHE_WR_DUMP: dumping cache page %i for fd %i:%04x, boundary viol, offs:%i size:%i\n",
- fd->cache_page->ix, fd->file_nbr, fd->obj_id, fd->cache_page->offset, fd->cache_page->size);
- res = spiffs_hydro_write(fs, fd,
- spiffs_get_cache_page(fs, spiffs_get_cache(fs), fd->cache_page->ix),
- fd->cache_page->offset, fd->cache_page->size);
- spiffs_cache_fd_release(fs, fd->cache_page);
- SPIFFS_API_CHECK_RES(fs, res);
- } else {
- // writing within cache
- alloc_cpage = 0;
- }
- }
- if (alloc_cpage) {
- fd->cache_page = spiffs_cache_page_allocate_by_fd(fs, fd);
- if (fd->cache_page) {
- fd->cache_page->offset = offset;
- fd->cache_page->size = 0;
- SPIFFS_CACHE_DBG("CACHE_WR_ALLO: allocating cache page %i for fd %i:%04x\n",
- fd->cache_page->ix, fd->file_nbr, fd->obj_id);
- }
- }
- if (fd->cache_page) {
- u32_t offset_in_cpage = offset - fd->cache_page->offset;
- SPIFFS_CACHE_DBG("CACHE_WR_WRITE: storing to cache page %i for fd %i:%04x, offs %i:%i len %i\n",
- fd->cache_page->ix, fd->file_nbr, fd->obj_id,
- offset, offset_in_cpage, len);
- spiffs_cache *cache = spiffs_get_cache(fs);
- u8_t *cpage_data = spiffs_get_cache_page(fs, cache, fd->cache_page->ix);
- c_memcpy(&cpage_data[offset_in_cpage], buf, len);
- fd->cache_page->size = MAX(fd->cache_page->size, offset_in_cpage + len);
- fd->fdoffset += len;
- SPIFFS_UNLOCK(fs);
- return len;
- } else {
- res = spiffs_hydro_write(fs, fd, buf, offset, len);
- SPIFFS_API_CHECK_RES(fs, res);
- fd->fdoffset += len;
- SPIFFS_UNLOCK(fs);
- return res;
- }
- } else {
- // big write, no need to cache it - but first check if there is a cached write already
- if (fd->cache_page) {
- // write back cache first
- SPIFFS_CACHE_DBG("CACHE_WR_DUMP: dumping cache page %i for fd %i:%04x, big write, offs:%i size:%i\n",
- fd->cache_page->ix, fd->file_nbr, fd->obj_id, fd->cache_page->offset, fd->cache_page->size);
- res = spiffs_hydro_write(fs, fd,
- spiffs_get_cache_page(fs, spiffs_get_cache(fs), fd->cache_page->ix),
- fd->cache_page->offset, fd->cache_page->size);
- spiffs_cache_fd_release(fs, fd->cache_page);
- SPIFFS_API_CHECK_RES(fs, res);
- res = spiffs_hydro_write(fs, fd, buf, offset, len);
- SPIFFS_API_CHECK_RES(fs, res);
- }
- }
- }
- #endif
- res = spiffs_hydro_write(fs, fd, buf, offset, len);
- SPIFFS_API_CHECK_RES(fs, res);
- fd->fdoffset += len;
- SPIFFS_UNLOCK(fs);
- return res;
- }
- s32_t SPIFFS_lseek(spiffs *fs, spiffs_file fh, s32_t offs, int whence) {
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_fd *fd;
- s32_t res;
- res = spiffs_fd_get(fs, fh, &fd);
- SPIFFS_API_CHECK_RES(fs, res);
- #if SPIFFS_CACHE_WR
- spiffs_fflush_cache(fs, fh);
- #endif
- switch (whence) {
- case SPIFFS_SEEK_CUR:
- offs = fd->fdoffset+offs;
- break;
- case SPIFFS_SEEK_END:
- offs = (fd->size == SPIFFS_UNDEFINED_LEN ? 0 : fd->size) + offs;
- break;
- }
- if (offs > (s32_t)fd->size) {
- res = SPIFFS_ERR_END_OF_OBJECT;
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- spiffs_span_ix data_spix = offs / SPIFFS_DATA_PAGE_SIZE(fs);
- spiffs_span_ix objix_spix = SPIFFS_OBJ_IX_ENTRY_SPAN_IX(fs, data_spix);
- if (fd->cursor_objix_spix != objix_spix) {
- spiffs_page_ix pix;
- res = spiffs_obj_lu_find_id_and_span(
- fs, fd->obj_id | SPIFFS_OBJ_ID_IX_FLAG, objix_spix, 0, &pix);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- fd->cursor_objix_spix = objix_spix;
- fd->cursor_objix_pix = pix;
- }
- fd->fdoffset = offs;
- SPIFFS_UNLOCK(fs);
- return offs;
- }
- s32_t SPIFFS_remove(spiffs *fs, char *path) {
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_fd *fd;
- spiffs_page_ix pix;
- s32_t res;
- res = spiffs_fd_find_new(fs, &fd);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_object_find_object_index_header_by_name(fs, (u8_t *)path, &pix);
- if (res != SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_object_open_by_page(fs, pix, fd, 0,0);
- if (res != SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_object_truncate(fd, 0, 1);
- if (res != SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- SPIFFS_UNLOCK(fs);
- return 0;
- }
- s32_t SPIFFS_fremove(spiffs *fs, spiffs_file fh) {
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_fd *fd;
- s32_t res;
- res = spiffs_fd_get(fs, fh, &fd);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- if ((fd->flags & SPIFFS_WRONLY) == 0) {
- res = SPIFFS_ERR_NOT_WRITABLE;
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- }
- #if SPIFFS_CACHE_WR
- spiffs_cache_fd_release(fs, fd->cache_page);
- #endif
- res = spiffs_object_truncate(fd, 0, 1);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- SPIFFS_UNLOCK(fs);
- return 0;
- }
- static s32_t spiffs_stat_pix(spiffs *fs, spiffs_page_ix pix, spiffs_file fh, spiffs_stat *s) {
- spiffs_page_object_ix_header objix_hdr;
- spiffs_obj_id obj_id;
- s32_t res =_spiffs_rd(fs, SPIFFS_OP_T_OBJ_IX | SPIFFS_OP_C_READ, fh,
- SPIFFS_PAGE_TO_PADDR(fs, pix), sizeof(spiffs_page_object_ix_header), (u8_t *)&objix_hdr);
- SPIFFS_API_CHECK_RES(fs, res);
- u32_t obj_id_addr = SPIFFS_BLOCK_TO_PADDR(fs, SPIFFS_BLOCK_FOR_PAGE(fs , pix)) +
- SPIFFS_OBJ_LOOKUP_ENTRY_FOR_PAGE(fs, pix) * sizeof(spiffs_obj_id);
- res =_spiffs_rd(fs, SPIFFS_OP_T_OBJ_LU | SPIFFS_OP_C_READ, fh,
- obj_id_addr, sizeof(spiffs_obj_id), (u8_t *)&obj_id);
- SPIFFS_API_CHECK_RES(fs, res);
- s->obj_id = obj_id;
- s->type = objix_hdr.type;
- s->size = objix_hdr.size == SPIFFS_UNDEFINED_LEN ? 0 : objix_hdr.size;
- strncpy((char *)s->name, (char *)objix_hdr.name, SPIFFS_OBJ_NAME_LEN);
- return res;
- }
- s32_t SPIFFS_stat(spiffs *fs, char *path, spiffs_stat *s) {
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- s32_t res;
- spiffs_page_ix pix;
- res = spiffs_object_find_object_index_header_by_name(fs, (u8_t*)path, &pix);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_stat_pix(fs, pix, 0, s);
- SPIFFS_UNLOCK(fs);
- return res;
- }
- s32_t SPIFFS_fstat(spiffs *fs, spiffs_file fh, spiffs_stat *s) {
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_fd *fd;
- s32_t res;
- res = spiffs_fd_get(fs, fh, &fd);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- #if SPIFFS_CACHE_WR
- spiffs_fflush_cache(fs, fh);
- #endif
- res = spiffs_stat_pix(fs, fd->objix_hdr_pix, fh, s);
- SPIFFS_UNLOCK(fs);
- return res;
- }
- // Checks if there are any cached writes for the object id associated with
- // given filehandle. If so, these writes are flushed.
- static s32_t spiffs_fflush_cache(spiffs *fs, spiffs_file fh) {
- s32_t res = SPIFFS_OK;
- #if SPIFFS_CACHE_WR
- spiffs_fd *fd;
- res = spiffs_fd_get(fs, fh, &fd);
- SPIFFS_API_CHECK_RES(fs, res);
- if ((fd->flags & SPIFFS_DIRECT) == 0) {
- if (fd->cache_page == 0) {
- // see if object id is associated with cache already
- fd->cache_page = spiffs_cache_page_get_by_fd(fs, fd);
- }
- if (fd->cache_page) {
- SPIFFS_CACHE_DBG("CACHE_WR_DUMP: dumping cache page %i for fd %i:%04x, flush, offs:%i size:%i\n",
- fd->cache_page->ix, fd->file_nbr, fd->obj_id, fd->cache_page->offset, fd->cache_page->size);
- res = spiffs_hydro_write(fs, fd,
- spiffs_get_cache_page(fs, spiffs_get_cache(fs), fd->cache_page->ix),
- fd->cache_page->offset, fd->cache_page->size);
- if (res < SPIFFS_OK) {
- fs->err_code = res;
- }
- spiffs_cache_fd_release(fs, fd->cache_page);
- }
- }
- #endif
- return res;
- }
- s32_t SPIFFS_fflush(spiffs *fs, spiffs_file fh) {
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- s32_t res = SPIFFS_OK;
- #if SPIFFS_CACHE_WR
- SPIFFS_LOCK(fs);
- res = spiffs_fflush_cache(fs, fh);
- SPIFFS_API_CHECK_RES_UNLOCK(fs,res);
- SPIFFS_UNLOCK(fs);
- #endif
- return res;
- }
- void SPIFFS_close(spiffs *fs, spiffs_file fh) {
- if (!SPIFFS_CHECK_CFG((fs))) {
- (fs)->err_code = SPIFFS_ERR_NOT_CONFIGURED;
- return;
- }
- if (!SPIFFS_CHECK_MOUNT(fs)) {
- fs->err_code = SPIFFS_ERR_NOT_MOUNTED;
- return;
- }
- SPIFFS_LOCK(fs);
- #if SPIFFS_CACHE
- spiffs_fflush_cache(fs, fh);
- #endif
- spiffs_fd_return(fs, fh);
- SPIFFS_UNLOCK(fs);
- }
- s32_t SPIFFS_rename(spiffs *fs, char *old, char *new) {
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_page_ix pix_old, pix_dummy;
- spiffs_fd *fd;
- s32_t res = spiffs_object_find_object_index_header_by_name(fs, (u8_t*)old, &pix_old);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_object_find_object_index_header_by_name(fs, (u8_t*)new, &pix_dummy);
- if (res == SPIFFS_ERR_NOT_FOUND) {
- res = SPIFFS_OK;
- } else if (res == SPIFFS_OK) {
- res = SPIFFS_ERR_CONFLICTING_NAME;
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_fd_find_new(fs, &fd);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_object_open_by_page(fs, pix_old, fd, 0, 0);
- if (res != SPIFFS_OK) {
- spiffs_fd_return(fs, fd->file_nbr);
- }
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- res = spiffs_object_update_index_hdr(fs, fd, fd->obj_id, fd->objix_hdr_pix, 0, (u8_t*)new,
- 0, &pix_dummy);
- spiffs_fd_return(fs, fd->file_nbr);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- SPIFFS_UNLOCK(fs);
- return res;
- }
- spiffs_DIR *SPIFFS_opendir(spiffs *fs, char *name, spiffs_DIR *d) {
- (void)name;
- if (!SPIFFS_CHECK_CFG((fs))) {
- (fs)->err_code = SPIFFS_ERR_NOT_CONFIGURED;
- return 0;
- }
- if (!SPIFFS_CHECK_MOUNT(fs)) {
- fs->err_code = SPIFFS_ERR_NOT_MOUNTED;
- return 0;
- }
- d->fs = fs;
- d->block = 0;
- d->entry = 0;
- return d;
- }
- static s32_t spiffs_read_dir_v(
- spiffs *fs,
- spiffs_obj_id obj_id,
- spiffs_block_ix bix,
- int ix_entry,
- u32_t user_data,
- void *user_p) {
- (void)user_data;
- s32_t res;
- spiffs_page_object_ix_header objix_hdr;
- if (obj_id == SPIFFS_OBJ_ID_FREE || obj_id == SPIFFS_OBJ_ID_DELETED ||
- (obj_id & SPIFFS_OBJ_ID_IX_FLAG) == 0) {
- return SPIFFS_VIS_COUNTINUE;
- }
- spiffs_page_ix pix = SPIFFS_OBJ_LOOKUP_ENTRY_TO_PIX(fs, bix, ix_entry);
- res = _spiffs_rd(fs, SPIFFS_OP_T_OBJ_LU2 | SPIFFS_OP_C_READ,
- 0, SPIFFS_PAGE_TO_PADDR(fs, pix), sizeof(spiffs_page_object_ix_header), (u8_t *)&objix_hdr);
- if (res != SPIFFS_OK) return res;
- if ((obj_id & SPIFFS_OBJ_ID_IX_FLAG) &&
- objix_hdr.p_hdr.span_ix == 0 &&
- (objix_hdr.p_hdr.flags& (SPIFFS_PH_FLAG_DELET | SPIFFS_PH_FLAG_FINAL | SPIFFS_PH_FLAG_IXDELE)) ==
- (SPIFFS_PH_FLAG_DELET | SPIFFS_PH_FLAG_IXDELE)) {
- struct spiffs_dirent *e = (struct spiffs_dirent *)user_p;
- e->obj_id = obj_id;
- strncpy((char *)e->name, (char *)objix_hdr.name, SPIFFS_OBJ_NAME_LEN);
- e->type = objix_hdr.type;
- e->size = objix_hdr.size == SPIFFS_UNDEFINED_LEN ? 0 : objix_hdr.size;
- e->pix = pix;
- return SPIFFS_OK;
- }
- return SPIFFS_VIS_COUNTINUE;
- }
- struct spiffs_dirent *SPIFFS_readdir(spiffs_DIR *d, struct spiffs_dirent *e) {
- if (!SPIFFS_CHECK_MOUNT(d->fs)) {
- d->fs->err_code = SPIFFS_ERR_NOT_MOUNTED;
- return 0;
- }
- SPIFFS_LOCK(fs);
- spiffs_block_ix bix;
- int entry;
- s32_t res;
- struct spiffs_dirent *ret = 0;
- res = spiffs_obj_lu_find_entry_visitor(d->fs,
- d->block,
- d->entry,
- SPIFFS_VIS_NO_WRAP,
- 0,
- spiffs_read_dir_v,
- 0,
- e,
- &bix,
- &entry);
- if (res == SPIFFS_OK) {
- d->block = bix;
- d->entry = entry + 1;
- ret = e;
- } else {
- d->fs->err_code = res;
- }
- SPIFFS_UNLOCK(fs);
- return ret;
- }
- s32_t SPIFFS_closedir(spiffs_DIR *d) {
- SPIFFS_API_CHECK_CFG(d->fs);
- SPIFFS_API_CHECK_MOUNT(d->fs);
- return 0;
- }
- s32_t SPIFFS_check(spiffs *fs) {
- s32_t res;
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- res = spiffs_lookup_consistency_check(fs, 0);
- res = spiffs_object_index_consistency_check(fs);
- res = spiffs_page_consistency_check(fs);
- res = spiffs_obj_lu_scan(fs);
- SPIFFS_UNLOCK(fs);
- return res;
- }
- s32_t SPIFFS_info(spiffs *fs, u32_t *total, u32_t *used) {
- s32_t res = SPIFFS_OK;
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- u32_t pages_per_block = SPIFFS_PAGES_PER_BLOCK(fs);
- u32_t blocks = fs->block_count;
- u32_t obj_lu_pages = SPIFFS_OBJ_LOOKUP_PAGES(fs);
- u32_t data_page_size = SPIFFS_DATA_PAGE_SIZE(fs);
- u32_t total_data_pages = (blocks - 2) * (pages_per_block - obj_lu_pages) + 1; // -2 for spare blocks, +1 for emergency page
- if (total) {
- *total = total_data_pages * data_page_size;
- }
- if (used) {
- *used = fs->stats_p_allocated * data_page_size;
- }
- SPIFFS_UNLOCK(fs);
- return res;
- }
- s32_t SPIFFS_tell(spiffs *fs, spiffs_file fh) {
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_fd *fd;
- s32_t res;
- res = spiffs_fd_get(fs, fh, &fd);
- SPIFFS_API_CHECK_RES(fs, res);
- #if SPIFFS_CACHE_WR
- spiffs_fflush_cache(fs, fh);
- #endif
- res = fd->fdoffset;
- SPIFFS_UNLOCK(fs);
- return res;
- }
- s32_t SPIFFS_eof(spiffs *fs, spiffs_file fh) {
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_fd *fd;
- s32_t res;
- res = spiffs_fd_get(fs, fh, &fd);
- SPIFFS_API_CHECK_RES(fs, res);
- #if SPIFFS_CACHE_WR
- spiffs_fflush_cache(fs, fh);
- #endif
- res = (fd->fdoffset == fd->size);
- SPIFFS_UNLOCK(fs);
- return res;
- }
- s32_t SPIFFS_size(spiffs *fs, spiffs_file fh) {
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- spiffs_fd *fd;
- s32_t res;
- res = spiffs_fd_get(fs, fh, &fd);
- SPIFFS_API_CHECK_RES(fs, res);
- #if SPIFFS_CACHE_WR
- spiffs_fflush_cache(fs, fh);
- #endif
- res = fd->size;
- SPIFFS_UNLOCK(fs);
- return res;
- }
- s32_t SPIFFS_gc_quick(spiffs *fs, u16_t max_free_pages) {
- s32_t res;
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- res = spiffs_gc_quick(fs, max_free_pages);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- SPIFFS_UNLOCK(fs);
- return 0;
- }
- s32_t SPIFFS_gc(spiffs *fs, u32_t size) {
- s32_t res;
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- res = spiffs_gc_check(fs, size);
- SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
- SPIFFS_UNLOCK(fs);
- return 0;
- }
- #if SPIFFS_TEST_VISUALISATION
- s32_t SPIFFS_vis(spiffs *fs) {
- s32_t res = SPIFFS_OK;
- SPIFFS_API_CHECK_CFG(fs);
- SPIFFS_API_CHECK_MOUNT(fs);
- SPIFFS_LOCK(fs);
- int entries_per_page = (SPIFFS_CFG_LOG_PAGE_SZ(fs) / sizeof(spiffs_obj_id));
- spiffs_obj_id *obj_lu_buf = (spiffs_obj_id *)fs->lu_work;
- spiffs_block_ix bix = 0;
- while (bix < fs->block_count) {
- // check each object lookup page
- int obj_lookup_page = 0;
- int cur_entry = 0;
- while (res == SPIFFS_OK && obj_lookup_page < (int)SPIFFS_OBJ_LOOKUP_PAGES(fs)) {
- int entry_offset = obj_lookup_page * entries_per_page;
- res = _spiffs_rd(fs, SPIFFS_OP_T_OBJ_LU | SPIFFS_OP_C_READ,
- 0, bix * SPIFFS_CFG_LOG_BLOCK_SZ(fs) + SPIFFS_PAGE_TO_PADDR(fs, obj_lookup_page), SPIFFS_CFG_LOG_PAGE_SZ(fs), fs->lu_work);
- // check each entry
- while (res == SPIFFS_OK &&
- cur_entry - entry_offset < entries_per_page && cur_entry < (int)(SPIFFS_PAGES_PER_BLOCK(fs)-SPIFFS_OBJ_LOOKUP_PAGES(fs))) {
- spiffs_obj_id obj_id = obj_lu_buf[cur_entry-entry_offset];
- if (cur_entry == 0) {
- spiffs_printf("%4i ", bix);
- } else if ((cur_entry & 0x3f) == 0) {
- spiffs_printf(" ");
- }
- if (obj_id == SPIFFS_OBJ_ID_FREE) {
- spiffs_printf(SPIFFS_TEST_VIS_FREE_STR);
- } else if (obj_id == SPIFFS_OBJ_ID_DELETED) {
- spiffs_printf(SPIFFS_TEST_VIS_DELE_STR);
- } else if (obj_id & SPIFFS_OBJ_ID_IX_FLAG){
- spiffs_printf(SPIFFS_TEST_VIS_INDX_STR(obj_id));
- } else {
- spiffs_printf(SPIFFS_TEST_VIS_DATA_STR(obj_id));
- }
- cur_entry++;
- if ((cur_entry & 0x3f) == 0) {
- spiffs_printf("\n");
- }
- } // per entry
- obj_lookup_page++;
- } // per object lookup page
- spiffs_obj_id erase_count;
- res = _spiffs_rd(fs, SPIFFS_OP_C_READ | SPIFFS_OP_T_OBJ_LU2, 0,
- SPIFFS_ERASE_COUNT_PADDR(fs, bix),
- sizeof(spiffs_obj_id), (u8_t *)&erase_count);
- SPIFFS_CHECK_RES(res);
- if (erase_count != (spiffs_obj_id)-1) {
- spiffs_printf("\tera_cnt: %i\n", erase_count);
- } else {
- spiffs_printf("\tera_cnt: N/A\n");
- }
- bix++;
- } // per block
- spiffs_printf("era_cnt_max: %i\n", fs->max_erase_count);
- spiffs_printf("last_errno: %i\n", fs->err_code);
- spiffs_printf("blocks: %i\n", fs->block_count);
- spiffs_printf("free_blocks: %i\n", fs->free_blocks);
- spiffs_printf("page_alloc: %i\n", fs->stats_p_allocated);
- spiffs_printf("page_delet: %i\n", fs->stats_p_deleted);
- u32_t total, used;
- SPIFFS_info(fs, &total, &used);
- spiffs_printf("used: %i of %i\n", used, total);
- SPIFFS_UNLOCK(fs);
- return res;
- }
- #endif
|