blend/overlayfs-tools/logic.c

582 lines
25 KiB
C
Raw Normal View History

2023-04-25 06:14:01 -05:00
#define _GNU_SOURCE
#include <stdio.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <linux/limits.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <sys/xattr.h>
#include <fts.h>
#include <libgen.h>
#include "logic.h"
#include "sh.h"
// exactly the same as in linux/fs.h
#define WHITEOUT_DEV 0
// exact the same as in fs/overlayfs/overlayfs.h
const char *ovl_opaque_xattr = "trusted.overlay.opaque";
const char *ovl_redirect_xattr = "trusted.overlay.redirect";
const char *ovl_metacopy_xattr = "trusted.overlay.metacopy";
#define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
#define TRAILING_SLASH(ftype) (((ftype) == S_IFDIR) ? "/" : "")
static inline mode_t file_type(const struct stat *status) {
return status->st_mode & S_IFMT;
}
const char *ftype_name(mode_t type) {
switch (type) {
case S_IFDIR:
return "directory";
case S_IFREG:
return "regular file";
case S_IFLNK:
return "symbolic link";
default:
return "special file";
}
}
const char *ftype_name_plural(mode_t type) {
switch (type) {
case S_IFDIR:
return "Directories";
case S_IFREG:
return "Files";
case S_IFLNK:
return "Symbolic links";
default:
return "Special files";
}
}
static inline bool is_whiteout(const struct stat *status) {
return (file_type(status) == S_IFCHR) && (status->st_rdev == WHITEOUT_DEV);
}
static inline mode_t permission_bits(const struct stat *status) { // not used yet. I haven't decided how to treat permission bit changes
return status->st_mode & (S_IRWXU | S_IRWXG | S_IRWXO | S_ISVTX);
}
int is_opaque(const char *path, bool *output) {
char val;
ssize_t res = getxattr(path, ovl_opaque_xattr, &val, 1);
if ((res < 0) && (errno != ENODATA)) {
return -1;
}
*output = (res == 1 && val == 'y');
return 0;
}
int is_redirect(const char *path, bool *output) {
ssize_t res = getxattr(path, ovl_redirect_xattr, NULL, 0);
if ((res < 0) && (errno != ENODATA)) {
fprintf(stderr, "File %s redirect xattr can not be read.\n", path);
return -1;
}
*output = (res > 0);
return 0;
}
int is_metacopy(const char *path, bool *output) {
ssize_t res = getxattr(path, ovl_metacopy_xattr, NULL, 0);
if ((res < 0) && (errno != ENODATA)) {
fprintf(stderr, "File %s metacopy xattr can not be read.\n", path);
return -1;
}
*output = (res >= 0);
return 0;
}
// Treat redirect as opaque dir because it hides the tree in lower_path
// and we do not support following to redirected lower path
int is_opaquedir(const char *path, bool *output) {
bool opaque, redirect;
if (is_opaque(path, &opaque) < 0) { return -1; }
if (is_redirect(path, &redirect) < 0) { return -1; }
*output = opaque || redirect;
return 0;
}
bool permission_identical(const struct stat *lower_status, const struct stat *upper_status) {
return (permission_bits(lower_status) == permission_bits(upper_status)) && (lower_status->st_uid == upper_status->st_uid) && (lower_status->st_gid == upper_status->st_gid);
}
int read_chunk(int fd, char *buf, int len) {
ssize_t ret;
ssize_t remain = len;
while (remain > 0 && (ret = read(fd, buf, remain)) != 0) {
if (ret == -1) {
if (errno == EINTR) {
continue;
}
return -1;
}
remain -= ret;
buf += ret;
}
return len - remain;
}
int regular_file_identical(const char *lower_path, const struct stat *lower_status, const char *upper_path, const struct stat *upper_status, bool *output) {
size_t blksize = (size_t) MIN(lower_status->st_blksize, upper_status->st_blksize);
if (lower_status->st_size != upper_status->st_size) { // different sizes
*output = false;
return 0;
}
bool metacopy, redirect;
if (is_metacopy(upper_path, &metacopy) < 0) { return -1; }
if (is_redirect(upper_path, &redirect) < 0) { return -1; }
if (metacopy) {
// metacopy means data is indentical, but redirect means it is not identical to lower_path
*output = !redirect;
return 0;
}
char lower_buffer[blksize];
char upper_buffer[blksize];
int lower_file = open(lower_path, O_RDONLY);
int upper_file = open(upper_path, O_RDONLY);
if (lower_file < 0) {
fprintf(stderr, "File %s can not be read for content.\n", lower_path);
return -1;
}
if (upper_file < 0) {
fprintf(stderr, "File %s can not be read for content.\n", upper_path);
return -1;
}
ssize_t read_lower; ssize_t read_upper;
do { // we can assume one will not reach EOF earlier than the other, as the file sizes are checked to be the same earlier
read_lower = read_chunk(lower_file, lower_buffer, blksize);
read_upper = read_chunk(upper_file, upper_buffer, blksize);
if (read_lower < 0) {
fprintf(stderr, "Error occured when reading file %s.\n", lower_path);
return -1;
}
if (read_upper < 0) {
fprintf(stderr, "Error occured when reading file %s.\n", upper_path);
return -1;
}
if (read_upper != read_lower) { // this should not happen as we've checked the sizes
fprintf(stderr, "Unexpected size difference: %s.\n", upper_path);
return -1;
}
if (memcmp(lower_buffer, upper_buffer, read_upper)) { *output = false; return 0; } // the output is by default false, but we still set it for ease of reading
} while (read_lower || read_upper);
*output = true; // now we can say they are identical
if (close(lower_file) || close(upper_file)) { return -1; }
return 0;
}
int symbolic_link_identical(const char *lower_path, const char *upper_path, bool *output) {
char lower_buffer[PATH_MAX];
char upper_buffer[PATH_MAX];
ssize_t lower_len = readlink(lower_path, lower_buffer, PATH_MAX);
ssize_t upper_len = readlink(upper_path, upper_buffer, PATH_MAX);
if (lower_len < 0 || lower_len == PATH_MAX) {
fprintf(stderr, "Symbolic link %s cannot be resolved.\n", lower_path);
return -1;
}
if (upper_len < 0 || upper_len == PATH_MAX) {
fprintf(stderr, "Symbolic link %s cannot be resolved.\n", upper_path);
return -1;
}
lower_buffer[lower_len] = '\0';
upper_buffer[upper_len] = '\0';
*output = (strcmp(lower_buffer, upper_buffer) == 0);
return 0;
}
static int vacuum_d(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
bool opaque;
if (is_opaquedir(upper_path, &opaque) < 0) { return -1; }
if (opaque) { // TODO: sometimes removing opaque directory (and combine with lower directory) might be better
*fts_instr = FTS_SKIP;
}
return 0;
}
static int vacuum_dp(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
if (lower_status == NULL) { return 0; } // lower does not exist
if (file_type(lower_status) != S_IFDIR) { return 0; }
if (!permission_identical(lower_status, upper_status)) { return 0; }
bool opaque;
if (is_opaquedir(upper_path, &opaque) < 0) {
return -1;
}
if (opaque) { return 0; }
// this directory might be empty if all children are deleted in previous commands. but we simply don't test whether it's that case
return command(script_stream, "rmdir --ignore-fail-on-non-empty %U", upper_path);
}
static int vacuum_f(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
if (lower_status == NULL) { return 0; } // lower does not exist
if (file_type(lower_status) != S_IFREG) { return 0; }
if (!permission_identical(lower_status, upper_status)) { return 0; }
bool identical;
if (regular_file_identical(lower_path, lower_status, upper_path, upper_status, &identical) < 0) {
return -1;
}
if (!identical) { return 0; }
return command(script_stream, "rm %U", upper_path);
}
static int vacuum_sl(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
if (lower_status == NULL) { return 0; } // lower does not exist
if (file_type(lower_status) != S_IFLNK) { return 0; }
if (!permission_identical(lower_status, upper_status)) { return 0; }
bool identical;
if (symbolic_link_identical(lower_path, upper_path, &identical) < 0) {
return -1;
}
if (!identical) { return 0; }
return command(script_stream, "rm %U", upper_path);
}
void print_only_in(const char *path) {
char *dirc = strdup(path);
char *basec = strdup(path);
char *dname = dirname(dirc);
char *bname = basename(basec);
printf("Only in %s: %s\n", dname, bname);
free(dirc);
free(basec);
}
void print_removed(const char *lower_path, const size_t lower_root_len, mode_t lower_type) {
if (brief) {
print_only_in(lower_path);
} else {
printf("Removed: %s%s\n", &lower_path[lower_root_len], TRAILING_SLASH(lower_type));
}
}
void print_added(const char *lower_path, const size_t lower_root_len, const char *upper_path, mode_t upper_type) {
if (brief) {
print_only_in(upper_path);
} else {
printf("Added: %s%s\n", &lower_path[lower_root_len], TRAILING_SLASH(upper_type));
}
}
void print_replaced(const char *lower_path, const size_t lower_root_len, mode_t lower_type, const char *upper_path, mode_t upper_type) {
if (brief) {
printf("File %s is a %s while file %s is a %s\n", lower_path, ftype_name(lower_type), upper_path, ftype_name(upper_type));
} else {
if (lower_type != S_IFDIR) { // dir removed already printed by list_deleted_files()
print_removed(lower_path, lower_root_len, lower_type);
}
print_added(lower_path, lower_root_len, upper_path, upper_type);
}
}
void print_modified(const char *lower_path, const size_t lower_root_len, mode_t lower_type, const char *upper_path, bool identical) {
if (brief) {
if (!identical) { // brief format does not print permission difference
printf("%s %s and %s differ\n", ftype_name_plural(lower_type), lower_path, upper_path);
}
} else {
printf("Modified: %s%s\n", &lower_path[lower_root_len], TRAILING_SLASH(lower_type));
}
}
int list_deleted_files(const char *lower_path, size_t lower_root_len, mode_t upper_type) { // This WORKS with files and itself is listed. However, prefixs are WRONG!
// brief format needs to print only first level deleted children under opaque dir
bool children = (brief && (upper_type == S_IFDIR));
if (!verbose && !children) {
if (!brief || upper_type == S_IFCHR) { // dir replaced already printed by print_replaced()
print_removed(lower_path, lower_root_len, S_IFDIR);
}
return 0;
}
FTSENT *cur;
char *paths[2] = {(char *) lower_path, NULL };
FTS *ftsp = fts_open(paths, FTS_NOCHDIR | FTS_PHYSICAL, NULL);
if (ftsp == NULL) { return -1; }
int return_val = 0;
while (((cur = fts_read(ftsp)) != NULL) && (return_val == 0)) {
switch (cur->fts_info) {
case FTS_D:
// brief format does not need to print deleted grand children under opaque dir
if (children && cur->fts_level > 0) {
print_removed(cur->fts_path, lower_root_len, S_IFDIR);
fts_set(ftsp, cur, FTS_SKIP);
}
break; // do nothing
case FTS_DP:
// brief format does not need to print deleted dir under opaque dir itself
if (!children) {
print_removed(cur->fts_path, lower_root_len, S_IFDIR);
}
break;
case FTS_F:
print_removed(cur->fts_path, lower_root_len, S_IFREG);
break;
case FTS_SL:
print_removed(cur->fts_path, lower_root_len, S_IFLNK);
break;
case FTS_DEFAULT:
fprintf(stderr, "File %s is a special file (device or pipe). We cannot handle that.\n", cur->fts_path);
return_val = -1;
break;
default:
fprintf(stderr, "Error occured when opening %s.\n", cur->fts_path);
return_val = -1;
}
}
if (errno) { return_val = -1; } // if no error happened, fts_read will "sets the external variable errno to 0" according to the documentation
return fts_close(ftsp) || return_val;
}
static int diff_d(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
bool opaque = false;
bool lower_exist = (lower_status != NULL);
if (lower_exist) {
if (file_type(lower_status) == S_IFDIR) {
if (is_opaquedir(upper_path, &opaque) < 0) { return -1; }
if (opaque) {
if (list_deleted_files(lower_path, lower_root_len, S_IFDIR) < 0) { return -1; }
} else {
if (!permission_identical(lower_status, upper_status)) {
print_modified(lower_path, lower_root_len, S_IFDIR, upper_path, true);
}
return 0; // children must be recursed, and directory itself does not need to be printed
}
} else { // other types of files
print_replaced(lower_path, lower_root_len, file_type(lower_status), upper_path, S_IFDIR);
}
}
if (!(verbose || (brief && opaque))) { // brief format needs to print children of opaque dir
*fts_instr = FTS_SKIP;
}
if (!lower_exist || (!brief && opaque)) { // brief format does not need to print opaque dir itself
print_added(lower_path, lower_root_len, upper_path, S_IFDIR);
}
return 0;
}
static int diff_f(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
bool identical;
if (lower_status != NULL) {
switch (file_type(lower_status)) {
case S_IFREG:
if (regular_file_identical(lower_path, lower_status, upper_path, upper_status, &identical) < 0) {
return -1;
}
if (!(identical && permission_identical(lower_status, upper_status))) {
print_modified(lower_path, lower_root_len, S_IFREG, upper_path, identical);
}
return 0;
case S_IFDIR:
if (list_deleted_files(lower_path, lower_root_len, S_IFREG) < 0) { return -1; }
/* fallthrough */
case S_IFLNK:
print_replaced(lower_path, lower_root_len, file_type(lower_status), upper_path, S_IFREG);
return 0;
default:
fprintf(stderr, "File %s is a special file (device or pipe). We cannot handle that.\n", lower_path);
return -1;
}
}
print_added(lower_path, lower_root_len, upper_path, S_IFREG);
return 0;
}
static int diff_sl(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
bool identical;
if (lower_status != NULL) {
switch (file_type(lower_status)) {
case S_IFDIR:
if (list_deleted_files(lower_path, lower_root_len, S_IFLNK) < 0) { return -1; }
/* fallthrough */
case S_IFREG:
print_replaced(lower_path, lower_root_len, file_type(lower_status), upper_path, S_IFLNK);
return 0;
case S_IFLNK:
if (symbolic_link_identical(lower_path, upper_path, &identical) < 0) {
return -1;
}
if (!(identical && permission_identical(lower_status, upper_status))) {
print_modified(lower_path, lower_root_len, S_IFLNK, upper_path, identical);
}
return 0;
default:
fprintf(stderr, "File %s is a special file (device or pipe). We cannot handle that.\n", lower_path);
return -1;
}
}
print_added(lower_path, lower_root_len, upper_path, S_IFLNK);
return 0;
}
static int diff_whiteout(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
if (lower_status != NULL) {
if (file_type(lower_status) == S_IFDIR) {
if (list_deleted_files(lower_path, lower_root_len, S_IFCHR) < 0) { return -1; }
} else {
print_removed(lower_path, lower_root_len, file_type(lower_status));
}
} // else: whiteouting a nonexistent file? must be an error. but we ignore that :)
return 0;
}
static int merge_d(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
bool redirect;
if (is_redirect(upper_path, &redirect) < 0) { return -1; }
// merging redirects is not supported, we must abort merge so redirected lower (under whiteout) won't be deleted
// upper_path may be hiding the directory in lower_path, but there may be another redirect upper pointing at it
if (redirect) {
fprintf(stderr, "Found redirect on %s. Merging redirect is not supported - Abort.\n", upper_path);
return -1;
}
if (lower_status != NULL) {
if (file_type(lower_status) == S_IFDIR) {
bool opaque = false;
if (is_opaquedir(upper_path, &opaque) < 0) { return -1; }
if (opaque) {
if (command(script_stream, "rm -r %L", lower_path) < 0) { return -1; };
} else {
if (!permission_identical(lower_status, upper_status)) {
command(script_stream, "chmod --reference %U %L", upper_path, lower_path);
}
return 0; // children must be recursed, and directory itself does not need to be printed
}
} else {
command(script_stream, "rm %L", lower_path);
}
}
*fts_instr = FTS_SKIP;
return command(script_stream, "mv -T %U %L", upper_path, lower_path);
}
static int merge_dp(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
if (lower_status != NULL) {
if (file_type(lower_status) == S_IFDIR) {
bool opaque = false;
if (is_opaquedir(upper_path, &opaque) < 0) { return -1; }
if (!opaque) { // delete the directory: it should be empty already
return command(script_stream, "rmdir %U", upper_path);
}
}
}
return 0;
}
static int merge_f(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
bool metacopy, redirect;
if (is_metacopy(upper_path, &metacopy) < 0) { return -1; }
if (is_redirect(upper_path, &redirect) < 0) { return -1; }
// merging metacopy is not supported, we must abort merge so lower data won't be deleted
if (metacopy || redirect) {
fprintf(stderr, "Found metacopy/redirect on %s. Merging metacopy/redirect is not supported - Abort.\n", upper_path);
return -1;
}
return command(script_stream, "rm -rf %L", lower_path) || command(script_stream, "mv -T %U %L", upper_path, lower_path);
}
static int merge_sl(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
return command(script_stream, "rm -rf %L", lower_path) || command(script_stream, "mv -T %U %L", upper_path, lower_path);
}
static int merge_whiteout(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
return command(script_stream, "rm -r %L", lower_path) || command(script_stream, "rm %U", upper_path);
}
typedef int (*TRAVERSE_CALLBACK)(const char *lower_path, const char* upper_path, const size_t lower_root_len, const struct stat *lower_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr);
int traverse(const char *lower_root, const char *upper_root, FILE* script_stream, TRAVERSE_CALLBACK callback_d, TRAVERSE_CALLBACK callback_dp, TRAVERSE_CALLBACK callback_f, TRAVERSE_CALLBACK callback_sl, TRAVERSE_CALLBACK callback_whiteout) { // returns 0 on success
FTSENT *cur;
char *paths[2] = {(char *) upper_root, NULL };
char lower_path[PATH_MAX];
strcpy(lower_path, lower_root);
size_t upper_root_len = strlen(upper_root);
size_t lower_root_len = strlen(lower_root);
FTS *ftsp = fts_open(paths, FTS_NOCHDIR | FTS_PHYSICAL, NULL);
if (ftsp == NULL) { return -1; }
int return_val = 0;
while ((return_val == 0) && ((cur = fts_read(ftsp)) != NULL)) {
TRAVERSE_CALLBACK callback = NULL;
switch (cur->fts_info) {
case FTS_D:
callback = callback_d;
break;
case FTS_DP:
callback = callback_dp;
break;
case FTS_F:
callback = callback_f;
break;
case FTS_SL:
callback = callback_sl;
break;
case FTS_DEFAULT:
if (is_whiteout(cur->fts_statp)) {
callback = callback_whiteout;
} else {
return_val = -1;
fprintf(stderr, "File %s is a special file (device or pipe). We cannot handle that.\n", cur->fts_path);
}
break;
default:
return_val = -1;
fprintf(stderr, "Error occured when opening %s.\n", cur->fts_path);
}
if (callback != NULL) {
int fts_instr = 0;
struct stat lower_status;
bool lower_exist = true;
strcpy(&lower_path[lower_root_len], &(cur->fts_path[upper_root_len]));
if (lstat(lower_path, &lower_status) != 0) {
if (errno == ENOENT || errno == ENOTDIR) { // the corresponding lower file (or its ancestor) does not exist at all
lower_exist = false;
} else { // stat failed for some unknown reason
fprintf(stderr, "Failed to stat %s.\n", lower_path);
return_val = -1;
break; // do not call callback in this case
}
}
return_val = callback(lower_path, cur->fts_path, lower_root_len, lower_exist ? &lower_status : NULL, cur->fts_statp, script_stream, &fts_instr); // return_val must previously be 0
if (fts_instr) {
fts_set(ftsp, cur, fts_instr);
}
}
}
if (errno) { return_val = -1; } // if no error happened, fts_read will "sets the external variable errno to 0" according to the documentation
return fts_close(ftsp) || return_val;
}
static int deref_d(const char *mnt_path, const char* upper_path, const size_t mnt_root_len, const struct stat *mnt_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
bool redirect;
if (is_redirect(upper_path, &redirect) < 0) { return -1; }
if (!redirect) { return 0; }
*fts_instr = FTS_SKIP;
return command(script_stream, "rm -rf %U", upper_path) || command(script_stream, "cp -a %M %U", mnt_path, upper_path);
}
static int deref_f(const char *mnt_path, const char* upper_path, const size_t mnt_root_len, const struct stat *mnt_status, const struct stat *upper_status, FILE* script_stream, int *fts_instr) {
bool metacopy;
if (is_metacopy(upper_path, &metacopy) < 0) { return -1; }
if (!metacopy) { return 0; }
return command(script_stream, "rm -r %U", upper_path) || command(script_stream, "cp -a %M %U", mnt_path, upper_path);
}
int vacuum(const char* lowerdir, const char* upperdir, FILE* script_stream) {
return traverse(lowerdir, upperdir, script_stream, vacuum_d, vacuum_dp, vacuum_f, vacuum_sl, NULL);
}
int diff(const char* lowerdir, const char* upperdir) {
return traverse(lowerdir, upperdir, NULL, diff_d, NULL, diff_f, diff_sl, diff_whiteout);
}
int merge(const char* lowerdir, const char* upperdir, FILE* script_stream) {
return traverse(lowerdir, upperdir, script_stream, merge_d, merge_dp, merge_f, merge_sl, merge_whiteout);
}
int deref(const char* mountdir, const char* upperdir, FILE* script_stream) {
return traverse(mountdir, upperdir, script_stream, deref_d, NULL, deref_f, NULL, NULL);
}