Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Dan Moulding <dmoulding@me.com>
To:     linux-kernel@vger.kernel.org
Cc:     linux-doc@vger.kernel.org, tglx@linutronix.de,
        akpm@linux-foundation.org, corbet@lwn.net,
        Dan Moulding <dmoulding@me.com>
Subject: [PATCH 1/1] init: Add "hostname" kernel parameter
Date:   Thu,  5 May 2022 12:06:51 -0600
Message-Id: <20220505180651.22849-2-dmoulding@me.com>
In-Reply-To: <20220505180651.22849-1-dmoulding@me.com>
References: <20220505180651.22849-1-dmoulding@me.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

The gethostname system call returns the hostname for the current
machine. However, the kernel has no mechanism to initially set the
current machine's name in such a way as to guarantee that the first
userspace process to call gethostname will receive a meaningful
result. It relies on some unspecified userspace process to first call
sethostname before gethostname can produce a meaningful name.

Traditionally the machine's hostname is set from userspace by the init
system. The init system, in turn, often relies on a configuration file
(say, /etc/hostname) to provide the value that it will supply in the
call to sethostname. Consequently, the file system containing
/etc/hostname usually must be available before the hostname will be
set. There may, however, be earlier userspace processes that could
call gethostname before the file system containing /etc/hostname is
mounted. Such a process will get some other, likely meaningless, name
from gethostname (such as "(none)", "localhost", or "darkstar").

A real-world example where this can happen, and lead to undesirable
results, is with mdadm. When assembling arrays, mdadm distinguishes
between "local" arrays and "foreign" arrays. A local array is one that
properly belongs to the current machine, and a foreign array is one
that is (possibly temporarily) attached to the current machine, but
properly belongs to some other machine. To determine if an array is
local or foreign, mdadm may compare the "homehost" recorded on the
array with the current hostname. If mdadm is run before the root file
system is mounted, perhaps because the root file system itself resides
on an md-raid array, then /etc/hostname isn't yet available and the
init system will not yet have called sethostname, causing mdadm to
incorrectly conclude that all of the local arrays are foreign.

Solving this problem *could* be delegated to the init system. It could
be left up to the init system (including any init system that starts
within an initramfs, if one is in use) to ensure that sethostname is
called before any other userspace process could possibly call
gethostname. However, it may not always be obvious which processes
could call gethostname (for example, udev itself might not call
gethostname, but it could via udev rules invoke processes that
do). Additionally, the init system has to ensure that the hostname
configuration value is stored in some place where it will be readily
accessible during early boot. Unfortunately, every init system will
attempt to (or has already attempted to) solve this problem in a
different, possibly incorrect, way. This makes getting consistently
working configurations harder for users.

I believe it is better for the kernel to provide the means by which
the hostname may be set early, rather than making this a problem for
the init system to solve. The option to set the hostname during early
startup, via a kernel parameter, provides a simple, reliable way to
solve this problem. It also could make system configuration easier for
some embedded systems.

Signed-off-by: Dan Moulding <dmoulding@me.com>
---
 Documentation/admin-guide/kernel-parameters.txt | 13 +++++++++++++
 init/version.c                                  | 17 +++++++++++++++++
 2 files changed, 30 insertions(+)

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 3f1cc5e317ed..873481d72e94 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -1615,6 +1615,19 @@
 			Valid parameters: "on", "off"
 			Default: "on"
 
+	hostname=	[KNL] Set the hostname (aka UTS nodename).
+			Format: <string>
+			This allows setting the system's hostname during early
+			startup. This sets the name returned by gethostname.
+			Using this parameter to set the hostname makes it
+			possible to ensure the hostname is correctly set before
+			any userspace processes run, avoiding the possibility
+			that a process may call gethostname before the hostname
+			has been explicitly set, resulting in the calling
+			process getting an incorrect result. The string must
+			not exceed the maximum allowed hostname length (usually
+			64 characters) and will be truncated otherwise.
+
 	hlt		[BUGS=ARM,SH]
 
 	hpet=		[X86-32,HPET] option to control HPET usage
diff --git a/init/version.c b/init/version.c
index 1a356f5493e8..66d237d5629c 100644
--- a/init/version.c
+++ b/init/version.c
@@ -11,6 +11,8 @@
 #include <linux/build-salt.h>
 #include <linux/elfnote-lto.h>
 #include <linux/export.h>
+#include <linux/init.h>
+#include <linux/printk.h>
 #include <linux/uts.h>
 #include <linux/utsname.h>
 #include <generated/utsrelease.h>
@@ -35,6 +37,21 @@ struct uts_namespace init_uts_ns = {
 };
 EXPORT_SYMBOL_GPL(init_uts_ns);
 
+static int __init early_hostname(char *arg)
+{
+	size_t bufsize = sizeof(init_uts_ns.name.nodename);
+	size_t maxlen  = bufsize - 1;
+
+	strncpy(init_uts_ns.name.nodename, arg, bufsize);
+	if (strlen(arg) > maxlen) {
+		pr_warn("hostname parameter exceeds %zd characters and will be truncated",
+			maxlen);
+		init_uts_ns.name.nodename[maxlen] = '\0';
+	}
+	return 0;
+}
+early_param("hostname", early_hostname);
+
 /* FIXED STRINGS! Don't touch! */
 const char linux_banner[] =
 	"Linux version " UTS_RELEASE " (" LINUX_COMPILE_BY "@"
-- 
2.35.1