Bug 193701 - [patch] rc.conf.d subdirectory support added in 271260 potentially sources /rc.conf.d/
Summary: [patch] rc.conf.d subdirectory support added in 271260 potentially sources /r...
Status: Open
Alias: None
Product: Base System
Classification: Unclassified
Component: conf (show other bugs)
Version: 10.1-STABLE
Hardware: Any Any
: --- Affects Many People
Assignee: freebsd-bugs mailing list
URL:
Keywords: patch
Depends on:
Blocks:
 
Reported: 2014-09-17 01:24 UTC by J. Pernfuß
Modified: 2018-01-08 04:14 UTC (History)
1 user (show)

See Also:


Attachments
Proposed patch to etc/defaults/rc.conf and etc/rc.subr (2.71 KB, patch)
2014-09-17 01:24 UTC, J. Pernfuß
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description J. Pernfuß 2014-09-17 01:24:42 UTC
Created attachment 147389 [details]
Proposed patch to etc/defaults/rc.conf and etc/rc.subr

Hi,

the newly added support for directories under rc.conf.d (MFC in 271260) has two issues in my opinion.

1) it uses the shell variable $local_startup from /etc/defaults/rc.conf to construct one of the paths to source files from. But the rc.conf loading handler in rc.subr still has support to source /etc/rc.conf directly if /etc/defaults/rc.conf does not exist. For this reason, $local_startup may be empty. In this case, rc.subr will actually test "/rc.conf.d/$_name" for sourcing.

2) we have the variable $rc_conf_files that defines the locations of rc.conf files. This variable does not contain /usr/local/etc/rc.conf. Probably for this reason, the patch introduces rc.conf.d directories relative to the value of the $local_startup variable. Similarly, /etc/rc.conf.d is used without any relation to the value of $rc_conf_files. Deriving a rc.conf.d location relative to the path of startup scripts is incorrect in my opinion, because it introduced a dependency between the paths that was previously not there.

This results in the following sourcing order, assuming /etc/defaults/rc.conf exists and default values for $rc_conf_files:
1. /etc/defaults/rc.conf
2. /etc/rc.conf
3. /etc/rc.conf.local
4. /etc/rc.conf.d/$_name OR /etc/rc.conf.d/$_name/*
5. /usr/local/etc/rc.conf.d/$_name OR /usr/local/etc/rc.conf.d/$_name/*

I propose the attached patch, which introduces the following behavior. It applies to 10.1-BETA1, I have not tested it against HEAD.

* extend /etc/defaults/rc.conf with the new variable $extra_rc_conf_files which defaults to /usr/local/etc/rc.conf
* in /etc/rc.subr check if the variable $source_rc_confs_defined has been set, as an indicator if the regular /etc/defaults/rc.conf, or the fallback direct /etc/rc.conf sourcing happened
* if regular sourcing happened:
-- construct the rc.conf.d-directory paths $_d by appending .d to the values from $rc_conf_files (with duplicate definition checks). Skip over rc.conf.local
-- check if $_d/$_name exists. Source it or $_d/$_name/* depending on if it is a file or directory
-- for every entry in $extra_rc_conf_files, source it. then construct the $_d directory from it and check that as well
* if the fallback sourcing happened
-- try sourcing from /etc/rc.conf.d and /usr/local/etc/rc.conf.d directly

This results in the following sourcing order, assuming the /etc/defaults/rc.conf exists and the following values are set:
rc_conf_files="/etc/rc.conf /etc/rc.conf.local"
extra_rc_conf_files="/usr/local/etc/rc.conf /foo/bar/baz.conf"

1. /etc/defaults/rc.conf
2. /etc/rc.conf
3. /etc/rc.conf.local
4. /etc/rc.conf.d/$_name OR /etc/rc.conf.d/$_name/*
5. --skip /etc/rc.conf.local.d --
6. /usr/local/etc/rc.conf
7. /usr/local/etc/rc.conf.d/$_name OR /usr/local/etc/rc.conf.d/$_name/*
8. /foo/bar/baz.conf
9. /foo/bar/baz.conf.d/$_name OR /foo/bar/baz.conf.d/$_name/*

Since the directory paths are defined relative to the values of $rc_conf_files and $extra_rc_conf_files, every entry in it automatically gets the "there may be a .d directory for it" treatment as shown with the /foo/bar/baz.conf example.

The $extra_rc_conf_files variable should really be called $local_rc_conf_files, but this is confusing while /etc/rc.conf.local is still supported.

Folding /usr/local/etc/rc.conf into rc_conf_files with the current behavior of sourcing the .d directories in rc.subr would result in /etc/rc.conf.d/$_name overwriting /usr/local/etc/rc.conf which I consider a POLA violation.

Example of a FreeBSD 10.1-BETA1 system with the applied patch:

:~ # mkdir -p /etc/rc.conf.d/syslogd /usr/local/etc/rc.conf.d/syslogd
:~ # service syslogd rcvar
# syslogd
#
syslogd_enable="YES"
#   (default: "")

:~ # echo 'syslogd_enable="NO"' > /etc/rc.conf.d/syslogd/enable
:~ # service syslogd rcvar
# syslogd
#
syslogd_enable="NO"
#   (default: "")

:~ # echo 'syslogd_enable="YES"' > /usr/local/etc/rc.conf
:~ # service syslogd rcvar
# syslogd
#
syslogd_enable="YES"
#   (default: "")

:~ # echo 'syslogd_enable="NO"' > /usr/local/etc/rc.conf.d/syslogd/enable
:~ # service syslogd rcvar
# syslogd
#
syslogd_enable="NO"
#   (default: "")

Regards,
  Jörg
Comment 1 J. Pernfuß 2014-09-17 02:16:27 UTC
Forgot to add something. By not handling $extra_rc_conf_files in sourc_rc_confs(), the value of $extra_rc_conf_files can of course be overwritten/extended in /etc/rc.conf prior to sourcing the default value.

Any such defined location still inherits the consistent behavior and the full tooling support as shown with the /foo/bar/baz.conf example.
Comment 2 Marcus von Appen freebsd_committer freebsd_triage 2015-02-18 11:54:22 UTC
Updated 10.1-BETA and 10.1-RC versioned bugs to 10.1-STABLE.
Comment 3 Eitan Adler freebsd_committer freebsd_triage 2018-01-08 04:14:44 UTC
For the following conditions
Product: Base System, Documentation Status: New, Open, In Progress, UNCONFIRMED 
Assignee: Former FreeBSD committer 

Reset to default assignee. Reset status to "Open".