spiffs_hydrogen.c 27 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018
  1. /*
  2. * spiffs_hydrogen.c
  3. *
  4. * Created on: Jun 16, 2013
  5. * Author: petera
  6. */
  7. #include "spiffs.h"
  8. #include "spiffs_nucleus.h"
  9. static s32_t spiffs_fflush_cache(spiffs *fs, spiffs_file fh);
  10. #if SPIFFS_BUFFER_HELP
  11. u32_t SPIFFS_buffer_bytes_for_filedescs(spiffs *fs, u32_t num_descs) {
  12. return num_descs * sizeof(spiffs_fd);
  13. }
  14. #if SPIFFS_CACHE
  15. u32_t SPIFFS_buffer_bytes_for_cache(spiffs *fs, u32_t num_pages) {
  16. return sizeof(spiffs_cache) + num_pages * (sizeof(spiffs_cache_page) + SPIFFS_CFG_LOG_PAGE_SZ(fs));
  17. }
  18. #endif
  19. #endif
  20. u8_t SPIFFS_mounted(spiffs *fs) {
  21. return SPIFFS_CHECK_MOUNT(fs);
  22. }
  23. s32_t SPIFFS_format(spiffs *fs) {
  24. SPIFFS_API_CHECK_CFG(fs);
  25. if (SPIFFS_CHECK_MOUNT(fs)) {
  26. fs->err_code = SPIFFS_ERR_MOUNTED;
  27. return -1;
  28. }
  29. s32_t res;
  30. SPIFFS_LOCK(fs);
  31. spiffs_block_ix bix = 0;
  32. while (bix < fs->block_count) {
  33. fs->max_erase_count = 0;
  34. res = spiffs_erase_block(fs, bix);
  35. if (res != SPIFFS_OK) {
  36. res = SPIFFS_ERR_ERASE_FAIL;
  37. }
  38. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  39. bix++;
  40. }
  41. SPIFFS_UNLOCK(fs);
  42. return 0;
  43. }
  44. s32_t SPIFFS_mount(spiffs *fs, spiffs_config *config, u8_t *work,
  45. u8_t *fd_space, u32_t fd_space_size,
  46. void *cache, u32_t cache_size,
  47. spiffs_check_callback check_cb_f) {
  48. SPIFFS_LOCK(fs);
  49. c_memset(fs, 0, sizeof(spiffs));
  50. c_memcpy(&fs->cfg, config, sizeof(spiffs_config));
  51. fs->block_count = SPIFFS_CFG_PHYS_SZ(fs) / SPIFFS_CFG_LOG_BLOCK_SZ(fs);
  52. fs->work = &work[0];
  53. fs->lu_work = &work[SPIFFS_CFG_LOG_PAGE_SZ(fs)];
  54. c_memset(fd_space, 0, fd_space_size);
  55. // align fd_space pointer to pointer size byte boundary, below is safe
  56. u8_t ptr_size = sizeof(void*);
  57. #pragma GCC diagnostic push
  58. #pragma GCC diagnostic ignored "-Wpointer-to-int-cast"
  59. u8_t addr_lsb = ((u8_t)fd_space) & (ptr_size-1);
  60. #pragma GCC diagnostic pop
  61. if (addr_lsb) {
  62. fd_space += (ptr_size-addr_lsb);
  63. fd_space_size -= (ptr_size-addr_lsb);
  64. }
  65. fs->fd_space = fd_space;
  66. fs->fd_count = (fd_space_size/sizeof(spiffs_fd));
  67. // align cache pointer to 4 byte boundary, below is safe
  68. #pragma GCC diagnostic push
  69. #pragma GCC diagnostic ignored "-Wpointer-to-int-cast"
  70. addr_lsb = ((u8_t)cache) & (ptr_size-1);
  71. #pragma GCC diagnostic pop
  72. if (addr_lsb) {
  73. u8_t *cache_8 = (u8_t *)cache;
  74. cache_8 += (ptr_size-addr_lsb);
  75. cache = cache_8;
  76. cache_size -= (ptr_size-addr_lsb);
  77. }
  78. if (cache_size & (ptr_size-1)) {
  79. cache_size -= (cache_size & (ptr_size-1));
  80. }
  81. #if SPIFFS_CACHE
  82. fs->cache = cache;
  83. fs->cache_size = (cache_size > (config->log_page_size*32)) ? config->log_page_size*32 : cache_size;
  84. spiffs_cache_init(fs);
  85. #endif
  86. s32_t res;
  87. #if SPIFFS_USE_MAGIC
  88. res = SPIFFS_CHECK_MAGIC_POSSIBLE(fs) ? SPIFFS_OK : SPIFFS_ERR_MAGIC_NOT_POSSIBLE;
  89. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  90. #endif
  91. fs->config_magic = SPIFFS_CONFIG_MAGIC;
  92. res = spiffs_obj_lu_scan(fs);
  93. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  94. SPIFFS_DBG("page index byte len: %i\n", SPIFFS_CFG_LOG_PAGE_SZ(fs));
  95. SPIFFS_DBG("object lookup pages: %i\n", SPIFFS_OBJ_LOOKUP_PAGES(fs));
  96. SPIFFS_DBG("page pages per block: %i\n", SPIFFS_PAGES_PER_BLOCK(fs));
  97. SPIFFS_DBG("page header length: %i\n", sizeof(spiffs_page_header));
  98. SPIFFS_DBG("object header index entries: %i\n", SPIFFS_OBJ_HDR_IX_LEN(fs));
  99. SPIFFS_DBG("object index entries: %i\n", SPIFFS_OBJ_IX_LEN(fs));
  100. SPIFFS_DBG("available file descriptors: %i\n", fs->fd_count);
  101. SPIFFS_DBG("free blocks: %i\n", fs->free_blocks);
  102. fs->check_cb_f = check_cb_f;
  103. fs->mounted = 1;
  104. SPIFFS_UNLOCK(fs);
  105. return 0;
  106. }
  107. void SPIFFS_unmount(spiffs *fs) {
  108. if (!SPIFFS_CHECK_CFG(fs) || !SPIFFS_CHECK_MOUNT(fs)) return;
  109. SPIFFS_LOCK(fs);
  110. u32_t i;
  111. spiffs_fd *fds = (spiffs_fd *)fs->fd_space;
  112. for (i = 0; i < fs->fd_count; i++) {
  113. spiffs_fd *cur_fd = &fds[i];
  114. if (cur_fd->file_nbr != 0) {
  115. #if SPIFFS_CACHE
  116. (void)spiffs_fflush_cache(fs, cur_fd->file_nbr);
  117. #endif
  118. spiffs_fd_return(fs, cur_fd->file_nbr);
  119. }
  120. }
  121. fs->mounted = 0;
  122. SPIFFS_UNLOCK(fs);
  123. }
  124. s32_t SPIFFS_errno(spiffs *fs) {
  125. return fs->err_code;
  126. }
  127. void SPIFFS_clearerr(spiffs *fs) {
  128. fs->err_code = SPIFFS_OK;
  129. }
  130. s32_t SPIFFS_creat(spiffs *fs, char *path, spiffs_mode mode) {
  131. (void)mode;
  132. SPIFFS_API_CHECK_CFG(fs);
  133. SPIFFS_API_CHECK_MOUNT(fs);
  134. SPIFFS_LOCK(fs);
  135. spiffs_obj_id obj_id;
  136. s32_t res;
  137. res = spiffs_obj_lu_find_free_obj_id(fs, &obj_id, (u8_t *)path);
  138. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  139. res = spiffs_object_create(fs, obj_id, (u8_t *)path, SPIFFS_TYPE_FILE, 0);
  140. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  141. SPIFFS_UNLOCK(fs);
  142. return 0;
  143. }
  144. spiffs_file SPIFFS_open(spiffs *fs, char *path, spiffs_flags flags, spiffs_mode mode) {
  145. (void)mode;
  146. SPIFFS_API_CHECK_CFG(fs);
  147. SPIFFS_API_CHECK_MOUNT(fs);
  148. SPIFFS_LOCK(fs);
  149. spiffs_fd *fd;
  150. spiffs_page_ix pix;
  151. s32_t res = spiffs_fd_find_new(fs, &fd);
  152. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  153. res = spiffs_object_find_object_index_header_by_name(fs, (u8_t*)path, &pix);
  154. if ((flags & SPIFFS_CREAT) == 0) {
  155. if (res < SPIFFS_OK) {
  156. spiffs_fd_return(fs, fd->file_nbr);
  157. }
  158. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  159. }
  160. if ((flags & SPIFFS_CREAT) && res == SPIFFS_ERR_NOT_FOUND) {
  161. spiffs_obj_id obj_id;
  162. // no need to enter conflicting name here, already looked for it above
  163. res = spiffs_obj_lu_find_free_obj_id(fs, &obj_id, 0);
  164. if (res < SPIFFS_OK) {
  165. spiffs_fd_return(fs, fd->file_nbr);
  166. }
  167. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  168. res = spiffs_object_create(fs, obj_id, (u8_t*)path, SPIFFS_TYPE_FILE, &pix);
  169. if (res < SPIFFS_OK) {
  170. spiffs_fd_return(fs, fd->file_nbr);
  171. }
  172. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  173. flags &= ~SPIFFS_TRUNC;
  174. } else {
  175. if (res < SPIFFS_OK) {
  176. spiffs_fd_return(fs, fd->file_nbr);
  177. }
  178. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  179. }
  180. res = spiffs_object_open_by_page(fs, pix, fd, flags, mode);
  181. if (res < SPIFFS_OK) {
  182. spiffs_fd_return(fs, fd->file_nbr);
  183. }
  184. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  185. if (flags & SPIFFS_TRUNC) {
  186. res = spiffs_object_truncate(fd, 0, 0);
  187. if (res < SPIFFS_OK) {
  188. spiffs_fd_return(fs, fd->file_nbr);
  189. }
  190. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  191. }
  192. fd->fdoffset = 0;
  193. SPIFFS_UNLOCK(fs);
  194. return fd->file_nbr;
  195. }
  196. spiffs_file SPIFFS_open_by_dirent(spiffs *fs, struct spiffs_dirent *e, spiffs_flags flags, spiffs_mode mode) {
  197. SPIFFS_API_CHECK_CFG(fs);
  198. SPIFFS_API_CHECK_MOUNT(fs);
  199. SPIFFS_LOCK(fs);
  200. spiffs_fd *fd;
  201. s32_t res = spiffs_fd_find_new(fs, &fd);
  202. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  203. res = spiffs_object_open_by_page(fs, e->pix, fd, flags, mode);
  204. if (res < SPIFFS_OK) {
  205. spiffs_fd_return(fs, fd->file_nbr);
  206. }
  207. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  208. if (flags & SPIFFS_TRUNC) {
  209. res = spiffs_object_truncate(fd, 0, 0);
  210. if (res < SPIFFS_OK) {
  211. spiffs_fd_return(fs, fd->file_nbr);
  212. }
  213. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  214. }
  215. fd->fdoffset = 0;
  216. SPIFFS_UNLOCK(fs);
  217. return fd->file_nbr;
  218. }
  219. s32_t SPIFFS_read(spiffs *fs, spiffs_file fh, void *buf, s32_t len) {
  220. SPIFFS_API_CHECK_CFG(fs);
  221. SPIFFS_API_CHECK_MOUNT(fs);
  222. SPIFFS_LOCK(fs);
  223. spiffs_fd *fd;
  224. s32_t res;
  225. res = spiffs_fd_get(fs, fh, &fd);
  226. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  227. if ((fd->flags & SPIFFS_RDONLY) == 0) {
  228. res = SPIFFS_ERR_NOT_READABLE;
  229. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  230. }
  231. #if SPIFFS_CACHE_WR
  232. spiffs_fflush_cache(fs, fh);
  233. #endif
  234. if (fd->fdoffset + len >= fd->size) {
  235. // reading beyond file size
  236. s32_t avail = fd->size - fd->fdoffset;
  237. if (avail <= 0) {
  238. SPIFFS_API_CHECK_RES_UNLOCK(fs, SPIFFS_ERR_END_OF_OBJECT);
  239. }
  240. res = spiffs_object_read(fd, fd->fdoffset, avail, (u8_t*)buf);
  241. if (res == SPIFFS_ERR_END_OF_OBJECT) {
  242. fd->fdoffset += avail;
  243. SPIFFS_UNLOCK(fs);
  244. return avail;
  245. } else {
  246. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  247. len = avail;
  248. }
  249. } else {
  250. // reading within file size
  251. res = spiffs_object_read(fd, fd->fdoffset, len, (u8_t*)buf);
  252. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  253. }
  254. fd->fdoffset += len;
  255. SPIFFS_UNLOCK(fs);
  256. return len;
  257. }
  258. static s32_t spiffs_hydro_write(spiffs *fs, spiffs_fd *fd, void *buf, u32_t offset, s32_t len) {
  259. (void)fs;
  260. s32_t res = SPIFFS_OK;
  261. s32_t remaining = len;
  262. if (fd->size != SPIFFS_UNDEFINED_LEN && offset < fd->size) {
  263. s32_t m_len = MIN((s32_t)(fd->size - offset), len);
  264. res = spiffs_object_modify(fd, offset, (u8_t *)buf, m_len);
  265. SPIFFS_CHECK_RES(res);
  266. remaining -= m_len;
  267. u8_t *buf_8 = (u8_t *)buf;
  268. buf_8 += m_len;
  269. buf = buf_8;
  270. offset += m_len;
  271. }
  272. if (remaining > 0) {
  273. res = spiffs_object_append(fd, offset, (u8_t *)buf, remaining);
  274. SPIFFS_CHECK_RES(res);
  275. }
  276. return len;
  277. }
  278. s32_t SPIFFS_write(spiffs *fs, spiffs_file fh, void *buf, s32_t len) {
  279. SPIFFS_API_CHECK_CFG(fs);
  280. SPIFFS_API_CHECK_MOUNT(fs);
  281. SPIFFS_LOCK(fs);
  282. spiffs_fd *fd;
  283. s32_t res;
  284. u32_t offset;
  285. res = spiffs_fd_get(fs, fh, &fd);
  286. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  287. if ((fd->flags & SPIFFS_WRONLY) == 0) {
  288. res = SPIFFS_ERR_NOT_WRITABLE;
  289. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  290. }
  291. offset = fd->fdoffset;
  292. #if SPIFFS_CACHE_WR
  293. if (fd->cache_page == 0) {
  294. // see if object id is associated with cache already
  295. fd->cache_page = spiffs_cache_page_get_by_fd(fs, fd);
  296. }
  297. #endif
  298. if (fd->flags & SPIFFS_APPEND) {
  299. if (fd->size == SPIFFS_UNDEFINED_LEN) {
  300. offset = 0;
  301. } else {
  302. offset = fd->size;
  303. }
  304. #if SPIFFS_CACHE_WR
  305. if (fd->cache_page) {
  306. offset = MAX(offset, fd->cache_page->offset + fd->cache_page->size);
  307. }
  308. #endif
  309. }
  310. #if SPIFFS_CACHE_WR
  311. if ((fd->flags & SPIFFS_DIRECT) == 0) {
  312. if (len < (s32_t)SPIFFS_CFG_LOG_PAGE_SZ(fs)) {
  313. // small write, try to cache it
  314. u8_t alloc_cpage = 1;
  315. if (fd->cache_page) {
  316. // have a cached page for this fd already, check cache page boundaries
  317. if (offset < fd->cache_page->offset || // writing before cache
  318. offset > fd->cache_page->offset + fd->cache_page->size || // writing after cache
  319. offset + len > fd->cache_page->offset + SPIFFS_CFG_LOG_PAGE_SZ(fs)) // writing beyond cache page
  320. {
  321. // boundary violation, write back cache first and allocate new
  322. SPIFFS_CACHE_DBG("CACHE_WR_DUMP: dumping cache page %i for fd %i:%04x, boundary viol, offs:%i size:%i\n",
  323. fd->cache_page->ix, fd->file_nbr, fd->obj_id, fd->cache_page->offset, fd->cache_page->size);
  324. res = spiffs_hydro_write(fs, fd,
  325. spiffs_get_cache_page(fs, spiffs_get_cache(fs), fd->cache_page->ix),
  326. fd->cache_page->offset, fd->cache_page->size);
  327. spiffs_cache_fd_release(fs, fd->cache_page);
  328. SPIFFS_API_CHECK_RES(fs, res);
  329. } else {
  330. // writing within cache
  331. alloc_cpage = 0;
  332. }
  333. }
  334. if (alloc_cpage) {
  335. fd->cache_page = spiffs_cache_page_allocate_by_fd(fs, fd);
  336. if (fd->cache_page) {
  337. fd->cache_page->offset = offset;
  338. fd->cache_page->size = 0;
  339. SPIFFS_CACHE_DBG("CACHE_WR_ALLO: allocating cache page %i for fd %i:%04x\n",
  340. fd->cache_page->ix, fd->file_nbr, fd->obj_id);
  341. }
  342. }
  343. if (fd->cache_page) {
  344. u32_t offset_in_cpage = offset - fd->cache_page->offset;
  345. SPIFFS_CACHE_DBG("CACHE_WR_WRITE: storing to cache page %i for fd %i:%04x, offs %i:%i len %i\n",
  346. fd->cache_page->ix, fd->file_nbr, fd->obj_id,
  347. offset, offset_in_cpage, len);
  348. spiffs_cache *cache = spiffs_get_cache(fs);
  349. u8_t *cpage_data = spiffs_get_cache_page(fs, cache, fd->cache_page->ix);
  350. c_memcpy(&cpage_data[offset_in_cpage], buf, len);
  351. fd->cache_page->size = MAX(fd->cache_page->size, offset_in_cpage + len);
  352. fd->fdoffset += len;
  353. SPIFFS_UNLOCK(fs);
  354. return len;
  355. } else {
  356. res = spiffs_hydro_write(fs, fd, buf, offset, len);
  357. SPIFFS_API_CHECK_RES(fs, res);
  358. fd->fdoffset += len;
  359. SPIFFS_UNLOCK(fs);
  360. return res;
  361. }
  362. } else {
  363. // big write, no need to cache it - but first check if there is a cached write already
  364. if (fd->cache_page) {
  365. // write back cache first
  366. SPIFFS_CACHE_DBG("CACHE_WR_DUMP: dumping cache page %i for fd %i:%04x, big write, offs:%i size:%i\n",
  367. fd->cache_page->ix, fd->file_nbr, fd->obj_id, fd->cache_page->offset, fd->cache_page->size);
  368. res = spiffs_hydro_write(fs, fd,
  369. spiffs_get_cache_page(fs, spiffs_get_cache(fs), fd->cache_page->ix),
  370. fd->cache_page->offset, fd->cache_page->size);
  371. spiffs_cache_fd_release(fs, fd->cache_page);
  372. SPIFFS_API_CHECK_RES(fs, res);
  373. res = spiffs_hydro_write(fs, fd, buf, offset, len);
  374. SPIFFS_API_CHECK_RES(fs, res);
  375. }
  376. }
  377. }
  378. #endif
  379. res = spiffs_hydro_write(fs, fd, buf, offset, len);
  380. SPIFFS_API_CHECK_RES(fs, res);
  381. fd->fdoffset += len;
  382. SPIFFS_UNLOCK(fs);
  383. return res;
  384. }
  385. s32_t SPIFFS_lseek(spiffs *fs, spiffs_file fh, s32_t offs, int whence) {
  386. SPIFFS_API_CHECK_CFG(fs);
  387. SPIFFS_API_CHECK_MOUNT(fs);
  388. SPIFFS_LOCK(fs);
  389. spiffs_fd *fd;
  390. s32_t res;
  391. res = spiffs_fd_get(fs, fh, &fd);
  392. SPIFFS_API_CHECK_RES(fs, res);
  393. #if SPIFFS_CACHE_WR
  394. spiffs_fflush_cache(fs, fh);
  395. #endif
  396. switch (whence) {
  397. case SPIFFS_SEEK_CUR:
  398. offs = fd->fdoffset+offs;
  399. break;
  400. case SPIFFS_SEEK_END:
  401. offs = (fd->size == SPIFFS_UNDEFINED_LEN ? 0 : fd->size) + offs;
  402. break;
  403. }
  404. if (offs > (s32_t)fd->size) {
  405. res = SPIFFS_ERR_END_OF_OBJECT;
  406. }
  407. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  408. spiffs_span_ix data_spix = offs / SPIFFS_DATA_PAGE_SIZE(fs);
  409. spiffs_span_ix objix_spix = SPIFFS_OBJ_IX_ENTRY_SPAN_IX(fs, data_spix);
  410. if (fd->cursor_objix_spix != objix_spix) {
  411. spiffs_page_ix pix;
  412. res = spiffs_obj_lu_find_id_and_span(
  413. fs, fd->obj_id | SPIFFS_OBJ_ID_IX_FLAG, objix_spix, 0, &pix);
  414. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  415. fd->cursor_objix_spix = objix_spix;
  416. fd->cursor_objix_pix = pix;
  417. }
  418. fd->fdoffset = offs;
  419. SPIFFS_UNLOCK(fs);
  420. return offs;
  421. }
  422. s32_t SPIFFS_remove(spiffs *fs, char *path) {
  423. SPIFFS_API_CHECK_CFG(fs);
  424. SPIFFS_API_CHECK_MOUNT(fs);
  425. SPIFFS_LOCK(fs);
  426. spiffs_fd *fd;
  427. spiffs_page_ix pix;
  428. s32_t res;
  429. res = spiffs_fd_find_new(fs, &fd);
  430. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  431. res = spiffs_object_find_object_index_header_by_name(fs, (u8_t *)path, &pix);
  432. if (res != SPIFFS_OK) {
  433. spiffs_fd_return(fs, fd->file_nbr);
  434. }
  435. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  436. res = spiffs_object_open_by_page(fs, pix, fd, 0,0);
  437. if (res != SPIFFS_OK) {
  438. spiffs_fd_return(fs, fd->file_nbr);
  439. }
  440. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  441. res = spiffs_object_truncate(fd, 0, 1);
  442. if (res != SPIFFS_OK) {
  443. spiffs_fd_return(fs, fd->file_nbr);
  444. }
  445. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  446. SPIFFS_UNLOCK(fs);
  447. return 0;
  448. }
  449. s32_t SPIFFS_fremove(spiffs *fs, spiffs_file fh) {
  450. SPIFFS_API_CHECK_CFG(fs);
  451. SPIFFS_API_CHECK_MOUNT(fs);
  452. SPIFFS_LOCK(fs);
  453. spiffs_fd *fd;
  454. s32_t res;
  455. res = spiffs_fd_get(fs, fh, &fd);
  456. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  457. if ((fd->flags & SPIFFS_WRONLY) == 0) {
  458. res = SPIFFS_ERR_NOT_WRITABLE;
  459. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  460. }
  461. #if SPIFFS_CACHE_WR
  462. spiffs_cache_fd_release(fs, fd->cache_page);
  463. #endif
  464. res = spiffs_object_truncate(fd, 0, 1);
  465. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  466. SPIFFS_UNLOCK(fs);
  467. return 0;
  468. }
  469. static s32_t spiffs_stat_pix(spiffs *fs, spiffs_page_ix pix, spiffs_file fh, spiffs_stat *s) {
  470. spiffs_page_object_ix_header objix_hdr;
  471. spiffs_obj_id obj_id;
  472. s32_t res =_spiffs_rd(fs, SPIFFS_OP_T_OBJ_IX | SPIFFS_OP_C_READ, fh,
  473. SPIFFS_PAGE_TO_PADDR(fs, pix), sizeof(spiffs_page_object_ix_header), (u8_t *)&objix_hdr);
  474. SPIFFS_API_CHECK_RES(fs, res);
  475. u32_t obj_id_addr = SPIFFS_BLOCK_TO_PADDR(fs, SPIFFS_BLOCK_FOR_PAGE(fs , pix)) +
  476. SPIFFS_OBJ_LOOKUP_ENTRY_FOR_PAGE(fs, pix) * sizeof(spiffs_obj_id);
  477. res =_spiffs_rd(fs, SPIFFS_OP_T_OBJ_LU | SPIFFS_OP_C_READ, fh,
  478. obj_id_addr, sizeof(spiffs_obj_id), (u8_t *)&obj_id);
  479. SPIFFS_API_CHECK_RES(fs, res);
  480. s->obj_id = obj_id;
  481. s->type = objix_hdr.type;
  482. s->size = objix_hdr.size == SPIFFS_UNDEFINED_LEN ? 0 : objix_hdr.size;
  483. strncpy((char *)s->name, (char *)objix_hdr.name, SPIFFS_OBJ_NAME_LEN);
  484. return res;
  485. }
  486. s32_t SPIFFS_stat(spiffs *fs, char *path, spiffs_stat *s) {
  487. SPIFFS_API_CHECK_CFG(fs);
  488. SPIFFS_API_CHECK_MOUNT(fs);
  489. SPIFFS_LOCK(fs);
  490. s32_t res;
  491. spiffs_page_ix pix;
  492. res = spiffs_object_find_object_index_header_by_name(fs, (u8_t*)path, &pix);
  493. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  494. res = spiffs_stat_pix(fs, pix, 0, s);
  495. SPIFFS_UNLOCK(fs);
  496. return res;
  497. }
  498. s32_t SPIFFS_fstat(spiffs *fs, spiffs_file fh, spiffs_stat *s) {
  499. SPIFFS_API_CHECK_CFG(fs);
  500. SPIFFS_API_CHECK_MOUNT(fs);
  501. SPIFFS_LOCK(fs);
  502. spiffs_fd *fd;
  503. s32_t res;
  504. res = spiffs_fd_get(fs, fh, &fd);
  505. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  506. #if SPIFFS_CACHE_WR
  507. spiffs_fflush_cache(fs, fh);
  508. #endif
  509. res = spiffs_stat_pix(fs, fd->objix_hdr_pix, fh, s);
  510. SPIFFS_UNLOCK(fs);
  511. return res;
  512. }
  513. // Checks if there are any cached writes for the object id associated with
  514. // given filehandle. If so, these writes are flushed.
  515. static s32_t spiffs_fflush_cache(spiffs *fs, spiffs_file fh) {
  516. s32_t res = SPIFFS_OK;
  517. #if SPIFFS_CACHE_WR
  518. spiffs_fd *fd;
  519. res = spiffs_fd_get(fs, fh, &fd);
  520. SPIFFS_API_CHECK_RES(fs, res);
  521. if ((fd->flags & SPIFFS_DIRECT) == 0) {
  522. if (fd->cache_page == 0) {
  523. // see if object id is associated with cache already
  524. fd->cache_page = spiffs_cache_page_get_by_fd(fs, fd);
  525. }
  526. if (fd->cache_page) {
  527. SPIFFS_CACHE_DBG("CACHE_WR_DUMP: dumping cache page %i for fd %i:%04x, flush, offs:%i size:%i\n",
  528. fd->cache_page->ix, fd->file_nbr, fd->obj_id, fd->cache_page->offset, fd->cache_page->size);
  529. res = spiffs_hydro_write(fs, fd,
  530. spiffs_get_cache_page(fs, spiffs_get_cache(fs), fd->cache_page->ix),
  531. fd->cache_page->offset, fd->cache_page->size);
  532. if (res < SPIFFS_OK) {
  533. fs->err_code = res;
  534. }
  535. spiffs_cache_fd_release(fs, fd->cache_page);
  536. }
  537. }
  538. #endif
  539. return res;
  540. }
  541. s32_t SPIFFS_fflush(spiffs *fs, spiffs_file fh) {
  542. SPIFFS_API_CHECK_CFG(fs);
  543. SPIFFS_API_CHECK_MOUNT(fs);
  544. s32_t res = SPIFFS_OK;
  545. #if SPIFFS_CACHE_WR
  546. SPIFFS_LOCK(fs);
  547. res = spiffs_fflush_cache(fs, fh);
  548. SPIFFS_API_CHECK_RES_UNLOCK(fs,res);
  549. SPIFFS_UNLOCK(fs);
  550. #endif
  551. return res;
  552. }
  553. void SPIFFS_close(spiffs *fs, spiffs_file fh) {
  554. if (!SPIFFS_CHECK_CFG((fs))) {
  555. (fs)->err_code = SPIFFS_ERR_NOT_CONFIGURED;
  556. return;
  557. }
  558. if (!SPIFFS_CHECK_MOUNT(fs)) {
  559. fs->err_code = SPIFFS_ERR_NOT_MOUNTED;
  560. return;
  561. }
  562. SPIFFS_LOCK(fs);
  563. #if SPIFFS_CACHE
  564. spiffs_fflush_cache(fs, fh);
  565. #endif
  566. spiffs_fd_return(fs, fh);
  567. SPIFFS_UNLOCK(fs);
  568. }
  569. s32_t SPIFFS_rename(spiffs *fs, char *old, char *new) {
  570. SPIFFS_API_CHECK_CFG(fs);
  571. SPIFFS_API_CHECK_MOUNT(fs);
  572. SPIFFS_LOCK(fs);
  573. spiffs_page_ix pix_old, pix_dummy;
  574. spiffs_fd *fd;
  575. s32_t res = spiffs_object_find_object_index_header_by_name(fs, (u8_t*)old, &pix_old);
  576. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  577. res = spiffs_object_find_object_index_header_by_name(fs, (u8_t*)new, &pix_dummy);
  578. if (res == SPIFFS_ERR_NOT_FOUND) {
  579. res = SPIFFS_OK;
  580. } else if (res == SPIFFS_OK) {
  581. res = SPIFFS_ERR_CONFLICTING_NAME;
  582. }
  583. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  584. res = spiffs_fd_find_new(fs, &fd);
  585. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  586. res = spiffs_object_open_by_page(fs, pix_old, fd, 0, 0);
  587. if (res != SPIFFS_OK) {
  588. spiffs_fd_return(fs, fd->file_nbr);
  589. }
  590. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  591. res = spiffs_object_update_index_hdr(fs, fd, fd->obj_id, fd->objix_hdr_pix, 0, (u8_t*)new,
  592. 0, &pix_dummy);
  593. spiffs_fd_return(fs, fd->file_nbr);
  594. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  595. SPIFFS_UNLOCK(fs);
  596. return res;
  597. }
  598. spiffs_DIR *SPIFFS_opendir(spiffs *fs, char *name, spiffs_DIR *d) {
  599. (void)name;
  600. if (!SPIFFS_CHECK_CFG((fs))) {
  601. (fs)->err_code = SPIFFS_ERR_NOT_CONFIGURED;
  602. return 0;
  603. }
  604. if (!SPIFFS_CHECK_MOUNT(fs)) {
  605. fs->err_code = SPIFFS_ERR_NOT_MOUNTED;
  606. return 0;
  607. }
  608. d->fs = fs;
  609. d->block = 0;
  610. d->entry = 0;
  611. return d;
  612. }
  613. static s32_t spiffs_read_dir_v(
  614. spiffs *fs,
  615. spiffs_obj_id obj_id,
  616. spiffs_block_ix bix,
  617. int ix_entry,
  618. u32_t user_data,
  619. void *user_p) {
  620. (void)user_data;
  621. s32_t res;
  622. spiffs_page_object_ix_header objix_hdr;
  623. if (obj_id == SPIFFS_OBJ_ID_FREE || obj_id == SPIFFS_OBJ_ID_DELETED ||
  624. (obj_id & SPIFFS_OBJ_ID_IX_FLAG) == 0) {
  625. return SPIFFS_VIS_COUNTINUE;
  626. }
  627. spiffs_page_ix pix = SPIFFS_OBJ_LOOKUP_ENTRY_TO_PIX(fs, bix, ix_entry);
  628. res = _spiffs_rd(fs, SPIFFS_OP_T_OBJ_LU2 | SPIFFS_OP_C_READ,
  629. 0, SPIFFS_PAGE_TO_PADDR(fs, pix), sizeof(spiffs_page_object_ix_header), (u8_t *)&objix_hdr);
  630. if (res != SPIFFS_OK) return res;
  631. if ((obj_id & SPIFFS_OBJ_ID_IX_FLAG) &&
  632. objix_hdr.p_hdr.span_ix == 0 &&
  633. (objix_hdr.p_hdr.flags& (SPIFFS_PH_FLAG_DELET | SPIFFS_PH_FLAG_FINAL | SPIFFS_PH_FLAG_IXDELE)) ==
  634. (SPIFFS_PH_FLAG_DELET | SPIFFS_PH_FLAG_IXDELE)) {
  635. struct spiffs_dirent *e = (struct spiffs_dirent *)user_p;
  636. e->obj_id = obj_id;
  637. strncpy((char *)e->name, (char *)objix_hdr.name, SPIFFS_OBJ_NAME_LEN);
  638. e->type = objix_hdr.type;
  639. e->size = objix_hdr.size == SPIFFS_UNDEFINED_LEN ? 0 : objix_hdr.size;
  640. e->pix = pix;
  641. return SPIFFS_OK;
  642. }
  643. return SPIFFS_VIS_COUNTINUE;
  644. }
  645. struct spiffs_dirent *SPIFFS_readdir(spiffs_DIR *d, struct spiffs_dirent *e) {
  646. if (!SPIFFS_CHECK_MOUNT(d->fs)) {
  647. d->fs->err_code = SPIFFS_ERR_NOT_MOUNTED;
  648. return 0;
  649. }
  650. SPIFFS_LOCK(fs);
  651. spiffs_block_ix bix;
  652. int entry;
  653. s32_t res;
  654. struct spiffs_dirent *ret = 0;
  655. res = spiffs_obj_lu_find_entry_visitor(d->fs,
  656. d->block,
  657. d->entry,
  658. SPIFFS_VIS_NO_WRAP,
  659. 0,
  660. spiffs_read_dir_v,
  661. 0,
  662. e,
  663. &bix,
  664. &entry);
  665. if (res == SPIFFS_OK) {
  666. d->block = bix;
  667. d->entry = entry + 1;
  668. ret = e;
  669. } else {
  670. d->fs->err_code = res;
  671. }
  672. SPIFFS_UNLOCK(fs);
  673. return ret;
  674. }
  675. s32_t SPIFFS_closedir(spiffs_DIR *d) {
  676. SPIFFS_API_CHECK_CFG(d->fs);
  677. SPIFFS_API_CHECK_MOUNT(d->fs);
  678. return 0;
  679. }
  680. s32_t SPIFFS_check(spiffs *fs) {
  681. s32_t res;
  682. SPIFFS_API_CHECK_CFG(fs);
  683. SPIFFS_API_CHECK_MOUNT(fs);
  684. SPIFFS_LOCK(fs);
  685. res = spiffs_lookup_consistency_check(fs, 0);
  686. res = spiffs_object_index_consistency_check(fs);
  687. res = spiffs_page_consistency_check(fs);
  688. res = spiffs_obj_lu_scan(fs);
  689. SPIFFS_UNLOCK(fs);
  690. return res;
  691. }
  692. s32_t SPIFFS_info(spiffs *fs, u32_t *total, u32_t *used) {
  693. s32_t res = SPIFFS_OK;
  694. SPIFFS_API_CHECK_CFG(fs);
  695. SPIFFS_API_CHECK_MOUNT(fs);
  696. SPIFFS_LOCK(fs);
  697. u32_t pages_per_block = SPIFFS_PAGES_PER_BLOCK(fs);
  698. u32_t blocks = fs->block_count;
  699. u32_t obj_lu_pages = SPIFFS_OBJ_LOOKUP_PAGES(fs);
  700. u32_t data_page_size = SPIFFS_DATA_PAGE_SIZE(fs);
  701. u32_t total_data_pages = (blocks - 2) * (pages_per_block - obj_lu_pages) + 1; // -2 for spare blocks, +1 for emergency page
  702. if (total) {
  703. *total = total_data_pages * data_page_size;
  704. }
  705. if (used) {
  706. *used = fs->stats_p_allocated * data_page_size;
  707. }
  708. SPIFFS_UNLOCK(fs);
  709. return res;
  710. }
  711. s32_t SPIFFS_tell(spiffs *fs, spiffs_file fh) {
  712. SPIFFS_API_CHECK_MOUNT(fs);
  713. SPIFFS_LOCK(fs);
  714. spiffs_fd *fd;
  715. s32_t res;
  716. res = spiffs_fd_get(fs, fh, &fd);
  717. SPIFFS_API_CHECK_RES(fs, res);
  718. #if SPIFFS_CACHE_WR
  719. spiffs_fflush_cache(fs, fh);
  720. #endif
  721. res = fd->fdoffset;
  722. SPIFFS_UNLOCK(fs);
  723. return res;
  724. }
  725. s32_t SPIFFS_eof(spiffs *fs, spiffs_file fh) {
  726. SPIFFS_API_CHECK_MOUNT(fs);
  727. SPIFFS_LOCK(fs);
  728. spiffs_fd *fd;
  729. s32_t res;
  730. res = spiffs_fd_get(fs, fh, &fd);
  731. SPIFFS_API_CHECK_RES(fs, res);
  732. #if SPIFFS_CACHE_WR
  733. spiffs_fflush_cache(fs, fh);
  734. #endif
  735. res = (fd->fdoffset == fd->size);
  736. SPIFFS_UNLOCK(fs);
  737. return res;
  738. }
  739. s32_t SPIFFS_size(spiffs *fs, spiffs_file fh) {
  740. SPIFFS_API_CHECK_MOUNT(fs);
  741. SPIFFS_LOCK(fs);
  742. spiffs_fd *fd;
  743. s32_t res;
  744. res = spiffs_fd_get(fs, fh, &fd);
  745. SPIFFS_API_CHECK_RES(fs, res);
  746. #if SPIFFS_CACHE_WR
  747. spiffs_fflush_cache(fs, fh);
  748. #endif
  749. res = fd->size;
  750. SPIFFS_UNLOCK(fs);
  751. return res;
  752. }
  753. s32_t SPIFFS_gc_quick(spiffs *fs, u16_t max_free_pages) {
  754. s32_t res;
  755. SPIFFS_API_CHECK_CFG(fs);
  756. SPIFFS_API_CHECK_MOUNT(fs);
  757. SPIFFS_LOCK(fs);
  758. res = spiffs_gc_quick(fs, max_free_pages);
  759. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  760. SPIFFS_UNLOCK(fs);
  761. return 0;
  762. }
  763. s32_t SPIFFS_gc(spiffs *fs, u32_t size) {
  764. s32_t res;
  765. SPIFFS_API_CHECK_CFG(fs);
  766. SPIFFS_API_CHECK_MOUNT(fs);
  767. SPIFFS_LOCK(fs);
  768. res = spiffs_gc_check(fs, size);
  769. SPIFFS_API_CHECK_RES_UNLOCK(fs, res);
  770. SPIFFS_UNLOCK(fs);
  771. return 0;
  772. }
  773. #if SPIFFS_TEST_VISUALISATION
  774. s32_t SPIFFS_vis(spiffs *fs) {
  775. s32_t res = SPIFFS_OK;
  776. SPIFFS_API_CHECK_CFG(fs);
  777. SPIFFS_API_CHECK_MOUNT(fs);
  778. SPIFFS_LOCK(fs);
  779. int entries_per_page = (SPIFFS_CFG_LOG_PAGE_SZ(fs) / sizeof(spiffs_obj_id));
  780. spiffs_obj_id *obj_lu_buf = (spiffs_obj_id *)fs->lu_work;
  781. spiffs_block_ix bix = 0;
  782. while (bix < fs->block_count) {
  783. // check each object lookup page
  784. int obj_lookup_page = 0;
  785. int cur_entry = 0;
  786. while (res == SPIFFS_OK && obj_lookup_page < (int)SPIFFS_OBJ_LOOKUP_PAGES(fs)) {
  787. int entry_offset = obj_lookup_page * entries_per_page;
  788. res = _spiffs_rd(fs, SPIFFS_OP_T_OBJ_LU | SPIFFS_OP_C_READ,
  789. 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);
  790. // check each entry
  791. while (res == SPIFFS_OK &&
  792. cur_entry - entry_offset < entries_per_page && cur_entry < (int)(SPIFFS_PAGES_PER_BLOCK(fs)-SPIFFS_OBJ_LOOKUP_PAGES(fs))) {
  793. spiffs_obj_id obj_id = obj_lu_buf[cur_entry-entry_offset];
  794. if (cur_entry == 0) {
  795. spiffs_printf("%4i ", bix);
  796. } else if ((cur_entry & 0x3f) == 0) {
  797. spiffs_printf(" ");
  798. }
  799. if (obj_id == SPIFFS_OBJ_ID_FREE) {
  800. spiffs_printf(SPIFFS_TEST_VIS_FREE_STR);
  801. } else if (obj_id == SPIFFS_OBJ_ID_DELETED) {
  802. spiffs_printf(SPIFFS_TEST_VIS_DELE_STR);
  803. } else if (obj_id & SPIFFS_OBJ_ID_IX_FLAG){
  804. spiffs_printf(SPIFFS_TEST_VIS_INDX_STR(obj_id));
  805. } else {
  806. spiffs_printf(SPIFFS_TEST_VIS_DATA_STR(obj_id));
  807. }
  808. cur_entry++;
  809. if ((cur_entry & 0x3f) == 0) {
  810. spiffs_printf("\n");
  811. }
  812. } // per entry
  813. obj_lookup_page++;
  814. } // per object lookup page
  815. spiffs_obj_id erase_count;
  816. res = _spiffs_rd(fs, SPIFFS_OP_C_READ | SPIFFS_OP_T_OBJ_LU2, 0,
  817. SPIFFS_ERASE_COUNT_PADDR(fs, bix),
  818. sizeof(spiffs_obj_id), (u8_t *)&erase_count);
  819. SPIFFS_CHECK_RES(res);
  820. if (erase_count != (spiffs_obj_id)-1) {
  821. spiffs_printf("\tera_cnt: %i\n", erase_count);
  822. } else {
  823. spiffs_printf("\tera_cnt: N/A\n");
  824. }
  825. bix++;
  826. } // per block
  827. spiffs_printf("era_cnt_max: %i\n", fs->max_erase_count);
  828. spiffs_printf("last_errno: %i\n", fs->err_code);
  829. spiffs_printf("blocks: %i\n", fs->block_count);
  830. spiffs_printf("free_blocks: %i\n", fs->free_blocks);
  831. spiffs_printf("page_alloc: %i\n", fs->stats_p_allocated);
  832. spiffs_printf("page_delet: %i\n", fs->stats_p_deleted);
  833. u32_t total, used;
  834. SPIFFS_info(fs, &total, &used);
  835. spiffs_printf("used: %i of %i\n", used, total);
  836. SPIFFS_UNLOCK(fs);
  837. return res;
  838. }
  839. #endif