/src/nDPI/src/include/ndpi_define.h

Source
/*
 *
 * Copyright (C) 2011-17 - ntop.org
 *
 * This file is part of nDPI, an open source deep packet inspection
 * library based on the OpenDPI and PACE technology by ipoque GmbH
 *
 * nDPI is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * nDPI is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with nDPI.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef __NDPI_DEFINE_INCLUDE_FILE__
#define __NDPI_DEFINE_INCLUDE_FILE__

/*
 * The #define below is used for apps that dynamically link with nDPI to make
 * sure that datastructures and in sync across versions
 */
#define NDPI_API_VERSION 15

/*
  gcc -E -dM - < /dev/null |grep ENDIAN
*/

#if defined(__FreeBSD__) || defined(__NetBSD__)
#include <sys/endian.h>
#endif

#ifdef __OpenBSD__
#include <endian.h>
#define __BYTE_ORDER BYTE_ORDER
#if BYTE_ORDER == LITTLE_ENDIAN
#ifndef __LITTLE_ENDIAN__
#define __LITTLE_ENDIAN__
#endif /* __LITTLE_ENDIAN__ */
#else
#define __BIG_ENDIAN__
#endif/* BYTE_ORDER */
#endif/* __OPENBSD__ */


#if __BYTE_ORDER == __LITTLE_ENDIAN
#ifndef __LITTLE_ENDIAN__
#define __LITTLE_ENDIAN__
#endif
#else
#ifndef __BIG_ENDIAN__
#define __BIG_ENDIAN__
#endif
#endif

#ifdef WIN32
#ifndef __LITTLE_ENDIAN__
#define __LITTLE_ENDIAN__ 1
#endif
#endif

#if !(defined(__LITTLE_ENDIAN__) || defined(__BIG_ENDIAN__))
#if defined(__mips__)
#undef __LITTLE_ENDIAN__
#undef __LITTLE_ENDIAN
#define __BIG_ENDIAN__
#endif

/* Everything else */
#if (defined(__BYTE_ORDER__) && defined(__ORDER_LITTLE_ENDIAN__))
#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
#define __LITTLE_ENDIAN__
#else
#define __BIG_ENDIAN__
#endif
#endif

#endif

#define NDPI_SELECTION_BITMASK_PROTOCOL_SIZE      u_int32_t

#define MAX_DEFAULT_PORTS                                        5

#define NDPI_EXCLUDE_DISSECTOR(mod,flow) exclude_dissector(mod, &flow->core, mod->current_dissector_idx, __FILE__, __func__, __LINE__)
#define NDPI_EXCLUDE_CORE_DISSECTOR(mod,core) exclude_dissector(mod, core, mod->current_dissector_idx, __FILE__, __func__, __LINE__)

/**
 * macro for getting the string len of a static string
 *
 * use it instead of strlen to avoid runtime calculations
 */
#define NDPI_STATICSTRING_LEN( s ) ( sizeof( s ) - 1 )

/** macro to compare 2 IPv6 addresses with each other to identify the "smaller" IPv6 address  */
#define NDPI_COMPARE_IPV6_ADDRESS_STRUCTS(x,y)  \
  ((x.u6_addr.u6_addr64[0] < y.u6_addr.u6_addr64[0]) || ((x.u6_addr.u6_addr64[0] == y.u6_addr.u6_addr64[0]) && (x.u6_addr.u6_addr64[1] < y.u6_addr.u6_addr64[1])))

#define howmanybits(x, y)   (((x)+((y)-1))/(y))

#define NDPI_SET_BIT(num, n)    num |= 1ULL << ( n )
#define NDPI_CLR_BIT(num, n)    num &= ~(1ULL << ( n ))
#define NDPI_CLR_BIT(num, n)    num &= ~(1ULL << ( n ))
#define NDPI_ISSET_BIT(num, n)  (num & (1ULL << ( n )))
#define NDPI_ZERO_BIT(num)      num = 0
#define NDPI_ONES_BIT(num)      num = -1;

#define ndpi_min(a,b)   ((a < b) ? a : b)
#define ndpi_max(a,b)   ((a > b) ? a : b)

#define NDPI_NUM_DEFAULT_ROOT_NODES        512

#define NDPI_IPSEC_PROTOCOL_ESP    50
#define NDPI_IPSEC_PROTOCOL_AH     51
#define NDPI_GRE_PROTOCOL_TYPE     0x2F
#define NDPI_ICMP_PROTOCOL_TYPE    0x01
#define NDPI_IGMP_PROTOCOL_TYPE    0x02
#define NDPI_EGP_PROTOCOL_TYPE     0x08
#define NDPI_OSPF_PROTOCOL_TYPE    0x59
#define NDPI_VRRP_PROTOCOL_TYPE    112
#define NDPI_SCTP_PROTOCOL_TYPE    132
#define NDPI_IPIP_PROTOCOL_TYPE    0x04
#define NDPI_ICMPV6_PROTOCOL_TYPE  0x3a
#define NDPI_PGM_PROTOCOL_TYPE     0x71
#define NDPI_PIM_PROTOCOL_TYPE     0x67

#define NDPI_ARRAY_LENGTH(array) (sizeof(array) / sizeof((array)[0]))

/* The get_uXX helpers return raw network packet bytes. */
#ifndef NDPI_CFFI_PREPROCESSING
#include <stdint.h>
#include <string.h>

#define get_u_int8_t(X,O)   (((const uint8_t *)(X))[O])

static inline uint16_t ndpi_get_u_int16_t(const void *X, int O)
{
  uint16_t value;
  memcpy(&value, ((const uint8_t *)X) + O, sizeof(value));
  return value;
}

static inline uint32_t ndpi_get_u_int32_t(const void *X, int O)
{
  uint32_t value;
  memcpy(&value, ((const uint8_t *)X) + O, sizeof(value));
  return value;
}

static inline uint64_t ndpi_get_u_int64_t(const void *X, int O)
{
  uint64_t value;
  memcpy(&value, ((const uint8_t *)X) + O, sizeof(value));
  return value;
}

#define get_u_int16_t(X,O)  ndpi_get_u_int16_t((X), (O))
#define get_u_int32_t(X,O)  ndpi_get_u_int32_t((X), (O))
#define get_u_int64_t(X,O)  ndpi_get_u_int64_t((X), (O))
#endif /* NDPI_CFFI_PREPROCESSING */

/* new definitions to get little endian from network bytes */
#define get_ul8(X,O) get_u_int8_t(X,O)

#if defined(__LITTLE_ENDIAN__) || defined(_LITTLE_ENDIAN)
#define get_l16(X,O)  get_u_int16_t(X,O)
#define get_l32(X,O)  get_u_int32_t(X,O)
#elif defined(__BIG_ENDIAN__) || defined(__BIG_ENDIAN)
/* convert the bytes from big to little endian */
# define get_l16(X,O) bswap_16(get_u_int16_t(X,O))
# define get_l32(X,O) bswap_32(get_u_int32_t(X,O))
#else
#error "__BYTE_ORDER MUST BE DEFINED !"
#endif              /* __BYTE_ORDER */

/* define memory callback function */
#define match_first_bytes(payload,st) (memcmp((payload),(st),(sizeof(st)-1))==0)

#if defined(WIN32)
#undef strtok_r
#define strtok_r strtok_s

#if BYTE_ORDER == LITTLE_ENDIAN
#define le16toh(x) (x)
#define le32toh(x) (x)
#else
#error "byte order not supported"
#endif

#endif /* WIN32 */

#define NDPI_MAJOR                              6
#define NDPI_MINOR                              1
#define NDPI_PATCH                              0

#define NDPI_MAX_DNS_REQUESTS                   75
#define NDPI_MIN_NUM_STUN_DETECTION             8

/* IMPORTANT: order according to its severity */
#define NDPI_CIPHER_SAFE                        0
#define NDPI_CIPHER_WEAK                        1
#define NDPI_CIPHER_INSECURE                    2

#define NDPI_OPTIMAL_HLL_NUM_BUCKETS           16

#ifdef __APPLE__

#include <libkern/OSByteOrder.h>

#ifndef htobe16
#   define htobe16(x) OSSwapHostToBigInt16(x)
#endif

#ifndef htole16
#   define htole16(x) OSSwapHostToLittleInt16(x)
#endif

#ifndef be16toh
#   define be16toh(x) OSSwapBigToHostInt16(x)
#endif

#ifndef le16toh
#   define le16toh(x) OSSwapLittleToHostInt16(x)
#endif

#ifndef htobe32
#   define htobe32(x) OSSwapHostToBigInt32(x)
#endif

#ifndef htole32
#   define htole32(x) OSSwapHostToLittleInt32(x)
#endif

#ifndef be32toh
#   define be32toh(x) OSSwapBigToHostInt32(x)
#endif

#ifndef le32toh
#   define le32toh(x) OSSwapLittleToHostInt32(x)
#endif

#ifndef htobe64
#   define htobe64(x) OSSwapHostToBigInt64(x)
#endif

#ifndef htole64
#   define htole64(x) OSSwapHostToLittleInt64(x)
#endif

#ifndef be64toh
#   define be64toh(x) OSSwapBigToHostInt64(x)
#endif

#ifndef le64toh
#   define le64toh(x) OSSwapLittleToHostInt64(x)
#endif

#endif /* __APPLE__ */


#if defined(_WINDOWS_)

#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__

#ifndef htobe16
#define htobe16(x) htons(x)
#endif

#ifndef htole16
#define htole16(x) (x)
#endif

#ifndef be16toh
#define be16toh(x) ntohs(x)
#endif

#ifndef le16toh
#define le16toh(x) (x)
#endif

#ifndef htobe32
#define htobe32(x) htonl(x)
#endif

#ifndef htole32
#define htole32(x) (x)
#endif

#ifndef be32toh
#define be32toh(x) ntohl(x)
#endif

#ifndef le32toh
#define le32toh(x) (x)
#endif

#ifndef htobe64
#define htobe64(x) ndpi_htonll(x)
#endif

#ifndef htole64
#define htole64(x) (x)
#endif

#ifndef be64toh
#define be64toh(x) ndpi_ntohll(x)
#endif

#ifndef le64toh
#define le64toh(x) (x)
#endif

#elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__

#ifndef htobe16
#define htobe16(x) (x)
#endif

#ifndef htole16
#define htole16(x) __builtin_bswap16(x)
#endif

#ifndef be16toh
#define be16toh(x) (x)
#endif

#ifndef le16toh
#define le16toh(x) __builtin_bswap16(x)
#endif

#ifndef htobe32
#define htobe32(x) (x)
#endif

#ifndef htole32
#define htole32(x) __builtin_bswap32(x)
#endif

#ifndef be32toh
#define be32toh(x) (x)
#endif

#ifndef le32toh
#define le32toh(x) __builtin_bswap32(x)
#endif

#ifndef htobe64
#define htobe64(x) (x)
#endif

#ifndef htole64
#define htole64(x) __builtin_bswap64(x)
#endif

#ifndef be64toh
#define be64toh(x) (x)
#endif

#ifndef le64toh
#define le64toh(x) __builtin_bswap64(x)
#endif

#else
#error Unexpected __BYTE_ORDER__

#endif /* __BYTE_ORDER__ */
#endif /* __MINGW32__ */


#ifndef ETH_ARP
#define ETH_ARP                0x0806
#endif

#ifndef ETH_P_IP
#define ETH_P_IP               0x0800   /* IPv4 */
#endif

#ifndef ETH_P_IPV6
#define ETH_P_IPV6         0x86dd /* IPv6 */
#endif

#ifndef ETH_P_VLAN
#define ETH_P_VLAN             0x8100
#endif

#ifndef ETH_P_MPLS_UNI
#define ETH_P_MPLS_UNI         0x8847
#endif

#ifndef ETH_P_MPLS_MULTI
#define ETH_P_MPLS_MULTI       0x8848
#endif

#ifndef ETH_P_PPPoE
#define ETH_P_PPPoE            0x8864
#endif

#define MAX_NBPF_CUSTOM_PROTO  8

/* Unused parameters can be silenced as follows */
#define __ndpi_unused_param(x) (void)(x)

/* Maximum number of plugins supported by nDPI */
#define NDPI_MAX_NUM_PLUGINS    32

/* JA3/4 Information */
#define MAX_NUM_JA         128
#define MAX_JA_STRLEN      256

#endif /* __NDPI_DEFINE_INCLUDE_FILE__ */

Coverage Report

Created: 2026-09-14 06:54

Line	Count	Source
1		/*
2		*
3		* Copyright (C) 2011-17 - ntop.org
4		*
5		* This file is part of nDPI, an open source deep packet inspection
6		* library based on the OpenDPI and PACE technology by ipoque GmbH
7		*
8		* nDPI is free software: you can redistribute it and/or modify
9		* it under the terms of the GNU Lesser General Public License as published by
10		* the Free Software Foundation, either version 3 of the License, or
11		* (at your option) any later version.
12		*
13		* nDPI is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16		* GNU Lesser General Public License for more details.
17		*
18		* You should have received a copy of the GNU Lesser General Public License
19		* along with nDPI. If not, see <http://www.gnu.org/licenses/>.
20		*
21		*/
22
23		#ifndef __NDPI_DEFINE_INCLUDE_FILE__
24		#define __NDPI_DEFINE_INCLUDE_FILE__
25
26		/*
27		* The #define below is used for apps that dynamically link with nDPI to make
28		* sure that datastructures and in sync across versions
29		*/
30		#define NDPI_API_VERSION 15
31
32		/*
33		gcc -E -dM - < /dev/null \|grep ENDIAN
34		*/
35
36		#if defined(__FreeBSD__) \|\| defined(__NetBSD__)
37		#include <sys/endian.h>
38		#endif
39