Differences between revisions 153 and 192 (spanning 39 versions)
Revision 153 as of 2008-11-30 10:27:05
Size: 6383
Editor: ?PetterReinholdtsen
Comment: New status update sent.
Revision 192 as of 2015-09-21 08:48:11
Size: 11040
Comment: Clarified applicability to Jessie.
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
#language en
~-[[DebianWiki/EditorGuide#translation|Translation(s)]]: none-~
----
Line 4: Line 7:
It is possible to converting Debian to order the boot sequence using the
LSB headers in the init.d scripts. This will get rid of several bugs in the
current boot sequence, and make it easier to keep the sequence correct.
Before Debian 8.0, Debian used init to boot-up the system. This page provide information of the details to resolve the dependency issues. Since Debian 8.0, Systemd replaced init and the dependency was relied on its target files. The information described here no longer applies to Debian's default in Jessie.
Line 8: Line 9:
The feature [http://lists.debian.org/debian-devel-announce/2008/01/msg00004.html was announced on debian-devel-announce] 2008-01-17.
A status update message was sent [http://lists.debian.org/debian-devel-announce/2008/03/msg00011.html 2008-03-16] and
[http://lists.debian.org/debian-devel-announce/2008/11/msg00007.html 2008-11-30].
Debian was converted to order the boot sequence using the LSB fields in the header of each init.d script. This has removed several bugs in the former boot sequence, and now makes it easier to keep the sequence correct.
Line 13: Line 12:
Did you ever need to insert a init.d scripts Y before init.d scripts Z and after init.d script X, where both Z and X is started using boot sequence number 20 (as in 20X and 20Z)? Adding your script as 20Y would not cut it, because you need Z to start before X. To do this, in Debian you currently need to talk to the maintainer of packages with scripts Z and X, asking one of them (or both) to move their script into a different number. Dependency based boot sequencing make it possible for each package maintainer to specify the dependencies of its scripts, and leave the number allocation to the dependency resolver.
Line 14: Line 14:
Did you every need to insert a init.d scripts Y before init.d scripts
Z and after init.d script X, where both Z and X is started using boot
sequence number 20 (as in 20X and 20Z)? Adding your script as 20Y
would not cut it, because you need Z to start before X. To do this,
in Debian you currently need to talk to the maintainer of packages
with scripts Z and X, asking one of them (or both) to move their
script into a different number. Dependency based boot sequencing make
it possible for each package maintainer to specify the dependencies of
its scripts, and leave the number allocation to the dependency
resolver.
Some examples of such problems are DebianBug:256699 DebianBug:294053, DebianBug:279297, DebianBug:311057 and DebianBug:475626 .
Line 25: Line 16:
=== Example of such problems ===
Line 27: Line 17:
 * http://bugs.debian.org/294053
 * http://bugs.debian.org/279297
 * http://bugs.debian.org/475626
== How to add a service when using dependency-based booting ==

In Debian releases '''prior to 6.0''', a service could be added with update-rc.d:

{{{
update-rc.d mydaemon defaults
}}}

Starting with Debian 6.0, the insserv command is used instead, if dependency-based booting is enabled:

{{{
insserv mydaemon
}}}

Where ''mydaemon'' is an executable init script placed in /etc/init.d. insserv will produce no output if everything went OK. Examine the error code in $? if you want to be sure.

Both the old and the new way requires an init script to be present in /etc/init.d. For dependency-based booting, the script needs to be an [[LSBInitScripts|LSB init script]].

As of Debian 7 [[http://manpages.debian.org/cgi-bin/man.cgi?query=insserv&apropos=0&sektion=0&manpath=Debian+7.0+wheezy&format=html&locale=en|man insserv]] states

 insserv is a low level tool used by update-rc.d which enables an installed system init script (`boot script') by reading the comment header of the script

so you need not use it ''instead'' of update-rc.d - see your local manpage for details.

== History of the feature ==

The feature was [[http://alioth.debian.org/docman/view.php/30730/38/debconf2-initscripts-bkg.pdf|proposed at debconf in 2002]], and has been worked on since before 2006, and [[http://lists.debian.org/debian-devel-announce/2008/01/msg00004.html|was announced on debian-devel-announce]] 2008-01-17. A status update message was sent [[http://lists.debian.org/debian-devel-announce/2008/03/msg00011.html|2008-03-16]] and [[http://lists.debian.org/debian-devel-announce/2008/11/msg00007.html|2008-11-30]]. The default in Debian was changed to dependency based boot sequencing 2009-07-27, and an updated announcement about the plans for the boot system was sent out [[http://lists.debian.org/debian-devel-announce/2009/09/msg00003.html|2009-09-05]]. The default in Debian was changed to run scripts in parallel 2010-05-14 and an announcement was sent on [[http://lists.debian.org/debian-devel-announce/2010/05/msg00009.html|2010-05-21]].
Line 33: Line 47:
This page is created to keep track of the state of this feature, to make it easier
to coordinate an effort to implement it for
Debian Lenny. It is [http://lists.debian.org/debian-release/2007/06/msg00164.html proposed] as a [http://release.debian.org/lenny-goals.txt release goal] for Lenny.
This page was created to keep track of the state of this feature, to make it easier to coordinate an effort to implement it in Debian. It was [[http://lists.debian.org/debian-release/2007/06/msg00164.html|proposed]] as a [[http://release.debian.org/lenny-goals.txt|release goal]] for Lenny.  It will be the default boot ordering method for Squeeze.
During Debconf in 2009, the default in Sid was changed to use dependency based boot sequencing by default.
Line 36: Line 50:
|| || 2007-07-03 || 2007-07-22 || 2007-08-08 || 2007-09-06 || 2007-10-24 || 2007-11-14 || 2007-11-29 || 2007-12-22 || 2007-12-30 || 2008-01-06 || 2008-01-14 || 2008-01-26 || 2008-02-03 || 2008-02-08 || 2008-02-20 || 2008-02-23 || 2008-03-07 || 2008-03-09 || 2008-03-13 || 2008-03-19 || 2008-04-16 || 2008-05-01 || 2008-05-18 || 2008-11-30 ||
|| packages with init.d scripts || 843 || 843|| 845 || 849 || 855 || 852 || 851 || 857 || 860 || 863 || 863 || 864 || 863 || 863 || 866 || 866 || 873 || 873 || 873 || 873 || 873 || 873 || 873 || 909 ||
|| fraction with LSB headers || 56% || 57% || 58% || 60% || 62% || 63% || 64% || 66% || 67% || 68% || 69% || 70% || 73% || 73% || 76% || 77% || 78% || 79% || 80% || 83% || 98% || 99% || 99% || 99.8% ||
|| packages without LSB headers || 373 || 363|| 353 || 336 || 325 || 319 || 303 || 292 || 287 || 280 || 269 || 258 || 237 || 229 || 212 || 203 || 187 || 181 || 172 || 148 || 16 || 12 || 9 || 2 ||
|| base packages without LSB headers || 2 of 40 || || || || || 1 of 40 (1 of 12 pkgs) || || || || 0 of 38 (0 of 10 pkgs) || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 ||
|| desktop packages without LSB headers || 6 of 58 || || || || || 7 of 70 (7 of 39 pkgs) || || || || 4 of 75 (4 of 42 pkgs) || || || || || || || || || || || || || 0 || 0 ||
A number of [[http://bugs.debian.org/cgi-bin/pkgreport.cgi?usertag=initscripts-ng-devel@lists.alioth.debian.org&dist=unstable|bug reports]] are submitted to request LSB fields in init.d scripts. It is useful to track [[http://bugs.debian.org/cgi-bin/pkgreport.cgi?usertag=initscripts-ng-devel@lists.alioth.debian.org&dist=testing|the ones open in testing]] as well.
Line 43: Line 52:
A number of [http://bugs.debian.org/cgi-bin/pkgreport.cgi?usertag=initscripts-ng-devel@lists.alioth.debian.org&dist=unstable bug reports] are submitted to request LSB headers in init.d scripts. It is useful to track [http://bugs.debian.org/cgi-bin/pkgreport.cgi?usertag=initscripts-ng-devel@lists.alioth.debian.org&dist=testing the ones open in testing] as well. A daily updated archive wide check of init.d scripts is available from
http://lintian.debian.org/~pere/ . [[http://piuparts.debian.org/sid/insserv_error.html|Piuparts]] now reports installation errors due to incorrect dependencies, and [[http://piuparts.debian.org/sid/initdscript_lsb_header_issue.html|inconsistencies]] between update-rc.d calls and LSB fields.
Line 45: Line 55:
=== Known issues === === Plan of migration ===
Line 47: Line 57:
 * Some init.d scripts provide the same service, and this is not supported by insserv. The provided service should be unique for each script. Example problems caused by this: This is a proposal for a plan to migrate all of Debian over to dependency based boot sequencing.
Line 49: Line 59:
   * It is not possible to migrate between exim and postfix without purging the other package.
   * It is not possible to migrate between inetutils-inetd and openbsd-inetd without purging the other package.
   * It is not possible to activate insserv when obsolete scripts, which are removed from their package but not properly removed from the disk, are still present in /etc/init.d/. It might also create problems with package installation.
 1. Change the debconf default in DebPkg:insserv to enable dependency based boot sequencing when the package is installed, if it is safe to do so. Show the question again on upgrades if the conversion isn’t done yet. Remove/disable the option to disable DebPkg:insserv after it is enabled.
 1. Change DebPkg:sysv-rc to depend on DebPkg:insserv, to pull it in on all (non-file-rc) installations.
 1. Wait 6 months, while rewriting policy text to document the new way {{{update-rc.d}}} is going to work.
 1. Drop support for specifying sequence numbers in {{{update-rc.d}}}.
Line 53: Line 64:
 * Some init.d scripts have buggy headers, making them fail to install properly in the boot sequence. This will enable dependency based boot sequencing for all in Debian from Squeeze and onwards.
Line 55: Line 66:
To see the boot and reboot sequence dependecy graph, use == How to solve migration problems ==

=== package X removed but not purged ===

If a script in {{{/etc/init.d/}}} belongs to a package that is removed but not purged, the field is probably missing or is outdated. Purging the package will solve the issue.

=== package X left obsolete init.d script behind ===

The script was probably dropped from its package, but the package
maintainer forgot to add code in the postinst to remove the obsolete
script during upgrades. Removing the script is probably the correct
solution. We have seen [[DebianBug:463632|one report]] where dpkg
would claim that a script
was obsolete one time and not obsolete one upgrade later, so this should
probably be checked a bit before the script is removed.

To verify that a package really left behind obsolete conffiles, one can run

{{{
dpkg-query -W -f='${Conffiles}\n' packagename | grep obsolete
}}}

There are several reasons why these scripts are not removed automatically during upgrades. First of all, reporting these issues exposes bugs that should be fixed in the individual packages. Second, it is hard to know if the script reported was left behind for a strange and particular reason, or just forgotten. And last, there is the one report that a non-obsolete script was reported as obsolete. Still not sure if that was for real or not, but until we know the reason, it seemed risky to just remove scripts in other packages during upgrades. Besides doing so from the sysv-rc postinst would be a policy violation.

=== insserv: warning: script 'X' missing LSB tags and overrides ===

The {{{/etc/init.d/X}}} script is lacking the LSB fields. Adding them
to the script header or as a override file in /etc/insserv/overrides/X would solve it.

=== insserv: script X: service Y already provided! ===

Bug in the package with script X: The facility provided in script
{{{/etc/init.d/X}}} uses a non-unique value. Changing it to a unique
value (for example the script name without .sh ending), solves
the issue.

== Common problems with init.d script header LSB fields ==

Here are some problems I have seen with the LSB fields in init.d scripts during the last three years. I provide it here for those of you wondering if your package’s init.d scripts are correct.

 1. Non-unique Provides field

     When two packages have scripts with the same Provides field, it will only be able to install these packages if the init.d script of the other is not present in {{{/etc/init.d/}}}. Packages sharing a common service with other packages could use virtual facilities instead of conflicting provides, or normal dependencies if few packages are involved.

 2. Incorrect runlevel list

    If the Default-Start and Default-Stop fields do not list the runlevels where a script should be stopped or started, the wrong set of start and stop symlinks will be created when the script is installed, and the boot and shutdown sequence will most likely be incorrect. Fixing it require both updates to the fields, and code in the postinst script to add or remove symlinks that where missing.

 3. Missing dependency on {{{$syslog}}} when logging to syslog

     Without it, services might be started too early during boot and some syslog messages might be lost.

 4. Missing dependency on {{{$remote_fs}}} when needing files in {{{/usr/}}}.

     Scripts starting from {{{rcS.d/}}} will start too early when {{{/usr/}}} is on NFS, and will probably fail to work because some of its expected files and programs are missing when the script starts.

 5. Depending on incorrect or non-existing provides

     The intended relationship with another script does not take effect, making the script run too early or too late during boot and shutdown.

To see the boot and reboot sequence dependency graph, use
Line 64: Line 136:
The number of packages with init.d scripts was counted using {{{apt-file update && apt-file search etc/init.d|cut -d: -f1|sort -u|wc -l}}} in Debian/Sid. The number of packages missing LSB headers are fetched from [http://lintian.debian.org/reports/tags.html the lintian reports] for the [http://lintian.debian.org/reports/Tinit.d-script-missing-lsb-section.html init.d-script-missing-lsb-section] tag. The number of base and desktop packages missing headers were
counted by creating chroots with debootstrap and tasksel.
The list of packages whose init.d script is lacking an LSB header can be fetched from [[http://lintian.debian.org/reports/tags.html|the lintian reports]] for the [[http://lintian.debian.org/reports/Tinit.d-script-missing-lsb-section.html|init.d-script-missing-lsb-section]] tag.
Line 67: Line 138:
To enable dependency based boot, the [http://packages.qa.debian.org/i/insserv.html insserv] package can be used.
At
[http://user.skolelinux.no/~pere/mypapers/200706-bootseq/200706-bootseq.html debconf7] and [http://www.hungry.com/~pere/mypapers/200802-bootsequence/200802-bootsequence.html FOSDEM 2008] ([http://meetings-archive.debian.net/pub/debian-meetings/2008/fosdem/ogg_theora/384x288/Reordering_the_Debian_boot_sequence_for_correctness_and_speed___Petter_Reinholdtsen.ogg video]), Petter Reinholdtsen gave a talk
about the dependency based boot system. To enable it, install the insserv package and
activate it lik
e this:
To enable dependency based boot, DebPkg:insserv can be used. At [[http://user.skolelinux.no/~pere/mypapers/200706-bootseq/200706-bootseq.html|debconf7]] and [[http://www.hungry.com/~pere/mypapers/200802-bootsequence/200802-bootsequence.html|FOSDEM 2008]] ([[http://meetings-archive.debian.net/pub/debian-meetings/2008/fosdem/ogg_theora/384x288/Reordering_the_Debian_boot_sequence_for_correctness_and_speed___Petter_Reinholdtsen.ogg|video]]), Petter Reinholdtsen gave a talk about the dependency based boot system. To enable it in older versions of Debian, install DebPkg:insserv and activate it like this:
Line 73: Line 141:
aptitude install insserv && dpkg-reconfigure insserv aptitude install insserv && dpkg-reconfigure insserv sysv-rc
Line 76: Line 144:
Make sure to use insserv version 1.09.0-6 or higher. Make sure to use DebPkg:insserv version 1.09.0-6 or higher.
Line 78: Line 146:
To usertag related bugs, send an email to request (at) bugs.debian.org,
with content like this:
To usertag related bugs, send an email to request (at) bugs.debian.org, with content like this:
Line 86: Line 154:

== Packages left to fix ==

Generated using {{{dd-list $(lynx -nolist -dump http://lintian.debian.org/reports/tags/init.d-script-missing-lsb-section.html | grep binary | cut -d" " -f1 | sort)}}}

{{{
Daniel Baumann <daniel@debian.org>
   ipmasq

Jaakko Niemi <liiwi@debian.org>
   sfs
}}}
Line 99: Line 155:
CategoryDeveloper ## This page is linked from sysv-rc postinst script
CategoryBootProcess | CategoryDeveloper | CategoryPermalink

Translation(s): none


Dependency based boot sequence

Before Debian 8.0, Debian used init to boot-up the system. This page provide information of the details to resolve the dependency issues. Since Debian 8.0, Systemd replaced init and the dependency was relied on its target files. The information described here no longer applies to Debian's default in Jessie.

Debian was converted to order the boot sequence using the LSB fields in the header of each init.d script. This has removed several bugs in the former boot sequence, and now makes it easier to keep the sequence correct.

Advantages

Did you ever need to insert a init.d scripts Y before init.d scripts Z and after init.d script X, where both Z and X is started using boot sequence number 20 (as in 20X and 20Z)? Adding your script as 20Y would not cut it, because you need Z to start before X. To do this, in Debian you currently need to talk to the maintainer of packages with scripts Z and X, asking one of them (or both) to move their script into a different number. Dependency based boot sequencing make it possible for each package maintainer to specify the dependencies of its scripts, and leave the number allocation to the dependency resolver.

Some examples of such problems are 256699 294053, 279297, 311057 and 475626 .

How to add a service when using dependency-based booting

In Debian releases prior to 6.0, a service could be added with update-rc.d:

update-rc.d mydaemon defaults

Starting with Debian 6.0, the insserv command is used instead, if dependency-based booting is enabled:

insserv mydaemon

Where mydaemon is an executable init script placed in /etc/init.d. insserv will produce no output if everything went OK. Examine the error code in $? if you want to be sure.

Both the old and the new way requires an init script to be present in /etc/init.d. For dependency-based booting, the script needs to be an LSB init script.

As of Debian 7 man insserv states

  • insserv is a low level tool used by update-rc.d which enables an installed system init script (`boot script') by reading the comment header of the script

so you need not use it instead of update-rc.d - see your local manpage for details.

History of the feature

The feature was proposed at debconf in 2002, and has been worked on since before 2006, and was announced on debian-devel-announce 2008-01-17. A status update message was sent 2008-03-16 and 2008-11-30. The default in Debian was changed to dependency based boot sequencing 2009-07-27, and an updated announcement about the plans for the boot system was sent out 2009-09-05. The default in Debian was changed to run scripts in parallel 2010-05-14 and an announcement was sent on 2010-05-21.

Status

This page was created to keep track of the state of this feature, to make it easier to coordinate an effort to implement it in Debian. It was proposed as a release goal for Lenny. It will be the default boot ordering method for Squeeze. During Debconf in 2009, the default in Sid was changed to use dependency based boot sequencing by default.

A number of bug reports are submitted to request LSB fields in init.d scripts. It is useful to track the ones open in testing as well.

A daily updated archive wide check of init.d scripts is available from http://lintian.debian.org/~pere/ . Piuparts now reports installation errors due to incorrect dependencies, and inconsistencies between update-rc.d calls and LSB fields.

Plan of migration

This is a proposal for a plan to migrate all of Debian over to dependency based boot sequencing.

  1. Change the debconf default in insserv to enable dependency based boot sequencing when the package is installed, if it is safe to do so. Show the question again on upgrades if the conversion isn’t done yet. Remove/disable the option to disable insserv after it is enabled.

  2. Change sysv-rc to depend on insserv, to pull it in on all (non-file-rc) installations.

  3. Wait 6 months, while rewriting policy text to document the new way update-rc.d is going to work.

  4. Drop support for specifying sequence numbers in update-rc.d.

This will enable dependency based boot sequencing for all in Debian from Squeeze and onwards.

How to solve migration problems

package X removed but not purged

If a script in /etc/init.d/ belongs to a package that is removed but not purged, the field is probably missing or is outdated. Purging the package will solve the issue.

package X left obsolete init.d script behind

The script was probably dropped from its package, but the package maintainer forgot to add code in the postinst to remove the obsolete script during upgrades. Removing the script is probably the correct solution. We have seen one report where dpkg would claim that a script was obsolete one time and not obsolete one upgrade later, so this should probably be checked a bit before the script is removed.

To verify that a package really left behind obsolete conffiles, one can run

dpkg-query -W -f='${Conffiles}\n' packagename | grep obsolete

There are several reasons why these scripts are not removed automatically during upgrades. First of all, reporting these issues exposes bugs that should be fixed in the individual packages. Second, it is hard to know if the script reported was left behind for a strange and particular reason, or just forgotten. And last, there is the one report that a non-obsolete script was reported as obsolete. Still not sure if that was for real or not, but until we know the reason, it seemed risky to just remove scripts in other packages during upgrades. Besides doing so from the sysv-rc postinst would be a policy violation.

insserv: warning: script 'X' missing LSB tags and overrides

The /etc/init.d/X script is lacking the LSB fields. Adding them to the script header or as a override file in /etc/insserv/overrides/X would solve it.

insserv: script X: service Y already provided!

Bug in the package with script X: The facility provided in script /etc/init.d/X uses a non-unique value. Changing it to a unique value (for example the script name without .sh ending), solves the issue.

Common problems with init.d script header LSB fields

Here are some problems I have seen with the LSB fields in init.d scripts during the last three years. I provide it here for those of you wondering if your package’s init.d scripts are correct.

  1. Non-unique Provides field
    • When two packages have scripts with the same Provides field, it will only be able to install these packages if the init.d script of the other is not present in /etc/init.d/. Packages sharing a common service with other packages could use virtual facilities instead of conflicting provides, or normal dependencies if few packages are involved.

  2. Incorrect runlevel list
    • If the Default-Start and Default-Stop fields do not list the runlevels where a script should be stopped or started, the wrong set of start and stop symlinks will be created when the script is installed, and the boot and shutdown sequence will most likely be incorrect. Fixing it require both updates to the fields, and code in the postinst script to add or remove symlinks that where missing.
  3. Missing dependency on $syslog when logging to syslog

    • Without it, services might be started too early during boot and some syslog messages might be lost.
  4. Missing dependency on $remote_fs when needing files in /usr/.

    • Scripts starting from rcS.d/ will start too early when /usr/ is on NFS, and will probably fail to work because some of its expected files and programs are missing when the script starts.

  5. Depending on incorrect or non-existing provides
    • The intended relationship with another script does not take effect, making the script run too early or too late during boot and shutdown.

To see the boot and reboot sequence dependency graph, use

aptitude install insserv graphviz
/usr/share/insserv/check-initd-order -g > boot.dot
/usr/share/insserv/check-initd-order -g -k > reboot.dot
dotty boot.dot
dotty reboot.dot

The list of packages whose init.d script is lacking an LSB header can be fetched from the lintian reports for the init.d-script-missing-lsb-section tag.

To enable dependency based boot, insserv can be used. At debconf7 and FOSDEM 2008 (video), Petter Reinholdtsen gave a talk about the dependency based boot system. To enable it in older versions of Debian, install insserv and activate it like this:

aptitude install insserv && dpkg-reconfigure insserv sysv-rc

Make sure to use insserv version 1.09.0-6 or higher.

To usertag related bugs, send an email to request (at) bugs.debian.org, with content like this:

user initscripts-ng-devel (at) lists.alioth.debian.org
usertag 361054 + incorrect-dependency
usertag 361358 + missing-dependency
thanks


CategoryBootProcess | CategoryDeveloper | CategoryPermalink