[mirror_iproute2.git] / include / uapi / linux / btf.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/* Copyright (c) 2018 Facebook */
#ifndef __LINUX_BTF_H__
#define __LINUX_BTF_H__

#include <linux/types.h>

#define BTF_MAGIC	0xeB9F
#define BTF_VERSION	1

struct btf_header {
	__u16	magic;
	__u8	version;
	__u8	flags;
	__u32	hdr_len;

	/* All offsets are in bytes relative to the end of this header */
	__u32	type_off;	/* offset of type section	*/
	__u32	type_len;	/* length of type section	*/
	__u32	str_off;	/* offset of string section	*/
	__u32	str_len;	/* length of string section	*/
};

/* Max # of type identifier */
#define BTF_MAX_TYPE	0x0000ffff
/* Max offset into the string section */
#define BTF_MAX_NAME_OFFSET	0x0000ffff
/* Max # of struct/union/enum members or func args */
#define BTF_MAX_VLEN	0xffff

struct btf_type {
	__u32 name_off;
	/* "info" bits arrangement
	 * bits  0-15: vlen (e.g. # of struct's members)
	 * bits 16-23: unused
	 * bits 24-27: kind (e.g. int, ptr, array...etc)
	 * bits 28-31: unused
	 */
	__u32 info;
	/* "size" is used by INT, ENUM, STRUCT and UNION.
	 * "size" tells the size of the type it is describing.
	 *
	 * "type" is used by PTR, TYPEDEF, VOLATILE, CONST, RESTRICT,
	 * FUNC and FUNC_PROTO.
	 * "type" is a type_id referring to another type.
	 */
	union {
		__u32 size;
		__u32 type;
	};
};

#define BTF_INFO_KIND(info)	(((info) >> 24) & 0x0f)
#define BTF_INFO_VLEN(info)	((info) & 0xffff)

#define BTF_KIND_UNKN		0	/* Unknown	*/
#define BTF_KIND_INT		1	/* Integer	*/
#define BTF_KIND_PTR		2	/* Pointer	*/
#define BTF_KIND_ARRAY		3	/* Array	*/
#define BTF_KIND_STRUCT		4	/* Struct	*/
#define BTF_KIND_UNION		5	/* Union	*/
#define BTF_KIND_ENUM		6	/* Enumeration	*/
#define BTF_KIND_FWD		7	/* Forward	*/
#define BTF_KIND_TYPEDEF	8	/* Typedef	*/
#define BTF_KIND_VOLATILE	9	/* Volatile	*/
#define BTF_KIND_CONST		10	/* Const	*/
#define BTF_KIND_RESTRICT	11	/* Restrict	*/
#define BTF_KIND_FUNC		12	/* Function	*/
#define BTF_KIND_FUNC_PROTO	13	/* Function Proto	*/
#define BTF_KIND_MAX		13
#define NR_BTF_KINDS		14

/* For some specific BTF_KIND, "struct btf_type" is immediately
 * followed by extra data.
 */

/* BTF_KIND_INT is followed by a u32 and the following
 * is the 32 bits arrangement:
 */
#define BTF_INT_ENCODING(VAL)	(((VAL) & 0x0f000000) >> 24)
#define BTF_INT_OFFSET(VAL)	(((VAL  & 0x00ff0000)) >> 16)
#define BTF_INT_BITS(VAL)	((VAL)  & 0x000000ff)

/* Attributes stored in the BTF_INT_ENCODING */
#define BTF_INT_SIGNED	(1 << 0)
#define BTF_INT_CHAR	(1 << 1)
#define BTF_INT_BOOL	(1 << 2)

/* BTF_KIND_ENUM is followed by multiple "struct btf_enum".
 * The exact number of btf_enum is stored in the vlen (of the
 * info in "struct btf_type").
 */
struct btf_enum {
	__u32	name_off;
	__s32	val;
};

/* BTF_KIND_ARRAY is followed by one "struct btf_array" */
struct btf_array {
	__u32	type;
	__u32	index_type;
	__u32	nelems;
};

/* BTF_KIND_STRUCT and BTF_KIND_UNION are followed
 * by multiple "struct btf_member".  The exact number
 * of btf_member is stored in the vlen (of the info in
 * "struct btf_type").
 */
struct btf_member {
	__u32	name_off;
	__u32	type;
	__u32	offset;	/* offset in bits */
};

/* BTF_KIND_FUNC_PROTO is followed by multiple "struct btf_param".
 * The exact number of btf_param is stored in the vlen (of the
 * info in "struct btf_type").
 */
struct btf_param {
	__u32	name_off;
	__u32	type;
};

#endif /* __LINUX_BTF_H__ */
Commit	Line	Data
50819791 DA	1	/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
	2	/* Copyright (c) 2018 Facebook */
	3	#ifndef __LINUX_BTF_H__
	4	#define __LINUX_BTF_H__
	5
	6	#include <linux/types.h>
	7
	8	#define BTF_MAGIC 0xeB9F
	9	#define BTF_VERSION 1
	10
	11	struct btf_header {
	12	__u16 magic;
	13	__u8 version;
	14	__u8 flags;
	15	__u32 hdr_len;
	16
	17	/* All offsets are in bytes relative to the end of this header */
	18	__u32 type_off; /* offset of type section */
	19	__u32 type_len; /* length of type section */
	20	__u32 str_off; /* offset of string section */
	21	__u32 str_len; /* length of string section */
	22	};
	23
	24	/* Max # of type identifier */
	25	#define BTF_MAX_TYPE 0x0000ffff
	26	/* Max offset into the string section */
	27	#define BTF_MAX_NAME_OFFSET 0x0000ffff
	28	/* Max # of struct/union/enum members or func args */
	29	#define BTF_MAX_VLEN 0xffff
	30
	31	struct btf_type {
	32	__u32 name_off;
	33	/* "info" bits arrangement
	34	* bits 0-15: vlen (e.g. # of struct's members)
	35	* bits 16-23: unused
	36	* bits 24-27: kind (e.g. int, ptr, array...etc)
	37	* bits 28-31: unused
	38	*/
	39	__u32 info;
	40	/* "size" is used by INT, ENUM, STRUCT and UNION.
	41	* "size" tells the size of the type it is describing.
	42	*
17689d30 DA	43	* "type" is used by PTR, TYPEDEF, VOLATILE, CONST, RESTRICT,
17689d30 DA	44	* FUNC and FUNC_PROTO.
50819791 DA	45	* "type" is a type_id referring to another type.
	46	*/
	47	union {
	48	__u32 size;
	49	__u32 type;
	50	};
	51	};
	52
	53	#define BTF_INFO_KIND(info) (((info) >> 24) & 0x0f)
	54	#define BTF_INFO_VLEN(info) ((info) & 0xffff)
	55
	56	#define BTF_KIND_UNKN 0 /* Unknown */
	57	#define BTF_KIND_INT 1 /* Integer */
	58	#define BTF_KIND_PTR 2 /* Pointer */
	59	#define BTF_KIND_ARRAY 3 /* Array */
	60	#define BTF_KIND_STRUCT 4 /* Struct */
	61	#define BTF_KIND_UNION 5 /* Union */
	62	#define BTF_KIND_ENUM 6 /* Enumeration */
	63	#define BTF_KIND_FWD 7 /* Forward */
	64	#define BTF_KIND_TYPEDEF 8 /* Typedef */
	65	#define BTF_KIND_VOLATILE 9 /* Volatile */
	66	#define BTF_KIND_CONST 10 /* Const */
	67	#define BTF_KIND_RESTRICT 11 /* Restrict */
17689d30 DA	68	#define BTF_KIND_FUNC 12 /* Function */
	69	#define BTF_KIND_FUNC_PROTO 13 /* Function Proto */
	70	#define BTF_KIND_MAX 13
	71	#define NR_BTF_KINDS 14
50819791 DA	72
	73	/* For some specific BTF_KIND, "struct btf_type" is immediately
	74	* followed by extra data.
	75	*/
	76
	77	/* BTF_KIND_INT is followed by a u32 and the following
	78	* is the 32 bits arrangement:
	79	*/
	80	#define BTF_INT_ENCODING(VAL) (((VAL) & 0x0f000000) >> 24)
	81	#define BTF_INT_OFFSET(VAL) (((VAL & 0x00ff0000)) >> 16)
74eb09ad	82	#define BTF_INT_BITS(VAL) ((VAL) & 0x000000ff)
50819791 DA	83
	84	/* Attributes stored in the BTF_INT_ENCODING */
	85	#define BTF_INT_SIGNED (1 << 0)
	86	#define BTF_INT_CHAR (1 << 1)
	87	#define BTF_INT_BOOL (1 << 2)
	88
	89	/* BTF_KIND_ENUM is followed by multiple "struct btf_enum".
	90	* The exact number of btf_enum is stored in the vlen (of the
	91	* info in "struct btf_type").
	92	*/
	93	struct btf_enum {
	94	__u32 name_off;
	95	__s32 val;
	96	};
	97
	98	/* BTF_KIND_ARRAY is followed by one "struct btf_array" */
	99	struct btf_array {
	100	__u32 type;
	101	__u32 index_type;
	102	__u32 nelems;
	103	};
	104
	105	/* BTF_KIND_STRUCT and BTF_KIND_UNION are followed
	106	* by multiple "struct btf_member". The exact number
	107	* of btf_member is stored in the vlen (of the info in
	108	* "struct btf_type").
	109	*/
	110	struct btf_member {
	111	__u32 name_off;
	112	__u32 type;
	113	__u32 offset; /* offset in bits */
	114	};
	115
17689d30 DA	116	/* BTF_KIND_FUNC_PROTO is followed by multiple "struct btf_param".
	117	* The exact number of btf_param is stored in the vlen (of the
	118	* info in "struct btf_type").
	119	*/
	120	struct btf_param {
	121	__u32 name_off;
	122	__u32 type;
	123	};
	124
50819791	125	#endif /* __LINUX_BTF_H__ */