ftypes.h

Go to the documentation of this file.

#pragma once
#include <wireshark.h>
 
#include <wsutil/regex.h>
#include <epan/wmem_scopes.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define ASSERT_FTYPE_NOT_REACHED(ft) \
    ws_error("Invalid field type '%s'.", ftype_name(ft))

enum ftenum {
    FT_NONE,             
    FT_PROTOCOL,         
    FT_BOOLEAN,          
    FT_CHAR,             
    FT_UINT8,            
    FT_UINT16,           
    FT_UINT24,           
    FT_UINT32,           
    FT_UINT40,           
    FT_UINT48,           
    FT_UINT56,           
    FT_UINT64,           
    FT_INT8,             
    FT_INT16,            
    FT_INT24,            
    FT_INT32,            
    FT_INT40,            
    FT_INT48,            
    FT_INT56,            
    FT_INT64,            
    FT_IEEE_11073_SFLOAT, 
    FT_IEEE_11073_FLOAT,  
    FT_FLOAT,            
    FT_DOUBLE,           
    FT_ABSOLUTE_TIME,    
    FT_RELATIVE_TIME,    
    FT_STRING,           
    FT_STRINGZ,          
    FT_UINT_STRING,      
    FT_ETHER,            
    FT_BYTES,            
    FT_UINT_BYTES,       
    FT_IPv4,             
    FT_IPv6,             
    FT_IPXNET,           
    FT_FRAMENUM,         
    FT_GUID,             
    FT_OID,              
    FT_EUI64,            
    FT_AX25,             
    FT_VINES,            
    FT_REL_OID,          
    FT_SYSTEM_ID,        
    FT_STRINGZPAD,       
    FT_FCWWN,            
    FT_STRINGZTRUNC,     
    FT_NUM_TYPES,        
    FT_SCALAR,           
    FT_ENUM_SIZE = FT_SCALAR 
};
 

#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 || (ft) == FT_AX25)

#define FT_IS_SCALAR(ft) ((ft) == FT_INT64 || (ft) == FT_DOUBLE)
 

#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
 

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     
};

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_UNDERFLOW,     
    FT_BADARG,        
    FT_ERROR,         
};
 

typedef int ft_bool_t;
#define FT_TRUE  1 
#define FT_FALSE 0 
 

enum ftrepr {
    FTREPR_DISPLAY, 
    FTREPR_DFILTER, 
    FTREPR_JSON,    
    FTREPR_RAW,     
    FTREPR_EK,      
};
 
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. */
WS_DLL_PUBLIC
int
ftype_wire_size(ftenum_t ftype);

WS_DLL_PUBLIC
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);

WS_DLL_PUBLIC
bool
ftype_can_bitwise_and(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_unary_minus(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_add(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_subtract(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_multiply(enum ftenum ftype);

WS_DLL_PUBLIC
bool
ftype_can_divide(enum ftenum ftype);

WS_DLL_PUBLIC
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_is_nan(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);

WS_DLL_PUBLIC
bool
ftype_can_val_to_double(enum ftenum ftype);
 
/* ---------------- FVALUE ----------------- */
 
#include <wsutil/inet_cidr.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;            
    unsigned  length;         
    char*     proto_string;   
    bool      tvb_is_private; 
} protocol_value_t;
 
typedef struct _fvalue_t fvalue_t;

WS_DLL_PUBLIC
fvalue_t*
fvalue_new(ftenum_t ftype);

WS_DLL_PUBLIC
fvalue_t*
fvalue_new_pool(wmem_allocator_t *scope, ftenum_t ftype);

WS_DLL_PUBLIC
fvalue_t*
fvalue_dup(const fvalue_t *fv);

WS_DLL_PUBLIC
void
fvalue_init(fvalue_t *fv, ftenum_t ftype);

WS_DLL_PUBLIC
void
fvalue_cleanup(fvalue_t *fv);

WS_DLL_PUBLIC
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);

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);

fvalue_t*
fvalue_from_sinteger64(ftenum_t ftype, const char *s, int64_t number, char **err_msg);

 
fvalue_t*
fvalue_from_uinteger64(ftenum_t ftype, const char *s, uint64_t number, char **err_msg);

fvalue_t*
fvalue_from_floating(ftenum_t ftype, const char *s, double number, char **err_msg);

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 enum ft_result
fvalue_to_double(const fvalue_t *fv, double *repr);

WS_DLL_PUBLIC ftenum_t
fvalue_type_ftenum(const fvalue_t *fv);

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

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

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

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

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

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

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

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

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

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

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

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

WS_DLL_PUBLIC
void
fvalue_set_protocol_length(fvalue_t *fv, unsigned length);
 

WS_DLL_PUBLIC
void
fvalue_set_uinteger(fvalue_t *fv, uint32_t value);

WS_DLL_PUBLIC
void
fvalue_set_sinteger(fvalue_t *fv, int32_t value);

WS_DLL_PUBLIC
void
fvalue_set_uinteger64(fvalue_t *fv, uint64_t value);

WS_DLL_PUBLIC
void
fvalue_set_sinteger64(fvalue_t *fv, int64_t value);

WS_DLL_PUBLIC
void
fvalue_set_floating(fvalue_t *fv, double value);

WS_DLL_PUBLIC
void
fvalue_set_ipv4(fvalue_t *fv, const ipv4_addr_and_mask *value);

WS_DLL_PUBLIC
void
fvalue_set_ipv6(fvalue_t *fv, const ipv6_addr_and_prefix *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 ipv4_addr_and_mask *
fvalue_get_ipv4(fvalue_t *fv);

WS_DLL_PUBLIC
const ipv6_addr_and_prefix *
fvalue_get_ipv6(fvalue_t *fv);

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

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

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

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

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

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

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

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

fvalue_is_zero(const fvalue_t *a);

WS_DLL_PUBLIC
bool
fvalue_is_negative(const fvalue_t *a);

WS_DLL_PUBLIC
bool
fvalue_is_nan(const fvalue_t *a);

WS_DLL_PUBLIC
size_t
fvalue_length2(fvalue_t *fv);

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

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

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

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

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

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

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

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

WS_DLL_PUBLIC
unsigned
fvalue_hash(const fvalue_t *fv);

WS_DLL_PUBLIC
bool
fvalue_equal(const fvalue_t *a, const fvalue_t *b);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
/*
 * 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:
 */