Skip to content

Add in-memory caching for directory reads #613

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
zapdos26 wants to merge 3 commits into
base: main
Choose a base branch
from
+44 −0
Open

Add in-memory caching for directory reads #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
32be80a
perf: add in-memory cache for getFilesInDirectory results
zapdos26 Feb 17, 2026
45e34c0
test: add directory read cache consistency tests
zapdos26 Feb 17, 2026
450d178
Fix test to include the 2.0 which is not hidden due to not setting se…
zapdos26 Feb 17, 2026
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
13 changes: 13 additions & 0 deletions tcl/main.tcl.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,20 @@ if {[catch {
rename ::__initStateClockSeconds ::initStateClockSeconds
rename ::__parseDateTimeArg ::parseDateTimeArg
}
# wrap getFilesInDirectory with in-memory cache to avoid redundant
# directory reads within a single modulecmd invocation
rename ::getFilesInDirectory ::_getFilesInDirectoryUncached
proc getFilesInDirectory {dir fetch_dotversion} {
set cachekey $dir:$fetch_dotversion
if {[info exists ::g_filesInDirCache($cachekey)]} {
return $::g_filesInDirCache($cachekey)
}
set result [_getFilesInDirectoryUncached $dir $fetch_dotversion]
set ::g_filesInDirCache($cachekey) $result
return $result
}
##nagelfar syntax readFile x x? x?
##nagelfar syntax _getFilesInDirectoryUncached x x
##nagelfar syntax getFilesInDirectory x x
##nagelfar syntax initStateUsergroups
##nagelfar syntax initStateUsername
Expand Down
31 changes: 31 additions & 0 deletions testsuite/modules.90-avail/025-memcache.exp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
##############################################################################
# Modules Revision 3.0
# Providing a flexible user environment
#
# Description: In-memory cache for getFilesInDirectory
# Command: avail
# Modulefiles: loc_rc1, loc_fq
#
# Test that the in-memory directory read cache returns correct results
# when the same modulepath is queried multiple times within a single
# invocation. The cache wraps getFilesInDirectory so repeated avail
# calls on overlapping paths must produce identical results.
#
##############################################################################

# test that consecutive avail queries return consistent results
# first query populates the cache, second should hit it
set ts2 "$modpath:\nloc_rc1/1.0(foo)\nloc_rc1/2.0"
testouterr_cmd "sh" "avail -t loc_rc1" "OK" $ts2

# second query on same path exercises the cache
testouterr_cmd "sh" "avail -t loc_fq" "OK" $ts1

skip_if_quick_mode

# query a different module in the same modulepath
set ts2 "$modpath:\nloc_rc1/1.0(foo)"
testouterr_cmd "sh" "avail -t loc_rc1" "OK" $ts2

# unset local variables
unset ts1 ts2