progress: speed up progress updates

We now keep the lists sorted at all times,
so we can do binary search.

list: add find_node_by_comparing_data method

Right now the list finding function looks soley by
pointer comparison.  This new method allows the user
to pass in a custom comparison function.

If we know the list is sorted, we take advantage of that
by using binary search over the list to zero in on the
right node.

list: add new insert_and_sort_data method

When needing to maintain a sorted list,
it's often nice to be able to just sort items
as they're inserted.  This prevents a lot of
excessive looping.

This commit adds a new function that will sort
the list if it's not already sorted, and then
maintain the sort for new items added with the
function.

list: drop node_set_data method

It's not used anywhere, so drop it.

progress: plug small memory leak

We weren't freeing the message structures.

main: NULL initialize "console" variable

check_for_consoles is a really small function, that has historically
been loaded with bugs.

This commit fixes another bug in it, where the consoles variable is
never initialized to NULL.

branch-merge: clean up socket name

The plymouth client talks to the plymouth daemon via
an abstract socket.  There aren't a lot of "rules" for
the name of the abstract socket, and so plymouth has just
used "/ply-boot-protocol" for the name.  While this is
perfectly valid, a number programs (hal, udev, etc) use
the convention "/org/freedesktop/program".

"/org/freedesktop/plymouthd" is certainly much nicer than
"/ply-boot-protocol" so we're going to change to that, and
fall back to the old name for compatibility.

One other niggle is trailing zeros in the name.  The socket
address is stored in a fixed size buffer.  Traditionally,
programms would pass the size of the entire socket structure,
including the full size of the aaddress buffer to bind and
connect.  This means that any NUL bytes in the address buffer
after the address become part of the address.  This means users
looking at /proc/net/unix will see all the extra NUL bytes.

One trick that some programs employee to skirt around this problem,
is to pass only the size of the structure less the trailing
NUL bytes of the address buffer to bind and connected.  While maybe
not 100% kosher, this works okay in practice.

plymouth will now use that trick as well.

protocol: change socket path

Before we were using

  /ply-boot-protocol\0\0\0\0...\0

for our address which really uglifies /proc/net/unix
and doesn't match what a lot of other programs do.

This commit changes the address to just

  /org/freedesktop/plymouthd

which is much nicer.

protocol: drop leading \0 from socket path

The socket path is currently defined to be:

 #define PLY_BOOT_PROTOCOL_SOCKET_PATH "\0/ply-boot-protocol"

The \0 is because it's an abstract socket, and abstract sockets
have a leading NUL.  The code always ignores the NUL though and
adds it back later, so it's not needed.

This commit just drops it.

utils: add support for "trimmed abstract" sockets

Right now plymouth listens on an abstract socket with a name
that has a bunch of trailing NUL bytes.  These zeroes uglify
the output of /proc/net/unix among other things.

This commit adds support for a new "trimmed abstract" socket
type, which drops the zeroes.

A subsequent commit will actually change plymouthd to use the
new api.

set-default-theme: redirect to /dev/null not /null

The set-default-theme script was incorrectly redirecting
stderr from a grep command to /null instead of /dev/null.

This causes a /null file to get created on the filesystem.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=30576
Reported by: David LeBlanc <leblancdw@yahoo.com>

viewer: Add a title to the status icon

set-default-theme: exit 0 at bottom of file

This is so that if there is no --rebuild-initrd it still
exits successfully.

terminal-session: add debug messages

terminal-session: try to continue logging after tty disconnect

Currently, we give up on boot logging after a tty disconnect.
This commit makes the terminal session reattach to the tty, and
continue logging.

terminal-session: rename "session_done" to "session_hangup"

In truth, we can get hangups at any time during boot.  It doesn't
mean the session is done, so use better terminology.

main: add __DATE__ to debug prolog

When looking at debug logs, it's often useful to know
how old the build of plymouth featured in the log is.

main: add plymouthd: prefix to some error messages

This will make it clear the error messages are coming
from plymouthd and not some other component during boot.

main: use ply_error_without_new_line for help string

It already has new lines in it.

utils: Improve debug spew in ply_create_daemon

Right now if plymouthd dies while daemonizing, we show a horrible
error message on the console:

could not read byte from child: Success

This commit mops that up, so we give a little clue why plymouthd's
child process died in its infancy.

main: Fix up check_for_consoles

commit c40fd792b6edf931a6bbe2ec23518b57483a4e2f was just wrong.

Attempt to fix it up to be less awful.

utils: plug memory leak

commit ffdfb78be1bcda708fd89faf645b582f88c6f1d5 introduced
a memory leak because of a copy-and-paste-o.

boot-server: print who is making requests

One of the big painpoints in plymouth distro integration
out which distro scripts are calling into plymouthd.

This commit makes plymouthd output that information whenever
there is a request from a connected client.

gitignore: Ignore generated script string files

script: Add compatibility redirect for set message function

client: Alias display-message command to message for backward compatibility

command-parser: Allow commands to be aliased

Adds aliases to commands which allow backward compatibility to old names.

script: Implement hide message function in the example script theme

This leaves ugly spaces where messages used to be, but is simple.

script: Add hide message support to the script plugin themes

This also renames SetMessageFunction to SetDisplayMessageFunction, and adds
SetHideMessageFunction

main: Inform plugins of hidden messages

Informs plugins of each message that is now hidden. Later could match on
wild-cards, but plugins will get a list of exact string matches.

boot-splash: Add "hide message" splash plugin call

No splashes use this yet.

boot-splash: Clean up indenting and function order

Display normal, password, quastion should be together

boot-splash: Clean up indenting

main: Remove the hidden message from the message list

The plugins are not updated unless they are switched off and on again

boot-client: Add hide-message client command

This renames "message" command to "display-message".

boot-server: Add "hide message" handler to boot server

Main server currently sets this to NULL to disable this callback.

protocol: Add "hide message" command to the protocol

This also renames the "message" command to "show message".

details: Implement display_message

Messages are queued until any question or password entry prompts
complete.

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

main: Open /proc/cmdline by absolute path

Open /proc/cmdline, not proc/cmdline.  (Technically this doesn't matter
in the daemon, since it's already done chdir ("/"), but the client does
need this and it's clearer to have them match.)

client: Open /proc/cmdline by absolute path

Open /proc/cmdline, not proc/cmdline.

[script] Add font selection argument to text to image capability

Enables scripts to choose the font they want with a sixth argument to
Image.Text API:
new_image = Image.Text("Hello", 1, 1, 1, 1, "DejaVu Bold,Italic 18");

[label] Add font controls to label plugins

[label] Factorize some font init code

[drm] plug driver_name leak

The previous commit accidentially added a small memory leak.
This commit mops that up.

[drm] Add preliminary support for libkms

This commit adds most of the pieces in place to use libkms, a
library by Jakob Bornecrantz, that abstracts the drm drivers
behind a common api.

Right now, we only fallback to libkms if the existing
backends won't work for the configured hardware.

In theory, this will give us pretty boot in virtual
machines, since libkms has support for the vmwgfx drm driver.

Aside from vmwgfx, libkms also supports intel and nouveau right
now.  When it supports radeon, too, I'll probably switch to
using libkms by default instead of as a fallback.  Eventually,
I'd like to drop all the non-libkms backend bits and the whole
driver vtable abstraction thing from plymouth completely.

This commit is just a copy-and-paste of one of the existing
drm backend files, with changes made to accomodate the libkms
api.  I haven't actually tested it, yet, so it will probably
need changes after I get a chance to do that.

[client] Update top line of help output

It said "Boot splash control client" before, but we do
boot and shutdown splashes.

[main] Update top line of help output

It said "Boot splash control server" before, but we do
boot and shutdown splashes, and the word "control" doesn't
make sense.

[two-step] Add prototype for exported function

[space-flares] mark functions static

[space-flares] Add prototype for exported function

Add prototype for exported function

[fade-throbber] Add prototype for exported function

[throbgress] add prototype for exported function

[label] add prototype for exported function

[label] remove bogus whitespace

[label] mark functions static

[throbber] drop unused variable

[throbber] fix incorrect cast

[animation] drop unsed variable

[animation] fix signedness warnings

[throbber] fix signedness warning

[region] clean up bogus whitespace

[region] drop unused variables

[region] mark do_test static

[rectangle] Remove bogus whitespace

[rectangle] drop unused variable

[region] Use correct type for loops

We were using ints when dealing with rectangles which
use longs.

[two-step] Don't crash if throbber is unavailable

While the code took some steps to make the throbber optional,
it missed conditionalizing usage of the throbber in the
exit path.

[animation] Properly handle zero animation frames

In the event there are no animation frames, we should
fail to load the animation control.

[drm] free stored connector

For most connectors associating monitors with our virtual
'heads', we merely track their ids.  This means we don't have
to bother freeing any client side state at deallocation time.

There's one exception, though.  The main connector, connector0,
we keep an open reference to.  We do this, because it owns the
mode object we use in SetCrtc calls.

This commit ensures that connector0 for each head is properly freed
when that head is deallocated.

[drm] Allow multiple monitors to share one controller

Some underpowered video cards will have multiple connectors
tied to one controller.  In this case all connectors get
the same "cloned" output automatically.

This commit detects this situation and prevents plymouth from
wastefully trying to allocate several frame buffers.  This
commit also prevents plymouth from constantly trying to switch
between those allocated frame buffers every frame of the animation.

[array] Support integer elements

Right now all array elements must be pointer values, or
at least pointer sized values.

This commit allows 32-bit integers as elements as well.

Revert "[drm] Store color depth in buffers"

This reverts commit 4469b8719e32cb179a4ae792e4aaf1bcf7789618.

It was really only needed for commit
625b82f2c3a4f7aa1ea90133fbbda854bd3c2f8d which we've now
reverted, so revert this one, too.

Revert "[drm] bail if not in 24bpp color mode"

This reverts commit 625b82f2c3a4f7aa1ea90133fbbda854bd3c2f8d.

Even if the kernel fb console is 8bpp, we can (and indeed do)
create our own 24bpp buffer, so the commit wasn't right.

[drm] bail if not in 24bpp color mode

Some server hardware gets initialized into 8bpp mode to
conserve memory.  We can't work in that mode, so we now
check for it and back early.

[drm] Store color depth in buffers

We only really support full color layouts at the moment
for kernel modesetting drivers, but this commit adds a
"color_depth" member to the buffer structs so we can at
least recognize non-conforming buffers.

[main] Properly handle no serial consoles

The previous commit introduced an error where
console could potentially be accessed while
NULL.

This commit addresses that problem.

[main] Ignore duplicate serial consoles on kernel command line

Right now if a user erroneously puts, e.g., console=ttyS0 twice
on their kernel command line, plymouth will open that tty twice
and write to it twice, and read from it twice, etc.

This commit filters those duplicates out.

[boot-splash] Add built-in plugin

There are times when plymouth is running that the filesystem isn't
accessible.  For instance, if a user has /usr as a separate partition,
then when first leaving the initrd, plymouth won't have access to its
plugins.

In those cases we really need to survive if the user hits escape.

This commit compiles details into the binary.  In this way, if the
plugins aren't available, we still have something to fall back to.

[main] Parse args at end of /proc/cmdline properly

We weren't treating \n as an acceptable boundary

[terminal] fix debug statement

It was missing an argument.

[configure] Bump configure to 0.8.4

We aren't doing a release yet, this is just prep work
for an eventual release.

[main] only look for a shell in valid returned prefixed strings

Fixes a segfault if no "init=" is present

[main] Don't watch for keyboard input if no keyboard

In the event should_ignore_show_splash_calls () returns
true, we won't ever have a keyboard set.  This commit
make sure that we don't try to use the keyboard if its
unavailable.

[main] Try to be smarter about init=/foo on kernel command line

Right now, we put plymouth into a sort of degraded mode when we
find init=/anything on the kernel command line.  This is so if
the user does init=/bin/sh to get fix their system, we don't
get in the way.

This breaks plymouth for things like init=/sbin/bootchartd and even
init=/sbin/init.  We've previously had a plymouth.override-splash
kernel command line option to force plymouth on in those cases.

This commit flips things around a bit.  Now init=/sbin/bootchartd
will work by default and there's a new option
plymouth.ignore-show-splash which forces things back into degraded
mode.  We also will implicitly do the degraded mode for e.g.
init=/foo/barsh

[main] Use plymouth.arg instead of plymouth:arg for kernel cmdline

Plymouth has historically used "plymouth:" to identify arguments destined
for it on the kernel command line.  Most other things seem to the period
instead of colon, so this commit just makes plymouth conform.

For compatibility, we still support the old way.

[main] drop all the open strstr calls

Our kernel command line processing is rather ad hoc.
This commit tries to clean it up a small amount by
adding functions to hide the strstr details.

[populate-initrd] don't croak when encountering broken symlink

Because of an apparent think-o in the script, if a custom theme
has a broken symlink in it, plymouth-populate-initrd would silently
stop processing files and ship an incomplete set of data files.

This commit changes "break" to "continue" so that broken symlinks
are ignored, which was probably the original intent.

[set-default-theme] Properly quote arguments to basename

It's important to make sure the theme name is properly
quoted when passed to the basename command.  This
is because, if the theme name is empty we want the empty
string returned, not the suffix that would otherwise be
stripped off.

Some discussion here:
https://bugzilla.redhat.com/show_bug.cgi?id=606634

[details] detach from event loop when quitting

If the user has the details plugin configured, and the
system does plymouth quit --retain-splash, then their
may be a crash.

This is because the plugin event loop exit handler will called
after the plugin is destroyed.  This commit makes sure
the exit handler is removed before the plugin is freed.

[main] try more aggressively to find a terminal

Before we defaulted to tty1, but some systems just
don't have tty1.  Normally, those systems specify
an alternate console on the kernel command line,
but not always.

This commit tries to make things work in those cases
as well.

I'd like to find a more generic way to make this all
work.

[terminal] Add OPOST to tty attributes

ONLCR apparently requires OPOST to work.

This should prevent weird "stair stepping"
effects when non-plymouth things try to
use the terminal.

[terminal] Force enter to output newline

This matches the default unix behavior, and so we're going to be a lot
more robust against our terminal settings getting mucked with.

[client] Fix watch-keystroke cancellation

If someone calls --ignore-keystroke then
the watch-keystroke command shouldn't get
run and the exit code should be different
than if it does get run.

[viewer] make boot messages show up in monospace

They're sort of designed for it, and look weird in some cases,
otherwise.

[viewer] add window icon

Before it was showing up as an ugly generic icon.

[throbber] fix drawing artifact

The code was using the wrong x and y values, which meant initially
there is an opportunity to draw a frame in the wrong place.

[event-loop] Handle more than 8 events at once

epoll_wait was getting passed a pointer to 64 events,
but was only being told to use up to 8 of those events
at a time because it was using sizeof (pointer) for the
argument specifying the number of events instead of the
actual number of events.

[drm] Try to maintain current mode when overridden

plymouth has naïvely been treating the first available mode in
the connector object as the active mode. While this is true
most of the time, it doesn't hold true if the user overrides the
mode on the kernel command line.

This commit changes things to look up the actual active mode, and go
with that, which should help prevent flicker at start up in some cases.

This patch is based heavily on a patch from Forest Bond
<forest@alittletooquiet.net> here:

http://lists.freedesktop.org/archives/plymouth/2010-June/000369.html

and first mentioned in commit abfda7550ac2fca6d816862e271126c2f44fa3cc

[drm] Make find_controller return the crtc not crtc id

This will give us the ability to look at the currently active
mode and so paves the way toward cleaning up a recently added
FIXME in the code.