ARP.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIB_LIBNET_ARP_H
#define __LIB_LIBNET_ARP_H
 
#include <Types.h>
#include <HashTable.h>
#include <Timer.h>
#include <KernelTimer.h>
#include "Ethernet.h"
#include "IPV4.h"
#include "NetworkProtocol.h"
 
class ARPSocket;
 
class ARP : public NetworkProtocol
{
  private:
 
    static const Size MaxRetries = 3;
 
    typedef struct ARPCache
    {
        Ethernet::Address ethAddr;
        Timer::Info time;
        Size retryCount;
        bool valid;
    }
    ARPCache;
 
  public:
 
    enum HardwareType
    {
        Ethernet = 1
    };
 
    enum ProtocolType
    {
        IPV4 = 0x0800
    };
 
    enum Operation
    {
        Request = 1,
        Reply   = 2
    };
 
    typedef struct Header
    {
        u16 hardwareType;
        u16 protocolType;
        u8  hardwareLength;
        u8  protocolLength;
        u16 operation;
 
        Ethernet::Address etherSender;
        IPV4::Address     ipSender;
 
        Ethernet::Address etherTarget;
        IPV4::Address     ipTarget;
    }
    PACKED Header;
 
  public:
 
    ARP(NetworkServer &server,
        NetworkDevice &device,
        NetworkProtocol &parent);
 
    virtual ~ARP();
 
    virtual FileSystem::Result initialize();
 
    void setIP(::IPV4 *ip);
 
    FileSystem::Result lookupAddress(const IPV4::Address *ipAddr,
                                     Ethernet::Address *ethAddr);
 
    FileSystem::Result sendRequest(const IPV4::Address address);
 
    FileSystem::Result sendReply(const Ethernet::Address *ethaddr,
                                 const IPV4::Address ipAddr);
 
    virtual FileSystem::Result process(const NetworkQueue::Packet *pkt,
                                       const Size offset);
 
  private:
 
    ARPCache * insertCacheEntry(const IPV4::Address ipAddr);
 
    ARPCache * getCacheEntry(const IPV4::Address ipAddr);
 
    void updateCacheEntry(const IPV4::Address ipAddr,
                          const Ethernet::Address *ethAddr);
 
  private:
 
    ARPSocket *m_sock;
 
    ::IPV4 *m_ip;
 
    HashTable<IPV4::Address, ARPCache *> m_cache;
 
    KernelTimer m_kernelTimer;
};
 
#endif /* __LIB_LIBNET_ARP_H */