 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>
		
	
			
		
			
				
	
	
		
			40 lines
		
	
	
		
			1.0 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			40 lines
		
	
	
		
			1.0 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
|  * virtual css bridge definition
 | |
|  *
 | |
|  * Copyright 2012,2016 IBM Corp.
 | |
|  * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
 | |
|  *            Pierre Morel <pmorel@linux.vnet.ibm.com>
 | |
|  *
 | |
|  * This work is licensed under the terms of the GNU GPL, version 2 or (at
 | |
|  * your option) any later version. See the COPYING file in the top-level
 | |
|  * directory.
 | |
|  */
 | |
| 
 | |
| #ifndef HW_S390X_CSS_BRIDGE_H
 | |
| #define HW_S390X_CSS_BRIDGE_H
 | |
| 
 | |
| #include "qom/object.h"
 | |
| #include "hw/sysbus.h"
 | |
| 
 | |
| /* virtual css bridge */
 | |
| typedef struct VirtualCssBridge {
 | |
|     SysBusDevice sysbus_dev;
 | |
|     bool css_dev_path;
 | |
| } VirtualCssBridge;
 | |
| 
 | |
| #define TYPE_VIRTUAL_CSS_BRIDGE "virtual-css-bridge"
 | |
| #define VIRTUAL_CSS_BRIDGE(obj) \
 | |
|     OBJECT_CHECK(VirtualCssBridge, (obj), TYPE_VIRTUAL_CSS_BRIDGE)
 | |
| 
 | |
| /* virtual css bus type */
 | |
| typedef struct VirtualCssBus {
 | |
|     BusState parent_obj;
 | |
| } VirtualCssBus;
 | |
| 
 | |
| #define TYPE_VIRTUAL_CSS_BUS "virtual-css-bus"
 | |
| #define VIRTUAL_CSS_BUS(obj) \
 | |
|      OBJECT_CHECK(VirtualCssBus, (obj), TYPE_VIRTUAL_CSS_BUS)
 | |
| VirtualCssBus *virtual_css_bus_init(void);
 | |
| 
 | |
| #endif
 |