Use passive language in test-test-environment-setup.xml

Changes the single instance of "we" in this file.

Minor grammatical fixes.

Grammatical fix to test-nsm-dummy.xml

It now uses passive language throughout.

Other minor grammatical fixes

Make the description of the NSM dummy more clear to unfamiliar readers

Fix the link to test-luc-finish-only

Revert "Depend on systemd 37 to be able to build on Fedora 16"

This reverts commit 5dfb47b1b80d3aa91b8493491050b9d70c31c57b.

Finish documentation of build commands

Fix conflicting part/refentry IDs to make the building page show up

Add required command line utilities to build dependency docs

Add library dependencies for building to the docs

Depend on systemd 37 to be able to build on Fedora 16

Add parentheses in the shutdown mode rejection conditionals

Make shutdown mode registration similar in NSC and helper binary

The shutdown mode checker in the Node Startup Controller now uses the
same logging message as the legacy app handler helper binary.

The shutdown mode checker in the helper binary now uses the condition
statement from the Node Startup Controller

Make legacy app handler refuse invalid shutdown modes

Added code to the register signal handler to refuse any register signal
which is not a combination of NSM_SHUTDOWN_TYPE_NORMAL and
NSM_SHUTDOWN_TYPE_FAST and log an error.

Fix the title of the Test legacy application handler.

Replace the previous title by "Tests for legazy application handling".
Fix some paragraphs.

Better test case titles and always set the node state in TSM tests

Test titles are made more descriptive by including the name of the node
state which is being set.

A link is included to the enum which defines the NSMNodeState.

Tests are changed to always set the node state. This is done by
starting the unit twice in most cases. In addition, the less-important
lines in the DLT log output are no longer specified.

Capitalization in titles has been cleaned up somewhat.

Add the documentation for legacy app handling tests

Add the documentation for legacy app handling tests.
The following tests are provided:
 1. Register a normal and a fast shutdown consumer.
   - Check that node-startup-controller.service registers itself
     as a shutdown consumer.
   - Check that the registration for the shutdown consumer are ok.
   - Check that in the process of shutting down the fast consumers
     shutting down first and the normal consumers second.
   - Check that the shutdown consumers are unregister as a shutdown
     consumers when they have been shutting down.
   - Check that node-startup-controller.service unregisters itself
     as a shutdown consumer when it has been shutting down.

 2. Register two normal shutdown consumers
   - Check that in the process of shutting down the consumers are
     shutting down in reverse order of registration.

 3. Register a shutdown consumer twice within different modes and timeouts
   - Check that the re-registration modify the final mode to a combination
     of both modes (normal and fast) and the timeout has been set to the
     last registration value of timeout.
   - Check that in the process of shutting down the consumer is shutting down
     for the both modes.

 4. Register a shutdown consumer with invalid arguments
  - Check that register a consumer without unit name fails.
  - Check that register a consumer within mode 0 fails
  - Check that register a consumer with a negative timeout fails.

Document that timeout is non-mandatory parameter and its default value

Modify in the documentation for legacy app handler that timeout is a
non-mandatory legacy app handler argument and its default value is
1000 milliseconds.

Add NSM dummy documentation page

Restructure and number the Target Startup Monitoring tests

Tests are restructured in the same way as the previous commit

Number and restructure luc management test cases

Test cases are restructured into:
* Description
* Test Commands
* Desired behaviour and Output

Add missing XML files to the reference manual Makefile.am

Work on documentation of functional scope and interfaces

Also fix a mistyped systemd command.

Rework reference manual a bit, start reworking test case layout

Split test scenarios into separate pages, add legacy app skeleton

Each test scenario (i.e. luc, legacy app, tsm) has been split into a
separate file.

Setup steps which have to be performed for every scenario are moved into
test-general-setup.xml

Cross-references are used so that the test overview links to each test
case, and the "Testing" page links to the general setup and also each
test.

test-example has been removed because it is no longer necessary.

Add test scenarios for the Last User Context handling

The following test scenarios are added to the documentation:
* Registration of a simple dictionary
* Registration does not happen on an isolated RegisterWithLUC() call
* An isolated FinishLUCRegistration() call will not change the LUC
* Registration of a complex dictionary
* Registration can happen with a series of RegisterWithLUC() calls
* Repeated registration of an app changes the order in the LUC

Specify difference between NSM and NSM dummy in docmentation

Explicitly states the difference between the Node State Manager Dummy
and the real Node State Manager, i.e.
* The NSM dummy toggles between successfully setting the node state
  and failing to set the node state.
* The NSM dummy toggles between the LUC being required, and the LUC
  not being required.
* The NSM dummy will shut down its fast shutdown clients, then its
  normal shutdown clients, on receiving the SIGHUP signal

Add TSM test and improve layout of test document

The improvements to the layout of the test document are that the
individual tests will now show up on the table of contents.

The Target Startup Monitor (TSM) tests check that the following cases
attempt to change the node state:
* The Node Startup Controller starting
* focussed.target starting
* unfocussed.target starting
* lazy.target starting

The following case should not attempt to change the node state:
* focussed.target stopping

Add testing skeleton

Lays out the structure of the test document XML

Change required version of systemd from 37 to 183

Fix build instructions to include creating the m4 directory

Unregister exported D-Bus objects on finalization

Adds unregistration to the following services:
* legacy app handler
* shutdown client
* node startup controller
* nsm dummy lifecycle control
* nsm dummy consumer

Rework log messages a bit to make them more readable

Use DLT_LOG_INFO rather than DLT_LOG_DEBUG for everything

We can't get DLT to log our debug messages, setting LoggingLevel to 7
(LOG_DEBUG) in /etc/dlt.conf does not work as expected. So for now we'll
have to resort to logging all debug messages as info messages.

Adjust DLT log levels (info -> debug, some warnings, some errors)

Exclusively use DLT facilities to build log strings

We used to build the log strings using g_strdup_printf() but this
results in a certain amount of overhead and extra code.

Fix the name used for the LUCStarter::node-startup-controller property

Replace g_debug/g_warning calls with DLT logging

Unregister the NSM dummy DLT connection at exit

Fix small issues in Makefiles to make "make distcheck" happy

Rename all remaining bits and pieces

Rename service files and boot-manager binary

Rename BMGR DLT app ID to NSC, rename MGR context to CTRL

Rename BootManagerApplication to NodeStartupControllerApplication

Rename boot manager D-Bus interface and BootManagerService class

First step of renaming the Boot Manager to Node Startup Controller

This includes mostly files, directories and the package/tarball name.
The classes and D-Bus interfaces will be renamed in the next step.

Query the "active-state" property of units in the "job-removed" handler

Our previous attempt to fix the TargetStartupMonitor failed because when
a target is stopped, systemd drops the unit from the system bus and the
proxies we created in TargetStartupMonitor were no longer associated
with these unit objects that previously existed on the bus. When such a
target is started again, the proxy will no longer receive property
change signals from systemd.

This commit tries to implement the TargetStartupMonitor in yet another
way, which is to listen to systemd's "job-removed" signal again. In
response to receiving "job-removed" signals, we now create a SystemdUnit
for the affected unit and query that for its current "active-state"
value. Perhaps this will work.

Avoid a segmentation fault by fixing a GVariant format string

Retrieve invalidated properties before emitting "g-properties-changed"

It seems like the "active-state" property might be part of the
invalidated properties, not the changed ones. By passing
G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES to the proxy constructor
we force GDBusProxy to retrieve the new "active-state" value before
calling "g-properties-changed".

Hopefully this will fix TargetStartupMonitor for real.

Try the units' "g-properties-changed" signal to monitor the active state

For some reason the cached "active-state" property of the SystemdUnit
objects was NULL even when the "notify::active-state" signal had been
emitted.

Remove the assertion for an unused parameter

Apparently the callback for g_dbus_proxy_new() does not receive a
GDBusConnection as the first parameter, so this assertion fails.
However, since we don't need the parameter, we can just drop the
assertion.

Rework small bits of the legacy-app-handler documentation

Document the legacy app handler API

Rewrite TargetStartupMonitor to monitor ActiveState properties of units

Try to query systemd jobs synchronously in the "job-removed" handler

When we query the jobs asynchronously, systemd might have removed the
job we are looking for, and it will not be in the list of jobs it
returns. Perhaps querying jobs synchronously in the "job-removed"
handler helps to work around that.

Revert "Indicate the system manager that the job remove callback finished."

This reverts commit 97e53e2458589c5a7f7ad65b5af45626fa4d1ea1.

The "job-removed" signal doesn't expect signal handlers to return a
boolean value, so adding such a return value to our handlers will not
have any effect.

Fix built sources not always being built in common/Makefile.am

Add missing parentheses in macro definitions

These are difficult to spot but shouldn't have caused any problems
so far because we never use the affected macros in our code.

Remove LUC registration debug output

Indicate the system manager that the job remove callback finished.

Return a boolean to indicate is the job remove callback was
successful or failure.

Add even more debug output to TargetStartupMonitor

Add more debugging output to TargetStartupMonitor

Fix missing build rules for .c files of generated D-Bus sources

The order in which make processes the source files can be random. So
sometimes it will pick the -dbus.c file before the -dbus.h file. This
commit makes sure that we have a rule to build both in the Makefile.am
instead of just having a rule for the -dbus.h file.

Remove unused org.freedesktop.systemd1.Manager D-Bus methods

We don't need to generate code for these methods unless we actually
intend to use them.

Set the node state only in response to start jobs

The node state only should be set it for systemd start jobs.
To avoid setting the node state for other types of jobs like kill,
stop etc. we query systemd for a list of all jobs and check if
the type of the removed job is "start". Only then do we change
the node state.

Apply a few changes to fix make distcheck and regular builds

Add initial version of the reference manual templates

Most of the chapters in this manual still need to be written but this
is a start.

Add rudimentary gtk-doc support to the project

This includes adjusting the configure script to check for gtk-doc as
well as creating the necessary directories and Makefile.am files.

At the moment, no documentation is generated. We'll have to add initial
templates that include the docbook XML generated for the D-Bus API.

Add option to gdbus-codegen to generate DocBook for the public interface

Add --generate-docbook to gdbus-codegen in Makefile.am in order to
get the documentation for org.genivi.BootManager1.BootManager
interface. It makes a .xml file called
boot-manager-dbus-doc-org.genivi.BootManager1.BootManager.xml

Add build dependencies to the README file

Add licensing/build/testing instructions to the README file

Fix make distcheck, rework tests, reorganise files

This commit fixes make distcheck by making the LUC handler test part of
"make installcheck" and by disabling the legacy app tests in "make
check".

For the LUC handler test to not interfere with the LUC on the system,
the boot-manager binary is now aware of a LUC_PATH environment variable
that overrides the LUC_PATH string defined at build-time. This way we
can use a different LUC file for the test.

This commit also drops the nsm-dummy/dbus/ and nsm-dummy/systemd/
directories and moves the corresponding files to nsm-dummy/.

Fix a crash caused by using the old JobRemoved signature in JobManager

The signature of the JobRemoved signal recently changed in systemd, when
a new "unit" parameter was added. This commit changes the JobManager to
include this parameter in its JobRemoved handler and thereby avoids
segmentation faults caused by assuming fourth parameter is a JobManager
object.

Log more information when completing lifecycle requests

Use $(sysconfdir) and $(libdir) in NSM dummy Makefiles

Set node state in the TargetStartupMonitor when certain targets started

Set the node state from the TargetStartupMonitor when certain targets
have been started (focussed, unfocussed, lazy).

Also, add a NSMNodeState enum type to nsm-enum-types.{c,h}.

Use the WATCHDOG_USEC env variable to define the watchdog timeout

Also, set WatchdogSec to 5 seconds in boot-manager.service.in and
nsm-dummy.service.in.

The way this works is that systemd will take the WatchdogSec value,
convert it to micro-seconds and set the WATCHDOG_USEC environment
variable for the boot manager or nsm-dummy process. The boot manager
or NSM dummy then halves that value and creates the WatchdogClient
so that it calls sd_notify(0, WATCHDOG=1) twice in each
WATCHDOG_USEC interval. If WATCHDOG_USEC can't be parsed into a
number or if it is not set, the systemd watchdog timestamp is
never updated.

This is what systemd's requires services to do in order to support its
watchdog feature properly.

Add 'luc-groups-started' signal to send sd_notify(READY=1) to systemd

We need to notify systemd when the boot manager process has finished
starting the LUC. What we did so far was to call sd_notify() while
constructing the BootManagerApplication. This commit adds a
'luc-groups-started' signal to LUCStarter. BootManagerApplication now
connects to that in order to call sd_notify() at the right time.

Unregister the boot manager itself as a shutdown client

Unregister the boot manager as a shutdown client after it has been
shutting down. Handle gracefully the application lifecycle request to
manage the shutting down and the unregistration correctly.

Avoid compiler warnings due to casting pointers to uint

Check with NSM whether to load the LUC or not

If the NSM is not available or the NSMLifecycleControl proxy cannot be
created, we assume that we should start the LUC anyway.

Upon receiving SIGHUP, shut down all clients asynchronously

This is done by asynchronously processing the list of registered
shutdown clients once for each shutdown mode. We start with fast and
then continue with normal once all clients registered for fast shutdown
have been shut down.

This commit also implements waiting for pending lifecycle requests using
a timeout and advances to the next client in the queue if the timeout is
triggered before LifecycleRequestComplete is called by the client we are
currently waiting for.

Make sure to release the NSMConsumer in LAHandlerService

Otherwise we'd be leaking memory

Fix LifecycleRequest handler by returning a boolean value

This caused a GLib-internal critical warning about g_object_unref being
called with something that wasn't a GObject. It works fine now.

Register boot manager itself as a shutdown consumer asynchronously

Replace the synchronous registration by an asynchronous
registration for the boot manager. Gracefully handle/ignore any
errors in the finish callback apart from logging them using the DLT
framework.

Remove debugging output we no longer need

Make NSMShutdownType a flags type rather than an enum type

This makes more sense because enums are not supposed to be combined
using bitwise operators. Flags, however, exist exactly for this
purpose.

Move deregistration of shutdown consumers into LAHandlerService

LAHandlerService is a better place for this functionalit than
BootManagerApplication. Apart from this deregistration, anything related
to legacy app shutdown consumers is already handled solely by the
LAHandlerService anyway, so it makes sense to move the deregistration
there as well.

Allow shutdown consumers for legacy apps to be re-registered

Until now we always ignored re-registrations of legacy apps. In order
to allow the shutdown mode or timeout of a shutdown consumer for a
legacy app to be updated, however, this commit now forwards legacy app
re-registrations to the NSM.

Use an int for the --shutdown-mode/-m option of legacy-app-handler

This allows to register for multiple modes at the same time, e.g. by
passing in 3 for normal and fast.

Handle re-registration of shutdown clients by updating the mode/timeout

Whenever a shutdown client (now identified only by the bus name and
object path instead of bus name, object path and shutdown mode) is
registered a second or third time, we simply update the shutdown mode
by combining the old and new one with a bitwise OR. The shutdown
timeout is also replaced with the new one.

Deregister shutdown consumer when shutting down boot manager

Implement deregister shutdown consumer when boot manager is
shutting down. Change the shutdown tables replacing shutdown
consumers by shutdown clients. Modify in the same terms the
boot manager registration (from shutdown consumer registration
to shutdown client registration).

Fix the previous commit, forgot to rename the SIGINT handler

Use SIGHUP instead of SIGINT for simulating an NSM shutdown

In the SIGHUP handler, we no longer shut down the NSM process so that we
can keep it around for debugging purposes.

Fix corrupted list after reverse shutdown client traversal

The problem is that g_list_reverse() modifies the list in place, so in
order to not corrupt the shutdown client list of the NSMConsumerService,
we would have to copy the list. What this commit does instead is to not
call g_list_reverse() and instead traverse the list in reverse order
directly.

This commit also improves the shutdown logging a bit.

Implement the LifecycleRequestComplete by logging request ID and status

Start the boot manager D-Bus services in main()

Before we started them in boot_manager_application_constructed() but
that meant that we could not react to errors properly. We now log a
fatal error using the DLT framework and exit if we can't bring up the
D-Bus services.

Improve shutdown handling, keep shutdown clients around afterwards

Use the new ShutdownClient class to bundle information about registered
shutdown clients and their units, modes and timeouts.

Do not remove shutdown clients from the registered clients list after
shutting them down. Instead, wait for a separate unregister request.

Shut clients down mode by mode when receiving SIGINT. Start with clients
registered for fast, then continue with clients registered for normal.

Improve logging output a little bit.

Add new ShutdownClient class to bundle information about consumers

Objects of this class store the bus name, the object path, the shutdown
mode, the shutdown timeout and a ShutdownConsumer proxy or skeleton for
a shutdown consumer.

Implement a shutdown consumer for the boot manager itself

Create a ShutdownConsumer skeleton in BootManagerApplication and
implement its "handle-lifecycle-request" signal to shutdown the
process.

In addition to that, the "handle-lifecycle-request" implementation also
cancels the LUC startup. It replaces the SIGINT handler, which is
removed with this commit.

Fix the systemd unit associated with the boot manager D-Bus service