[libvirt] [PATCH 04/10] daemon: remove obsolete doc describing daemon threading

[Daniel P. Berrangé]

The THREADS.txt describes the way threading worked in libvirtd many many
years ago, long before even the RPC code was modularized. Things have
evolved significantly since then, so delete this potentially misleading doc.

Signed-off-by: Daniel P. Berrangé <berrange at redhat.com>
---
 daemon/THREADS.txt | 52 ----------------------------------------------------
 1 file changed, 52 deletions(-)
 delete mode 100644 daemon/THREADS.txt

diff --git a/daemon/THREADS.txt b/daemon/THREADS.txt
deleted file mode 100644
index ae4e9bad90..0000000000
--- a/daemon/THREADS.txt
+++ /dev/null
@@ -1,52 +0,0 @@
-
-     Threading in the libvirtd daemon
-     ================================
-
-To allow efficient processing of RPC requests, the libvirtd daemon
-makes use of threads.
-
- - The process leader. This is the initial thread of control
-   when the daemon starts running. It is responsible for
-   initializing all the state, and starting the event loop.
-   Once that's all done, this thread does nothing except
-   wait for the event loop to quit, thus indicating an orderly
-   shutdown is required.
-
- - The event loop. This thread runs the event loop, sitting
-   in poll() on all monitored file handles, and calculating
-   and dispatching any timers that may be registered. When
-   this thread quits, the entire daemon will shutdown.
-
- - The workers. These 'n' threads all sit around waiting to
-   process incoming RPC requests. Since RPC requests may take
-   a long time to complete, with long idle periods, there will
-   be quite a few workers running.
-
-The use of threads obviously requires locking to ensure safety when
-accessing/changing data structures.
-
- - the top level lock is on 'struct qemud_server'. This must be
-   held before acquiring any other lock
-
- - Each 'struct qemud_client' object has a lock. The server lock
-   must be held before acquiring it. Once the client lock is acquired
-   the server lock can (optionally) be dropped.
-
- - The event loop has its own self-contained lock. You can ignore
-   this as a caller of virEvent APIs.
-
-
-The server lock is used in conjunction with a condition variable
-to pass jobs from the event loop thread to the workers. The main
-event loop thread handles I/O from the client socket, and once a
-complete RPC message has been read off the wire (and optionally
-decrypted), it will be placed on the 'dx' job queue for the
-associated client object. The job condition will be signalled and
-a worker will wakeup and process it.
-
-The worker thread must quickly drop its locks on the server and
-client to allow the main event loop thread to continue running
-with its other work. Critically important, is that now libvirt
-API call will ever be made with the server or client locks held.
-
--- End
-- 
2.14.3