* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ * SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __ADDRESS_H__
#include <string.h> /* for memcmp */
+#include "tvbuff.h"
+#include "wmem/wmem.h"
+
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
AT_IPv4, /* IPv4 */
AT_IPv6, /* IPv6 */
AT_IPX, /* IPX */
- AT_VINES, /* Banyan Vines */
AT_FC, /* Fibre Channel */
AT_FCWWN, /* Fibre Channel WWN */
- AT_SS7PC, /* SS7 Point Code */
AT_STRINGZ, /* null-terminated string */
AT_EUI64, /* IEEE EUI-64 */
AT_IB, /* Infiniband GID/LID */
- AT_USB, /* USB Device address
- * (0xffffffff represents the host) */
AT_AX25, /* AX.25 */
+ AT_VINES, /* Banyan Vines address */
AT_END_OF_LIST /* Must be last in list */
} address_type;
typedef struct _address {
int type; /* type of address */
int len; /* length of address, in bytes */
- const void *data; /* pointer to address data */
+ const void *data; /* pointer to address data */
+
+ /* private */
+ void *priv;
} address;
+#define ADDRESS_INIT(type, len, data) {type, len, data, NULL}
+#define ADDRESS_INIT_NONE ADDRESS_INIT(AT_NONE, 0, NULL)
+
+static inline void
+clear_address(address *addr)
+{
+ addr->type = AT_NONE;
+ addr->len = 0;
+ addr->data = NULL;
+ addr->priv = NULL;
+}
+
/** Initialize an address with the given values.
*
* @param addr [in,out] The address to initialize.
* @param addr_type [in] Address type.
* @param addr_len [in] The length in bytes of the address data. For example, 4 for
- * AT_IPv4 or sizeof(struct e_in6_addr) for AT_IPv6.
+ * AT_IPv4 or sizeof(ws_in6_addr) for AT_IPv6.
* @param addr_data [in] Pointer to the address data.
*/
static inline void
-set_address(address *addr, int addr_type, int addr_len, const void * addr_data) {
- addr->data = addr_data;
+set_address(address *addr, int addr_type, int addr_len, const void *addr_data) {
+ if (addr_len == 0) {
+ /* Zero length must mean no data */
+ g_assert(addr_data == NULL);
+ } else {
+ /* Must not be AT_NONE - AT_NONE must have no data */
+ g_assert(addr_type != AT_NONE);
+ /* Make sure we *do* have data */
+ g_assert(addr_data != NULL);
+ }
addr->type = addr_type;
addr->len = addr_len;
+ addr->data = addr_data;
+ addr->priv = NULL;
}
-#define SET_ADDRESS(addr, addr_type, addr_len, addr_data) \
- set_address((addr), (addr_type), (addr_len), (addr_data))
/** Initialize an address from TVB data.
*
- * Same as SET_ADDRESS but it takes a TVB and an offset. This is preferred
+ * Same as set_address but it takes a TVB and an offset. This is preferred
* over passing the return value of tvb_get_ptr() to set_address().
*
* This calls tvb_get_ptr() (including throwing any exceptions) before
* @param tvb [in] Pointer to the TVB.
* @param offset [in] Offset within the TVB.
* @param addr_len [in] The length in bytes of the address data. For example, 4 for
- * AT_IPv4 or sizeof(struct e_in6_addr) for AT_IPv6.
+ * AT_IPv4 or sizeof(ws_in6_addr) for AT_IPv6.
+ */
+static inline void
+set_address_tvb(address *addr, int addr_type, int addr_len, tvbuff_t *tvb, int offset) {
+ const void *p;
+
+ if (addr_len != 0) {
+ /* Must not be AT_NONE - AT_NONE must have no data */
+ g_assert(addr_type != AT_NONE);
+ p = tvb_get_ptr(tvb, offset, addr_len);
+ } else
+ p = NULL;
+ set_address(addr, addr_type, addr_len, p);
+}
+
+/** Initialize an address with the given values, allocating a new buffer
+ * for the address data using wmem-scoped memory.
+ *
+ * @param scope [in] The lifetime of the allocated memory, e.g., wmem_packet_scope()
+ * @param addr [in,out] The address to initialize.
+ * @param addr_type [in] Address type.
+ * @param addr_len [in] The length in bytes of the address data. For example, 4 for
+ * AT_IPv4 or sizeof(ws_in6_addr) for AT_IPv6.
+ * @param addr_data [in] Pointer to the address data.
+ */
+static inline void
+alloc_address_wmem(wmem_allocator_t *scope, address *addr,
+ int addr_type, int addr_len, const void *addr_data) {
+ g_assert(addr);
+ clear_address(addr);
+ addr->type = addr_type;
+ if (addr_len == 0) {
+ /* Zero length must mean no data */
+ g_assert(addr_data == NULL);
+ /* Nothing to copy */
+ return;
+ }
+ /* Must not be AT_NONE - AT_NONE must have no data */
+ g_assert(addr_type != AT_NONE);
+ /* Make sure we *do* have data to copy */
+ g_assert(addr_data != NULL);
+ addr->data = addr->priv = wmem_memdup(scope, addr_data, addr_len);
+ addr->len = addr_len;
+}
+
+/** Allocate an address from TVB data.
+ *
+ * Same as alloc_address_wmem but it takes a TVB and an offset.
+ *
+ * @param scope [in] The lifetime of the allocated memory, e.g., wmem_packet_scope()
+ * @param addr [in,out] The address to initialize.
+ * @param addr_type [in] Address type.
+ * @param addr_len [in] The length in bytes of the address data. For example, 4 for
+ * AT_IPv4 or sizeof(ws_in6_addr) for AT_IPv6.
+ * @param tvb [in] Pointer to the TVB.
+ * @param offset [in] Offset within the TVB.
*/
-#define TVB_SET_ADDRESS(addr, addr_type, tvb, offset, addr_len) \
- do { \
- const void *TVB_SET_ADDRESS_data = (const void *)tvb_get_ptr(tvb, offset, addr_len); \
- set_address((addr), (addr_type), (addr_len), TVB_SET_ADDRESS_data); \
- } while (0)
+static inline void
+alloc_address_tvb(wmem_allocator_t *scope, address *addr,
+ int addr_type, int addr_len, tvbuff_t *tvb, int offset) {
+ const void *p;
+
+ p = tvb_get_ptr(tvb, offset, addr_len);
+ alloc_address_wmem(scope, addr, addr_type, addr_len, p);
+}
/** Compare two addresses.
*
if (addr1->type < addr2->type) return -1;
if (addr1->len > addr2->len) return 1;
if (addr1->len < addr2->len) return -1;
+ if (addr1->len == 0) {
+ /*
+ * memcmp(NULL, NULL, 0) is *not* guaranteed to work, so
+ * if both addresses are zero-length, don't compare them
+ * (there's nothing to compare, so they're equal).
+ */
+ return 0;
+ }
return memcmp(addr1->data, addr2->data, addr1->len);
}
-#define CMP_ADDRESS(addr1, addr2) cmp_address((addr1), (addr2))
/** Check two addresses for equality.
*
* Given two addresses, return "true" if they're equal, "false" otherwise.
- * Addresses are equal only if they have the same type; if the type is
- * AT_NONE, they are then equal, otherwise they must have the same
- * amount of data and the data must be the same.
+ * Addresses are equal only if they have the same type and length; if the
+ * length is zero, they are then equal, otherwise the data must be the
+ * same.
*
* @param addr1 [in] The first address to compare.
* @param addr2 [in] The second address to compare.
- * @return TRUE if the adresses are equal, FALSE otherwise.
+ * @return TRUE if the addresses are equal, FALSE otherwise.
*/
static inline gboolean
addresses_equal(const address *addr1, const address *addr2) {
- if (addr1->type == addr2->type
- && ( addr1->type == AT_NONE
- || ( addr1->len == addr2->len
- && memcmp(addr1->data, addr2->data, addr1->len) == 0
- )
- )
- ) return TRUE;
+ /*
+ * memcmp(NULL, NULL, 0) is *not* guaranteed to work, so
+ * if both addresses are zero-length, don't compare them
+ * (there's nothing to compare, so they're equal).
+ */
+ if (addr1->type == addr2->type &&
+ addr1->len == addr2->len &&
+ (addr1->len == 0 ||
+ memcmp(addr1->data, addr2->data, addr1->len) == 0))
+ return TRUE;
return FALSE;
}
-#define ADDRESSES_EQUAL(addr1, addr2) addresses_equal((addr1), (addr2))
/** Check the data of two addresses for equality.
*
*
* @param addr1 [in] The first address to compare.
* @param addr2 [in] The second address to compare.
- * @return TRUE if the adresses are equal, FALSE otherwise.
+ * @return TRUE if the addresses are equal, FALSE otherwise.
*/
static inline gboolean
addresses_data_equal(const address *addr1, const address *addr2) {
return FALSE;
}
-/** Copy an address, allocating a new buffer for the address data.
+/** Perform a shallow copy of the address (both addresses point to the same
+ * memory location).
*
* @param to [in,out] The destination address.
* @param from [in] The source address.
+ *
+ * \warning Make sure 'from' memory stays valid for the lifetime of this object.
+ * Also it's strongly recommended to use this function instead of copy-assign.
*/
static inline void
-copy_address(address *to, const address *from) {
- guint8 *to_data;
-
- to->type = from->type;
- to->len = from->len;
- to_data = (guint8 *)g_malloc(from->len);
- if (from->len != 0)
- memcpy(to_data, from->data, from->len);
- to->data = to_data;
+copy_address_shallow(address *to, const address *from) {
+ set_address(to, from->type, from->len, from->data);
}
-#define COPY_ADDRESS(to, from) copy_address((to), (from))
-/** Perform a shallow copy of the address (both addresses point to the same
- * memory location).
+/** Copy an address, allocating a new buffer for the address data
+ * using wmem-scoped memory.
*
+ * @param scope [in] The lifetime of the allocated memory, e.g., wmem_packet_scope()
* @param to [in,out] The destination address.
* @param from [in] The source address.
*/
static inline void
-copy_address_shallow(address *to, const address *from) {
- memcpy(to, from, sizeof(address));
- /*
- to->type = from->type;
- to->len = from->len;
- to->data = from->data;
- */
+copy_address_wmem(wmem_allocator_t *scope, address *to, const address *from) {
+ alloc_address_wmem(scope, to, from->type, from->len, from->data);
}
-#define COPY_ADDRESS_SHALLOW(to, from) copy_address_shallow((to), (from))
-/** Copy an address, allocating a new buffer for the address data
- * using wmem-scoped memory.
+/** Copy an address, allocating a new buffer for the address data.
*
- * @param scope [in] The lifetime of the allocated memory, wmem_packet_scope()
* @param to [in,out] The destination address.
* @param from [in] The source address.
*/
-#define WMEM_COPY_ADDRESS(scope, to, from) \
- do { \
- void *WMEM_COPY_ADDRESS_data; \
- copy_address_shallow((to), (from)); \
- WMEM_COPY_ADDRESS_data = wmem_alloc(scope, (from)->len); \
- if ((from)->len != 0) \
- memcpy(WMEM_COPY_ADDRESS_data, (from)->data, (from)->len); \
- (to)->data = WMEM_COPY_ADDRESS_data; \
- } while (0)
+static inline void
+copy_address(address *to, const address *from) {
+ copy_address_wmem(NULL, to, from);
+}
+/** Free an address allocated with wmem-scoped memory.
+ *
+ * @param scope [in] The lifetime of the allocated memory, e.g., wmem_packet_scope()
+ * @param addr [in,out] The address whose data to free.
+ */
+static inline void
+free_address_wmem(wmem_allocator_t *scope, address *addr) {
+ /* Because many dissectors set 'type = AT_NONE' to mean clear we check for that */
+ if (addr->type != AT_NONE && addr->len > 0 && addr->priv != NULL) {
+ /* Make sure API use is correct */
+ /* if priv is not null then data == priv */
+ g_assert(addr->data == addr->priv);
+ wmem_free(scope, addr->priv);
+ }
+ clear_address(addr);
+}
+
+/** Free an address.
+ *
+ * @param addr [in,out] The address whose data to free.
+ */
+static inline void
+free_address(address *addr) {
+ free_address_wmem(NULL, addr);
+}
/** Hash an address into a hash value (which must already have been set).
*
}
return hash_val;
}
-#define ADD_ADDRESS_TO_HASH(hash_val, addr) do { hash_val = add_address_to_hash(hash_val, (addr)); } while (0)
/** Hash an address into a hash value (which must already have been set).
* 64-bit version of add_address_to_hash().
return hash_val;
}
+WS_DLL_PUBLIC guint address_to_bytes(const address *addr, guint8 *buf, guint buf_len);
+
/* Types of port numbers Wireshark knows about. */
typedef enum {
PT_NONE, /* no port number */
PT_UDP, /* UDP */
PT_DCCP, /* DCCP */
PT_IPX, /* IPX sockets */
- PT_NCP, /* NCP connection */
- PT_EXCHG, /* Fibre Channel exchange */
PT_DDP, /* DDP AppleTalk connection */
- PT_SBCCS, /* FICON */
PT_IDP, /* XNS IDP sockets */
- PT_TIPC, /* TIPC PORT */
PT_USB, /* USB endpoint 0xffff means the host */
PT_I2C,
PT_IBQP, /* Infiniband QP number */
- PT_BLUETOOTH,
- PT_TDMOP
+ PT_BLUETOOTH
} port_type;
-/* Types of circuit IDs Wireshark knows about. */
-typedef enum {
- CT_NONE, /* no circuit type */
- CT_DLCI, /* Frame Relay DLCI */
- CT_ISDN, /* ISDN channel number */
- CT_X25, /* X.25 logical channel number */
- CT_ISUP, /* ISDN User Part CIC */
- CT_IAX2, /* IAX2 call id */
- CT_H223, /* H.223 logical channel number */
- CT_BICC, /* BICC Circuit identifier */
- CT_DVBCI /* DVB-CI session number|transport connection id */
- /* Could also have ATM VPI/VCI pairs */
-} circuit_type;
-
#ifdef __cplusplus
}
#endif /* __cplusplus */
git.samba.org / metze / wireshark / wip.git / blobdiff