Skip to content

fix(RegionMap): compact storage /regions3, fix save/load return values, add paged region CLI output #2236

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.

Sign up for GitHub

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

Open
jirogit wants to merge 1 commit into
base: dev
Choose a base branch
from
+109 −38
Open

fix(RegionMap): compact storage /regions3, fix save/load return values, add paged region CLI output #2236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 44 additions & 2 deletions examples/simple_repeater/MyMesh.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1180,8 +1180,50 @@ void MyMesh::handleCommand(uint32_t sender_timestamp, char *command, char *reply

const char* parts[4];
int n = mesh::Utils::parseTextParts(command, parts, 4, ' ');
if (n == 1) {
region_map.exportTo(reply, 160);
if (n == 1 || (n >= 2 && parts[1][0] >= '0' && parts[1][0] <= '9')) {
// Paged region listing. Argument is the start index into the named-region
// array (0-based). 'region' or 'region 0' starts from the beginning.
// The first page always prepends the wildcard (*).
// The reply footer shows the next start index, e.g. ">5" meaning
// run 'region 5' to continue. No footer = last page.
int start = (n >= 2) ? atoi(parts[1]) : 0;
if (start < 0) start = 0;

int total = region_map.getCount(); // named regions only (excludes *)

char *dp = reply;
char *limit = reply + 148; // leave 12 bytes for ">NN\0" footer + safety

if (start == 0) {
// always show wildcard on first page
const RegionEntry& wc = region_map.getWildcard();
int wlen = snprintf(dp, (size_t)(limit - dp), "*%s\n",
(wc.flags & REGION_DENY_FLOOD) ? "" : " F");
if (wlen > 0 && dp + wlen < limit) dp += wlen;
}

int i = start;
for (; i < total; i++) {
const RegionEntry* r = region_map.getByIdx(i);
const char* name = r->name[0] == '#' ? r->name + 1 : r->name;
int rlen = snprintf(dp, (size_t)(limit - dp), "%s%s\n",
name,
(r->flags & REGION_DENY_FLOOD) ? "" : " F");
if (rlen > 0 && dp + rlen < limit) {
dp += rlen;
} else {
break; // no more space; i is the next start index
}
}

if (i < total) {
// more entries remain: show next start index as footer
snprintf(dp, (size_t)(reply + 160 - dp), ">%d", i);
} else if (dp > reply) {
*(dp - 1) = 0; // trim trailing newline on last page
}

if (reply[0] == 0) strcpy(reply, "-none-");
} else if (n >= 2 && strcmp(parts[1], "load") == 0) {
temp_map.resetFrom(region_map); // rebuild regions in a temp instance
memset(load_stack, 0, sizeof(load_stack));
Expand Down
101 changes: 65 additions & 36 deletions src/helpers/RegionMap.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,56 +68,81 @@ static File openWrite(FILESYSTEM* _fs, const char* filename) {
#endif
}

// Load from /regions3 format (64-byte per-record padding).
// Falls back to legacy /regions2 format (128-byte padding) for migration.
bool RegionMap::load(FILESYSTEM* _fs, const char* path) {
if (_fs->exists(path ? path : "/regions2")) {
// /regions3: current format, 64-byte per-record padding (written by this save()).
// /regions2: legacy format, 128-byte per-record padding (read-only, for migration).
const char* path_v3 = path ? path : "/regions3";
const char* path_v2 = path ? path : "/regions2";

bool use_legacy = false;
if (!_fs->exists(path_v3)) {
if (!_fs->exists(path_v2)) return false; // neither file exists
use_legacy = true; // migrate from /regions2 on next save()
}

const char* chosen = use_legacy ? path_v2 : path_v3;

#if defined(RP2040_PLATFORM)
File file = _fs->open(path ? path : "/regions2", "r");
File file = _fs->open(chosen, "r");
#else
File file = _fs->open(path ? path : "/regions2");
File file = _fs->open(chosen);
#endif

if (file) {
uint8_t pad[128];

num_regions = 0; next_id = 1; home_id = 0;

bool success = file.read(pad, 5) == 5; // reserved header
success = success && file.read((uint8_t *) &home_id, sizeof(home_id)) == sizeof(home_id);
success = success && file.read((uint8_t *) &wildcard.flags, sizeof(wildcard.flags)) == sizeof(wildcard.flags);
success = success && file.read((uint8_t *) &next_id, sizeof(next_id)) == sizeof(next_id);

if (success) {
while (num_regions < MAX_REGION_ENTRIES) {
auto r = &regions[num_regions];

success = file.read((uint8_t *) &r->id, sizeof(r->id)) == sizeof(r->id);
success = success && file.read((uint8_t *) &r->parent, sizeof(r->parent)) == sizeof(r->parent);
success = success && file.read((uint8_t *) r->name, sizeof(r->name)) == sizeof(r->name);
success = success && file.read((uint8_t *) &r->flags, sizeof(r->flags)) == sizeof(r->flags);
success = success && file.read(pad, sizeof(pad)) == sizeof(pad);
if (!file) return false;

uint8_t hdr[5];
num_regions = 0; next_id = 1; home_id = 0;

bool success = file.read(hdr, 5) == 5; // reserved header
success = success && file.read((uint8_t *) &home_id, sizeof(home_id)) == sizeof(home_id);
success = success && file.read((uint8_t *) &wildcard.flags, sizeof(wildcard.flags)) == sizeof(wildcard.flags);
success = success && file.read((uint8_t *) &next_id, sizeof(next_id)) == sizeof(next_id);

if (success) {
while (num_regions < MAX_REGION_ENTRIES) {
auto r = &regions[num_regions];

success = file.read((uint8_t *) &r->id, sizeof(r->id)) == sizeof(r->id);
success = success && file.read((uint8_t *) &r->parent, sizeof(r->parent)) == sizeof(r->parent);
success = success && file.read((uint8_t *) r->name, sizeof(r->name)) == sizeof(r->name);
success = success && file.read((uint8_t *) &r->flags, sizeof(r->flags)) == sizeof(r->flags);

if (use_legacy) {
// Legacy /regions2 had 128 bytes of per-record padding; skip it.
uint8_t pad[128];
success = success && file.read(pad, sizeof(pad)) == sizeof(pad);
} else {
// /regions3 has 64 bytes of per-record padding for future expansion.
uint8_t pad[64];
success = success && file.read(pad, sizeof(pad)) == sizeof(pad);
}

if (!success) break; // EOF
if (!success) break; // EOF

if (r->id >= next_id) { // make sure next_id is valid
next_id = r->id + 1;
}
num_regions++;
}
if (r->id >= next_id) { // make sure next_id is valid
next_id = r->id + 1;
}
file.close();
return true;
num_regions++;
}
}
return false; // failed
file.close();
return num_regions > 0 || success; // true if header was readable (even empty map)
}

// Save in /regions3 format: 64-byte per-record padding for future expansion.
// Each record is 100 bytes (2 id + 2 parent + 31 name + 1 flags + 64 pad),
// vs. 164 bytes in the legacy /regions2 format.
// All 32 entries fit within ~3.2 KB (78% of one nRF52 4096B LittleFS block).
bool RegionMap::save(FILESYSTEM* _fs, const char* path) {
File file = openWrite(_fs, path ? path : "/regions2");
const char* save_path = path ? path : "/regions3";
File file = openWrite(_fs, save_path);
if (file) {
uint8_t pad[128];
memset(pad, 0, sizeof(pad));
uint8_t hdr[5] = {0};
uint8_t pad[64] = {0};

bool success = file.write(pad, 5) == 5; // reserved header
bool success = file.write(hdr, 5) == 5; // reserved header
success = success && file.write((uint8_t *) &home_id, sizeof(home_id)) == sizeof(home_id);
success = success && file.write((uint8_t *) &wildcard.flags, sizeof(wildcard.flags)) == sizeof(wildcard.flags);
success = success && file.write((uint8_t *) &next_id, sizeof(next_id)) == sizeof(next_id);
Expand All @@ -135,7 +160,11 @@ bool RegionMap::save(FILESYSTEM* _fs, const char* path) {
}
}
file.close();
return true;
if (success && !path) {
// Migration complete: remove legacy /regions2 if it exists.
if (_fs->exists("/regions2")) _fs->remove("/regions2");
}
return success;
}
return false; // failed
}
Expand Down