two-step: set is_idle=TRUE at shutdown time

Right now, we do the end animation immediately if in
shutdown mode.  This is because shutdown is fast,
and we don't try to estimate how long it will take.

The code depends on is_idle being true after the end
animation is run, but we neglect to do that in the
shutdown case.

This commit makes shutdown mode just call
"become_idle" right away, and deletes the duplicated
shutdown code path.

drm: flush pending draw to kernel buffer on vt switch

When plymouth's VT is not the foreground VT, we tell the
kernel not to scan out from the kernel buffer we manage.
Also, we don't bother dispatching rendering to the kernel
buffer (since it's not getting scanned out anyway).

When plymouth's VT becomes the foreground VT, we tell the
kernel to start scanning out from our buffer again.
Unfortunately, we neglect to flush all the pending drawing
that happens while VT switched away.

This means we briefly show stale contents.

This commit flushes all pending rendering to the kernel,
before resetting the scan out buffer, so we get a current
view of the splash shown immediately.

drm: don't set mode initially if on different vt

In the shutdown path we start out on a different
vt than where the splash is drawn.  Make sure we
don't set a mode until the jump.

This prevents unnecessary flicker.

Revert "main: force frame-buffer plugin at shutdown"

This reverts commit 3f14f2700e031e6fbb674ebb1ab86a73b4469dc8.

Forcing frame-buffer plugin makes multi-monitor look really bad.
Instead, depend on the init system to make sure we stay alive
until the end.

systemd: pull units from systemd tree

Kay and Lenny want the service files shipped with plymouth
instead of systemd, so toss them into the tree.

main: rename process to be more systemd friendly

Systemd will cleanse the system of running processes
in the hand over from the initrd to the main root filesystem,
and at shutdown.

In both cases we want to keep on chugging, so we tag ourselves
in a way that systemd won't kill us.

See http://www.freedesktop.org/wiki/Software/systemd/RootStorageDaemons

drm: for minimum buffer size to be greater than 0

The drm driver tells us the minimum dimensions it supports
for buffer objects.  We use this minimum for creating a
small temporary 32-bit buffer to test if 32-bit buffers
are supported.

Unfortunately, some drivers neglect to fill in
min_width/min_height and then we try to allocate a buffer
with 0 sized dimensions.

This commit checks for min_width/min_height being 0, and then
bumps them to 1.

Minor changes to initial patch by Ray Strode.

client: add new flush api

In some cases, clients may need a way to ensure that all queued
messages have been flushed and are sent to the daemon
(before, for instance, exiting).

This commit adds an API to block until the outgoing request queue is
empty.

docs: Add keyboard shortcuts

This commit adds four keyboard shortcuts to the developer
documentation that were found from reading the source:

Esc: Toggle between system console and plymouth boot animation.

Ctrl-V: Toogle verbose mode on and off.

Ctrl-U or Ctrl-W: erase a line

docs: do a pass over new development.txt

I just did a quick read through and made various changes here and
there.

docs: specify where to send contributions

docs: Start document for developers

This commit starts to document plymouth to help
new contributors get into the code.

The aim of the document is to provide useful information,
such as the overall architecture, the most
important data structures, and howto recipes for
typical user cases, like debugging.

The document is explicitly not meant to be detailed API documentation.
In the future, that type of documentation may be provided with gtk-doc
style annotations.

The documentation is written in asciidoc
(http://www.methods.co.nz/asciidoc/) and is therefore easily readable as
its ascii text and can also be translated into more rich formats
(like HTML).

For example, to get an HTML version of the document:

yum install asciidoc (or equivalent for your distribution)
cd docs
make development.html

two-step: quit properly when boot finishes while waiting for password

When the computer is progressing through its boot up process, plymouth
calls into the splash plugin's on_boot_progress function at regular
intervals with increasing values for "percent_done".  At some point, it
gets to 90% done, and that's when two-step begins its finishing
animation sequence.  As soon as this sequence finishes, two-step pulls
its stop trigger, which

1) sets its "is_idle" flag to true and
2) pulls the core plymouthd code's idle trigger, to notify that
   code that it's at a good animation frame to quit (if the core
   plymouthd code has an idle trigger set up)

During the boot process, the user may need to enter a password
(the "plymouth ask-for-password" command).  When that happens,
the splash waits for the user to enter a password, but boot progresses
in the background.

If the user then enters a password, the boot animation restarts again
(from the display_normal function).  This restarting of the boot
animation will cause the "is_idle" flag of the splash to get set back
to false.

Later when plymouthd wants to quit, it calls the become_idle function
of the splash plugin. That function notices "is_idle" is false, and
the stop_trigger is not NULL.  The function isn't suited to work
with this combination, and so at this point the splash never
tells the code daemon code it's idle.

This commit changes on_boot_progress to return before looking at
percent_done, if the user is getting asked a question.  This way
the stop_trigger won't get created prematurely, and is_idle won't
get out of sync.

https://bugs.freedesktop.org/show_bug.cgi?id=49355

drm: rename ENABLE_GDM_TRANSITION to ENABLE_GDM_DEPRECATED_TRANSITION

Most distributions no longer use this transition, which relies
on plymouth quitting before X starts.

For clarity, rename the #define to include the word DEPRECATED

drm: add generic driver to drm renderer plugin

Since around 2.6.39, the kernel has offered a generic ioctl interface
for modesetting (the KMS 'dumb' interface).  This interface is now
provided by most all of the modesetting drivers.

Adding support for this interface means that plymouth will automatically
gain support for new modesetting drivers going forward.

This commit adds that support. Some changes made by Ray Strode.

label: add alignment and width for labels.

A ply_label can now be alignment with ply_label_set_alignment()
taking one of PLY_LABEL_ALIGN_LEFT, PLY_LABEL_ALIGN_CENTER, or
PLY_LABEL_ALIGN_RIGHT.

This alignment is made within a horizontal box which width can be set with
ply_label_set_width().

Both functions are now used by the plugin "two-step" to make sure, that
the prompt for "ask-for-password" gets centered on the screen. Previously
the prompt started in the middle of the screen and was cropped at the right
border of the screen (fixes bz #681513). This lead to unreadable prompts
for disk encryption.

drm: use queried minimum size, not 1x1 for dummy buffer

The previous commit tries to create a 32bpp 1x1 dummy buffer
to know whether or not the modesetting driver can handle
our needs.  It's concievable (though not realized in practice) that
the driver could support our needs fine, but not support buffers
as small as 1x1.

This commit uses the queried minimum buffer dimensions for the dummy
buffer instead of assuming 1x1.

drm: ensure modesetting driver supports 32bpp fb

Now that more and more hardware is getting kms support,
we need to be more careful about what hardware we try to
run on.  Cirrus cards can't make 32bpp framebuffers, which
is all we support in the drm renderer.

This commit tries to create a small buffer up front, just
to see if the driver will allow it.  If the driver chokes,
then we bail and fall back to the /dev/fb renderer, which
is more tolerant of aging hardware.

main: corrected error in read_consoles_from_file

main: fix bug in add_consoles_from_file

commit 6baab7a8f889f6b48cb559fd5a62750203f62c3b was the
result of Ray Strode splitting part of a larger patch
out. The splitting and subsequent modifications weren't
completely right.

This commit contains some fixes to address the problems
with those changes.

main: add plymouth.ignore-serial-consoles

This commit adds plymouth.ignore-serial-consoles kernel command
line for OLPC to use.

Eventually, we'll support multiple plugins at once, and we can
run details on the serial console and e.g. two-step on the main
console and then this argument won't be needed.

Revert "main: add way to ignore /sys/class/tty/console/active"

This reverts commit 9e3071520db104b6a87a7f6a011e83319db4b586.

This command line option is sort of awkward. It would be better
to provide a kernel command line escape hatch.

main: add default console for default scenarios

commit e810532e5d2387e121bbded67c1b4cccc01dda4c contained
a function called add_consoles_from_file that was a badly
modified version of add_consoles_from_kernel_command_line
changed to read from /sys/class/tty/console/active instead
of /proc/cmdline.

Previously, if we had console=SOMETHING on the kernel command
line, then we would assume the user is using serial consoles
and force details.  This translated to if add_consoles_from_file
finds any devices in /sys/class/tty/console/active force details.

Of course, /sys/class/tty/console/active contains tty0 even when
the user doesn't specify console=tty0 on the kernel command line,
so this broke show-splash calls.

This commit changes the logic bit.  We now only force details if
there is some console in the list that isn't tty0.

This restores show-splash functionality.

main: make add_consoles_from_file more robust

add_consoles_from_file was a little fast and loose in its parsing.

This commit makes it a little more fault tolerant.

Patch split from larger patch, and modified by Ray Strode.

event-loop: hold reference to ready sources while handling timeouts

If ply_event_loop_handle_timeouts() is called before the events returned
by epoll_wait() are given references, a timeout handler can prematurely
free an event source by calling ply_event_loop_stop_watching_fd leading
to crashes and other undefined behaviour since
ply_event_loop_process_pending_events() dispatches the event sources
returned by epoll_wait() after the timeouts have been handled.

Thanks to cjwatson for a simpler solution to my original fix.

Minor changes by Ray Strode.

https://bugs.freedesktop.org/show_bug.cgi?id=28548

event-loop: drop redundant EINTR/EAGAIN check

We check it a couple lines earlier in the code, so
there's no reason to check it again.

main: add way to ignore /sys/class/tty/console/active

Previously OLPC used --kernel-command-line to make plymouth
ignore specific consoles.  That no longer works, now that we
read from /sys/class/tty/console/active

This commit adds an escape hatch, a way to get back to the old
behavior.

main: rename remaining_command_line to remaining_file_contents

add_consoles_from_file suffers from a sever case of
cut-and-paste-itis.  This commit renames its variable
"remaining_command_line" to "remaining_file_contents" so that
the variable name actually makes sense.

main: more console fixes

When parsing /sys/class/tty/console/active,
we need to make sure we jump over spaces in
the command line

main: only force details if system has non-tty0 console

Right now we're unconditionally forcing details mode,
which is clearly wrong.

populate-initrd: add new location for dracut source functions

main: more console fixes

main: break out of loop when hitting trailing new line

It's important to ignore chunks of the active tty buffer
that are just whitespace.

main: fix inverted conditional in active console reading code

We were failing when read succeeded, not when it failed, so
we were always reverting to fallback.

main: strdup default tty

Just noticed a memory management problem when looking through
the code.

main: Also show splash for 'splash=silent' arguments (which is what we use in Mageia)

main: Fix parsing of plymouth.debug=stream: argument.

It did not terminate at space so the log file to use was not
properly defined and any additional kernel command line args were
added to the end of the file name.

ulibc: Change the link order + add -ldl

ulibc linking is a bit more particular than regular glibc

ulibc: Make the /usr/lib substitution less greedy.

ulibc: Add header needed when compiling against ulibc

frame-buffer: use /dev/fb0 as default device

The /dev/fb symlink doesn't get created with any recent udev version.
dracut puts it in place "by hand" before starting plymouthd, which is
why things aren't broken in configurations that use dracut's plymouth
module.

Update the default device path so that it works out-of-the-box in
other setups too.

ply-splash-graphics: ensure link in config file

While building a theme externally I found that the link to
libply-splash-graphics was missing, due to an omission in the config
file.

plymouth-populate-initrd: Check for new path to dracut-functions

Revert "Hang around until killed by init at shutdown"

This reverts commit 841068ba125f30fedd52b62490c6a7424b30c768.

That commit made plymouthd hang around until the last round
of slayings by init to keep the splash screen up as long as
possible.

That adds 5 seconds to shut down in some cases, though, so
is wrong.  Instead we need a solution that keeps the splash
around after plymouth exits.

See http://bugzilla.redhat.com/744932

main: read consoles from /sys/class/tty/console/active

We currently read the list of available consoles from the
kernel command line.

This isn't the most reliable way to do things.

This commit changes the code to read

/sys/class/tty/console/active

instead.

main: close all terminals, not just local console terminal

It's important we close all terminals in the shutdown path,
so they all get unlocked and returned to cooked mode.

Previously, we would just close the local console terminal,
which meant other terminals would end up left in a broken state.

main: rename state->terminal to state->local_console_terminal

state->terminal is used for VT handling code.  To make it clear
what its role is, rename it to state->local_console_terminal.

main: don't overwrite state->terminal if there are multiple consoles

We call the add_display_and_keyboard_for_terminal function for
every console passed into the kernel command line and once for
/dev/tty1 if no console line is passed in. This function
repeatedly, reinitializes state->terminal with whatever
terminal is passed in each time its called.

This commit changes add_display_and_keyboard_for_terminal to not
touch state->terminal and instead makes the callers do it
(if appropriate)

boot-splash: deduce terminal from text display

Right now we pass a terminal to the constructor of the boot splash
object.  This terminal is used for going to KD_TEXT mode when
ctrl-T is tapped or when hiding the splash.

We only need to do this, though, when:

1) we're running on a local vt
2) we're showing graphics

the boot-splash code has all the knowledge it needs to figure these
two things out on its own, and furtermore it already can figure out
which terminal is the relevant one without being told at construct
time.

This commit adds those smarts to the boot splash code.

main: fix kernel command line parsing

check_for_consoles has another bug (surprised?) where it would
jump too many characters forward if the command line has
console=tty0 in it, since tty0 is transparently changed to /dev/tty1.

main: plug fd leak

This plugs an fd leak in an error path

utils: drop ply_list_directory

It's unused code

utils: plug dir fd leak

This commit calls closedir() in an error path.

logger: plug fd leak

This plugs an fd leak in an error path.

text-progress-bar: plug fd leak

This plugs a fd leak in an error path

client: fix fd leak

This plugs an fd leak in an error path

README: resync from wiki

walters pointed out the README had some stale information in
it.  I've copy and pasted the wiki text in, now, so there
will be hopefully a small quantity of said stale information.

autogen.sh: rework to be more buildsystem friendly

One of the goals laid out in
http://people.gnome.org/~walters/docs/build-api.txt
is to get projects to have autogen.sh scripts that
don't invoke configure after generating it.

This commit does that along with some other small
modifications designed to help be more confromant
with the Build API referenced in the above url.

https://bugs.freedesktop.org/show_bug.cgi?id=41629

event-loop: use static buffer instead of stack allocation buffer

alloca() isn't a good idea to use, in general, because it provides
undefined behavior when it fails.

This commit changes the epoll event buffer from being stack allocated
to static to avoid any potentially problems resulting from stack
space exhaustion.

https://bugs.freedesktop.org/show_bug.cgi?id=41562

README: spelling fix.

This changes the mispelled word analagous to the
word analogous.

https://bugs.freedesktop.org/show_bug.cgi?id=41196

throbgress: add plugin decelartion

This should fix the build.

https://bugs.freedesktop.org/show_bug.cgi?id=40240

throbgress: make colors configurable

This commit makes the background start and
background end colors configurable in throbgress.

Revert "Add --nowait option."

This reverts commit c926bccd83ed1391df80adfecd1229b0327e1f11.

It was an in-progress patch that I carelessly and erroneously
pushed.

x11: translate enter to new line

commit 4081bd29fb471a93daba746643419d858f06bdfe changed
our keyboard handling code to treat newline instead of
carriage return as the enter key.

That commit fixed up the tty settings to work under these
new assumptions.  It failed to update the X11 code, though.

This commit fixes the X11 renderer plugin so it works in
the same way.

Add --nowait option.

With --nowait option, plymouth will not wait for reply from plymouthd.

progress-animation: allow 0 frame animations

Currently ply-progress-animation crashes if you try to pass it
an animation with 0 available frames.

This commit makes it silently succeed.

two-step plugin: free plugin->animation_dir when destroy

key-file: minor code shuffle

Move things around to avoid false positives in coverity.

main: fix console=/dev/tty special case

commit 1d09ad7d51e803e56b52c4e84dd558a7ac4d2e39 contained a mistake
where it checked for "tty" twice instead of "tty" once and "/dev/tty"
once.

This commit fixes that error.

main: special case console=tty

Some people use console=tty in the same way they'd expect
console=tty0 to work.

This commit makes them behave the same way.

keyboard: handle kernel terminal EIO better

In commit 89096d735f78fab300248962030d6554f9894011 we added
reopen retries when the kernel returns EIO to ply-terminal.c.

This is because when the kernel is closing a tty down, that
tty is unavailable to userspace to reopen.

Unfortunately, that commit neglected to inform the ply-keyboard
part of the code when the terminal retry was successful.  The
upshot of this, is that if plymouthd needs to retry opening the
tty, then the splash screens lose control over the keyboard.

This commit changes how input notification is sent to the keyboard
handling code, so the tty disconnects are transparent.

main: allow log output to be redirected

Sometimes putting debug output on the screen has strange side
effects.  This commit adds a new kernel command line option,
e.g:

plymouth.debug=stream:/dev/null

that moves the output "out of the way"

main: write pid file and daemonize last

These actions serve to notify plymouthd's readiness.
We should make sure they are run after plymouthd is actually
done starting up.

main: write pid file even when not daemonizing

This commit moves the pid file writing code to main
from ply_create_daemon, so that it gets run even when we
plymouthd isn't daemonized.

This is more symmetrical, anyway, since unlinking of the pid
file is handled in main.

text-progress-bar: Add support for /etc/os-release

Systemd uses '/etc/os-release' as release file, see
http://0pointer.de/public/systemd-man/os-release.html

main: force frame-buffer plugin at shutdown

This way we hopefully won't get kicked out of KD_GRAPHICS
mode when we're SIGKILLed causing the splash to disappear
prematurely.

main: fix ply_mode_t/ply_boot_splash_mode_t confusion

They're very similar enums and I was using the wrong one,
which caused a harmless compiler warning.

renderer: provide way to override renderer plugin

This will allow us to force e.g. frame-buffer even
if drm would work.

main: create runtime directory if it doesn't exist already

This makes sure there is a convenient place to put pid files.

gdm: don't do legacy gdm transition at shutdown

systemd: change instrumentation points for systemd

We don't want to enable console verbosity until the splash is up,
and we want to disable it as soon as we aren't logging the console
anymore.

configure: s/text/test/

Just a typo from the previous commit

systemd: toggle systemd messages when toggling console redirection

Normally systemd is very mute about messages.  It's important,
though for it to be chatty when plymouth is running so we can
show verbose messages to the user when they hit escape.

This commit adds a new --enable-systemd-integration configure
flag which explicitly tells systemd when to print messages to
the console.

This may get dropped in the future in lieu of init script
changes doing this instead of plymouth directly.

main: consolidate ply_terminal_session_detach calls

It's called in several places through the code. This commit
moves it into a function and just calls that function instead.

client: small leak fix

utils: drop some bizarre looking code

splash: add new spinner theme

This is a very simple theme with a small spinner on a dark background.

main: add new --kernel-command-line option

It's really annoying when you're running plymouthd in
debug mode and don't happen to have "splash" on your kernel
command line and then need to reboot.

This commit adds a new debug option to override the kernel
command line for ths system.

progress-animation: fail load if there are no frames

If there are no progress animation frames we need to
fail from the load function so plugins can deal with it
gracefully..

two-step: make progress animation optional

upstart-bridge: add new helper program

This commit adds a new program, plymouth-upstart-bridge,
the listens for upstart state changes and sends them to plymouth,
or prints them out as appropriate.

client: allow reply handlers to be optional.

This commit lightens the hard requirement that every
client request has to have a function handling the reply.

There's really no reason to be so strict, and it makes
life easier for none /bin/plymouth clients this way.

drm: don't light up unlit monitors

If a monitor is dark when plymouth is started, we shouldn't
try to light it up.  There are rules on which outputs can be
attached to which controllers and we're very likely to break
those rules just assigning things willy-nilly.

The kernel should set us up in the way it thinks is best anyway.
There's no reason to second guess the kernel here.

terminal: Keep retrying to reopen tty on EIO after hang up

If the tty hangs up on us, the kernel will return EIO while it's
closing down.  As far as I know, there's no way to get notified
when it's back up again, so just keep retrying in a loop over
the course of a second or so.  Eventually give up, though.

This is really suboptimal and suggests we should get away from
using ttys for input at some point.

client: do not wait forever if daemon is not started

Currently plymouth --wait will wait forever if daemon is not
started. This does not look right - we were asked to wait for
daemon to stop and daemon is obviously stopped. So make it
exit right away in this case.

This avoids timeouts during systemd boot if plymouth happened to be
stopped (or never started) before plymouth-quit-wait had chance to
start.

Signed-off-by: Andrey Borzenkov <arvidjaar@gmail.com>

terminal: apply terminal settings immediately

utils: don't depend on PAGE_SIZE

It's not defined for all architectures.

We don't really need the page size anyway, we just need a reasonably
large value.

main: convert tab to spaces

tests: don't run during make check

They aren't unit tests so running them in make check is wrong.

Eventually, I'd like them to be unit tests, though, and not
just little scratch programs.

terminal: unlock tty before mucking with it

It seems that sometimes when the tty is stolen from us
it remains locked when we get it back.  That would be okay
if the attributes were still kosher, but they aren't.

This commit unlocks the tty before trying to reinitialize
the terminal with suitable attributes.

Debugged by Andrey Borzenkov <arvidjaar@gmail.com>