pcap_util.h

/*
Copyright 2018 VMware, Inc.
 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
 
/*
 * A pcap utility library which provides several functions to read from and
 * write packets to pcap files.
 */
 
#ifndef BACKENDS_EBPF_RUNTIME_EBPF_PCAP_UTIL_H_
#define BACKENDS_EBPF_RUNTIME_EBPF_PCAP_UTIL_H_
 
#define PCAP_DONT_INCLUDE_PCAP_BPF_H
#include <pcap/pcap.h>
#include <stdint.h>     // uint32_t, uint16_t
 
/* Interfaces are named by integers */
typedef uint16_t iface_index;
 
/* A network packet.
   Contains packet content, timestamp and the interface where
   the packet has been received/sent.
 */
typedef struct {
    char *data;
    struct pcap_pkthdr pcap_hdr;
    iface_index ifindex;
} pcap_pkt;
 
struct pcap_list;
struct pcap_list_array;
typedef struct pcap_list pcap_list_t;
typedef struct pcap_list_array pcap_list_array_t;
 
pcap_list_t *read_pkts_from_pcap(const char *pcap_file_name, iface_index index);
 
int write_pkts_to_pcap(const char *pcap_file_name, const pcap_list_t *pkt_list);
 
pcap_list_t *merge_and_delete_lists(pcap_list_array_t *array, pcap_list_t *merged_list);
 
pcap_list_array_t *split_and_delete_list(pcap_list_t *input_list, pcap_list_array_t *result_arr);
 
pcap_list_t *append_packet(pcap_list_t *pkt_list, pcap_pkt *pkt);
 
pcap_list_array_t *insert_list(pcap_list_array_t *pkt_array, pcap_list_t *pkt_list, uint16_t index);
 
pcap_list_t *allocate_pkt_list();
 
 
pcap_list_array_t *allocate_pkt_list_array();
 
uint32_t get_pkt_list_length(pcap_list_t *pkt_list);
 
uint16_t get_list_array_length(pcap_list_array_t *pkt_list_array);
 
pcap_pkt *get_packet(pcap_list_t *list, uint32_t index);
 
pcap_list_t *get_list(pcap_list_array_t *list, uint16_t index);
 
pcap_pkt *copy_pkt(pcap_pkt *src_pkt);
 
void delete_list(pcap_list_t *pkt_list);
 
void delete_array(pcap_list_array_t *pkt_list_array);
 
void sort_pcap_list(pcap_list_t *pkt_list);
 
char *generate_pcap_name(const char *pcap_base, int index, const char *suffix);
 
#endif  // BACKENDS_EBPF_RUNTIME_EBPF_PCAP_UTIL_H_