nilfs_cleanerd.conf(5)

1NILFS_CLEANERD.CONF(5)        File Formats Manual       NILFS_CLEANERD.CONF(5)
2
3
4

NAME

6       nilfs_cleanerd.conf - nilfs_cleanerd(8) configuration file
7

DESCRIPTION

9       The   nilfs_cleanerd.conf  file  is  the  configuration  file  for  the
10       nilfs_cleanerd(8) which reclaims disk space of the  NILFS2  filesystem.
11       This  file  specifies the parameters related to garbage collection (GC)
12       and behaviour of the daemon program.
13
14       The file contains keyword argument pairs  or  keyword-only  directives,
15       one  per  line.   Lines  starting with '#' are interpreted as comments.
16       The comment lines and empty lines are ignored.
17

PARAMETERS

19       The possible keywords and their meanings are as follows  (keywords  and
20       arguments are both case-sensitive):
21
22       protection_period
23              Specify  the  period  during  which each checkpoint is protected
24              from the  garbage  collector  (in  seconds).   NILFS2  GC  never
25              deletes checkpoints and their blocks whose duration time is less
26              than the value.  The default value is 3600, meaning one hour.
27
28       min_clean_segments
29              Specify the minimum number of clean segments. A value of 0 means
30              continuous cleaning. A value greater than 0 means pause cleaning
31              until less than min_clean_segments are available.
32
33       max_clean_segments
34              Specify the maximum number of clean segments. If  min_clean_seg‐
35              ments  is  0, this value is ignored. If more than max_clean_seg‐
36              ments  are  available  cleaning  is  paused  until   less   than
37              min_clean_segments are available.
38
39       min_clean_segments  and max_clean_segments may be followed by a percent
40       sign or the following multiplicative suffixes:  kB  1000,  K  1024,  MB
41       1000*1000,  M 1024*1024, GB 1000*1000*1000, G 1024*1024*1024, and so on
42       for T, P, E.  If the argument is followed by a percent sign, it  repre‐
43       sents a disk capacity ratio.
44
45       The  default values of min_clean_segments and max_clean_segments are 10
46       percent and 20 percent respectively.
47
48       clean_check_interval
49              Specify the interval to wait between  checks  of  min_clean_seg‐
50              ments.   If min_clean_segments is 0, this value is ignored.  The
51              default value is 10.
52
53       selection_policy
54              Specify the GC policy. At present, only the `timestamp'  policy,
55              which  reclaims segments in order from oldest to newest, is sup‐
56              port.
57
58       nsegments_per_clean
59              Specify the number of segments reclaimed by  a  single  cleaning
60              step.  The default value is 2.
61
62       mc_nsegments_per_clean
63              Specify  the  number  of segments reclaimed by a single cleaning
64              step if clean segments < min_clean_segments.  The default  value
65              is 4.
66
67       cleaning_interval
68              Specify  the cleaning interval in seconds.  The default value is
69              5.
70
71       mc_cleaning_interval
72              Specify the cleaning interval in seconds  if  clean  segments  <
73              min_clean_segments.  The default value is 1.
74
75       retry_interval
76              Specify  retry  interval  in  seconds.   This value provides the
77              retry interval of GC in case of resource shortages.  The default
78              value is 60.
79
80       use_mmap
81              Specify  whether  to  use  mmap(2)  for  reading  segments.   At
82              present, this option is enabled if supported regardless of  this
83              directive.
84
85       use_set_suinfo
86              Specify  whether to use the set_suinfo ioctl if it is supported.
87              This is necessary for  the  min_reclaimable_blocks  feature.  By
88              disabling this switch min_reclaimable_blocks is also disabled.
89
90       min_reclaimable_blocks
91              Specify  the  minimum  number of reclaimable blocks in a segment
92              before it can be cleaned.
93
94       mc_min_reclaimable_blocks
95              Specify the minimum number of reclaimable blocks  in  a  segment
96              before  it  can  be  cleaned. if clean segments < min_clean_seg‐
97              ments.
98
99       min_reclaimable_blocks and mc_min_reclaimable_blocks may be followed by
100       a  percent  sign  or  the following multiplicative suffixes: kB 1000, K
101       1024, MB 1000*1000, M 1024*1024, GB 1000*1000*1000,  G  1024*1024*1024,
102       and  so on for T, P, E.  If the argument is followed by a percent sign,
103       it represents the ratio of blocks in a segment.
104
105       The     default     values      of      min_reclaimable_blocks      and
106       mc_min_reclaimable_blocks are 10 percent and 1 percent respectively.
107
108       log_priority
109              Gives  the  verbosity  level  that is used when logging messages
110              from nilfs_cleanerd(8).  The possible values are: emerg,  alert,
111              crit,  err,  warning,  notice,  info, and debug.  The default is
112              info.
113
114       Since nilfs-utils 2.1, subsecond value can be specified for time inter‐
115       val  parameters  in  decimal  fraction format.  This applies to protec‐
116       tion_period,   clean_check_interval,    cleaning_interval,    mc_clean‐
117       ing_interval, and retry_interval.
118

FILES

120       /etc/nilfs_cleanerd.conf
121              Configuration file for nilfs_cleanerd(8).
122

NAME

DESCRIPTION

PARAMETERS

FILES

SEE ALSO