path: root/epan/ftypes/ftypes.h

/** @file
 * Definitions for field types
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 2001 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */


#ifndef __FTYPES_H__
#define __FTYPES_H__

#include <wireshark.h>

#include <wsutil/regex.h>
#include <epan/wmem_scopes.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/* field types */
enum ftenum {
	FT_NONE,	/* used for text labels with no value */
	FT_PROTOCOL,
	FT_BOOLEAN,	/* true and false come from <glib.h> */
	FT_CHAR,	/* 1-octet character as 0-255 */
	FT_UINT8,
	FT_UINT16,
	FT_UINT24,	/* really a UINT32, but displayed as 6 hex-digits if FD_HEX*/
	FT_UINT32,
	FT_UINT40,	/* really a UINT64, but displayed as 10 hex-digits if FD_HEX*/
	FT_UINT48,	/* really a UINT64, but displayed as 12 hex-digits if FD_HEX*/
	FT_UINT56,	/* really a UINT64, but displayed as 14 hex-digits if FD_HEX*/
	FT_UINT64,
	FT_INT8,
	FT_INT16,
	FT_INT24,	/* same as for UINT24 */
	FT_INT32,
	FT_INT40, /* same as for UINT40 */
	FT_INT48, /* same as for UINT48 */
	FT_INT56, /* same as for UINT56 */
	FT_INT64,
	FT_IEEE_11073_SFLOAT,
	FT_IEEE_11073_FLOAT,
	FT_FLOAT,
	FT_DOUBLE,
	FT_ABSOLUTE_TIME,
	FT_RELATIVE_TIME,
	FT_STRING,	/* counted string, with no null terminator */
	FT_STRINGZ,	/* null-terminated string */
	FT_UINT_STRING,	/* counted string, with count being the first part of the value */
	FT_ETHER,
	FT_BYTES,
	FT_UINT_BYTES,
	FT_IPv4,
	FT_IPv6,
	FT_IPXNET,
	FT_FRAMENUM,	/* a UINT32, but if selected lets you go to frame with that number */
	FT_GUID,	/* GUID, UUID */
	FT_OID,		/* OBJECT IDENTIFIER */
	FT_EUI64,
	FT_AX25,
	FT_VINES,
	FT_REL_OID,	/* RELATIVE-OID */
	FT_SYSTEM_ID,
	FT_STRINGZPAD,	/* null-padded string */
	FT_FCWWN,
	FT_STRINGZTRUNC,	/* null-truncated string */
	FT_NUM_TYPES /* last item number plus one */
};

#define FT_IS_INT32(ft) \
	((ft) == FT_INT8 ||  \
	 (ft) == FT_INT16 || \
	 (ft) == FT_INT24 || \
	 (ft) == FT_INT32)

#define FT_IS_INT64(ft) \
	((ft) == FT_INT40 || \
	 (ft) == FT_INT48 || \
	 (ft) == FT_INT56 || \
	 (ft) == FT_INT64)

#define FT_IS_INT(ft) (FT_IS_INT32(ft) || FT_IS_INT64(ft))

#define FT_IS_UINT32(ft) \
	((ft) == FT_CHAR ||   \
	 (ft) == FT_UINT8 ||  \
	 (ft) == FT_UINT16 || \
	 (ft) == FT_UINT24 || \
	 (ft) == FT_UINT32 || \
	 (ft) == FT_FRAMENUM)

#define FT_IS_UINT64(ft) \
	((ft) == FT_UINT40 || \
	 (ft) == FT_UINT48 || \
	 (ft) == FT_UINT56 || \
	 (ft) == FT_UINT64)

#define FT_IS_UINT(ft) (FT_IS_UINT32(ft) || FT_IS_UINT64(ft))

#define FT_IS_INTEGER(ft) (FT_IS_INT(ft) || FT_IS_UINT(ft))

#define FT_IS_FLOATING(ft) ((ft) == FT_FLOAT || (ft) == FT_DOUBLE)

#define FT_IS_TIME(ft) \
	((ft) == FT_ABSOLUTE_TIME || (ft) == FT_RELATIVE_TIME)

#define FT_IS_STRING(ft) \
	((ft) == FT_STRING || (ft) == FT_STRINGZ || (ft) == FT_STRINGZPAD || \
	 (ft) == FT_STRINGZTRUNC || (ft) == FT_UINT_STRING)

/* field types lengths */
#define FT_ETHER_LEN		6
#define FT_GUID_LEN		16
#define FT_IPv4_LEN		4
#define FT_IPv6_LEN		16
#define FT_IPXNET_LEN		4
#define FT_EUI64_LEN		8
#define FT_AX25_ADDR_LEN	7
#define FT_VINES_ADDR_LEN	6
#define FT_FCWWN_LEN		8
#define FT_VARINT_MAX_LEN	10	/* Because 64 / 7 = 9 and 64 % 7 = 1, get an uint64 varint need reads up to 10 bytes. */

typedef enum ftenum ftenum_t;

enum ft_framenum_type {
	FT_FRAMENUM_NONE,
	FT_FRAMENUM_REQUEST,
	FT_FRAMENUM_RESPONSE,
	FT_FRAMENUM_ACK,
	FT_FRAMENUM_DUP_ACK,
	FT_FRAMENUM_RETRANS_PREV,
	FT_FRAMENUM_RETRANS_NEXT,
	FT_FRAMENUM_NUM_TYPES /* last item number plus one */
};

typedef enum ft_framenum_type ft_framenum_type_t;

struct _ftype_t;
typedef struct _ftype_t ftype_t;

enum ft_result {
	FT_OK = 0,
	FT_OVERFLOW,
	FT_BADARG,
	FT_ERROR, /* Generic. */
};

/*
 * True, false or error if negative.
 * Note that
 *     ft_bool == FT_FALSE
 * and
 *     ft_bool != FT_TRUE
 * are different results (three-state logic).
 */
typedef bool ft_bool_t;
#define FT_TRUE		1
#define FT_FALSE	0

/* String representation types. */
enum ftrepr {
	FTREPR_DISPLAY,
	FTREPR_DFILTER,
	FTREPR_JSON,
};

typedef enum ftrepr ftrepr_t;

/* Initialize the ftypes subsystem. Called once. */
void
ftypes_initialize(void);

void
ftypes_register_pseudofields(void);

/* ---------------- FTYPE ----------------- */

/* given two types, are they similar - for example can two
 * duplicate fields be registered of these two types. */
bool
ftype_similar_types(const enum ftenum ftype_a, const enum ftenum ftype_b);

/* Return a string representing the name of the type */
WS_DLL_PUBLIC
const char*
ftype_name(ftenum_t ftype);

/* Return a string presenting a "pretty" representation of the
 * name of the type. The pretty name means more to the user than
 * that "FT_*" name. */
WS_DLL_PUBLIC
const char*
ftype_pretty_name(ftenum_t ftype);

/* Returns length of field in packet, or 0 if not determinable/defined. */
int
ftype_wire_size(ftenum_t ftype);

bool
ftype_can_length(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_slice(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_eq(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_cmp(enum ftenum ftype);

bool
ftype_can_bitwise_and(enum ftenum ftype);

bool
ftype_can_unary_minus(enum ftenum ftype);

bool
ftype_can_add(enum ftenum ftype);

bool
ftype_can_subtract(enum ftenum ftype);

bool
ftype_can_multiply(enum ftenum ftype);

bool
ftype_can_divide(enum ftenum ftype);

bool
ftype_can_modulo(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_contains(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_matches(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_is_zero(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_is_negative(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_val_to_sinteger(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_val_to_uinteger(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_val_to_sinteger64(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_val_to_uinteger64(enum ftenum ftype);

/* ---------------- FVALUE ----------------- */

#include <epan/ipv4.h>
#include <epan/ipv6.h>
#include <epan/guid-utils.h>

#include <epan/tvbuff.h>
#include <wsutil/nstime.h>
#include <epan/dfilter/drange.h>

typedef struct _protocol_value_t
{
	tvbuff_t	*tvb;
	int		length;
	char		*proto_string;
	bool	tvb_is_private;
} protocol_value_t;

typedef struct _fvalue_t fvalue_t;

fvalue_t*
fvalue_new(ftenum_t ftype);

fvalue_t*
fvalue_dup(const fvalue_t *fv);

void
fvalue_init(fvalue_t *fv, ftenum_t ftype);

void
fvalue_cleanup(fvalue_t *fv);

void
fvalue_free(fvalue_t *fv);

WS_DLL_PUBLIC
fvalue_t*
fvalue_from_literal(ftenum_t ftype, const char *s, bool allow_partial_value, char **err_msg);

/* String *MUST* be null-terminated. Length is optional (pass zero) and does not include the null terminator. */
fvalue_t*
fvalue_from_string(ftenum_t ftype, const char *s, size_t len, char **err_msg);

fvalue_t*
fvalue_from_charconst(ftenum_t ftype, unsigned long number, char **err_msg);

/* Creates the string representation of the field value.
 * Memory for the buffer is allocated based on wmem allocator
 * provided.
 *
 * field_display parameter should be a BASE_ value (enum field_display_e)
 * BASE_NONE should be used if field information isn't available.
 *
 * Returns NULL if the string cannot be represented in the given rtype.*/
WS_DLL_PUBLIC char *
fvalue_to_string_repr(wmem_allocator_t *scope, const fvalue_t *fv, ftrepr_t rtype, int field_display);

#define fvalue_to_debug_repr(scope, fv) \
	fvalue_to_string_repr(scope, fv, FTREPR_DFILTER, 0)

WS_DLL_PUBLIC enum ft_result
fvalue_to_uinteger(const fvalue_t *fv, uint32_t *repr);

WS_DLL_PUBLIC enum ft_result
fvalue_to_sinteger(const fvalue_t *fv, int32_t *repr);

WS_DLL_PUBLIC enum ft_result
fvalue_to_uinteger64(const fvalue_t *fv, uint64_t *repr);

WS_DLL_PUBLIC enum ft_result
fvalue_to_sinteger64(const fvalue_t *fv, int64_t *repr);

WS_DLL_PUBLIC ftenum_t
fvalue_type_ftenum(fvalue_t *fv);

const char*
fvalue_type_name(const fvalue_t *fv);

/* GBytes reference count is automatically incremented. */
void
fvalue_set_bytes(fvalue_t *fv, GBytes *value);

void
fvalue_set_byte_array(fvalue_t *fv, GByteArray *value);

void
fvalue_set_bytes_data(fvalue_t *fv, const void *data, size_t size);

void
fvalue_set_fcwwn(fvalue_t *fv, const uint8_t *value);

void
fvalue_set_ax25(fvalue_t *fv, const uint8_t *value);

void
fvalue_set_vines(fvalue_t *fv, const uint8_t *value);

void
fvalue_set_ether(fvalue_t *fv, const uint8_t *value);

void
fvalue_set_guid(fvalue_t *fv, const e_guid_t *value);

void
fvalue_set_time(fvalue_t *fv, const nstime_t *value);

void
fvalue_set_string(fvalue_t *fv, const char *value);

void
fvalue_set_strbuf(fvalue_t *fv, wmem_strbuf_t *value);

void
fvalue_set_protocol(fvalue_t *fv, tvbuff_t *value, const char *name, int length);

void
fvalue_set_uinteger(fvalue_t *fv, uint32_t value);

void
fvalue_set_sinteger(fvalue_t *fv, int32_t value);

void
fvalue_set_uinteger64(fvalue_t *fv, uint64_t value);

void
fvalue_set_sinteger64(fvalue_t *fv, int64_t value);

void
fvalue_set_floating(fvalue_t *fv, double value);

void
fvalue_set_ipv6(fvalue_t *fv, const ws_in6_addr *value);

/* GBytes reference count is automatically incremented. */
WS_DLL_PUBLIC
GBytes *
fvalue_get_bytes(fvalue_t *fv);

WS_DLL_PUBLIC
size_t
fvalue_get_bytes_size(fvalue_t *fv);

/* Same as fvalue_length() */
WS_DLL_PUBLIC
const void *
fvalue_get_bytes_data(fvalue_t *fv);

WS_DLL_PUBLIC
const e_guid_t *
fvalue_get_guid(fvalue_t *fv);

WS_DLL_PUBLIC
const nstime_t *
fvalue_get_time(fvalue_t *fv);

WS_DLL_PUBLIC
const char *
fvalue_get_string(fvalue_t *fv);

WS_DLL_PUBLIC
const wmem_strbuf_t *
fvalue_get_strbuf(fvalue_t *fv);

WS_DLL_PUBLIC
tvbuff_t *
fvalue_get_protocol(fvalue_t *fv);

WS_DLL_PUBLIC uint32_t
fvalue_get_uinteger(fvalue_t *fv);

WS_DLL_PUBLIC int32_t
fvalue_get_sinteger(fvalue_t *fv);

WS_DLL_PUBLIC
uint64_t
fvalue_get_uinteger64(fvalue_t *fv);

WS_DLL_PUBLIC
int64_t
fvalue_get_sinteger64(fvalue_t *fv);

WS_DLL_PUBLIC double
fvalue_get_floating(fvalue_t *fv);

WS_DLL_PUBLIC const ws_in6_addr *
fvalue_get_ipv6(fvalue_t *fv);

ft_bool_t
fvalue_eq(const fvalue_t *a, const fvalue_t *b);

ft_bool_t
fvalue_ne(const fvalue_t *a, const fvalue_t *b);

ft_bool_t
fvalue_gt(const fvalue_t *a, const fvalue_t *b);

ft_bool_t
fvalue_ge(const fvalue_t *a, const fvalue_t *b);

ft_bool_t
fvalue_lt(const fvalue_t *a, const fvalue_t *b);

ft_bool_t
fvalue_le(const fvalue_t *a, const fvalue_t *b);

ft_bool_t
fvalue_contains(const fvalue_t *a, const fvalue_t *b);

ft_bool_t
fvalue_matches(const fvalue_t *a, const ws_regex_t *re);

bool
fvalue_is_zero(const fvalue_t *a);

bool
fvalue_is_negative(const fvalue_t *a);

size_t
fvalue_length2(fvalue_t *fv);

fvalue_t*
fvalue_slice(fvalue_t *fv, drange_t *dr);

fvalue_t*
fvalue_bitwise_and(const fvalue_t *a, const fvalue_t *b, char **err_msg);

fvalue_t*
fvalue_unary_minus(const fvalue_t *fv, char **err_msg);

fvalue_t*
fvalue_add(const fvalue_t *a, const fvalue_t *b, char **err_msg);

fvalue_t*
fvalue_subtract(const fvalue_t *a, const fvalue_t *b, char **err_msg);

fvalue_t*
fvalue_multiply(const fvalue_t *a, const fvalue_t *b, char **err_msg);

fvalue_t*
fvalue_divide(const fvalue_t *a, const fvalue_t *b, char **err_msg);

fvalue_t*
fvalue_modulo(const fvalue_t *a, const fvalue_t *b, char **err_msg);

unsigned
fvalue_hash(const fvalue_t *fv);

bool
fvalue_equal(const fvalue_t *a, const fvalue_t *b);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* __FTYPES_H__ */

/*
 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 8
 * tab-width: 8
 * indent-tabs-mode: t
 * End:
 *
 * vi: set shiftwidth=8 tabstop=8 noexpandtab:
 * :indentSize=8:tabSize=8:noTabs=false:
 */