rawsock_lamp.h

Go to the documentation of this file.

#ifndef RAWSOCK_LAMP_H_INCLUDED
#define RAWSOCK_LAMP_H_INCLUDED

#include "rawsock.h"
#include <linux/if_packet.h>
#include <sys/time.h>

#define PROTO_LAMP 0xAA 
#define PROTO_LAMP_CTRL_MASK 0xA0 
#define CTRL_PINGLIKE_REQ 0xA0 
#define CTRL_PINGLIKE_REPLY 0xA1 
#define CTRL_PINGLIKE_ENDREQ 0xA2 
#define CTRL_PINGLIKE_ENDREPLY 0xA3 
#define CTRL_UNIDIR_CONTINUE 0xA4 
#define CTRL_UNIDIR_STOP 0xA5 
#define CTRL_UNIDIR_REPORT 0xA6 
#define CTRL_ACK 0xA7 
#define CTRL_CONN_INIT 0xA8 
#define CTRL_PINGLIKE_REQ_TLESS 0xA9 
#define CTRL_PINGLIKE_REPLY_TLESS 0xAA 
#define CTRL_PINGLIKE_ENDREQ_TLESS 0xAB 
#define CTRL_PINGLIKE_ENDREPLY_TLESS 0xAC 
#define CTRL_FOLLOWUP_CTRL 0xAD 
#define CTRL_FOLLOWUP_DATA 0xAE 
// Follow-up types
#define FOLLOWUP_REQUEST    0x0000 
#define FOLLOWUP_DENY       0x0100 
#define FOLLOWUP_ACCEPT     0x0200 
#define FOLLOWUP_UNKNOWN    0xFFFF 
// Follow-up request types
#define FOLLOWUP_REQUEST_T_APP      0x0000 
#define FOLLOWUP_REQUEST_T_KRN_RX   0x0001 
#define FOLLOWUP_REQUEST_T_KRN      0x0002 
#define FOLLOWUP_REQUEST_T_HW       0x0003 
// Macro to check if a given "payload length or packet type" field, specified as 'idx', contains a valid FOLLOWUP_REQUEST or not, no matter the request type
#define IS_FOLLOWUP_REQUEST(lenortype_field) ((lenortype_field & 0xFF00)==0x0000) 
// Macros that accounts for more than one packet at once (to be used inside if-else statements)
#define IS_CTRL_PINGLIKE_REQ(ctrl) (ctrl==CTRL_PINGLIKE_REQ || ctrl==CTRL_PINGLIKE_REQ_TLESS) 
#define IS_CTRL_PINGLIKE_REPLY(ctrl) (ctrl==CTRL_PINGLIKE_REPLY || ctrl==CTRL_PINGLIKE_REPLY_TLESS) 
#define IS_CTRL_PINGLIKE_ENDREQ(ctrl) (ctrl==CTRL_PINGLIKE_ENDREQ || ctrl==CTRL_PINGLIKE_ENDREQ_TLESS) 
#define IS_CTRL_PINGLIKE_ENDREPLY(ctrl) (ctrl==CTRL_PINGLIKE_ENDREPLY || ctrl==CTRL_PINGLIKE_ENDREPLY_TLESS) 
#define INIT_PINGLIKE_INDEX 0x0001 
#define INIT_UNIDIR_INDEX 0x0002 
#define IS_INIT_INDEX_VALID(idx) (idx == INIT_PINGLIKE_INDEX || idx == INIT_UNIDIR_INDEX) 
#define IS_INIT(ctrl) (ctrl == CTRL_CONN_INIT) 
#define IS_FOLLOWUP_CTRL(ctrl) (ctrl == CTRL_FOLLOWUP_CTRL) 
#define IS_FOLLOWUP_CTRL_REQ_TYPE_VALID(idx) (idx == FOLLOWUP_REQUEST_T_APP || idx == FOLLOWUP_REQUEST_T_KRN_RX || idx == FOLLOWUP_REQUEST_T_KRN || idx == FOLLOWUP_REQUEST_T_HW || (idx >= 0x00F0 && idx<= 0x00FF)) 
#define IS_FOLLOWUP_CTRL_TYPE_VALID(idx) (idx == FOLLOWUP_REQUEST || idx == FOLLOWUP_DENY || idx == FOLLOWUP_ACCEPT || IS_FOLLOWUP_CTRL_REQ_TYPE_VALID(idx)) 
#define IS_UNIDIR(ctrl) (ctrl == CTRL_UNIDIR_CONTINUE || ctrl == CTRL_UNIDIR_STOP) 
#define IS_PINGLIKE(ctrl) (ctrl == CTRL_PINGLIKE_REQ || ctrl == CTRL_PINGLIKE_REPLY || ctrl == CTRL_PINGLIKE_ENDREQ || ctrl == CTRL_PINGLIKE_ENDREPLY || ctrl == CTRL_PINGLIKE_REQ_TLESS || ctrl == CTRL_PINGLIKE_REPLY_TLESS || ctrl == CTRL_PINGLIKE_ENDREQ_TLESS || ctrl == CTRL_PINGLIKE_ENDREPLY_TLESS) 
#define IS_LAMP(reserved, ctrl) (reserved==PROTO_LAMP && (ctrl & PROTO_LAMP_CTRL_MASK)==PROTO_LAMP_CTRL_MASK) 
#define ETHERTYPE_LAMP ETH_P_802_EX1 
#define MAX_LAMP_LEN (65535) 
#define LAMP_HDR_PAYLOAD_SIZE_STR(data) sizeof(struct lamphdr)+strlen(data) 
#define LAMP_HDR_PAYLOAD_SIZE(size) sizeof(struct lamphdr)+size 
#define LAMP_HDR_SIZE() sizeof(struct lamphdr) 
#define TYPE_TO_CTRL(field) (field | PROTO_LAMP_CTRL_MASK) 
#define CTRL_TO_TYPE(field) (field & 0x0F) 
#ifndef BYTE_TYPE
#define BYTE_TYPE
typedef unsigned char byte_t; 
#endif

typedef enum {
    PINGLIKE_REQ,               
    PINGLIKE_REPLY,             
    PINGLIKE_ENDREQ,            
    PINGLIKE_ENDREPLY,          
    UNIDIR_CONTINUE,            
    UNIDIR_STOP,                
    REPORT,                     
    ACK,                        
    INIT,                       
    PINGLIKE_REQ_TLESS,         
    PINGLIKE_REPLY_TLESS,       
    PINGLIKE_ENDREQ_TLESS,      
    PINGLIKE_ENDREPLY_TLESS,    
    FOLLOWUP_CTRL,              
    FOLLOWUP_DATA               
} lamptype_t;

typedef enum {
    FLG_CONTINUE, 
    FLG_STOP, 
    FLG_NONE 
} endflag_t;

struct lamphdr {
    uint8_t reserved; 
    uint8_t ctrl; 
    uint16_t id; 
    uint16_t seq; 
    uint16_t len; 
    uint64_t sec; 
    uint64_t usec; 
};

void lampHeadPopulate(struct lamphdr *lampHeader, unsigned char ctrl, unsigned short id, unsigned short seq);
void lampHeadSetTimestamp(struct lamphdr *lampHeader, struct timeval *tStampPtr); // Sets the LaMP header timestamp (specify NULL as struct timeval *tStampPtr to use the current time instead of a custom timestamp) -> to be used with non-raw sockets, in which rawLampSend() cannot be used
void lampEncapsulate(byte_t *packet, struct lamphdr *lampHeader, byte_t *data, size_t payloadsize);
void lampSetUnidirStop(struct lamphdr *lampHeader);
void lampSetPinglikeEndreq(struct lamphdr *lampHeader);
void lampSetPinglikeEndreqTless(struct lamphdr *lampHeader);
void lampSetPinglikeEndreqAll(struct lamphdr *lampHeader);
void lampHeadSetConnType(struct lamphdr *initLampHeader, uint16_t mode_index);
void lampHeadSetFollowupCtrlType(struct lamphdr *followupLampHeader, uint16_t followup_type);

void lampHeadIncreaseSeq(struct lamphdr *inpacket_headerptr);
int rawLampSend(int descriptor, struct sockaddr_ll addrll, struct lamphdr *inpacket_headerptr, byte_t *ethernetpacket, size_t finalpacketsize, endflag_t end_flag, protocol_t llprot);

void lampHeadGetData(byte_t *lampPacket, lamptype_t *type, unsigned short *id, unsigned short *seq, unsigned short *len, struct timeval *timestamp, byte_t *payload);
byte_t *lampGetPacketPointers(byte_t *pktbuf,struct lamphdr **lampHeader);
#endif