upstart-events


Event Summary
       This  manual page summarizes well-known events generated by the Upstart
       init(8) daemon.  It is not an exhaustive list of all  possible  events,
       but rather details a standard set of events expected to be generated on
       any Ubuntu system running Upstart.

       The primary table, Table 1, encodes the well-known events,  along  with
       the  type  of  each event (listed in Table 2), the emitter of the event
       (see Table 3) and the approximate time at which the event could be gen-
       erated.  Additionally, the Note column indexes into Table 4 for further
       details on a particular event.

       The Ref (Reference) column is used to refer to individual  events  suc-
       cinctly in the Time column.

       Note that the '<' and '>' characters in the Time column denote that the
       event in the Event column occurs respectively before or after the event
       specified in the Time column (for example, the mounting(7) event occurs
       "at some time" after the startup(7)  event,  and  the  virtual-filesys-
       tems(7) event occurs after the last mounted(7) event relating to a vir-
       tual filesystem has been emitted).

       For further details on events, consult the manual  pages  and  the  job
       configuration files, usually located in /etc/init.


Table 1: Well-Known Event Summary.

+----+--------------------------+------+------+------------------------+------+
|Ref |          Event           | Type | Emit |          Time          | Note |
+----+--------------------------+------+------+------------------------+------+
|    | all-swaps                |  S   |  M   | > (5)                  |      |
|    | control-alt-delete(7)    |  S   |  A   | > (5)                  |  A   |
|    | container                |  S   |  C   | > /run mounted         |  Q   |
|    | dbus-activation          |  S   |  B   | > D-Bus client request |      |
|    | deconfiguring-networking |  H   |  V   | < non-local IFs down   |  P   |
|    | desktop-session-start    |  H   |  D   | > X(7) session created |  B   |
|    | desktop-shutdown         |  H   |  D   | > X(7) session ended   |  O   |
|    | device-not-ready         |  H   |  M   | > (2)                  |  N   |
|    | drm-device-added         |  S   |  U   | > (5)                  |  C   |
|    | failsafe-boot            |  S   |  X   | > (7) and local IF     |  S   |
| 7  | filesystem               |  S   |  M   | After last (1)         |  D   |
|    | graphics-device-added    |  S   |  U   | > (5)                  |  C   |
|    | keyboard-request(7)      |  S   |  A   | > (5)                  |  E   |
|    | local-filesystems(7)     |  S   |  M   | > (6)                  |      |
|    | login-session-start      |  H   |  D   | < DM running           |  F   |
| 1  | mounted(7)               |  H   |  M   | > associated (2)       |  G   |
| 2  | mounting(7)              |  H   |  M   | > (5)                  |  H   |
| 3  | net-device-added         |  S   |  U   | > (5)                  |  C   |
|    | net-device-changed       |  S   |  U   | > (5)                  |  C   |
|    | net-device-down          |  S   |  F   | < (4)                  |  C   |
| 4  | net-device-removed       |  S   |  U   | > (5)                  |  C   |
|    | net-device-up            |  S   | F,N  | > (3)                  |  C   |
|    | unmounted-remote-        |  H   |  V   | >   last   remote   FS |  L   |
|    | filesystems              |      |      | unmounted              |      |
| 6  | virtual-filesystems(7)   |  S   |  M   | > last virtual FS (1)  |  M   |
+----+--------------------------+------+------+------------------------+------+
       Key:
         'DM' is an abbreviation for Display Manager.
         'FS' is an abbreviation for filesystem.
         'IF' is an abbreviation for Network Interface.


Table 2: Event Types.

+----+------------+---------------------+
|Ref | Event Type | Notes               |
+----+------------+---------------------+
| H  | Hook       | Blocking. Waits for |
|    |            | events  that  start |
|    |            | on  or stop on this |
|    |            | event.              |
| M  | Method     | Blocking task.      |
| S  | Signal     | Non-blocking.       |
+----+------------+---------------------+

Table 3: Event Emitters.

+----+----------------------------------+---------------------------------+
|Ref | Emitter                          | Notes                           |
+----+----------------------------------+---------------------------------+
| A  | System Administrator (initiator) | Technically emitted by init(8). |
| B  | dbus-daemon(1)                   | Run with "--activation=upstart" |
| C  | container-detect job             |                                 |
| D  | Display Manager                  | e.g. lightdm/gdm/kdm/xdm.       |
| F  | ifup(8) or ifdown(8)             | See /etc/network/.              |
| G  | bootloader or initramfs          |                                 |
| I  | init(8)                          |                                 |
| M  | mountall(8)                      |                                 |
| N  | network-interface job            |                                 |
| S  | upstart-socket-bridge(8)         |                                 |
| T  | telinit(8), shutdown(8)          |                                 |
| U  | upstart-udev-bridge(8)           |                                 |
| V  | System V init system             |                                 |
| X  | failsafe job                     |                                 |
+----+----------------------------------+---------------------------------+

Table 4: Event Summary Notes.

+-----+-----------------------------------------------------------------+
|Note | Detail                                                          |
+-----+-----------------------------------------------------------------+
| A   | Requires administrator to press Control-Alt-Delete key combina- |
|     | tion on the console.                                            |
| B   | Event generated when user performs graphical login.             |
| C   | These  are  specific examples. upstart-udev-bridge(8) will emit |
|     | events which match the pattern, "S-device-A" where 'S'  is  the |
| J   | Initial event.                                                  |
| K   | Although the events are emmitted by init(8), the instigator may |
|     | be initctl(8) if a System Administrator has manually started or |
|     | stopped a job.                                                  |
| L   | /etc/init/umountnfs.sh.                                         |
| M   | Emitted when all virtual filesystems (such as /proc) mounted.   |
| N   | Emitted when the --dev-wait-time timeout is exceeded for  moun- |
|     | tall(8).  This defaults to 30 seconds.                          |
| O   | Emitted  when  the  X(7)  display  manager exits at shutdown or |
|     | reboot, to hand off to the shutdown splash manager.             |
| P   | Emitted by /etc/init.d/networking just prior  to  stopping  all |
|     | non-local network interfaces.                                   |
| Q   | Either  'container' or 'not-container' is emitted (depending on |
|     | the environment), but not both.                                 |
| R   | Emitted by either the  initramfs  or  bootloader  (for  example |
|     | grub)  as  the initial event (rather than startup(7)) to denote |
|     | the system has booted into recovery mode. If recovery was  suc- |
|     | cessful,  the standard startup(7) event is then emitted, allow- |
|     | ing the system to boot as normal.                               |
| S   | Emitted to indicate the system has failed to  boot  within  the |
|     | expected  time.  This event will trigger other jobs to forcibly |
|     | attempt to bring the system into a usable state.                |
+-----+-----------------------------------------------------------------+

Job States
Table 5: Job Goals and State Transitions.

+---------------+------------------------------------------+
|               |                   Goal                   |
|               +---------------+--------------------------+
|Current State  |    start      |           stop           |
+---------------+---------------+--------------------------+
|waiting        |  starting        n/a                     |
|starting       |  pre-start       stopping                |
|pre-start      |  spawned         stopping                |
|spawned        |  post-start      stopping                |
|post-start     |  running         stopping                |
|running        |  stopping        pre-stop / stopping (*) |
|pre-stop       |  running         stopping                |
|stopping       |  killed          killed                  |
|killed         |  post-stop       post-stop               |
|post-stop      |  starting        waiting                 |
+---------------+------------------------------------------+
       Key:
         (*) If there is a script or exec section and this process is running,
         state will be 'pre-stop', else it will be 'stopping'.


Job Lifecycle
   Starting a Job
       1  Initially the job is "at rest" with a goal of 'stop' and a state  of
          'waiting' (shown as 'stop/waiting' by the initctl(8) list and status
          commands).


       7  The state is changed from 'starting' to 'pre-start'.

       8  If the pre-start stanza exists, the pre-start process is spawned.

       9  If  the pre-start process fails, the goal is changed from 'start' to
          'stop', and the stopping(7) and stopped(7) events are  emitted  with
          appropriate variables set denoting the error.

       10 Assuming the pre-start did not fail or did not call "stop", the main
          process is spawned.

       11 The state is changed from 'pre-start' to 'spawned'.

       12 Upstart then ascertains the final PID for the job  which  may  be  a
          descendent  of  the immediate child process if expect fork or expect
          daemon has been specified.

       13 The state is changed from 'spawned' to 'post-start'.

       14 If the post-start stanza exists, the post-start process is spawned.

       15 The state is changed from 'post-start' to 'running'.

       16 The started(7) event is emitted.

          For services, when this event completes the main process will now be
          fully  running.  If  the job refers to a task, it will now have com-
          pleted (successfully or otherwise).

       17 Any jobs whose 'start on' (or 'stop on') condition would  be  satis-
          fied  by  this  job  being  started  are started (or stopped respec-
          tively).


   Stopping a Job
       1  Assuming the job is fully running, it will have a  goal  of  'start'
          and a state of 'running' (shown as 'start/running' by the initctl(8)
          list and status commands).

       2  The goal is changed from 'start' to 'stop'  indicating  the  job  is
          attempting to stop.

       3  The state is changed from 'running' to 'pre-stop'.

       4  If the pre-stop stanza exists, the pre-stop process is spawned.

       5  The state is changed from 'pre-stop' to 'stopping'.

       6  The stopping(7) event is emitted.

       7  Any  jobs  whose 'start on' (or 'stop on') condition would be satis-
          fied by this job stopping are started (or stopped respectively).

          iii
             If the process is still running after the timeout, a SIGKILL sig-
             nal  is  sent  to  the  process  which cannot be ignored and will
             forcibly stop the processes in the process group.

       9  The state is changed from 'killed' to 'post-stop'.

       10 If the post-stop stanza exists, the post-stop process is spawned.

       11 The state is changed from 'post-stop' to 'waiting'.

       12 The stopped(7) event is emitted.

          When this event completes, the job is fully stopped.

       13 Any jobs whose 'start on' (or 'stop on') condition would  be  satis-
          fied  by  this  job  being  stopped  are started (or stopped respec-
          tively).


AUTHOR
       Manual page written by James Hunt <james.hunt@ubuntu.com>

REPORTING BUGS
       Report bugs at <https://launchpad.net/ubuntu/+source/upstart/+bugs>

COPYRIGHT
       Copyright (C) 2011-2012 Canonical Ltd.
       This is free software; see the source for copying conditions.  There is
       NO  warranty;  not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
       PURPOSE.

SEE ALSO
       init(5)   init(8)   initctl(8)   mountall(8)   started(7)   starting(7)
       stopped(7) stopping(7) telinit(8)



upstart                           2011-03-24                 upstart-events(7)
Man Pages Copyright Respective Owners. Site Copyright (C) 1994 - 2017 Hurricane Electric. All Rights Reserved.