0001 what: /sys/kernel/mm/damon/
0002 Date: Mar 2022
0003 Contact: SeongJae Park <sj@kernel.org>
0004 Description: Interface for Data Access MONitoring (DAMON). Contains files
0005 for controlling DAMON. For more details on DAMON itself,
0006 please refer to Documentation/admin-guide/mm/damon/index.rst.
0007
0008 What: /sys/kernel/mm/damon/admin/
0009 Date: Mar 2022
0010 Contact: SeongJae Park <sj@kernel.org>
0011 Description: Interface for privileged users of DAMON. Contains files for
0012 controlling DAMON that aimed to be used by privileged users.
0013
0014 What: /sys/kernel/mm/damon/admin/kdamonds/nr_kdamonds
0015 Date: Mar 2022
0016 Contact: SeongJae Park <sj@kernel.org>
0017 Description: Writing a number 'N' to this file creates the number of
0018 directories for controlling each DAMON worker thread (kdamond)
0019 named '0' to 'N-1' under the kdamonds/ directory.
0020
0021 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/state
0022 Date: Mar 2022
0023 Contact: SeongJae Park <sj@kernel.org>
0024 Description: Writing 'on' or 'off' to this file makes the kdamond starts or
0025 stops, respectively. Reading the file returns the keywords
0026 based on the current status. Writing 'commit' to this file
0027 makes the kdamond reads the user inputs in the sysfs files
0028 except 'state' again. Writing 'update_schemes_stats' to the
0029 file updates contents of schemes stats files of the kdamond.
0030
0031 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/pid
0032 Date: Mar 2022
0033 Contact: SeongJae Park <sj@kernel.org>
0034 Description: Reading this file returns the pid of the kdamond if it is
0035 running.
0036
0037 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/nr_contexts
0038 Date: Mar 2022
0039 Contact: SeongJae Park <sj@kernel.org>
0040 Description: Writing a number 'N' to this file creates the number of
0041 directories for controlling each DAMON context named '0' to
0042 'N-1' under the contexts/ directory.
0043
0044 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/avail_operations
0045 Date: Apr 2022
0046 Contact: SeongJae Park <sj@kernel.org>
0047 Description: Reading this file returns the available monitoring operations
0048 sets on the currently running kernel.
0049
0050 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/operations
0051 Date: Mar 2022
0052 Contact: SeongJae Park <sj@kernel.org>
0053 Description: Writing a keyword for a monitoring operations set ('vaddr' for
0054 virtual address spaces monitoring, 'fvaddr' for fixed virtual
0055 address ranges monitoring, and 'paddr' for the physical address
0056 space monitoring) to this file makes the context to use the
0057 operations set. Reading the file returns the keyword for the
0058 operations set the context is set to use.
0059
0060 Note that only the operations sets that listed in
0061 'avail_operations' file are valid inputs.
0062
0063 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/sample_us
0064 Date: Mar 2022
0065 Contact: SeongJae Park <sj@kernel.org>
0066 Description: Writing a value to this file sets the sampling interval of the
0067 DAMON context in microseconds as the value. Reading this file
0068 returns the value.
0069
0070 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/aggr_us
0071 Date: Mar 2022
0072 Contact: SeongJae Park <sj@kernel.org>
0073 Description: Writing a value to this file sets the aggregation interval of
0074 the DAMON context in microseconds as the value. Reading this
0075 file returns the value.
0076
0077 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/intervals/update_us
0078 Date: Mar 2022
0079 Contact: SeongJae Park <sj@kernel.org>
0080 Description: Writing a value to this file sets the update interval of the
0081 DAMON context in microseconds as the value. Reading this file
0082 returns the value.
0083
0084 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/nr_regions/min
0085
0086 WDate: Mar 2022
0087 Contact: SeongJae Park <sj@kernel.org>
0088 Description: Writing a value to this file sets the minimum number of
0089 monitoring regions of the DAMON context as the value. Reading
0090 this file returns the value.
0091
0092 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/monitoring_attrs/nr_regions/max
0093 Date: Mar 2022
0094 Contact: SeongJae Park <sj@kernel.org>
0095 Description: Writing a value to this file sets the maximum number of
0096 monitoring regions of the DAMON context as the value. Reading
0097 this file returns the value.
0098
0099 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/targets/nr_targets
0100 Date: Mar 2022
0101 Contact: SeongJae Park <sj@kernel.org>
0102 Description: Writing a number 'N' to this file creates the number of
0103 directories for controlling each DAMON target of the context
0104 named '0' to 'N-1' under the contexts/ directory.
0105
0106 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/targets/<T>/pid_target
0107 Date: Mar 2022
0108 Contact: SeongJae Park <sj@kernel.org>
0109 Description: Writing to and reading from this file sets and gets the pid of
0110 the target process if the context is for virtual address spaces
0111 monitoring, respectively.
0112
0113 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/targets/<T>/regions/nr_regions
0114 Date: Mar 2022
0115 Contact: SeongJae Park <sj@kernel.org>
0116 Description: Writing a number 'N' to this file creates the number of
0117 directories for setting each DAMON target memory region of the
0118 context named '0' to 'N-1' under the regions/ directory. In
0119 case of the virtual address space monitoring, DAMON
0120 automatically sets the target memory region based on the target
0121 processes' mappings.
0122
0123 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/targets/<T>/regions/<R>/start
0124 Date: Mar 2022
0125 Contact: SeongJae Park <sj@kernel.org>
0126 Description: Writing to and reading from this file sets and gets the start
0127 address of the monitoring region.
0128
0129 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/targets/<T>/regions/<R>/end
0130 Date: Mar 2022
0131 Contact: SeongJae Park <sj@kernel.org>
0132 Description: Writing to and reading from this file sets and gets the end
0133 address of the monitoring region.
0134
0135 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/nr_schemes
0136 Date: Mar 2022
0137 Contact: SeongJae Park <sj@kernel.org>
0138 Description: Writing a number 'N' to this file creates the number of
0139 directories for controlling each DAMON-based operation scheme
0140 of the context named '0' to 'N-1' under the schemes/ directory.
0141
0142 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/action
0143 Date: Mar 2022
0144 Contact: SeongJae Park <sj@kernel.org>
0145 Description: Writing to and reading from this file sets and gets the action
0146 of the scheme.
0147
0148 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/min
0149 Date: Mar 2022
0150 Contact: SeongJae Park <sj@kernel.org>
0151 Description: Writing to and reading from this file sets and gets the mimimum
0152 size of the scheme's target regions in bytes.
0153
0154 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/sz/max
0155 Date: Mar 2022
0156 Contact: SeongJae Park <sj@kernel.org>
0157 Description: Writing to and reading from this file sets and gets the maximum
0158 size of the scheme's target regions in bytes.
0159
0160 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/nr_accesses/min
0161 Date: Mar 2022
0162 Contact: SeongJae Park <sj@kernel.org>
0163 Description: Writing to and reading from this file sets and gets the manimum
0164 'nr_accesses' of the scheme's target regions.
0165
0166 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/nr_accesses/max
0167 Date: Mar 2022
0168 Contact: SeongJae Park <sj@kernel.org>
0169 Description: Writing to and reading from this file sets and gets the maximum
0170 'nr_accesses' of the scheme's target regions.
0171
0172 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/age/min
0173 Date: Mar 2022
0174 Contact: SeongJae Park <sj@kernel.org>
0175 Description: Writing to and reading from this file sets and gets the minimum
0176 'age' of the scheme's target regions.
0177
0178 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/access_pattern/age/max
0179 Date: Mar 2022
0180 Contact: SeongJae Park <sj@kernel.org>
0181 Description: Writing to and reading from this file sets and gets the maximum
0182 'age' of the scheme's target regions.
0183
0184 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/ms
0185 Date: Mar 2022
0186 Contact: SeongJae Park <sj@kernel.org>
0187 Description: Writing to and reading from this file sets and gets the time
0188 quota of the scheme in milliseconds.
0189
0190 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/bytes
0191 Date: Mar 2022
0192 Contact: SeongJae Park <sj@kernel.org>
0193 Description: Writing to and reading from this file sets and gets the size
0194 quota of the scheme in bytes.
0195
0196 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/reset_interval_ms
0197 Date: Mar 2022
0198 Contact: SeongJae Park <sj@kernel.org>
0199 Description: Writing to and reading from this file sets and gets the quotas
0200 charge reset interval of the scheme in milliseconds.
0201
0202 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/weights/sz_permil
0203 Date: Mar 2022
0204 Contact: SeongJae Park <sj@kernel.org>
0205 Description: Writing to and reading from this file sets and gets the
0206 under-quota limit regions prioritization weight for 'size' in
0207 permil.
0208
0209 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/weights/nr_accesses_permil
0210 Date: Mar 2022
0211 Contact: SeongJae Park <sj@kernel.org>
0212 Description: Writing to and reading from this file sets and gets the
0213 under-quota limit regions prioritization weight for
0214 'nr_accesses' in permil.
0215
0216 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/quotas/weights/age_permil
0217 Date: Mar 2022
0218 Contact: SeongJae Park <sj@kernel.org>
0219 Description: Writing to and reading from this file sets and gets the
0220 under-quota limit regions prioritization weight for 'age' in
0221 permil.
0222
0223 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/watermarks/metric
0224 Date: Mar 2022
0225 Contact: SeongJae Park <sj@kernel.org>
0226 Description: Writing to and reading from this file sets and gets the metric
0227 of the watermarks for the scheme. The writable/readable
0228 keywords for this file are 'none' for disabling the watermarks
0229 feature, or 'free_mem_rate' for the system's global free memory
0230 rate in permil.
0231
0232 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/watermarks/interval_us
0233 Date: Mar 2022
0234 Contact: SeongJae Park <sj@kernel.org>
0235 Description: Writing to and reading from this file sets and gets the metric
0236 check interval of the watermarks for the scheme in
0237 microseconds.
0238
0239 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/watermarks/high
0240 Date: Mar 2022
0241 Contact: SeongJae Park <sj@kernel.org>
0242 Description: Writing to and reading from this file sets and gets the high
0243 watermark of the scheme in permil.
0244
0245 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/watermarks/mid
0246 Date: Mar 2022
0247 Contact: SeongJae Park <sj@kernel.org>
0248 Description: Writing to and reading from this file sets and gets the mid
0249 watermark of the scheme in permil.
0250
0251 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/watermarks/low
0252 Date: Mar 2022
0253 Contact: SeongJae Park <sj@kernel.org>
0254 Description: Writing to and reading from this file sets and gets the low
0255 watermark of the scheme in permil.
0256
0257 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/stats/nr_tried
0258 Date: Mar 2022
0259 Contact: SeongJae Park <sj@kernel.org>
0260 Description: Reading this file returns the number of regions that the action
0261 of the scheme has tried to be applied.
0262
0263 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/stats/sz_tried
0264 Date: Mar 2022
0265 Contact: SeongJae Park <sj@kernel.org>
0266 Description: Reading this file returns the total size of regions that the
0267 action of the scheme has tried to be applied in bytes.
0268
0269 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/stats/nr_applied
0270 Date: Mar 2022
0271 Contact: SeongJae Park <sj@kernel.org>
0272 Description: Reading this file returns the number of regions that the action
0273 of the scheme has successfully applied.
0274
0275 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/stats/sz_applied
0276 Date: Mar 2022
0277 Contact: SeongJae Park <sj@kernel.org>
0278 Description: Reading this file returns the total size of regions that the
0279 action of the scheme has successfully applied in bytes.
0280
0281 What: /sys/kernel/mm/damon/admin/kdamonds/<K>/contexts/<C>/schemes/<S>/stats/qt_exceeds
0282 Date: Mar 2022
0283 Contact: SeongJae Park <sj@kernel.org>
0284 Description: Reading this file returns the number of the exceed events of
0285 the scheme's quotas.
