Fix mistakes in cptest asserts
[oweals/dinit.git] / TODO
diff --git a/TODO b/TODO
index 07e9236e379a73fdc1367a563dd5766f3313447f..a90c4a73ffcf291825976d8bdd0ae61735a46b75 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,61 +1,77 @@
-* CPBuffer: cleanup methods a bit (fix API)
-* When a PROCESS service process dies, and smooth_recovery is false, probably
-  need to force-stop dependents even if the process itself was stopped
-  deliberately.
-* Complete control socket handling and protocol
-  - support for pinned-start and pinned-stop
-  - support for listing all services
-* Implement a control utility to start/stop services after dinit has started
-  - very basic version exists, needs thorough cleanup
-* We've replaced libev, so that we don't abort on failure. But now exceptions
-  can be thrown when we register an event watch - need to handle these.
+For version 0.9.0:
+------------------
+* "chain-to" can result in an unbreakable loop if the chain is circular. Chained services should not be
+  started during shutdown to prevent this (also avoids a race condition where the chained service is left
+  running when everything else has shutdown).
+* Check that desired_state is getting set correctly. (Currently we don't decide whether a service
+  will restart until it stops...)
+* Add dinit command line option to run as pid 1 but not as system manager (i.e., in a container).
+  Currently dinit can be used as pid 1 in a container but it may try to shut down the system when
+  it terminates. (This results in a harmless warning, but is not ideal).
 
-For version 1.0:
-----------------
-* Log messages need to be duplicated to file (or to a logging process) once the
-  file system comes up read/write.
-* Log messages are completely prevented from going to the console if the console
-  is being held by a service, meaning some can get lost. It would be better if
-  there was a (limited) buffer.
+For version 0.10.+:
+------------------
+* for non-system init, fail if the control socket exists, with option to override this and re-
+  create the socket instead (as system init does).
+* report process launch failure reason (stage & errno) via dinitctl.
+* Show "activated" state in "dinitctl list" output
+* Service description sanity checks:
+  - Service type not specified
+    - maybe default to 'internal' if command not specified
+    - if command specified but type not, report an error
+    - other checks?
+  - errors should also be reported by dinitcheck
+
+For version 1.0 (i.e. longer-term plans):
+-----------------------------------------
+* Service description parse errors should report line number
+* dinitcheck should perform lint checks - do named files exist? etc
+* Limit memory use by control connections. Currently clients can queue commands without limit.
+* Consider using mlockall (if system process).
+* Dinitctl command to get full status of a service.
+* "triggered" service type: external process notifies Dinit when the service
+  has started. (maybe?)
+  - key thing is we want some way to eg mount filesystem once the disk comes up,
+    configure network when device comes up, etc, potentially relying an an external
+    tool/daemon.
+* on shutdown, after repeated intervals with no activity, display information
+  about services we are waiting on (or, do this when prompted via ^C or C-A-D).
+* Documentation must be complete (see section below).
+* Proper support for socket activation?
+* Chaining of service process input/output?
+* Be able to boot and shutdown Linux and FreeBSD (or OpenBSD).
+
+For later (post 1.0):
+---------------------
+* On linux when running with PID != 1, write PID to /proc/sys/kernel/cad_pid so
+  that we still receive SIGINT from ctrl+alt+del (must be done after /proc is
+  mounted, possibly could be left to a service script)
 * Perhaps need a way to prevent script services from re-starting.
   (eg there's no need to mount filesystems twice; there might be various other
    system initialisations that can't or shouldn't really be "undone" and so do
    not need to be re-done).
-* Documentation including sample service definitions
-* Better error handling, logging of errors (largely done, still some patches
-  of code where it may be missing).
-* Write wtmp entry on startup (see simpleinit)
-* Allow running services as a different UID
-* On linux when running with PID != 1, write PID to /proc/sys/kernel/cad_pid so
-  that we still receive SIGINT from ctrl+alt+del (must be done after /proc is
-  mounted, possibly could be left to a service script)
-
-For later:
 * Internationalisation
 * A service can prevent shutdown/reboot by failing to stop. Maybe make
   multiple CTRL-ALT-DEL presses (or ^C since that's more portable) commence
   immediate shutdown (or launch a simple control interface).
-* Interruptible scripted services - where it's ok to terminate the start
-  script with a signal (and return the service to the STOPPED state). So a long-
-  running filesystem check, for instance, need not hold up shutdown.
 * When we take down a service or tty session, it would be ideal if we could kill
-  the whole process tree, not just the leader process.
-* Investigate using cn_proc netlink connector (cn_proc.h) to receive process
-  termination events even when running with PID != 1 (Linux only).
-  Also, there is the possibility of having a small, simple PID-1 init which
-  sends terminated process IDs over a pipe to Dinit. Finally, it may be possible
-  to run dinit (and subprocesses) in a new PID namespace (again linux-only).
+  the whole process tree, not just the leader process (need cgroups or pid
+  namespace or other mechanism).
 * Allow logging tasks to memory (growing or circular buffer) and later
   switching to disk logging (allows for filesystem mounted readonly on boot).
   But perhaps this really the responsibility of another daemon.
-* Rate control on process respawn
 * Allow running services with different resource limits, chroot, cgroups,
   namespaces (pid/fs/uid), etc
-* Make default control socket location build-time configurable
-* Allow specifying a timeout for killing services; if they don't die within
-  the timeout (after a TERM) then hit them with a KILL.
+* Support chaining service output to another process (logger) input; if the
+  service dies the file descriptor of its stdout isn't closed and is reassigned
+  when the service is restarted, so that minimal output is lost.
+  - even more, it would be nice if a single logger process could be responsible
+    for receiving output from multiple services. This would require some kind of
+    protocol for passing new output descriptors to the logger (for when a
+    service starts).
 
 Even later / Maybe never:
+-------------------------
 * Support recognising /etc/init.d services automatically (as script services, with
   no dependency management - or upstart compatible dependency management)
   Also BSD's rc.d style scripts (PROVIDE, REQUIRE).
@@ -72,20 +88,6 @@ Even later / Maybe never:
 
 
 Documentation:
+--------------
 * Design philosophy/rationale document
-* Coding style guidelines
-
-* What's the best TERM setting? gogetty gives me "linux" but I think other variants may be
-  better (eg "linux-c").
-
-* Figure out the ConsoleKit/logind / PolicyKit mess & how dinit needs to fit into it.
-  * Consolekit/logind tracks "sessions". Provides a mechanism to mark a session starting,
-    associates processes with sessions, provides calls to terminate sessions etc (why?!!)
-    Can use environment variable or cgroups to track processes in a session.
-    A PAM module exists to create/destroy sessions.
-  * Consolekit/logind also allows for requesting shutdown, reboot, and inhibiting reboot
-    (via dbus API).
-  * "seats" are a set of input/output hardware (mouse/keyboard/monitor) on which a session
-    can be run. You can have multiple sessions on a seat - one is in the foreground
-    (eg linux virtual ttys implement multiple sessions on a single seat).
-    Sessions can run without a seat (eg ssh session).
+* More system integration documentation?