From aa0a6214e23a3f9a2b1938e56565d94552afde04 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Wed, 13 Oct 2021 22:24:24 +0200 Subject: [PATCH 1/2] =?UTF-8?q?homed:=20rename=20home=5Fprepare*()=20?= =?UTF-8?q?=E2=86=92=20home=5Fsetup*()?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit These set of functions are constructors for an object called HomeSetup, which has a destructor home_setup_undo(), hence to be reasonably symmetric, let's call it home_setup*() too, instead of using a new verb "prepare" for its name. No actual code changes, just some renaming. --- src/home/homework-cifs.c | 6 +++--- src/home/homework-cifs.h | 2 +- src/home/homework-directory.c | 6 +++--- src/home/homework-directory.h | 2 +- src/home/homework-fscrypt.c | 2 +- src/home/homework-fscrypt.h | 2 +- src/home/homework-luks.c | 6 +++--- src/home/homework-luks.h | 2 +- src/home/homework.c | 16 ++++++++-------- src/home/homework.h | 2 +- 10 files changed, 23 insertions(+), 23 deletions(-) diff --git a/src/home/homework-cifs.c b/src/home/homework-cifs.c index f1dfde50d0..3ae478462c 100644 --- a/src/home/homework-cifs.c +++ b/src/home/homework-cifs.c @@ -12,7 +12,7 @@ #include "strv.h" #include "tmpfile-util.h" -int home_prepare_cifs( +int home_setup_cifs( UserRecord *h, bool already_activated, HomeSetup *setup) { @@ -117,7 +117,7 @@ int home_activate_cifs( assert_se(hdo = user_record_home_directory(h)); hd = strdupa_safe(hdo); /* copy the string out, since it might change later in the home record object */ - r = home_prepare_cifs(h, false, &setup); + r = home_setup_cifs(h, false, &setup); if (r < 0) return r; @@ -160,7 +160,7 @@ int home_create_cifs(UserRecord *h, UserRecord **ret_home) { return log_error_errno(errno, "Unable to detect whether /sbin/mount.cifs exists: %m"); } - r = home_prepare_cifs(h, false, &setup); + r = home_setup_cifs(h, false, &setup); if (r < 0) return r; diff --git a/src/home/homework-cifs.h b/src/home/homework-cifs.h index da2e50a795..6bba2c951a 100644 --- a/src/home/homework-cifs.h +++ b/src/home/homework-cifs.h @@ -4,7 +4,7 @@ #include "homework.h" #include "user-record.h" -int home_prepare_cifs(UserRecord *h, bool already_activated, HomeSetup *setup); +int home_setup_cifs(UserRecord *h, bool already_activated, HomeSetup *setup); int home_activate_cifs(UserRecord *h, PasswordCache *cache, UserRecord **ret_home); diff --git a/src/home/homework-directory.c b/src/home/homework-directory.c index ed043491ad..5865f325ff 100644 --- a/src/home/homework-directory.c +++ b/src/home/homework-directory.c @@ -13,7 +13,7 @@ #include "tmpfile-util.h" #include "umask-util.h" -int home_prepare_directory(UserRecord *h, bool already_activated, HomeSetup *setup) { +int home_setup_directory(UserRecord *h, bool already_activated, HomeSetup *setup) { assert(h); assert(setup); @@ -44,7 +44,7 @@ int home_activate_directory( assert_se(hdo = user_record_home_directory(h)); hd = strdupa_safe(hdo); - r = home_prepare(h, false, cache, &setup, &header_home); + r = home_setup(h, false, cache, &setup, &header_home); if (r < 0) return r; @@ -205,7 +205,7 @@ int home_resize_directory( assert(ret_home); assert(IN_SET(user_record_storage(h), USER_DIRECTORY, USER_SUBVOLUME, USER_FSCRYPT)); - r = home_prepare(h, already_activated, cache, setup, NULL); + r = home_setup(h, already_activated, cache, setup, NULL); if (r < 0) return r; diff --git a/src/home/homework-directory.h b/src/home/homework-directory.h index 27d640f380..9f7e1470e2 100644 --- a/src/home/homework-directory.h +++ b/src/home/homework-directory.h @@ -4,7 +4,7 @@ #include "homework.h" #include "user-record.h" -int home_prepare_directory(UserRecord *h, bool already_activated, HomeSetup *setup); +int home_setup_directory(UserRecord *h, bool already_activated, HomeSetup *setup); int home_activate_directory(UserRecord *h, PasswordCache *cache, UserRecord **ret_home); int home_create_directory_or_subvolume(UserRecord *h, UserRecord **ret_home); int home_resize_directory(UserRecord *h, bool already_activated, PasswordCache *cache, HomeSetup *setup, UserRecord **ret_home); diff --git a/src/home/homework-fscrypt.c b/src/home/homework-fscrypt.c index 86dde4b78b..002b0b49b7 100644 --- a/src/home/homework-fscrypt.c +++ b/src/home/homework-fscrypt.c @@ -278,7 +278,7 @@ static int fscrypt_setup( return log_error_errno(SYNTHETIC_ERRNO(ENOKEY), "Failed to set up home directory with provided passwords."); } -int home_prepare_fscrypt( +int home_setup_fscrypt( UserRecord *h, bool already_activated, PasswordCache *cache, diff --git a/src/home/homework-fscrypt.h b/src/home/homework-fscrypt.h index 50b03993e0..becf4650a4 100644 --- a/src/home/homework-fscrypt.h +++ b/src/home/homework-fscrypt.h @@ -4,7 +4,7 @@ #include "homework.h" #include "user-record.h" -int home_prepare_fscrypt(UserRecord *h, bool already_activated, PasswordCache *cache, HomeSetup *setup); +int home_setup_fscrypt(UserRecord *h, bool already_activated, PasswordCache *cache, HomeSetup *setup); int home_create_fscrypt(UserRecord *h, char **effective_passwords, UserRecord **ret_home); int home_passwd_fscrypt(UserRecord *h, HomeSetup *setup, PasswordCache *cache, char **effective_passwords); diff --git a/src/home/homework-luks.c b/src/home/homework-luks.c index 90a49559f1..afee37490e 100644 --- a/src/home/homework-luks.c +++ b/src/home/homework-luks.c @@ -1098,7 +1098,7 @@ static int lock_image_fd(int image_fd, const char *ip) { return 0; } -int home_prepare_luks( +int home_setup_luks( UserRecord *h, bool already_activated, const char *force_image_path, @@ -1385,7 +1385,7 @@ int home_activate_luks( if (r > 0) return log_error_errno(SYNTHETIC_ERRNO(EEXIST), "Device mapper device %s already exists, refusing.", setup.dm_node); - r = home_prepare_luks( + r = home_setup_luks( h, false, NULL, @@ -2797,7 +2797,7 @@ int home_resize_luks( new_image_size = new_image_size_rounded; } - r = home_prepare_luks(h, already_activated, whole_disk, cache, setup, &header_home); + r = home_setup_luks(h, already_activated, whole_disk, cache, setup, &header_home); if (r < 0) return r; diff --git a/src/home/homework-luks.h b/src/home/homework-luks.h index eac8f0761b..770aa552e0 100644 --- a/src/home/homework-luks.h +++ b/src/home/homework-luks.h @@ -5,7 +5,7 @@ #include "homework.h" #include "user-record.h" -int home_prepare_luks(UserRecord *h, bool already_activated, const char *force_image_path, PasswordCache *cache, HomeSetup *setup, UserRecord **ret_luks_home); +int home_setup_luks(UserRecord *h, bool already_activated, const char *force_image_path, PasswordCache *cache, HomeSetup *setup, UserRecord **ret_luks_home); int home_activate_luks(UserRecord *h, PasswordCache *cache, UserRecord **ret_home); int home_deactivate_luks(UserRecord *h); diff --git a/src/home/homework.c b/src/home/homework.c index 48ff77213b..394b5c58ba 100644 --- a/src/home/homework.c +++ b/src/home/homework.c @@ -368,7 +368,7 @@ int home_setup_undo(HomeSetup *setup) { return r; } -int home_prepare( +int home_setup( UserRecord *h, bool already_activated, PasswordCache *cache, @@ -393,19 +393,19 @@ int home_prepare( switch (user_record_storage(h)) { case USER_LUKS: - return home_prepare_luks(h, already_activated, NULL, cache, setup, ret_header_home); + return home_setup_luks(h, already_activated, NULL, cache, setup, ret_header_home); case USER_SUBVOLUME: case USER_DIRECTORY: - r = home_prepare_directory(h, already_activated, setup); + r = home_setup_directory(h, already_activated, setup); break; case USER_FSCRYPT: - r = home_prepare_fscrypt(h, already_activated, cache, setup); + r = home_setup_fscrypt(h, already_activated, cache, setup); break; case USER_CIFS: - r = home_prepare_cifs(h, already_activated, setup); + r = home_setup_cifs(h, already_activated, setup); break; default: @@ -1445,7 +1445,7 @@ static int home_update(UserRecord *h, UserRecord **ret) { already_activated = r > 0; - r = home_prepare(h, already_activated, &cache, &setup, &header_home); + r = home_setup(h, already_activated, &cache, &setup, &header_home); if (r < 0) return r; @@ -1541,7 +1541,7 @@ static int home_passwd(UserRecord *h, UserRecord **ret_home) { already_activated = r > 0; - r = home_prepare(h, already_activated, &cache, &setup, &header_home); + r = home_setup(h, already_activated, &cache, &setup, &header_home); if (r < 0) return r; @@ -1613,7 +1613,7 @@ static int home_inspect(UserRecord *h, UserRecord **ret_home) { already_activated = r > 0; - r = home_prepare(h, already_activated, &cache, &setup, &header_home); + r = home_setup(h, already_activated, &cache, &setup, &header_home); if (r < 0) return r; diff --git a/src/home/homework.h b/src/home/homework.h index f20a23a918..b16f4a9086 100644 --- a/src/home/homework.h +++ b/src/home/homework.h @@ -56,7 +56,7 @@ void password_cache_free(PasswordCache *cache); int home_setup_undo(HomeSetup *setup); -int home_prepare(UserRecord *h, bool already_activated, PasswordCache *cache, HomeSetup *setup, UserRecord **ret_header_home); +int home_setup(UserRecord *h, bool already_activated, PasswordCache *cache, HomeSetup *setup, UserRecord **ret_header_home); int home_refresh(UserRecord *h, HomeSetup *setup, UserRecord *header_home, PasswordCache *cache, struct statfs *ret_statfs, UserRecord **ret_new_home); From 66aa51f8f9c3d6b3283ea1c247030b5c9cb900ae Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sat, 16 Oct 2021 14:45:42 +0200 Subject: [PATCH 2/2] =?UTF-8?q?homed:=20rename=20home=5Fsetup=5Fundo()=20?= =?UTF-8?q?=E2=86=92=20home=5Fsetup=5Fdone()?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This function is a destructor, hence it should be named like one. (We usually use xyz_free() for a destructor that frees the object passed itself. xyz_unref() we typically use for destructors that are similar, but ref counted. xyz_done() usually is used for destructors which free the members of an object, but not the object itself – to allow stack allocation of objects. We don't strictly follow this, but it's good to stick to rules wherever we can.) No actual code change, just renaming. --- src/home/homework-cifs.c | 4 ++-- src/home/homework-directory.c | 4 ++-- src/home/homework-luks.c | 4 ++-- src/home/homework.c | 16 ++++++++-------- src/home/homework.h | 2 +- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/home/homework-cifs.c b/src/home/homework-cifs.c index 3ae478462c..62625ab867 100644 --- a/src/home/homework-cifs.c +++ b/src/home/homework-cifs.c @@ -102,7 +102,7 @@ int home_activate_cifs( PasswordCache *cache, UserRecord **ret_home) { - _cleanup_(home_setup_undo) HomeSetup setup = HOME_SETUP_INIT; + _cleanup_(home_setup_done) HomeSetup setup = HOME_SETUP_INIT; _cleanup_(user_record_unrefp) UserRecord *new_home = NULL; const char *hdo, *hd; int r; @@ -140,7 +140,7 @@ int home_activate_cifs( } int home_create_cifs(UserRecord *h, UserRecord **ret_home) { - _cleanup_(home_setup_undo) HomeSetup setup = HOME_SETUP_INIT; + _cleanup_(home_setup_done) HomeSetup setup = HOME_SETUP_INIT; _cleanup_(user_record_unrefp) UserRecord *new_home = NULL; _cleanup_(closedirp) DIR *d = NULL; _cleanup_close_ int copy = -1; diff --git a/src/home/homework-directory.c b/src/home/homework-directory.c index 5865f325ff..4e978d2328 100644 --- a/src/home/homework-directory.c +++ b/src/home/homework-directory.c @@ -30,7 +30,7 @@ int home_activate_directory( UserRecord **ret_home) { _cleanup_(user_record_unrefp) UserRecord *new_home = NULL, *header_home = NULL; - _cleanup_(home_setup_undo) HomeSetup setup = HOME_SETUP_INIT; + _cleanup_(home_setup_done) HomeSetup setup = HOME_SETUP_INIT; const char *hdo, *hd, *ipo, *ip; int r; @@ -231,7 +231,7 @@ int home_resize_directory( if (r < 0) return r; - r = home_setup_undo(setup); + r = home_setup_done(setup); if (r < 0) return r; diff --git a/src/home/homework-luks.c b/src/home/homework-luks.c index afee37490e..f302ee5f0b 100644 --- a/src/home/homework-luks.c +++ b/src/home/homework-luks.c @@ -1362,7 +1362,7 @@ int home_activate_luks( UserRecord **ret_home) { _cleanup_(user_record_unrefp) UserRecord *new_home = NULL, *luks_home_record = NULL; - _cleanup_(home_setup_undo) HomeSetup setup = HOME_SETUP_INIT; + _cleanup_(home_setup_done) HomeSetup setup = HOME_SETUP_INIT; uint64_t host_size, encrypted_size; const char *hdo, *hd; struct statfs sfs; @@ -2999,7 +2999,7 @@ int home_resize_luks( if (r < 0) return r; - r = home_setup_undo(setup); + r = home_setup_done(setup); if (r < 0) return r; diff --git a/src/home/homework.c b/src/home/homework.c index 394b5c58ba..820cafd3bd 100644 --- a/src/home/homework.c +++ b/src/home/homework.c @@ -298,7 +298,7 @@ static void drop_caches_now(void) { log_debug("Dropped caches."); } -int home_setup_undo(HomeSetup *setup) { +int home_setup_done(HomeSetup *setup) { int r = 0, q; assert(setup); @@ -1426,7 +1426,7 @@ static int home_validate_update(UserRecord *h, HomeSetup *setup) { static int home_update(UserRecord *h, UserRecord **ret) { _cleanup_(user_record_unrefp) UserRecord *new_home = NULL, *header_home = NULL, *embedded_home = NULL; - _cleanup_(home_setup_undo) HomeSetup setup = HOME_SETUP_INIT; + _cleanup_(home_setup_done) HomeSetup setup = HOME_SETUP_INIT; _cleanup_(password_cache_free) PasswordCache cache = {}; bool already_activated = false; int r; @@ -1469,7 +1469,7 @@ static int home_update(UserRecord *h, UserRecord **ret) { if (r < 0) return r; - r = home_setup_undo(&setup); + r = home_setup_done(&setup); if (r < 0) return r; @@ -1480,7 +1480,7 @@ static int home_update(UserRecord *h, UserRecord **ret) { } static int home_resize(UserRecord *h, UserRecord **ret) { - _cleanup_(home_setup_undo) HomeSetup setup = HOME_SETUP_INIT; + _cleanup_(home_setup_done) HomeSetup setup = HOME_SETUP_INIT; _cleanup_(password_cache_free) PasswordCache cache = {}; bool already_activated = false; int r; @@ -1520,7 +1520,7 @@ static int home_resize(UserRecord *h, UserRecord **ret) { static int home_passwd(UserRecord *h, UserRecord **ret_home) { _cleanup_(user_record_unrefp) UserRecord *header_home = NULL, *embedded_home = NULL, *new_home = NULL; _cleanup_(strv_free_erasep) char **effective_passwords = NULL; - _cleanup_(home_setup_undo) HomeSetup setup = HOME_SETUP_INIT; + _cleanup_(home_setup_done) HomeSetup setup = HOME_SETUP_INIT; _cleanup_(password_cache_free) PasswordCache cache = {}; bool already_activated = false; int r; @@ -1583,7 +1583,7 @@ static int home_passwd(UserRecord *h, UserRecord **ret_home) { if (r < 0) return r; - r = home_setup_undo(&setup); + r = home_setup_done(&setup); if (r < 0) return r; @@ -1595,7 +1595,7 @@ static int home_passwd(UserRecord *h, UserRecord **ret_home) { static int home_inspect(UserRecord *h, UserRecord **ret_home) { _cleanup_(user_record_unrefp) UserRecord *header_home = NULL, *new_home = NULL; - _cleanup_(home_setup_undo) HomeSetup setup = HOME_SETUP_INIT; + _cleanup_(home_setup_done) HomeSetup setup = HOME_SETUP_INIT; _cleanup_(password_cache_free) PasswordCache cache = {}; bool already_activated = false; int r; @@ -1625,7 +1625,7 @@ static int home_inspect(UserRecord *h, UserRecord **ret_home) { if (r < 0) return r; - r = home_setup_undo(&setup); + r = home_setup_done(&setup); if (r < 0) return r; diff --git a/src/home/homework.h b/src/home/homework.h index b16f4a9086..1bb985a44d 100644 --- a/src/home/homework.h +++ b/src/home/homework.h @@ -54,7 +54,7 @@ void password_cache_free(PasswordCache *cache); .partition_size = UINT64_MAX, \ } -int home_setup_undo(HomeSetup *setup); +int home_setup_done(HomeSetup *setup); int home_setup(UserRecord *h, bool already_activated, PasswordCache *cache, HomeSetup *setup, UserRecord **ret_header_home);