packer.h

Go to the documentation of this file.

//
// Copyright (c) 2017 Regents of the SIGNET lab, University of Padova.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. Neither the name of the University of Padova (SIGNET lab) nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
 
#ifndef PACKER_H
#define PACKER_H
 
#include "hdr-uwal.h"
 
#include <math.h>
#include <packet.h>
 
#include <bitset>
#include <cstring>
#include <sstream>
#include <string>
#include <vector>
 
class packer : public TclObject
{
public:
    packer(bool);
 
    ~packer();
 
    int command(int, const char *const *);
 
    inline size_t
    getPayloadBytesLength()
    {
        return payload_length;
    }
 
    inline size_t
    getHdrBytesLength()
    {
        return hdr_length;
    }
 
    size_t getPayloadBinLength();
 
    size_t getHdrBinLength();
 
    std::string packPayload(Packet *);
 
    std::string packHdr(Packet *);
 
    Packet *unpackPayload(Packet *);
 
    Packet *unpackHdr(Packet *);
 
    void printMap();
 
    template <typename T>
    static T
    restoreSignedValue(T _header_field, const uint32_t &_num_compressed_bits)
    {
        if (_num_compressed_bits < sizeof(_header_field) * 8) {
            bitset<sizeof(_header_field) * 8> my_bitset(_header_field);
            if (my_bitset[_num_compressed_bits - 1] == 1) {
                for (size_t i = _num_compressed_bits;
                        i < sizeof(_header_field) * 8;
                        ++i) {
                    my_bitset.set(i, 1);
                }
            }
            return static_cast<T>(my_bitset.to_ulong());
        } else {
            return _header_field;
        }
    }
 
    static std::string hexdump_nice(std::string);
 
    static std::string hexdump_nice(const char *, size_t);
 
    static std::string hexdump(std::string);
 
    static std::string hex_bytes(float);
    static std::string hex_bytes(double);
    static std::string hex_bytes(const char &, const uint32_t &);
    static std::string hex_bytes(const int8_t &, const uint32_t &);
    static std::string hex_bytes(const int16_t &, const uint32_t &);
    static std::string hex_bytes(const int32_t &, const uint32_t &);
    static std::string hex_bytes(const int64_t &, const uint32_t &);
    static std::string hex_bytes(const uint8_t &, const uint32_t &);
    static std::string hex_bytes(const uint16_t &, const uint32_t &);
    static std::string hex_bytes(const uint32_t &, const uint32_t &);
    static std::string hex_bytes(const uint64_t &, const uint32_t &);
 
    static std::string hexdump(const char *, size_t);
 
    static std::string bindump(std::string);
 
    static std::string bindump(const char *, size_t);
 
protected:
    std::vector<size_t>
            n_bits; 
    int debug_; 
    virtual void init();
 
    virtual size_t packMyHdr(Packet *, unsigned char *, size_t);
 
    virtual size_t unpackMyHdr(unsigned char *, size_t, Packet *);
 
    virtual void printMyHdrMap();
 
    virtual void printMyHdrFields(Packet *);
 
    virtual void printMyHdrField(Packet *, int);
 
    size_t getMyHdrBinLength();
 
    size_t get(unsigned char *buffer, size_t offset, void *val, size_t h);
 
    size_t put(unsigned char *buffer, size_t offset, void *val, size_t h);
 
private:
    std::vector<packer *>
            activePackers; 
    size_t payload_length; 
    size_t hdr_length; 
    bool printAllFields;
 
    size_t SRC_ID_Bits; 
    size_t PKT_ID_Bits; 
    size_t FRAME_OFFSET_Bits; 
    size_t M_BIT_Bits; 
    size_t DUMMY_CONTENT_Bits; 
};
 
#endif