#ifndef NFTABLES_DATATYPE_H
#define NFTABLES_DATATYPE_H
#include <json.h>
/**
* enum datatypes
*
* @TYPE_INVALID: uninitialized
* @TYPE_VERDICT: nftables verdict
* @TYPE_NFPROTO: netfilter protocol (integer subtype)
* @TYPE_BITMASK: bitmask
* @TYPE_INTEGER: integer
* @TYPE_STRING: string
* @TYPE_LLADDR: link layer address (integer subtype)
* @TYPE_IPADDR: IPv4 address (integer subtype)
* @TYPE_IP6ADDR: IPv6 address (integer subtype)
* @TYPE_ETHERADDR: Ethernet address (lladdr subtype)
* @TYPE_ETHERTYPE: EtherType (integer subtype)
* @TYPE_ARPOP: ARP operation (integer subtype)
* @TYPE_INET_PROTOCOL: internet protocol (integer subtype)
* @TYPE_INET_SERVICE: internet service (integer subtype)
* @TYPE_ICMP_TYPE: ICMP type codes (integer subtype)
* @TYPE_TCP_FLAG: TCP flag (bitmask subtype)
* @TCPE_DCCP_PKTTYPE: DCCP packet type (integer subtype)
* @TYPE_MH_TYPE: Mobility Header type (integer subtype)
* @TYPE_TIME: relative time
* @TYPE_MARK: packet mark (integer subtype)
* @TYPE_IFINDEX: interface index (integer subtype)
* @TYPE_ARPHRD: interface type (integer subtype)
* @TYPE_REALM: routing realm (integer subtype)
* @TYPE_CLASSID: TC classid (integer subtype)
* @TYPE_UID: user ID (integer subtype)
* @TYPE_GID: group ID (integer subtype)
* @TYPE_CT_STATE: conntrack state (bitmask subtype)
* @TYPE_CT_DIR: conntrack direction
* @TYPE_CT_STATUS: conntrack status (bitmask subtype)
* @TYPE_ICMP6_TYPE: ICMPv6 type codes (integer subtype)
* @TYPE_CT_LABEL: Conntrack Label (bitmask subtype)
* @TYPE_PKTTYPE: packet type (integer subtype)
* @TYPE_ICMP_CODE: icmp code (integer subtype)
* @TYPE_ICMPV6_CODE: icmpv6 code (integer subtype)
* @TYPE_ICMPX_CODE: icmpx code (integer subtype)
* @TYPE_DEVGROUP: devgroup code (integer subtype)
* @TYPE_DSCP: Differentiated Services Code Point (integer subtype)
* @TYPE_IFNAME: interface name (string subtype)
* @TYPE_IGMP: IGMP type (integer subtype)
* @TYPE_TIME_DATA Date type (integer subtype)
* @TYPE_TIME_HOUR Hour type (integer subtype)
* @TYPE_TIME_DAY Day type (integer subtype)
*/
enum datatypes {
TYPE_INVALID,
TYPE_VERDICT,
TYPE_NFPROTO,
TYPE_BITMASK,
TYPE_INTEGER,
TYPE_STRING,
TYPE_LLADDR,
TYPE_IPADDR,
TYPE_IP6ADDR,
TYPE_ETHERADDR,
TYPE_ETHERTYPE,
TYPE_ARPOP,
TYPE_INET_PROTOCOL,
TYPE_INET_SERVICE,
TYPE_ICMP_TYPE,
TYPE_TCP_FLAG,
TYPE_DCCP_PKTTYPE,
TYPE_MH_TYPE,
TYPE_TIME,
TYPE_MARK,
TYPE_IFINDEX,
TYPE_ARPHRD,
TYPE_REALM,
TYPE_CLASSID,
TYPE_UID,
TYPE_GID,
TYPE_CT_STATE,
TYPE_CT_DIR,
TYPE_CT_STATUS,
TYPE_ICMP6_TYPE,
TYPE_CT_LABEL,
TYPE_PKTTYPE,
TYPE_ICMP_CODE,
TYPE_ICMPV6_CODE,
TYPE_ICMPX_CODE,
TYPE_DEVGROUP,
TYPE_DSCP,
TYPE_ECN,
TYPE_FIB_ADDR,
TYPE_BOOLEAN,
TYPE_CT_EVENTBIT,
TYPE_IFNAME,
TYPE_IGMP_TYPE,
TYPE_TIME_DATE,
TYPE_TIME_HOUR,
TYPE_TIME_DAY,
__TYPE_MAX
};
#define TYPE_MAX (__TYPE_MAX - 1)
#define TYPE_BITS 6
#define TYPE_MASK ((1 << TYPE_BITS) - 1)
/**
* enum byteorder
*
* @BYTEORDER_INVALID: uninitialized/unknown
* @BYTEORDER_HOST_ENDIAN: host endian
* @BYTEORDER_BIG_ENDIAN: big endian
*/
enum byteorder {
BYTEORDER_INVALID,
BYTEORDER_HOST_ENDIAN,
BYTEORDER_BIG_ENDIAN,
};
struct expr;
/**
* enum datatype_flags
*
* @DTYPE_F_ALLOC: datatype is dynamically allocated
* @DTYPE_F_PREFIX: preferred representation for ranges is a prefix
*/
enum datatype_flags {
DTYPE_F_ALLOC = (1 << 0),
DTYPE_F_PREFIX = (1 << 1),
};
struct parse_ctx;
/**
* struct datatype
*
* @type: numeric identifier
* @byteorder: byteorder of type (non-basetypes only)
* @flags: flags
* @size: type size (fixed sized non-basetypes only)
* @subtypes: number of subtypes (concat type)
* @name: type name
* @desc: type description
* @basetype: basetype for subtypes, determines type compatibility
* @basefmt: format string for basetype
* @print: function to print a constant of this type
* @parse: function to parse a symbol and return an expression
* @sym_tbl: symbol table for this type
* @refcnt: reference counter (only for DTYPE_F_ALLOC)
*/
struct datatype {
uint32_t type;
enum byteorder byteorder;
unsigned int flags;
unsigned int size;
unsigned int subtypes;
const char *name;
const char *desc;
const struct datatype *basetype;
const char *basefmt;
void (*print)(const struct expr *expr,
struct output_ctx *octx);
json_t *(*json)(const struct expr *expr,
struct output_ctx *octx);
struct error_record *(*parse)(struct parse_ctx *ctx,
const struct expr *sym,
struct expr **res);
const struct symbol_table *sym_tbl;
unsigned int refcnt;
};
extern const struct datatype *datatype_lookup(enum datatypes type);
extern const struct datatype *datatype_lookup_byname(const char *name);
extern struct datatype *datatype_get(const struct datatype *dtype);
extern void datatype_set(struct expr *expr, const struct datatype *dtype);
extern void datatype_free(const struct datatype *dtype);
struct parse_ctx {
struct symbol_tables *tbl;
};
extern struct error_record *symbol_parse(struct parse_ctx *ctx,
const struct expr *sym,
struct expr **res);
extern void datatype_print(const struct expr *expr, struct output_ctx *octx);
static inline bool datatype_equal(const struct datatype *d1,
const struct datatype *d2)
{
return d1->type == d2->type;
}
static inline const struct datatype *
datatype_basetype(const struct datatype *dtype)
{
return dtype->basetype ? dtype->basetype : dtype;
}
/**
* struct symbolic_constant - symbol <-> constant mapping
*
* @identifier: symbol
* @value: symbolic value
*/
struct symbolic_constant {
const char *identifier;
uint64_t value;
};
#define SYMBOL(id, v) { .identifier = (id), .value = (v) }
#define SYMBOL_LIST_END (struct symbolic_constant) { }
/**
* enum base - indicate how to display symbol table values
*
* @BASE_HEXADECIMAL: hexadecimal
* @BASE_DECIMAL: decimal
*/
enum base {
BASE_HEXADECIMAL,
BASE_DECIMAL,
};
/**
* struct symbol_table - type construction from symbolic values
*
* @base: base of symbols representation
* @symbols: the symbols
*/
struct symbol_table {
enum base base;
struct symbolic_constant symbols[];
};
extern struct error_record *symbolic_constant_parse(struct parse_ctx *ctx,
const struct expr *sym,
const struct symbol_table *tbl,
struct expr **res);
extern void symbolic_constant_print(const struct symbol_table *tbl,
const struct expr *expr, bool quotes,
struct output_ctx *octx);
extern void symbol_table_print(const struct symbol_table *tbl,
const struct datatype *dtype,
enum byteorder byteorder,
struct output_ctx *octx);
extern struct symbol_table *rt_symbol_table_init(const char *filename);
extern void rt_symbol_table_free(const struct symbol_table *tbl);
extern const struct datatype invalid_type;
extern const struct datatype verdict_type;
extern const struct datatype nfproto_type;
extern const struct datatype bitmask_type;
extern const struct datatype integer_type;
extern const struct datatype string_type;
extern const struct datatype lladdr_type;
extern const struct datatype ipaddr_type;
extern const struct datatype ip6addr_type;
extern const struct datatype etheraddr_type;
extern const struct datatype ethertype_type;
extern const struct datatype arphrd_type;
extern const struct datatype inet_protocol_type;
extern const struct datatype inet_service_type;
extern const struct datatype mark_type;
extern const struct datatype icmp_type_type;
extern const struct datatype icmp_code_type;
extern const struct datatype icmpv6_code_type;
extern const struct datatype icmpx_code_type;
extern const struct datatype igmp_type_type;
extern const struct datatype time_type;
extern const struct datatype boolean_type;
extern const struct datatype priority_type;
extern const struct datatype policy_type;
void inet_service_type_print(const struct expr *expr, struct output_ctx *octx);
extern const struct datatype *concat_type_alloc(uint32_t type);
static inline uint32_t concat_subtype_add(uint32_t type, uint32_t subtype)
{
return type << TYPE_BITS | subtype;
}
static inline uint32_t concat_subtype_id(uint32_t type, unsigned int n)
{
return (type >> TYPE_BITS * n) & TYPE_MASK;
}
static inline const struct datatype *
concat_subtype_lookup(uint32_t type, unsigned int n)
{
return datatype_lookup(concat_subtype_id(type, n));
}
extern const struct datatype *
set_datatype_alloc(const struct datatype *orig_dtype, unsigned int byteorder);
extern void time_print(uint64_t msec, struct output_ctx *octx);
extern struct error_record *time_parse(const struct location *loc,
const char *c, uint64_t *res);
extern struct error_record *rate_parse(const struct location *loc,
const char *str, uint64_t *rate,
uint64_t *unit);
extern struct error_record *data_unit_parse(const struct location *loc,
const char *str, uint64_t *rate);
#endif /* NFTABLES_DATATYPE_H */