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>
		
	
			
		
			
				
	
	
		
			48 lines
		
	
	
		
			1.2 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			48 lines
		
	
	
		
			1.2 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*
 | 
						|
 * Generic Loader
 | 
						|
 *
 | 
						|
 * Copyright (C) 2014 Li Guang
 | 
						|
 * Written by Li Guang <lig.fnst@cn.fujitsu.com>
 | 
						|
 *
 | 
						|
 * This program is free software; you can redistribute it and/or modify it
 | 
						|
 * under the terms of the GNU General Public License as published by the
 | 
						|
 * Free Software Foundation; either version 2 of the License, or
 | 
						|
 * (at your option) any later version.
 | 
						|
 *
 | 
						|
 * This program is distributed in the hope that it will be useful, but WITHOUT
 | 
						|
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 | 
						|
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 | 
						|
 * for more details.
 | 
						|
 */
 | 
						|
 | 
						|
#ifndef GENERIC_LOADER_H
 | 
						|
#define GENERIC_LOADER_H
 | 
						|
 | 
						|
#include "elf.h"
 | 
						|
#include "hw/qdev-core.h"
 | 
						|
 | 
						|
typedef struct GenericLoaderState {
 | 
						|
    /* <private> */
 | 
						|
    DeviceState parent_obj;
 | 
						|
 | 
						|
    /* <public> */
 | 
						|
    CPUState *cpu;
 | 
						|
 | 
						|
    uint64_t addr;
 | 
						|
    uint64_t data;
 | 
						|
    uint8_t data_len;
 | 
						|
    uint32_t cpu_num;
 | 
						|
 | 
						|
    char *file;
 | 
						|
 | 
						|
    bool force_raw;
 | 
						|
    bool data_be;
 | 
						|
    bool set_pc;
 | 
						|
} GenericLoaderState;
 | 
						|
 | 
						|
#define TYPE_GENERIC_LOADER "loader"
 | 
						|
#define GENERIC_LOADER(obj) OBJECT_CHECK(GenericLoaderState, (obj), \
 | 
						|
                                         TYPE_GENERIC_LOADER)
 | 
						|
 | 
						|
#endif
 |