inet::DiffservUtil Namespace Reference

Classes
class	ColorAttribute

Enumerations
enum	Color { GREEN, YELLOW, RED }

Functions
const char *	getRequiredAttribute (cXMLElement *element, const char *attrName)
	Returns the value of the named attribute of the XML element, or throws an exception if not found. More...
double	parseInformationRate (const char *attrValue, const char *attrName, IInterfaceTable *ift, cSimpleModule &owner, int defaultValue)
	Parses the information rate parameter (bits/sec). More...
int	parseIntAttribute (const char *attrValue, const char *attrName, bool isOptional=true)
	Parses an integer attribute. More...
int	parseProtocol (const char *attrValue, const char *attrName)
	Parses an IP protocol number. More...
int	parseDSCP (const char *attrValue, const char *attrName)
	Parses a Diffserv code point. More...
void	parseDSCPs (const char *attrValue, const char *attrName, std::vector< int > &result)
	Parses a space separated list of DSCP values and puts them into the result vector. More...
std::string	dscpToString (int dscp)
	Returns the string representation of the given DSCP value. More...
std::string	colorToString (int color)
	Returns the string representation of the given color. More...
double	getInterfaceDatarate (IInterfaceTable *ift, cSimpleModule *interfaceModule)
	Returns the datarate of the interface containing the given module. More...
cPacket *	findIPDatagramInPacket (cPacket *packet)
	Returns the IP datagram encapsulated inside packet, or the packet itself if it is an IPv4/IPv6 datagram. More...
int	getColor (cPacket *packet)
	Returns the color of the packet. More...
void	setColor (cPacket *packet, int color)
	Sets the color of the packet. More...
bool	isEmpty (const char *str)
	Returns true, if the string is empty (nullptr or "");. More...

Variables
cEnum *	dscpEnum = nullptr
cEnum *	protocolEnum = nullptr

Enumeration Type Documentation

enum inet::DiffservUtil::Color

Enumerator
GREEN
YELLOW
RED

{ GREEN, YELLOW, RED };

Function Documentation

std::string inet::DiffservUtil::colorToString

(

int

color

)

Returns the string representation of the given color.

For values defined in IMeter.h it returns their name, other values are returned as decimal constants.

Referenced by inet::DiffservUtil::ColorAttribute::info(), and isEmpty().

{
    switch (color) {
        case GREEN:
            return "green";

        case YELLOW:
            return "yellow";

        case RED:
            return "red";

        default:
            return ltostr(color);
    }
}

std::string inet::DiffservUtil::dscpToString

(

int

dscp

)

Returns the string representation of the given DSCP value.

Values defined in DSCP.msg are returned as "BE", "AF11", etc., others are returned as a decimal number.

Referenced by isEmpty(), and inet::DSCPMarker::markPacket().

{
    if (!dscpEnum)
        dscpEnum = cEnum::get("inet::DSCP");
    const char *name = dscpEnum->getStringFor(dscp);
    if (name) {
        if (!strncmp(name, "DSCP_", 5))
            name += 5;
        return name;
    }
    else
        return ltostr(dscp);
}

cPacket * inet::DiffservUtil::findIPDatagramInPacket

(

cPacket *

packet

)

Returns the IP datagram encapsulated inside packet, or the packet itself if it is an IPv4/IPv6 datagram.

Returns nullptr, if there is no IP datagram in the packet.

Referenced by inet::TokenBucketMeter::handleMessage(), inet::SingleRateThreeColorMeter::handleMessage(), inet::TwoRateThreeColorMeter::handleMessage(), and isEmpty().

{
    for ( ; packet; packet = packet->getEncapsulatedPacket()) {
#ifdef WITH_IPv4
        if (dynamic_cast<IPv4Datagram *>(packet))
            return packet;
#endif // ifdef WITH_IPv4
#ifdef WITH_IPv6
        if (dynamic_cast<IPv6Datagram *>(packet))
            return packet;
#endif // ifdef WITH_IPv6
    }

    return nullptr;
}

int inet::DiffservUtil::getColor

(

cPacket *

packet

)

Returns the color of the packet.

The color was set by a previous meter component. Returns -1, if the color was not set.

Referenced by inet::RSVPPathMsg_Base::getERO(), inet::visualizer::ColorSet::getSize(), isEmpty(), inet::TokenBucketMeter::meterPacket(), inet::SingleRateThreeColorMeter::meterPacket(), and inet::TwoRateThreeColorMeter::meterPacket().

{
    ColorAttribute *attr = dynamic_cast<ColorAttribute *>(packet->getParList().get("dscolor"));
    return attr ? attr->color : -1;
}

double inet::DiffservUtil::getInterfaceDatarate	(	IInterfaceTable *	ift,
		cSimpleModule *	interfaceModule
	)

Returns the datarate of the interface containing the given module.

Returns -1, if the interface entry not found.

Referenced by isEmpty(), and parseInformationRate().

{
    InterfaceEntry *ie = ift ? ift->getInterfaceByInterfaceModule(interfaceModule) : nullptr;
    return ie ? ie->getDatarate() : -1;
}

const char * inet::DiffservUtil::getRequiredAttribute	(	cXMLElement *	element,
		const char *	attrName
	)

Returns the value of the named attribute of the XML element, or throws an exception if not found.

Referenced by inet::MultiFieldClassifier::configureFilters(), and isEmpty().

{
    const char *attrValue = element->getAttribute(attrName);
    if (!attrValue)
        throw cRuntimeError("missing attribute '%s' from <%s> element", attrName, element->getTagName());
    return attrValue;
}

bool inet::DiffservUtil::isEmpty ( const char *  str )

inline

Returns true, if the string is empty (nullptr or "");.

Referenced by parseDSCP(), parseDSCPs(), parseInformationRate(), parseIntAttribute(), and parseProtocol().

{ return !str || !(*str); }

int inet::DiffservUtil::parseDSCP	(	const char *	attrValue,
		const char *	attrName
	)

Parses a Diffserv code point.

Recognizes the names defined in DSCP.msg (e.g. "BE", "AF11"), and accepts decimal/octal/hex/binary numbers.

Referenced by isEmpty(), and parseDSCPs().

{
    if (isEmpty(attrValue))
        throw cRuntimeError("missing %s attribute", attrName);
    if (isdigit(*attrValue)) {
        int dscp = parseIntAttribute(attrValue, attrName);
        if (dscp < 0 || dscp >= DSCP_MAX)
            throw cRuntimeError("value of %s attribute is out of range [0,%d)", DSCP_MAX);
        return dscp;
    }
    if (!dscpEnum)
        dscpEnum = cEnum::get("inet::DSCP");
    char name[20];
    strcpy(name, "DSCP_");
    const char *src;
    char *dest;
    for (src = attrValue, dest = name + 5; *src; ++src, ++dest)
        *dest = toupper(*src);
    *dest = '\0';

    int dscp = dscpEnum->lookup(name);
    if (dscp < 0)
        throw cRuntimeError("malformed %s attribute", attrName);
    return dscp;
}

void inet::DiffservUtil::parseDSCPs	(	const char *	attrValue,
		const char *	attrName,
		std::vector< int > &	result
	)

Parses a space separated list of DSCP values and puts them into the result vector.

"*" is interpreted as all possible DSCP values (i.e. the 0..63 range).

Referenced by inet::DSCPMarker::initialize(), inet::BehaviorAggregateClassifier::initialize(), and isEmpty().

{
    if (isEmpty(attrValue))
        return;
    if (*attrValue == '*' && *(attrValue + 1) == '\0') {
        for (int dscp = 0; dscp < DSCP_MAX; ++dscp)
            result.push_back(dscp);
    }
    else {
        cStringTokenizer tokens(attrValue);
        while (tokens.hasMoreTokens())
            result.push_back(parseDSCP(tokens.nextToken(), attrName));
    }
}

double inet::DiffservUtil::parseInformationRate	(	const char *	attrValue,
		const char *	attrName,
		IInterfaceTable *	ift,
		cSimpleModule &	owner,
		int	defaultValue
	)

Parses the information rate parameter (bits/sec).

Supported formats:

• absolute (e.g. 10Mbps)
• relative to the datarate of the interface (e.g. 10%)

Referenced by inet::TokenBucketMeter::initialize(), inet::SingleRateThreeColorMeter::initialize(), inet::TwoRateThreeColorMeter::initialize(), and isEmpty().

{
    if (isEmpty(attrValue))
        return defaultValue;

    const char *percentPtr = strchr(attrValue, '%');
    if (percentPtr) {
        char *e;
        double percent = strtod(attrValue, &e);
        if (e != percentPtr)
            throw cRuntimeError("malformed %s attribute: %s", attrName, attrValue);
        if (percent < 0.0 || percent > 100.0)
            throw cRuntimeError("%s must be between 0\% and 100\%, found: %s", attrName, attrValue);

        double datarate = getInterfaceDatarate(ift, &owner);
        if (datarate < 0.0)
            throw cRuntimeError("cannot determine datarate for module %s, (no interface table in the node?)", owner.getFullPath().c_str());

        return (percent / 100.0) * datarate;
    }
    else {
        char *unit;
        double datarate = strtod(attrValue, &unit);
        return cNEDValue::convertUnit(datarate, unit, "bps");
    }
}

int inet::DiffservUtil::parseIntAttribute	(	const char *	attrValue,
		const char *	attrName,
		bool	isOptional = true
	)

Parses an integer attribute.

Supports decimal, octal ("0" prefix), hexadecimal ("0x" prefix), and binary ("0b" prefix) bases.

Referenced by inet::MultiFieldClassifier::configureFilters(), isEmpty(), parseDSCP(), and parseProtocol().

{
    if (isEmpty(attrValue)) {
        if (isOptional)
            return -1;
        else
            throw cRuntimeError("missing %s attribute", attrName);
    }

    unsigned long num;
    char *endp;
    if (*attrValue == '0' && *(attrValue + 1) == 'b') // 0b prefix for binary
        num = strtoul(attrValue + 2, &endp, 2);
    else
        num = strtoul(attrValue, &endp, 0); // will handle hex/octal/decimal

    if (*endp != '\0')
        throw cRuntimeError("malformed %s attribute: %s", attrName, attrValue);

    if (num > INT_MAX)
        throw cRuntimeError("attribute %s is too large: %s", attrName, attrValue);

    return (int)num;
}

int inet::DiffservUtil::parseProtocol	(	const char *	attrValue,
		const char *	attrName
	)

Parses an IP protocol number.

Recognizes the names defined in IPProtocolId.msg (e.g. "UDP", "udp", "Tcp"), and accepts decimal/octal/hex/binary numbers.

Referenced by inet::MultiFieldClassifier::configureFilters(), and isEmpty().

{
    if (isEmpty(attrValue))
        return -1;
    if (isdigit(*attrValue))
        return parseIntAttribute(attrValue, attrName);
    if (!protocolEnum)
        protocolEnum = cEnum::get("inet::IPProtocolId");
    char name[20];
    strcpy(name, "IP_PROT_");
    char *dest;
    for (dest = name + 8; *attrValue; ++dest, ++attrValue)
        *dest = toupper(*attrValue);
    *dest = '\0';

    return protocolEnum->lookup(name);
}

void inet::DiffservUtil::setColor	(	cPacket *	packet,
		int	color
	)

Sets the color of the packet.

The color is stored in the parlist of the cPacket object.

Referenced by inet::RSVPPathMsg_Base::getERO(), isEmpty(), inet::TokenBucketMeter::meterPacket(), inet::SingleRateThreeColorMeter::meterPacket(), and inet::TwoRateThreeColorMeter::meterPacket().

{
    ColorAttribute *attr = dynamic_cast<ColorAttribute *>(packet->getParList().get("dscolor"));
    if (attr)
        attr->color = color;
    else
        packet->addObject(new ColorAttribute(color));
}

Variable Documentation

cEnum* inet::DiffservUtil::dscpEnum = nullptr

cEnum* inet::DiffservUtil::protocolEnum = nullptr