ethernetII.h

/*
 * Copyright (c) 2017, Matias Fontanini
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * 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.
 * 
 * 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 TINS_ETHERNET_II_H
#define TINS_ETHERNET_II_H

#include <stdint.h>
#include <tins/macros.h>
#include <tins/pdu.h>
#include <tins/config.h>
#include <tins/endianness.h>
#include <tins/hw_address.h>

namespace Tins {

class TINS_API EthernetII : public PDU {
public:
    typedef HWAddress<6> address_type;
    
    static const PDU::PDUType pdu_flag = PDU::ETHERNET_II;

    static const address_type BROADCAST;

    static metadata extract_metadata(const uint8_t *buffer, uint32_t total_sz);

    EthernetII(const address_type& dst_hw_addr = address_type(), 
               const address_type& src_hw_addr = address_type());

    EthernetII(const uint8_t* buffer, uint32_t total_sz);

    /* Getters */
    address_type dst_addr() const {
        return header_.dst_mac;
    }

    address_type src_addr() const {
        return header_.src_mac;
    }

    uint16_t payload_type() const {
        return Endian::be_to_host(header_.payload_type);
    }

    /* Setters */

    void dst_addr(const address_type& new_dst_addr);

    void src_addr(const address_type& new_src_addr);

    void payload_type(uint16_t new_payload_type);

    /* Virtual methods */
    uint32_t header_size() const;
    
    uint32_t trailer_size() const;

    void send(PacketSender& sender, const NetworkInterface& iface);

    bool matches_response(const uint8_t* ptr, uint32_t total_sz) const;

    #ifndef _WIN32

    PDU* recv_response(PacketSender& sender, const NetworkInterface& iface);
    #endif // _WIN32

    PDUType pdu_type() const {
        return pdu_flag;
    }

    EthernetII* clone() const {
        return new EthernetII(*this);
    }
private:
    TINS_BEGIN_PACK
    struct ethernet_header {
        uint8_t dst_mac[address_type::address_size];
        uint8_t src_mac[address_type::address_size];
        uint16_t payload_type;
    } TINS_END_PACK;
    
    void write_serialization(uint8_t* buffer, uint32_t total_sz);

    ethernet_header header_;
};

} // Tins

#endif // TINS_ETHERNET_II_H