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>
		
	
			
		
			
				
	
	
		
			66 lines
		
	
	
		
			1.6 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			66 lines
		
	
	
		
			1.6 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*
 | 
						|
 * Copyright (C) 2011       Citrix Ltd.
 | 
						|
 *
 | 
						|
 * This work is licensed under the terms of the GNU GPL, version 2.  See
 | 
						|
 * the COPYING file in the top-level directory.
 | 
						|
 *
 | 
						|
 */
 | 
						|
 | 
						|
#ifndef XEN_MAPCACHE_H
 | 
						|
#define XEN_MAPCACHE_H
 | 
						|
 | 
						|
#include "exec/cpu-common.h"
 | 
						|
 | 
						|
typedef hwaddr (*phys_offset_to_gaddr_t)(hwaddr phys_offset,
 | 
						|
                                         ram_addr_t size);
 | 
						|
#ifdef CONFIG_XEN
 | 
						|
 | 
						|
void xen_map_cache_init(phys_offset_to_gaddr_t f,
 | 
						|
                        void *opaque);
 | 
						|
uint8_t *xen_map_cache(hwaddr phys_addr, hwaddr size,
 | 
						|
                       uint8_t lock, bool dma);
 | 
						|
ram_addr_t xen_ram_addr_from_mapcache(void *ptr);
 | 
						|
void xen_invalidate_map_cache_entry(uint8_t *buffer);
 | 
						|
void xen_invalidate_map_cache(void);
 | 
						|
uint8_t *xen_replace_cache_entry(hwaddr old_phys_addr,
 | 
						|
                                 hwaddr new_phys_addr,
 | 
						|
                                 hwaddr size);
 | 
						|
#else
 | 
						|
 | 
						|
static inline void xen_map_cache_init(phys_offset_to_gaddr_t f,
 | 
						|
                                      void *opaque)
 | 
						|
{
 | 
						|
}
 | 
						|
 | 
						|
static inline uint8_t *xen_map_cache(hwaddr phys_addr,
 | 
						|
                                     hwaddr size,
 | 
						|
                                     uint8_t lock,
 | 
						|
                                     bool dma)
 | 
						|
{
 | 
						|
    abort();
 | 
						|
}
 | 
						|
 | 
						|
static inline ram_addr_t xen_ram_addr_from_mapcache(void *ptr)
 | 
						|
{
 | 
						|
    abort();
 | 
						|
}
 | 
						|
 | 
						|
static inline void xen_invalidate_map_cache_entry(uint8_t *buffer)
 | 
						|
{
 | 
						|
}
 | 
						|
 | 
						|
static inline void xen_invalidate_map_cache(void)
 | 
						|
{
 | 
						|
}
 | 
						|
 | 
						|
static inline uint8_t *xen_replace_cache_entry(hwaddr old_phys_addr,
 | 
						|
                                               hwaddr new_phys_addr,
 | 
						|
                                               hwaddr size)
 | 
						|
{
 | 
						|
    abort();
 | 
						|
}
 | 
						|
 | 
						|
#endif
 | 
						|
 | 
						|
#endif /* XEN_MAPCACHE_H */
 |