<para>The age of a file system entry is determined from its last
modification timestamp (mtime), its last access timestamp (atime),
and (except for directories) its last status change timestamp
- (ctime). Any of these three (or two) values will prevent cleanup
- if it is more recent than the current time minus the age
- field.</para>
+ (ctime). By default, any of these three (or two) values will
+ prevent cleanup if it is more recent than the current time minus
+ the age field. To restrict the deletion based on particular type
+ of file timestamps, the age-by argument can be used.</para>
+
+ <para>The age-by argument, when (optionally) specified along
+ with age will check if the file system entry has aged by the
+ type of file timestamp(s) provided. It can be specified by
+ prefixing the age argument with a set of file timestamp types
+ followed by a colon character <literal>:</literal>, i.e.,
+ <literal><replaceable>age-by</replaceable>:<replaceable>cleanup-age</replaceable></literal>.
+ The argument can be a set of:
+ <constant>a</constant> (<constant>A</constant> for directories),
+ <constant>b</constant> (<constant>B</constant> for directories),
+ <constant>c</constant> (<constant>C</constant> for directories; ignored by default), or
+ <constant>m</constant> (<constant>M</constant> for directories),
+ indicating access, creation, last status change, and last
+ modification times of a file system entry respectively. See
+ <citerefentry project='man-pages'><refentrytitle>statx</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+ file timestamp fields for more details.</para>
+
+ <para>If unspecified, the age-by field defaults to
+ <constant>abcmABM</constant>,
+ i.e., by default all file timestamps are taken into consideration,
+ with the exception of the last status change timestamp (ctime) for
+ directories. This is because the aging logic itself will alter the
+ ctime whenever it deletes a file inside it. To ensure that running
+ the aging logic does not feed back into the next iteration of it,
+ ctime for directories is ignored by default.</para>
+
+ <para>For example:<programlisting>
+# Files created and modified, and directories accessed more than
+# an hour ago in "/tmp/foo/bar", are subject to time-based cleanup.
+d /tmp/foo/bar - - - - bmA:1h -</programlisting></para>
<para>Note that while the aging algorithm is run a 'shared' BSD file lock (see <citerefentry
project='man-pages'><refentrytitle>flock</refentrytitle><manvolnum>2</manvolnum></citerefentry>) is
ADJUST_MODE = 'm', /* legacy, 'z' is identical to this */
} ItemType;
+typedef enum AgeBy {
+ AGE_BY_ATIME = 1 << 0,
+ AGE_BY_BTIME = 1 << 1,
+ AGE_BY_CTIME = 1 << 2,
+ AGE_BY_MTIME = 1 << 3,
+
+ /* All file timestamp types are checked by default. */
+ AGE_BY_DEFAULT_FILE = AGE_BY_ATIME | AGE_BY_BTIME | AGE_BY_CTIME | AGE_BY_MTIME,
+ AGE_BY_DEFAULT_DIR = AGE_BY_ATIME | AGE_BY_BTIME | AGE_BY_MTIME
+} AgeBy;
+
typedef struct Item {
ItemType type;
gid_t gid;
mode_t mode;
usec_t age;
+ AgeBy age_by_file, age_by_dir;
dev_t major_minor;
unsigned attribute_value;
return ts->tv_sec * NSEC_PER_SEC + ts->tv_nsec;
}
+static bool needs_cleanup(
+ nsec_t atime,
+ nsec_t btime,
+ nsec_t ctime,
+ nsec_t mtime,
+ nsec_t cutoff,
+ const char *sub_path,
+ AgeBy age_by,
+ bool is_dir) {
+
+ if (FLAGS_SET(age_by, AGE_BY_MTIME) && mtime != NSEC_INFINITY && mtime >= cutoff) {
+ char a[FORMAT_TIMESTAMP_MAX];
+ /* Follows spelling in stat(1). */
+ log_debug("%s \"%s\": modify time %s is too new.",
+ is_dir ? "Directory" : "File",
+ sub_path,
+ format_timestamp_style(a, sizeof(a), mtime / NSEC_PER_USEC, TIMESTAMP_US));
+
+ return false;
+ }
+
+ if (FLAGS_SET(age_by, AGE_BY_ATIME) && atime != NSEC_INFINITY && atime >= cutoff) {
+ char a[FORMAT_TIMESTAMP_MAX];
+ log_debug("%s \"%s\": access time %s is too new.",
+ is_dir ? "Directory" : "File",
+ sub_path,
+ format_timestamp_style(a, sizeof(a), atime / NSEC_PER_USEC, TIMESTAMP_US));
+
+ return false;
+ }
+
+ /*
+ * Note: Unless explicitly specified by the user, "ctime" is ignored
+ * by default for directories, because we change it when deleting.
+ */
+ if (FLAGS_SET(age_by, AGE_BY_CTIME) && ctime != NSEC_INFINITY && ctime >= cutoff) {
+ char a[FORMAT_TIMESTAMP_MAX];
+ log_debug("%s \"%s\": change time %s is too new.",
+ is_dir ? "Directory" : "File",
+ sub_path,
+ format_timestamp_style(a, sizeof(a), ctime / NSEC_PER_USEC, TIMESTAMP_US));
+
+ return false;
+ }
+
+ if (FLAGS_SET(age_by, AGE_BY_BTIME) && btime != NSEC_INFINITY && btime >= cutoff) {
+ char a[FORMAT_TIMESTAMP_MAX];
+ log_debug("%s \"%s\": birth time %s is too new.",
+ is_dir ? "Directory" : "File",
+ sub_path,
+ format_timestamp_style(a, sizeof(a), btime / NSEC_PER_USEC, TIMESTAMP_US));
+
+ return false;
+ }
+
+ return true;
+}
+
static int dir_cleanup(
Item *i,
const char *p,
dev_t rootdev_minor,
bool mountpoint,
int maxdepth,
- bool keep_this_level) {
+ bool keep_this_level,
+ AgeBy age_by_file,
+ AgeBy age_by_dir) {
bool deleted = false;
struct dirent *dent;
sub_path, sub_dir,
atime_nsec, mtime_nsec, cutoff_nsec,
rootdev_major, rootdev_minor,
- false, maxdepth-1, false);
+ false, maxdepth-1, false,
+ age_by_file, age_by_dir);
if (q < 0)
r = q;
}
continue;
}
- /* Ignore ctime, we change it when deleting */
- if (mtime_nsec != NSEC_INFINITY && mtime_nsec >= cutoff_nsec) {
- char a[FORMAT_TIMESTAMP_MAX];
- /* Follows spelling in stat(1). */
- log_debug("Directory \"%s\": modify time %s is too new.",
- sub_path,
- format_timestamp_style(a, sizeof(a), mtime_nsec / NSEC_PER_USEC, TIMESTAMP_US));
+ /*
+ * Check the file timestamps of an entry against the
+ * given cutoff time; delete if it is older.
+ */
+ if (!needs_cleanup(atime_nsec, btime_nsec, ctime_nsec, mtime_nsec,
+ cutoff_nsec, sub_path, age_by_dir, true))
continue;
- }
-
- if (atime_nsec != NSEC_INFINITY && atime_nsec >= cutoff_nsec) {
- char a[FORMAT_TIMESTAMP_MAX];
- log_debug("Directory \"%s\": access time %s is too new.",
- sub_path,
- format_timestamp_style(a, sizeof(a), atime_nsec / NSEC_PER_USEC, TIMESTAMP_US));
- continue;
- }
-
- if (btime_nsec != NSEC_INFINITY && btime_nsec >= cutoff_nsec) {
- char a[FORMAT_TIMESTAMP_MAX];
- log_debug("Directory \"%s\": birth time %s is too new.",
- sub_path,
- format_timestamp_style(a, sizeof(a), btime_nsec / NSEC_PER_USEC, TIMESTAMP_US));
- continue;
- }
log_debug("Removing directory \"%s\".", sub_path);
if (unlinkat(dirfd(d), dent->d_name, AT_REMOVEDIR) < 0)
continue;
}
- if (mtime_nsec != NSEC_INFINITY && mtime_nsec >= cutoff_nsec) {
- char a[FORMAT_TIMESTAMP_MAX];
- /* Follows spelling in stat(1). */
- log_debug("File \"%s\": modify time %s is too new.",
- sub_path,
- format_timestamp_style(a, sizeof(a), mtime_nsec / NSEC_PER_USEC, TIMESTAMP_US));
- continue;
- }
-
- if (atime_nsec != NSEC_INFINITY && atime_nsec >= cutoff_nsec) {
- char a[FORMAT_TIMESTAMP_MAX];
- log_debug("File \"%s\": access time %s is too new.",
- sub_path,
- format_timestamp_style(a, sizeof(a), atime_nsec / NSEC_PER_USEC, TIMESTAMP_US));
- continue;
- }
-
- if (ctime_nsec != NSEC_INFINITY && ctime_nsec >= cutoff_nsec) {
- char a[FORMAT_TIMESTAMP_MAX];
- log_debug("File \"%s\": change time %s is too new.",
- sub_path,
- format_timestamp_style(a, sizeof(a), ctime_nsec / NSEC_PER_USEC, TIMESTAMP_US));
+ if (!needs_cleanup(atime_nsec, btime_nsec, ctime_nsec, mtime_nsec,
+ cutoff_nsec, sub_path, age_by_file, false))
continue;
- }
-
- if (btime_nsec != NSEC_INFINITY && btime_nsec >= cutoff_nsec) {
- char a[FORMAT_TIMESTAMP_MAX];
- log_debug("File \"%s\": birth time %s is too new.",
- sub_path,
- format_timestamp_style(a, sizeof(a), btime_nsec / NSEC_PER_USEC, TIMESTAMP_US));
- continue;
- }
log_debug("Removing \"%s\".", sub_path);
if (unlinkat(dirfd(d), dent->d_name, 0) < 0)
}
}
+static char *age_by_to_string(AgeBy ab, bool is_dir) {
+ static const char ab_map[] = { 'a', 'b', 'c', 'm' };
+ size_t j = 0;
+ char *ret;
+
+ ret = new(char, ELEMENTSOF(ab_map) + 1);
+ if (!ret)
+ return NULL;
+
+ for (size_t i = 0; i < ELEMENTSOF(ab_map); i++)
+ if (FLAGS_SET(ab, 1U << i))
+ ret[j++] = is_dir ? ascii_toupper(ab_map[i]) : ab_map[i];
+
+ ret[j] = 0;
+ return ret;
+}
+
static int clean_item_instance(Item *i, const char* instance) {
char timestamp[FORMAT_TIMESTAMP_MAX];
_cleanup_closedir_ DIR *d = NULL;
sx.stx_ino != ps.st_ino;
}
- log_debug("Cleanup threshold for %s \"%s\" is %s",
- mountpoint ? "mount point" : "directory",
- instance,
- format_timestamp_style(timestamp, sizeof(timestamp), cutoff, TIMESTAMP_US));
+ if (DEBUG_LOGGING) {
+ _cleanup_free_ char *ab_f = NULL, *ab_d = NULL;
+
+ ab_f = age_by_to_string(i->age_by_file, false);
+ if (!ab_f)
+ return log_oom();
+
+ ab_d = age_by_to_string(i->age_by_dir, true);
+ if (!ab_d)
+ return log_oom();
+
+ log_debug("Cleanup threshold for %s \"%s\" is %s; age-by: %s%s",
+ mountpoint ? "mount point" : "directory",
+ instance,
+ format_timestamp_style(timestamp, sizeof(timestamp), cutoff, TIMESTAMP_US),
+ ab_f, ab_d);
+ }
return dir_cleanup(i, instance, d,
load_statx_timestamp_nsec(&sx.stx_atime),
load_statx_timestamp_nsec(&sx.stx_mtime),
cutoff * NSEC_PER_USEC,
sx.stx_dev_major, sx.stx_dev_minor, mountpoint,
- MAX_DEPTH, i->keep_first_level);
+ MAX_DEPTH, i->keep_first_level,
+ i->age_by_file, i->age_by_dir);
}
static int clean_item(Item *i) {
a->age_set == b->age_set &&
a->age == b->age &&
+ a->age_by_file == b->age_by_file &&
+ a->age_by_dir == b->age_by_dir &&
+
a->mask_perms == b->mask_perms &&
a->keep_first_level == b->keep_first_level &&
return name_to_gid_offline(arg_root, group, ret_gid, cache);
}
+static int parse_age_by_from_arg(const char *age_by_str, Item *item) {
+ AgeBy ab_f = 0, ab_d = 0;
+
+ static const struct {
+ char age_by_chr;
+ AgeBy age_by_flag;
+ } age_by_types[] = {
+ { 'a', AGE_BY_ATIME },
+ { 'b', AGE_BY_BTIME },
+ { 'c', AGE_BY_CTIME },
+ { 'm', AGE_BY_MTIME },
+ };
+
+ assert(age_by_str);
+ assert(item);
+
+ if (isempty(age_by_str))
+ return -EINVAL;
+
+ for (const char *s = age_by_str; *s != 0; s++) {
+ size_t i;
+
+ /* Ignore whitespace. */
+ if (strchr(WHITESPACE, *s))
+ continue;
+
+ for (i = 0; i < ELEMENTSOF(age_by_types); i++) {
+ /* Check lower-case for files, upper-case for directories. */
+ if (*s == age_by_types[i].age_by_chr) {
+ ab_f |= age_by_types[i].age_by_flag;
+ break;
+ } else if (*s == ascii_toupper(age_by_types[i].age_by_chr)) {
+ ab_d |= age_by_types[i].age_by_flag;
+ break;
+ }
+ }
+
+ /* Invalid character. */
+ if (i >= ELEMENTSOF(age_by_types))
+ return -EINVAL;
+ }
+
+ /* No match. */
+ if (ab_f == 0 && ab_d == 0)
+ return -EINVAL;
+
+ item->age_by_file = ab_f > 0 ? ab_f : AGE_BY_DEFAULT_FILE;
+ item->age_by_dir = ab_d > 0 ? ab_d : AGE_BY_DEFAULT_DIR;
+
+ return 0;
+}
+
static int parse_line(
const char *fname,
unsigned line,
Hashmap **gid_cache) {
_cleanup_free_ char *action = NULL, *mode = NULL, *user = NULL, *group = NULL, *age = NULL, *path = NULL;
- _cleanup_(item_free_contents) Item i = {};
+ _cleanup_(item_free_contents) Item i = {
+ /* The "age-by" argument considers all file timestamp types by default. */
+ .age_by_file = AGE_BY_DEFAULT_FILE,
+ .age_by_dir = AGE_BY_DEFAULT_DIR,
+ };
ItemArray *existing;
OrderedHashmap *h;
int r, pos;
if (!empty_or_dash(age)) {
const char *a = age;
+ _cleanup_free_ char *seconds = NULL, *age_by = NULL;
if (*a == '~') {
i.keep_first_level = true;
a++;
}
+ /* Format: "age-by:age"; where age-by is "[abcmABCM]+". */
+ r = split_pair(a, ":", &age_by, &seconds);
+ if (r == -ENOMEM)
+ return log_oom();
+ if (r < 0 && r != -EINVAL)
+ return log_error_errno(r, "Failed to parse age-by for '%s': %m", age);
+ if (r >= 0) {
+ /* We found a ":", parse the "age-by" part. */
+ r = parse_age_by_from_arg(age_by, &i);
+ if (r == -ENOMEM)
+ return log_oom();
+ if (r < 0) {
+ *invalid_config = true;
+ return log_syntax(NULL, LOG_ERR, fname, line, r, "Invalid age-by '%s'.", age_by);
+ }
+
+ /* For parsing the "age" part, after the ":". */
+ a = seconds;
+ }
+
r = parse_sec(a, &i.age);
if (r < 0) {
*invalid_config = true;
- return log_syntax(NULL, LOG_ERR, fname, line, r, "Invalid age '%s'.", age);
+ return log_syntax(NULL, LOG_ERR, fname, line, r, "Invalid age '%s'.", a);
}
i.age_set = true;
--- /dev/null
+#! /bin/bash
+
+# Test the "Age" parameter (with age-by) for systemd-tmpfiles.
+
+set -e
+set -x
+
+# Test directory structure looks like this:
+# /tmp/ageby/
+# ├── d1
+# │ ├── f1
+# │ ├── f2
+# │ ├── f3
+# │ └── f4
+# ├── d2
+# │ ├── f1
+# │ ├── f2
+# ...
+
+export SYSTEMD_LOG_LEVEL="debug"
+
+rm -rf /tmp/ageby
+mkdir -p /tmp/ageby/d{1..4}
+
+# TODO: There is probably a better way to figure this out.
+# Test for [bB] age-by arguments only on filesystems that expose
+# the creation time. Note that this is _not_ an accurate way to
+# check if the filesystem or kernel version don't provide the
+# timestamp. But, if the timestamp is visible in "stat" it is a
+# good indicator that the test can be run.
+TEST_TMPFILES_AGEBY_BTIME=${TEST_TMPFILES_AGEBY_BTIME:-0}
+if stat --format "%w" /tmp/ageby 2>/dev/null | grep -qv '^[\?\-]$'; then
+ TEST_TMPFILES_AGEBY_BTIME=1
+fi
+
+touch -a --date "2 minutes ago" /tmp/ageby/d1/f1
+touch -m --date "4 minutes ago" /tmp/ageby/d2/f1
+
+# Create a bunch of other files.
+touch /tmp/ageby/d{1,2}/f{2..4}
+
+# For "ctime".
+touch /tmp/ageby/d3/f1
+chmod +x /tmp/ageby/d3/f1
+sleep 1
+
+# For "btime".
+touch /tmp/ageby/d4/f1
+sleep 1
+
+# More files with recent "{a,b}time" values.
+touch /tmp/ageby/d{3,4}/f{2..4}
+
+# Check for cleanup of "f1" in each of "/tmp/d{1..4}".
+systemd-tmpfiles --clean - <<-EOF
+d /tmp/ageby/d1 - - - a:1m -
+e /tmp/ageby/d2 - - - m:3m -
+D /tmp/ageby/d3 - - - c:2s -
+EOF
+
+for d in d{1..3}; do
+ test ! -f "/tmp/ageby/${d}/f1"
+done
+
+if [[ $TEST_TMPFILES_AGEBY_BTIME -gt 0 ]]; then
+ systemd-tmpfiles --clean - <<-EOF
+d /tmp/ageby/d4 - - - b:1s -
+EOF
+
+ test ! -f "/tmp/ageby/d4/f1"
+else
+ # Remove the file manually.
+ rm "/tmp/ageby/d4/f1"
+fi
+
+# Check for an invalid "age" and "age-by" arguments.
+for a in ':' ':1s' '2:1h' 'nope:42h' '" :7m"' 'm:' '::' '"+r^w-x:2/h"' 'b ar::64'; do
+ systemd-tmpfiles --clean - <<EOF 2>&1 | grep -q -F 'Invalid age'
+d /tmp/ageby - - - ${a} -
+EOF
+done
+
+for d in d{1..4}; do
+ for f in f{2..4}; do
+ test -f "/tmp/ageby/${d}/${f}"
+ done
+done
+
+# Check for parsing with whitespace, repeated values
+# for "age-by" (valid arguments).
+for a in '" a:24h"' 'cccaab:2h' '" aa : 4h"' '" a A B C c:1h"'; do
+ systemd-tmpfiles --clean - <<EOF
+d /tmp/ageby - - - ${a} -
+EOF
+done
+
+for d in d{1..4}; do
+ for f in f{2..4}; do
+ test -f "/tmp/ageby/${d}/${f}"
+ done
+done
+
+# Check that all files are removed if the "Age" is
+# set to "0" (regardless of "age-by" argument).
+systemd-tmpfiles --clean - <<-EOF
+d /tmp/ageby/d1 - - - abc:0 -
+e /tmp/ageby/d2 - - - cmb:0 -
+EOF
+
+for d in d{1,2}; do
+ for f in f{2..4}; do
+ test ! -f "/tmp/ageby/${d}/${f}"
+ done
+done
+
+# Check for combinations:
+# - "/tmp/ageby/d3/f2" has file timestamps that
+# are older than the specified age, it will be
+# removed
+# - "/tmp/ageby/d4/f2", has not aged for the given
+# timestamp combination, it will not be removed
+touch -a -m --date "4 minutes ago" /tmp/ageby/d3/f2
+touch -a -m --date "8 minutes ago" /tmp/ageby/d4/f2
+systemd-tmpfiles --clean - <<-EOF
+e /tmp/ageby/d3 - - - am:3m -
+D /tmp/ageby/d4 - - - mc:7m -
+EOF
+
+test ! -f "/tmp/ageby/d3/f2"
+test -f "/tmp/ageby/d4/f2"
+
+# Check that all files are removed if only "Age" is set to 0.
+systemd-tmpfiles --clean - <<-EOF
+e /tmp/ageby/d3 - - - 0s
+d /tmp/ageby/d4 - - - 0s
+EOF
+
+for d in d{3,4}; do
+ for f in f{2..4}; do
+ test ! -f "/tmp/ageby/$d/${f}"
+ done
+done
+
+# Check "age-by" argument for sub-directories in "/tmp/ageby".
+systemd-tmpfiles --clean - <<-EOF
+d /tmp/ageby/ - - - A:1m -
+EOF
+
+for d in d{1..4}; do
+ test -d "/tmp/ageby/${d}"
+done
+
+# Check for combinations.
+touch -a -m --date "5 seconds ago" /tmp/ageby/d{1,2}
+systemd-tmpfiles --clean - <<-EOF
+e /tmp/ageby/ - - - AM:4s -
+EOF
+
+for d in d{1,2}; do
+ test ! -d "/tmp/ageby/${d}"
+done
+
+for d in d{3,4}; do
+ test -d "/tmp/ageby/${d}"
+done
+
+# Check "btime" for directories.
+if [[ $TEST_TMPFILES_AGEBY_BTIME -gt 0 ]]; then
+ systemd-tmpfiles --clean - <<-EOF
+d /tmp/ageby/ - - - B:8s -
+EOF
+
+ for d in d{3,4}; do
+ test -d "/tmp/ageby/${d}"
+ done
+fi
+
+# To bump "atime".
+touch -a --date "1 second ago" /tmp/ageby/d3
+systemd-tmpfiles --clean - <<-EOF
+d /tmp/ageby/ - - - A:2s -
+EOF
+
+test -d /tmp/ageby/d3
+test ! -d /tmp/ageby/d4
+
+# Check if sub-directories are removed regardless
+# of "age-by", when "Age" is set to "0".
+systemd-tmpfiles --clean - <<-EOF
+D /tmp/ageby/ - - - AM:0 -
+EOF
+
+test ! -d /tmp/ageby/d3
+
+# Cleanup the test directory (fail if not empty).
+rmdir /tmp/ageby
projects / thirdparty / systemd.git / commitdiff
