Skip to content

Add FS::info64 call for fielsystems > 4GB #6154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions cores/esp8266/FS.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,13 @@ bool FS::info(FSInfo& info){
return _impl->info(info);
}

bool FS::info64(FSInfo64& info){
if (!_impl) {
return false;
}
return _impl->info64(info);
}

File FS::open(const String& path, const char* mode) {
return open(path.c_str(), mode);
}
Expand Down
13 changes: 13 additions & 0 deletions cores/esp8266/FS.h
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ class Dir {
FS *_baseFS;
};

// Backwards compatible, <4GB filesystem usage
struct FSInfo {
size_t totalBytes;
size_t usedBytes;
Expand All @@ -146,6 +147,17 @@ struct FSInfo {
size_t maxPathLength;
};

// Support > 4GB filesystems (SD, etc.)
struct FSInfo64 {
uint64_t totalBytes;
uint64_t usedBytes;
size_t blockSize;
size_t pageSize;
size_t maxOpenFiles;
size_t maxPathLength;
};


class FSConfig
{
public:
Expand Down Expand Up @@ -186,6 +198,7 @@ class FS

bool format();
bool info(FSInfo& info);
bool info64(FSInfo64& info);

File open(const char* path, const char* mode);
File open(const String& path, const char* mode);
Expand Down
2 changes: 2 additions & 0 deletions cores/esp8266/FSImpl.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

#include <stddef.h>
#include <stdint.h>
#include <FS.h>

namespace fs {

Expand Down Expand Up @@ -75,6 +76,7 @@ class FSImpl {
virtual void end() = 0;
virtual bool format() = 0;
virtual bool info(FSInfo& info) = 0;
virtual bool info64(FSInfo64& info) = 0;
virtual FileImplPtr open(const char* path, OpenMode openMode, AccessMode accessMode) = 0;
virtual bool exists(const char* path) = 0;
virtual DirImplPtr openDir(const char* path) = 0;
Expand Down
15 changes: 14 additions & 1 deletion cores/esp8266/spiffs_api.h
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ class SPIFFSImpl : public FSImpl

bool info(FSInfo& info) override
{
info.maxOpenFiles = _maxOpenFds;
info.blockSize = _blockSize;
info.pageSize = _pageSize;
info.maxOpenFiles = _maxOpenFds;
Expand All @@ -101,6 +100,20 @@ class SPIFFSImpl : public FSImpl
return true;
}

virtual bool info64(FSInfo64& info64) {
FSInfo i;
if (!info(i)) {
return false;
}
info64.blockSize = i.blockSize;
info64.pageSize = i.pageSize;
info64.maxOpenFiles = i.maxOpenFiles;
info64.maxPathLength = i.maxPathLength;
info64.totalBytes = i.totalBytes;
info64.usedBytes = i.usedBytes;
return true;
}

bool remove(const char* path) override
{
if (!isSpiffsFilenameValid(path)) {
Expand Down
14 changes: 14 additions & 0 deletions libraries/LittleFS/src/LittleFS.h
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,20 @@ class LittleFSImpl : public FSImpl
return true;
}

virtual bool info64(FSInfo64& info64) {
FSInfo i;
if (!info(i)) {
return false;
}
info64.blockSize = i.blockSize;
info64.pageSize = i.pageSize;
info64.maxOpenFiles = i.maxOpenFiles;
info64.maxPathLength = i.maxPathLength;
info64.totalBytes = i.totalBytes;
info64.usedBytes = i.usedBytes;
return true;
}

bool remove(const char* path) override {
if (!_mounted || !path || !path[0]) {
return false;
Expand Down
28 changes: 24 additions & 4 deletions libraries/SDFS/src/SDFS.h
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ class SDFSImpl : public FSImpl

FileImplPtr open(const char* path, OpenMode openMode, AccessMode accessMode) override;

bool exists(const char* path) {
bool exists(const char* path) override {
return _mounted ? _fs.exists(path) : false;
}

Expand All @@ -104,7 +104,7 @@ class SDFSImpl : public FSImpl
return _mounted ? _fs.rename(pathFrom, pathTo) : false;
}

bool info(FSInfo& info) override {
bool info64(FSInfo64& info) override {
if (!_mounted) {
DEBUGV("SDFS::info: FS not mounted\n");
return false;
Expand All @@ -113,8 +113,28 @@ class SDFSImpl : public FSImpl
info.blockSize = _fs.vol()->blocksPerCluster() * 512;
info.pageSize = 0; // TODO ?
info.maxPathLength = 255; // TODO ?
info.totalBytes =_fs.vol()->volumeBlockCount() * 512;
info.usedBytes = info.totalBytes - (_fs.vol()->freeClusterCount() * _fs.vol()->blocksPerCluster() * 512);
info.totalBytes =_fs.vol()->volumeBlockCount() * 512LL;
info.usedBytes = info.totalBytes - (_fs.vol()->freeClusterCount() * _fs.vol()->blocksPerCluster() * 512LL);
return true;
}

bool info(FSInfo& info) override {
FSInfo64 i;
if (!info64(i)) {
return false;
}
info.blockSize = i.blockSize;
info.pageSize = i.pageSize;
info.maxOpenFiles = i.maxOpenFiles;
info.maxPathLength = i.maxPathLength;
#ifdef DEBUG_ESP_PORT
if (i.totalBytes > (uint64_t)SIZE_MAX) {
// This catches both total and used cases, since used must always be < total.
DEBUG_ESP_PORT.printf_P(PSTR("WARNING: SD card size overflow (%lld>= 4GB). Please update source to use info64().\n"), i.totalBytes);
}
#endif
info.totalBytes = (size_t)i.totalBytes;
info.usedBytes = (size_t)i.usedBytes;
return true;
}

Expand Down