Group socket_qos

group socket_qos

QoS Technologies

QoS settings are available for both Layer 2 and 3 of TCP/IP protocols:

Layer 2: IEEE 802.1p for Ethernet

IEEE 802.1p tagging will mark frames sent by a host for prioritized delivery using a 3-bit Priority field in the virtual local area network (VLAN) header of the Ethernet frame. The VLAN header is placed inside the Ethernet header, between the Source Address field and either the Length field (for an IEEE 802.3 frame) or the EtherType field (for an Ethernet II frame).

Layer 2: WMM

At the Network Interface layer for IEEE 802.11 wireless, the Wi-Fi Alliance certification for Wi-Fi Multimedia (WMM) defines four access categories for prioritizing network traffic. These access categories are (in order of highest to lowest priority) voice, video, best-effort, and background. Host support for WMM prioritization requires that both wireless network adapters and their drivers support WMM. Wireless access points (APs) must have WMM enabled.

Layer 3: DSCP

At the Internet layer, you can use Differentiated Services/Diffserv and set the value of the Differentiated Services Code Point (DSCP) in the IP header. As defined in RFC 2474, the DSCP value is the high-order 6 bits of the IP version 4 (IPv4) TOS field and the IP version 6 (IPv6) Traffic Class field.

Layer 3: Other

Other mechanisms exist (such as RSVP, IntServ) but this will not be implemented.

QoS Availability

Linux

DSCP is available via IP TOS option.

Ethernet 802.1p tagging is done by setting setsockopt(SO_PRIORITY) option of the socket, then with the set_egress_map option of the vconfig utility to convert this to set vlan-qos field of the packet.

WMM is not known to be available.

Windows and Windows Mobile

(It’s a mess!)

DSCP is settable with setsockopt() on Windows 2000 or older, but Windows would silently ignore this call on WinXP or later, unless administrator modifies the registry. On Windows 2000, Windows XP, and Windows Server 2003, GQoS (Generic QoS) API is the standard API, but this API may not be supported in the future. On Vista and Windows 7, the is a new QoS2 API, also known as Quality Windows Audio-Video Experience (qWAVE).

IEEE 802.1p tagging is available via Traffic Control (TC) API, available on Windows XP SP2, but this needs administrator access. For Vista and later, it’s in qWAVE.

WMM is available for mobile platforms on Windows Mobile 6 platform and Windows Embedded CE 6, via setsockopt(IP_DSCP_TRAFFIC_TYPE). qWAVE supports this as well.

Symbian S60 3rd Ed

Both DSCP and WMM is supported via RSocket::SetOpt() with will set both Layer 2 and Layer 3 QoS settings accordingly. Internally, PJLIB sets the DSCP field of the socket, and based on certain DSCP values mapping, Symbian will set the WMM tag accordingly.

PJLIB’s QoS API Abstraction

Based on the above, the following API is implemented.

Declare the following “standard” traffic types.

typedef enum pj_qos_type
{
   PJ_QOS_TYPE_BEST_EFFORT,
   PJ_QOS_TYPE_BACKGROUND, 
   PJ_QOS_TYPE_VIDEO,
   PJ_QOS_TYPE_VOICE,
   PJ_QOS_TYPE_CONTROL,
   PJ_QOS_TYPE_SIGNALLING
} pj_qos_type;

The traffic classes above will determine how the Layer 2 and 3 QoS settings will be used. The standard mapping between the classes above to the corresponding Layer 2 and 3 settings are as follows:

=================================================================
PJLIB Traffic Type  IP DSCP         WMM                 802.1p
-----------------------------------------------------------------
BEST_EFFORT         0x00            BE (Bulk Effort)        0
BACKGROUND          0x08            BK (Bulk)               2
VIDEO               0x28            VI (Video)              5
VOICE               0x30            VO (Voice)              6
CONTROL             0x38            VO (Voice)              7
SIGNALLING          0x28            VI (Video)              5
=================================================================

There are two sets of API provided to manipulate the QoS parameters.

Portable API

The first set of API is:

// Set QoS parameters
PJ_DECL(pj_status_t) pj_sock_set_qos_type(pj_sock_t sock,
                                          pj_qos_type val);

// Get QoS parameters
PJ_DECL(pj_status_t) pj_sock_get_qos_type(pj_sock_t sock,
                                          pj_qos_type *p_val);

The API will set the traffic type according to the DSCP class, for both Layer 2 and Layer 3 QoS settings, where it’s available. If any of the layer QoS setting is not settable, the API will silently ignore it. If both layers are not setable, the API will return error.

The API above is the recommended use of QoS, since it is the most portable across all platforms.

Fine Grained Control API

The second set of API is intended for application that wants to fine tune the QoS parameters.

The Layer 2 and 3 QoS parameters are stored in pj_qos_params structure:

typedef enum pj_qos_flag
{
   PJ_QOS_PARAM_HAS_DSCP = 1,
   PJ_QOS_PARAM_HAS_SO_PRIO = 2,
   PJ_QOS_PARAM_HAS_WMM = 4
} pj_qos_flag;

typedef enum pj_qos_wmm_prio
{
   PJ_QOS_WMM_PRIO_BULK_EFFORT,
   PJ_QOS_WMM_PRIO_BULK,
   PJ_QOS_WMM_PRIO_VIDEO,
   PJ_QOS_WMM_PRIO_VOICE
} pj_qos_wmm_prio;

typedef struct pj_qos_params
{
   pj_uint8_t      flags;    // Determines which values to 
                             // set, bitmask of pj_qos_flag
   pj_uint8_t      dscp_val; // The 6 bits DSCP value to set
   pj_uint8_t      so_prio;  // SO_PRIORITY value
   pj_qos_wmm_prio wmm_prio; // WMM priority value
} pj_qos_params;

The second set of API with more fine-grained control over the parameters are:

// Retrieve QoS params for the specified traffic type
PJ_DECL(pj_status_t) pj_qos_get_params(pj_qos_type type, 
                                       pj_qos_params *p);

// Set QoS parameters to the socket
PJ_DECL(pj_status_t) pj_sock_set_qos_params(pj_sock_t sock,
                                            const pj_qos_params *p);

// Get QoS parameters from the socket
PJ_DECL(pj_status_t) pj_sock_get_qos_params(pj_sock_t sock,
                                            pj_qos_params *p);

Important:

The pj_sock_set/get_qos_params() APIs are not portable, and it’s probably only going to be implemented on Linux. Application should always try to use pj_sock_set_qos_type() instead.

Enums

enum pj_qos_type

High level traffic classification.

Values:

enumerator PJ_QOS_TYPE_BEST_EFFORT: Best effort traffic (default value). Any QoS function calls with specifying this value are effectively no-op

enumerator PJ_QOS_TYPE_BACKGROUND: Background traffic.

enumerator PJ_QOS_TYPE_VIDEO: Video traffic.

enumerator PJ_QOS_TYPE_VOICE: Voice traffic.

enumerator PJ_QOS_TYPE_CONTROL: Control traffic.

enumerator PJ_QOS_TYPE_SIGNALLING: Signalling traffic.

enum pj_qos_flag

Bitmask flag to indicate which QoS layer setting is set in the flags field of the pj_qos_params structure.

Values:

enumerator PJ_QOS_PARAM_HAS_DSCP: DSCP field is set.

enumerator PJ_QOS_PARAM_HAS_SO_PRIO: Socket SO_PRIORITY

enumerator PJ_QOS_PARAM_HAS_WMM: WMM field is set.

enum pj_qos_wmm_prio

Standard WMM priorities.

Values:

enumerator PJ_QOS_WMM_PRIO_BULK_EFFORT: Bulk effort priority

enumerator PJ_QOS_WMM_PRIO_BULK: Bulk priority.

enumerator PJ_QOS_WMM_PRIO_VIDEO: Video priority

enumerator PJ_QOS_WMM_PRIO_VOICE: Voice priority

Functions

pj_status_t pj_sock_set_qos_type(pj_sock_t sock, pj_qos_type type)

This is the high level and portable API to enable QoS on the specified socket, by setting the traffic type to the specified parameter.

Parameters:

sock – The socket.
type – Traffic type to be set.

Returns:

PJ_SUCCESS if at least Layer 2 or Layer 3 setting is successfully set. If both Layer 2 and Layer 3 settings can’t be set, this function will return error.

pj_status_t pj_sock_get_qos_type(pj_sock_t sock, pj_qos_type *p_type)

This is the high level and portable API to get the traffic type that has been set on the socket. On occasions where the Layer 2 or Layer 3 settings were modified by using low level API, this function may return approximation of the closest QoS type that matches the settings.

Parameters:

sock – The socket.
p_type – Pointer to receive the traffic type of the socket.

Returns:

PJ_SUCCESS if traffic type for the socket can be obtained or approximated..

pj_status_t pj_sock_apply_qos(pj_sock_t sock, pj_qos_type qos_type, pj_qos_params *qos_params, unsigned log_level, const char *log_sender, const char *sock_name)

This is a convenience function to apply QoS to the socket, and print error logging if the operations failed. Both QoS traffic type and the low level QoS parameters can be applied with this function.