 ec150c7e09
			
		
	
	
		ec150c7e09
		
	
	
	
	
		
			
			Back in 2016, we discussed[1] rules for headers, and these were
generally liked:
1. Have a carefully curated header that's included everywhere first.  We
   got that already thanks to Peter: osdep.h.
2. Headers should normally include everything they need beyond osdep.h.
   If exceptions are needed for some reason, they must be documented in
   the header.  If all that's needed from a header is typedefs, put
   those into qemu/typedefs.h instead of including the header.
3. Cyclic inclusion is forbidden.
This patch gets include/ closer to obeying 2.
It's actually extracted from my "[RFC] Baby steps towards saner
headers" series[2], which demonstrates a possible path towards
checking 2 automatically.  It passes the RFC test there.
[1] Message-ID: <87h9g8j57d.fsf@blackfin.pond.sub.org>
    https://lists.nongnu.org/archive/html/qemu-devel/2016-03/msg03345.html
[2] Message-Id: <20190711122827.18970-1-armbru@redhat.com>
    https://lists.nongnu.org/archive/html/qemu-devel/2019-07/msg02715.html
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
Message-Id: <20190812052359.30071-2-armbru@redhat.com>
Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
		
	
			
		
			
				
	
	
		
			60 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			60 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
|  * Event loop thread
 | |
|  *
 | |
|  * Copyright Red Hat Inc., 2013
 | |
|  *
 | |
|  * Authors:
 | |
|  *  Stefan Hajnoczi   <stefanha@redhat.com>
 | |
|  *
 | |
|  * This work is licensed under the terms of the GNU GPL, version 2 or later.
 | |
|  * See the COPYING file in the top-level directory.
 | |
|  *
 | |
|  */
 | |
| 
 | |
| #ifndef IOTHREAD_H
 | |
| #define IOTHREAD_H
 | |
| 
 | |
| #include "block/aio.h"
 | |
| #include "qemu/thread.h"
 | |
| #include "qom/object.h"
 | |
| 
 | |
| #define TYPE_IOTHREAD "iothread"
 | |
| 
 | |
| typedef struct {
 | |
|     Object parent_obj;
 | |
| 
 | |
|     QemuThread thread;
 | |
|     AioContext *ctx;
 | |
|     bool run_gcontext;          /* whether we should run gcontext */
 | |
|     GMainContext *worker_context;
 | |
|     GMainLoop *main_loop;
 | |
|     QemuSemaphore init_done_sem; /* is thread init done? */
 | |
|     bool stopping;              /* has iothread_stop() been called? */
 | |
|     bool running;               /* should iothread_run() continue? */
 | |
|     int thread_id;
 | |
| 
 | |
|     /* AioContext poll parameters */
 | |
|     int64_t poll_max_ns;
 | |
|     int64_t poll_grow;
 | |
|     int64_t poll_shrink;
 | |
| } IOThread;
 | |
| 
 | |
| #define IOTHREAD(obj) \
 | |
|    OBJECT_CHECK(IOThread, obj, TYPE_IOTHREAD)
 | |
| 
 | |
| char *iothread_get_id(IOThread *iothread);
 | |
| IOThread *iothread_by_id(const char *id);
 | |
| AioContext *iothread_get_aio_context(IOThread *iothread);
 | |
| GMainContext *iothread_get_g_main_context(IOThread *iothread);
 | |
| 
 | |
| /*
 | |
|  * Helpers used to allocate iothreads for internal use.  These
 | |
|  * iothreads will not be seen by monitor clients when query using
 | |
|  * "query-iothreads".
 | |
|  */
 | |
| IOThread *iothread_create(const char *id, Error **errp);
 | |
| void iothread_stop(IOThread *iothread);
 | |
| void iothread_destroy(IOThread *iothread);
 | |
| 
 | |
| #endif /* IOTHREAD_H */
 |