wtp_pdu.h File Reference

#include "gwlib/gwlib.h"
#include "wtp_pdu.def"

Go to the source code of this file.

Data Structures
struct	wtp_tpi
struct	wtp_pdu

Macros
#define	PDU(name, docstring, fields, is_valid)   name,
#define	PDU(name, docstring, fields, is_valid)   struct name { fields } name;
#define	UINT(field, docstring, bits)   unsigned long field;
#define	UINTVAR(field, docstring)   unsigned long field;
#define	OCTSTR(field, docstring, lengthfield)   Octstr *field;
#define	REST(field, docstring)   Octstr *field;
#define	TYPE(bits, value)
#define	RESERVED(bits)
#define	TPI(confield)

Typedefs
typedef struct wtp_tpi	WTP_TPI
typedef struct wtp_pdu	WTP_PDU

Enumerations
enum	wtp_pdu_types { PDU, PDU }

Functions
void	wtp_pdu_append_tpi (WTP_PDU *pdu, int type, Octstr *data)
WTP_PDU *	wtp_pdu_create (int type)
WTP_PDU *	wtp_pdu_unpack (Octstr *data)
Octstr *	wtp_pdu_pack (WTP_PDU *pdu)
void	wtp_pdu_dump (WTP_PDU *pdu, int level)
void	wtp_pdu_destroy (WTP_PDU *pdu)
void	wtp_tpi_destroy (WTP_TPI *tpi)

Macro Definition Documentation

OCTSTR

#define OCTSTR	(		field,
			docstring,
			lengthfield
	)		Octstr *field;

Definition at line 92 of file wtp_pdu.h.

PDU [1/2]

#define PDU	(		name,
			docstring,
			fields,
			is_valid
	)		name,

Definition at line 89 of file wtp_pdu.h.

PDU [2/2]

#define PDU	(		name,
			docstring,
			fields,
			is_valid
	)		struct name { fields } name;

Definition at line 89 of file wtp_pdu.h.

RESERVED

#define RESERVED

(

bits

)

Definition at line 95 of file wtp_pdu.h.

REST

#define REST	(		field,
			docstring
	)		Octstr *field;

Definition at line 93 of file wtp_pdu.h.

TPI

#define TPI

(

confield

)

Definition at line 96 of file wtp_pdu.h.

TYPE

#define TYPE	(		bits,
			value
	)

Definition at line 94 of file wtp_pdu.h.

UINT

#define UINT	(		field,
			docstring,
			bits
	)		unsigned long field;

Definition at line 90 of file wtp_pdu.h.

UINTVAR

#define UINTVAR	(		field,
			docstring
	)		unsigned long field;

Definition at line 91 of file wtp_pdu.h.

Typedef Documentation

WTP_PDU

typedef struct wtp_pdu WTP_PDU

Definition at line 108 of file wtp_pdu.h.

WTP_TPI

typedef struct wtp_tpi WTP_TPI

Definition at line 74 of file wtp_pdu.h.

Enumeration Type Documentation

wtp_pdu_types

enum wtp_pdu_types

Enumerator
PDU
PDU

Definition at line 77 of file wtp_pdu.h.

                   {
#define PDU(name, docstring, fields, is_valid) name,
#include "wtp_pdu.def"
#undef PDU
};

Function Documentation

wtp_pdu_append_tpi()

void wtp_pdu_append_tpi	(	WTP_PDU *	pdu,
		int	type,
		Octstr *	data
	)

Definition at line 153 of file wtp_pdu.c.

References wtp_tpi::data, gwlist_append(), gwlist_create, wtp_pdu::options, wtp_tpi::type, and type.

Referenced by unpack_tpis(), and wtp_pack_sar_ack().

                                                              {
    WTP_TPI *tpi;

    tpi = gw_malloc(sizeof(*tpi));
    tpi->type = type;
    tpi->data = data;
    if (pdu->options == NULL)
        pdu->options = gwlist_create();
    gwlist_append(pdu->options, tpi);
}

wtp_pdu_create()

WTP_PDU* wtp_pdu_create

(

int

type

)

Definition at line 67 of file wtp_pdu.c.

References wtp_pdu::options, wtp_pdu::type, type, and warning().

Referenced by wtp_pack_abort(), wtp_pack_ack(), wtp_pack_invoke(), wtp_pack_result(), wtp_pack_sar_ack(), and wtp_pack_sar_result().

                                  {
    WTP_PDU *pdu;
    
    pdu = gw_malloc(sizeof(*pdu));
    pdu->type = type;
    pdu->options = NULL;

    switch (pdu->type) {
#define PDU(name, docstring, fields, is_valid) \
    case name: {\
    struct name *p; p = &pdu->u.name; \
    fields \
    } break;
#define UINT(field, docstring, bits) p->field = 0;
#define UINTVAR(field, docstring) p->field = 0;
#define OCTSTR(field, docstring, lengthfield) p->field = NULL;
#define REST(field, docstring) p->field = NULL;
#define TYPE(bits, value) 
#define RESERVED(bits) 
#define TPI(confield)
#include "wtp_pdu.def"
#undef TPI
#undef RESERVED
#undef TYPE
#undef REST
#undef OCTSTR
#undef UINTVAR
#undef UINT
#undef PDU
    default:
        warning(0, "Cannot create unknown WTP PDU type %d", pdu->type);
        break;
    }

    return pdu;
}

wtp_pdu_destroy()

void wtp_pdu_destroy

(

WTP_PDU *

pdu

)

Definition at line 104 of file wtp_pdu.c.

References gwlist_consume(), gwlist_destroy(), gwlist_len(), wtp_pdu::options, wtp_pdu::type, warning(), and wtp_tpi_destroy().

Referenced by main(), unpack_wdp_datagram_real(), wtp_pack_abort(), wtp_pack_ack(), wtp_pack_invoke(), wtp_pack_result(), wtp_pack_sar_ack(), and wtp_pack_sar_result().

                                   {
    if (pdu == NULL)
        return;

    switch (pdu->type) {
#define PDU(name, docstring, fields, is_valid) \
    case name: {\
    struct name *p; p = &pdu->u.name; \
    fields \
    } break;
#define UINT(field, docstring, bits)
#define UINTVAR(field, docstring)
#define OCTSTR(field, docstring, lengthfield) octstr_destroy(p->field);
#define REST(field, docstring) octstr_destroy(p->field);
#define TYPE(bits, value)
#define RESERVED(bits)
#define TPI(confield)
#include "wtp_pdu.def"
#undef TPI
#undef RESERVED
#undef TYPE
#undef REST
#undef OCTSTR
#undef UINTVAR
#undef UINT
#undef PDU
    default:
        warning(0, "Cannot destroy unknown WTP PDU type %d", pdu->type);
        break;
    }

    if (pdu->options) {
        while (gwlist_len(pdu->options)) {
            wtp_tpi_destroy(gwlist_consume(pdu->options));
        }
        gwlist_destroy(pdu->options, NULL);
    }

    gw_free(pdu);
}

wtp_pdu_dump()

void wtp_pdu_dump	(	WTP_PDU *	pdu,
		int	level
	)

Definition at line 446 of file wtp_pdu.c.

References debug(), and wtp_pdu::type.

Referenced by main().

                                           {
     char *dbg = "wap.wtp";

    switch (pdu->type) {
#define PDU(name, docstring, fields, is_valid) \
    case name: { \
        struct name *p = &pdu->u.name; \
        debug(dbg, 0, "%*sWTP %s PDU at %p:", \
            level, "", #name, (void *)pdu); \
        fields \
    } break;
#define UINT(field, docstring, bits) \
    debug(dbg, 0, "%*s %s: %lu", level, "", docstring, p->field);
#define UINTVAR(field, docstring) \
    debug(dbg, 0, "%*s %s: %lu", level, "", docstring, p->field);
#define OCTSTR(field, docstring, lengthfield) \
    debug(dbg, 0, "%*s %s:", level, "", docstring); \
    octstr_dump(p->field, level + 1);
#define REST(field, docstring) \
    debug(dbg, 0, "%*s %s:", level, "", docstring); \
    octstr_dump(p->field, level + 1);
#define TYPE(bits, value)
#define RESERVED(bits)
#define TPI(confield) dump_tpis(pdu->options, level);
#include "wtp_pdu.def"
#undef TPI
#undef RESERVED
#undef TYPE
#undef REST
#undef OCTSTR
#undef UINTVAR
#undef UINT
#undef PDU
    default:
        debug(dbg, 0, "%*sWTP PDU at %p:", level, "", (void *)pdu);
        debug(dbg, 0, "%*s unknown type %u", level, "", pdu->type);
        break;
    }
}

wtp_pdu_pack()

Octstr* wtp_pdu_pack

(

WTP_PDU *

pdu

)

Definition at line 388 of file wtp_pdu.c.

References fixup_length_fields(), octstr_create, panic, and wtp_pdu::type.

Referenced by main(), wtp_pack_abort(), wtp_pack_ack(), wtp_pack_invoke(), wtp_pack_result(), wtp_pack_sar_ack(), and wtp_pack_sar_result().

                                   {
    Octstr *data;
    long bitpos;

    /* We rely on octstr_set_bits to lengthen our octstr as needed. */
    data = octstr_create("");

    fixup_length_fields(pdu);

    bitpos = 0;
    switch (pdu->type) {
#define PDU(name, docstring, fields, is_valid) \
    case name: { \
        struct name *p = &pdu->u.name; \
        fields \
        gw_assert(bitpos % 8 == 0); \
    } break;
#define UINT(field, docstring, bits) \
    octstr_set_bits(data, bitpos, (bits), p->field); \
    bitpos += (bits);
#define UINTVAR(field, docstring) \
    gw_assert(bitpos % 8 == 0); \
    octstr_append_uintvar(data, p->field); \
    bitpos = 8 * octstr_len(data);
#define OCTSTR(field, docstring, lengthfield) \
    gw_assert(bitpos % 8 == 0); \
    if (p->field != NULL) \
        octstr_append(data, p->field); \
    bitpos += 8 * octstr_len(p->field);
#define REST(field, docstring) \
    gw_assert(bitpos % 8 == 0); \
    if (p->field != NULL) \
        octstr_append(data, p->field); \
    bitpos += 8 * octstr_len(p->field);
#define TYPE(bits, value) \
    octstr_set_bits(data, bitpos, (bits), (value)); \
    bitpos += (bits);
#define RESERVED(bits) bitpos += (bits);
#define TPI(confield) \
    if (p->confield) { \
        bitpos = pack_tpis(data, bitpos, pdu->options); \
    }
#include "wtp_pdu.def"
#undef TPI
#undef RESERVED
#undef TYPE
#undef REST
#undef OCTSTR
#undef UINTVAR
#undef UINT
#undef PDU
    default:
        panic(0, "Packing unknown WTP PDU type %ld", (long) pdu->type);
    }

    return data;
}

wtp_pdu_unpack()

WTP_PDU* wtp_pdu_unpack

(

Octstr *

data

)

Definition at line 284 of file wtp_pdu.c.

References gw_assert(), wtp_pdu::options, wtp_pdu::type, warning(), and wtp_pdu_type().

Referenced by main(), and unpack_wdp_datagram_real().

                                      {
    WTP_PDU *pdu = NULL;
    long bitpos = 0;

    gw_assert(data != NULL);

    pdu = gw_malloc(sizeof(*pdu));

    pdu->type = wtp_pdu_type(data);
    pdu->options = NULL;

    switch (pdu->type) {
#define PDU(name, docstring, fields, is_valid) \
    case name: { \
        struct name *p = &pdu->u.name; \
        fields \
        gw_assert(bitpos % 8 == 0); \
        if (bitpos / 8 != octstr_len(data)) { \
            warning(0, "Bad length for " #name " PDU, " \
                "expected %ld", bitpos / 8); \
        } \
        if (!(is_valid)) { \
            warning(0, #name " PDU failed %s", #is_valid); \
                        return NULL; \
        } \
    } break;
#define UINT(field, docstring, bits) \
    p->field = octstr_get_bits(data, bitpos, (bits)); \
    bitpos += (bits);
#define UINTVAR(field, docstring) \
    gw_assert(bitpos % 8 == 0); \
    p->field = octstr_get_bits(data, bitpos + 1, 7); \
    while (octstr_get_bits(data, bitpos, 1)) { \
        bitpos += 8; \
        p->field <<= 7; \
        p->field |= octstr_get_bits(data, bitpos + 1, 7); \
    } \
    bitpos += 8;
#define OCTSTR(field, docstring, lengthfield) \
    gw_assert(bitpos % 8 == 0); \
    p->field = octstr_copy(data, bitpos / 8, p->lengthfield); \
    bitpos += 8 * p->lengthfield;
#define REST(field, docstring) \
    gw_assert(bitpos % 8 == 0); \
    if (bitpos / 8 <= octstr_len(data)) { \
        p->field = octstr_copy(data, bitpos / 8, \
                octstr_len(data) - bitpos / 8); \
        bitpos = octstr_len(data) * 8; \
    } else { \
        p->field = octstr_create(""); \
    }
#define TYPE(bits, value) bitpos += (bits);
#define RESERVED(bits) bitpos += (bits);
#define TPI(confield) \
    if (p->confield) { \
        pdu->options = gwlist_create(); \
        bitpos = unpack_tpis(data, bitpos, pdu); \
    }
#include "wtp_pdu.def"
#undef TPI
#undef RESERVED
#undef TYPE
#undef REST
#undef OCTSTR
#undef UINTVAR
#undef UINT
#undef PDU
    default:
        warning(0, "WTP PDU with unknown type %d", pdu->type);
        gw_free(pdu);
        return NULL;
    }

    return pdu;
}

wtp_tpi_destroy()

void wtp_tpi_destroy

(

WTP_TPI *

tpi

)

Definition at line 145 of file wtp_pdu.c.

References wtp_tpi::data, and octstr_destroy().

Referenced by wtp_pdu_destroy().

                                 {
    if (p == NULL)
        return;

    octstr_destroy(p->data);
    gw_free(p);
}