aboutgitcodelistschat:MatrixIRC
path: root/cooker/cooker.h
blob: 9217c40e5f59fd9aee0c1d14025a166d03123530 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/* SPDX-License-Identifier: GPL-2.0-or-later
 * Copyright 2023 Red Hat GmbH
 * Author: Stefano Brivio <sbrivio@redhat.com>
 */

#ifndef COOKER_H
#define COOKER_H

#define _GNU_SOURCE
#include <fcntl.h>
#include <unistd.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/sysmacros.h>
#include <sys/types.h>
#include <arpa/inet.h>

#include <common.h>
#include <util.h>

#define TAGS_MAX			256
#define ATTRS_MAX			256
#define CALL_ARGS			6

struct num;
struct field;
struct select;
struct size;

/**
 * union desc - Description of lists of numbers, structs or selector fields
 * @d_num:	Pointer to a list of numbers and their labels
 * @d_struct:	Pointer to a struct description
 * @d_select:	Pointer to description of a selector
 * @d_arg_size:	Position of argument whose pointed length is described
 */
union desc {
	struct num		*d_num;
	struct field		*d_struct;
	struct select		*d_select;
	intptr_t		d_size;
};

/**
 * union value - Represent a generic value used internally by cooker
 * @v_int:	Value of type int
 * @v_u32:	Value of type u32
 * @v_num:	Value of type long long, or any other numeric type
 * @v_str:	String, directly from JSON
 */
union value {
	int			v_int;
	uint32_t		v_u32;
	uint64_t		v_u64;
	long long		v_num;
	const char		*v_str;
};

#define NO_VALUE ((union value){ .v_num = 0 })

/**
 * enum type - Types of values for arguments and fields within arguments
 */
enum type {
	UNDEF = 0,
	NONE,

	USHORT,
	INT,
	U32,
	U64,
	LONG,

	STRING,

	STRUCT,
	SELECT,
	SELECTED,

	PID,

	PORT,
	IPV4,
	IPV6,

	GNU_DEV_MAJOR,
	GNU_DEV_MINOR,

	FDPATH,
	UID_T,
	GID_T,

	TYPE_END,
};

enum flags {
	/* Mask field with all possible values, first */
	MASK	= BIT(1),
	/* Intersection of multiple bits */
	FLAGS	= BIT(2),
	/* Represent size of another argument */
	SIZE	= BIT(3),

	COPY_ON_CALL = BIT(4),

	/* Don't copy value from original call, but fill on return */
	RBUF	= BIT(5),
	/* Copy value from original call, ignore on return */
	WBUF	= BIT(6),
};

#define TYPE_COUNT		(TYPE_END - 1)

#define TYPE_IS_COMPOUND(t)						\
	((t) == STRUCT || (t) == SELECT)
#define TYPE_IS_NUM(t)							\
	((t) == USHORT || (t) == INT || (t) == U32 ||			\
	 (t) == U64 || (t) == LONG ||					\
	 (t) == GNU_DEV_MAJOR || (t) == GNU_DEV_MINOR) ||	        \
	 (t) == UID_T || (t) == GID_T
#define TYPE_IS_64BIT(t)						\
	((t) == U64 || (t) == LONG ||					\
	 (t) == GNU_DEV_MAJOR || (t) == GNU_DEV_MINOR)


/**
 * struct num - A numeric value and its label
 * @name:	Label for numeric value
 * @value:	Numeric value
 */
struct num {
	char *name;
	long long value;
};

/**
 * struct field - Field inside argument or struct
 * @name:	Name of field
 * @type:	Type of field
 * @flags:	Modifier flags for type
 * @offset:	Offset of field within argument or struct, in bytes
 * @size:	Turns int into int *, char into string, humans into paperclips
 * @desc:	Description of possible values for field, or linked struct
 */
struct field {
	char *name;
	enum type type;
	enum flags flags;

	off_t offset;

	size_t size;

	union desc desc;
};

/**
 * struct arg - Description of part of, or complete system call argument
 * @pos:	Index of argument in system call
 * @f:		Field describing part or complete argument
 */
struct arg {
	int pos;
	struct field f;
};

/**
 * struct select_num - List of possible selections based on numeric selector
 * @value:	Numeric value of the selector
 * @sel_size:	Size associated with selection (not necessarily argument size)
 * @target:	Argument description defined by this selector
 */
struct select_num {
	long long value;
	ssize_t sel_size;
	struct arg target;
};

/**
 * struct select - Association between argument description and selected values
 * @field:	Description of argument operating the selection
 * @d_num:	List of possible selections
 */
struct select {
	struct field *field;

	union {
		struct select_num *d_num;
	} desc;
};

enum attr_type {
	ATTR_NONE = 0,
	ATTR_SIZE,
};

/**
 * struct attr - Generic attribute for syscall model with link
 * @id:		Link
 * @v:		Attribute value
 */
struct attr {
	enum attr_type type;
	intptr_t id;
	union value v;
};

#endif /* COOKER_H */