While working with Linux pthreads and libpcap, I noticed some strange behavior when used pcap_breakloop. My goal is this:
Open a new thread that will start pcap_loopand process the captured packets, while the main thread will do other things. When the signal a (SIGINT) is received or when it exits, the global variable will be set, and the main thread will issue pcap_breakloopto end the second stream, and then finish it itself.
The idea may still need some work, but the weird behavior I noticed was:
When we create a structure bpf_programand compile it with pcap_compile, to use it as a filter in the capture, as soon as we exit the loop with pcap_breakloop, a memory leak of 8 bytes (both pcap_freecodeand pcap_close) will occur . This is true even if you do not use streams (as may be shown by the example of sniffex.clibpcap). The same code without a filter (without calling pcap_compileor bpf_program) comes out without a memory leak .
Is memory leak something expected from libpcap, like some memory leak that I see in other libraries (like gtk)? What will this be associated with the library later? Or is there something wrong with my code that I cannot see?
The following are sample code: one that uses pthreads and an example of modified sniffex with pcap_breakloop(I also included difffrom the original sniffex and modified, since the code is pretty big, but the difference is really small):
Example with pthreads:
#include <pcap.h>
#include <stdio.h>
#include <pthread.h>
#include <signal.h>
int CLOSE_PROGRAM = 0;
int CAPTURE_SETUP_SUCCESS = 0;
pcap_t *handler;
struct bpf_program fp;
void INT_Handler(int signum);
void capture_loop(unsigned char *args, const struct pcap_pkthdr *header, const unsigned char *packet);
void *thread_entrypoint(void *data);
void INT_Handler(int signum){
printf("Interrupt Signal Received\n");
CLOSE_PROGRAM = 1;
}
void capture_loop(unsigned char *args, const struct pcap_pkthdr *header, const unsigned char *packet){
printf("Captured Packet\n");
}
void *thread_entrypoint(void *data){
pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
char error[PCAP_ERRBUF_SIZE];
char filter_exp[] = "ip";
bpf_u_int32 mask;
bpf_u_int32 net;
char *dev = pcap_lookupdev(error);
if(NULL == dev){
printf("Failed to look up device!\n");
return NULL;
}
if(pcap_lookupnet(dev, &net, &mask, error) == -1){
printf("Failed to look up netmask: %s\n", error);
net = 0;
mask = 0;
}
printf("Opening live capture on device %s\n", dev);
handler = pcap_open_live(dev, 1518, 0, 1000, error);
if(NULL == handler){
printf("Failed to open live capture!\n");
return NULL;
}
if(pcap_compile(handler, &fp, filter_exp, 0, net?net:PCAP_NETMASK_UNKNOWN) == -1){
printf("Failed to compiler filter!\n");
return NULL;
}
if(pcap_setfilter(handler, &fp) == -1){
printf("Failed to install filter!\n");
return NULL;
}
CAPTURE_SETUP_SUCCESS = 1;
pcap_loop(handler, 0, capture_loop, NULL);
pcap_freecode(&fp);
pcap_close(handler);
printf("Capture end\n");
return NULL;
}
int main(int argc, char **argv){
pthread_t capture_thread;
pthread_create(&capture_thread, NULL, &thread_entrypoint, NULL);
signal(SIGINT, &INT_Handler);
while(0 == CLOSE_PROGRAM){
}
if(1 == CAPTURE_SETUP_SUCCESS){
pcap_breakloop(handler);
}
pthread_join(capture_thread, NULL);
return 0;
}
Modified sniffex example:
#define APP_NAME "sniffex"
#define APP_DESC "Sniffer example using libpcap"
#define APP_COPYRIGHT "Copyright (c) 2005 The Tcpdump Group"
#define APP_DISCLAIMER "THERE IS ABSOLUTELY NO WARRANTY FOR THIS PROGRAM."
#include <pcap.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
pcap_t *handle;
#define SNAP_LEN 1518
#define SIZE_ETHERNET 14
#define ETHER_ADDR_LEN 6
struct sniff_ethernet {
u_char ether_dhost[ETHER_ADDR_LEN];
u_char ether_shost[ETHER_ADDR_LEN];
u_short ether_type;
};
struct sniff_ip {
u_char ip_vhl;
u_char ip_tos;
u_short ip_len;
u_short ip_id;
u_short ip_off;
#define IP_RF 0x8000
#define IP_DF 0x4000
#define IP_MF 0x2000
#define IP_OFFMASK 0x1fff
u_char ip_ttl;
u_char ip_p;
u_short ip_sum;
struct in_addr ip_src,ip_dst;
};
#define IP_HL(ip) (((ip)->ip_vhl) & 0x0f)
#define IP_V(ip) (((ip)->ip_vhl) >> 4)
typedef u_int tcp_seq;
struct sniff_tcp {
u_short th_sport;
u_short th_dport;
tcp_seq th_seq;
tcp_seq th_ack;
u_char th_offx2;
#define TH_OFF(th) (((th)->th_offx2 & 0xf0) >> 4)
u_char th_flags;
#define TH_FIN 0x01
#define TH_SYN 0x02
#define TH_RST 0x04
#define TH_PUSH 0x08
#define TH_ACK 0x10
#define TH_URG 0x20
#define TH_ECE 0x40
#define TH_CWR 0x80
#define TH_FLAGS (TH_FIN|TH_SYN|TH_RST|TH_ACK|TH_URG|TH_ECE|TH_CWR)
u_short th_win;
u_short th_sum;
u_short th_urp;
};
void
got_packet(u_char *args, const struct pcap_pkthdr *header, const u_char *packet);
void
print_payload(const u_char *payload, int len);
void
print_hex_ascii_line(const u_char *payload, int len, int offset);
void
print_app_banner(void);
void
print_app_usage(void);
void
print_app_banner(void)
{
printf("%s - %s\n", APP_NAME, APP_DESC);
printf("%s\n", APP_COPYRIGHT);
printf("%s\n", APP_DISCLAIMER);
printf("\n");
return;
}
void
print_app_usage(void)
{
printf("Usage: %s [interface]\n", APP_NAME);
printf("\n");
printf("Options:\n");
printf(" interface Listen on <interface> for packets.\n");
printf("\n");
return;
}
void
print_hex_ascii_line(const u_char *payload, int len, int offset)
{
int i;
int gap;
const u_char *ch;
printf("%05d ", offset);
ch = payload;
for(i = 0; i < len; i++) {
printf("%02x ", *ch);
ch++;
if (i == 7)
printf(" ");
}
if (len < 8)
printf(" ");
if (len < 16) {
gap = 16 - len;
for (i = 0; i < gap; i++) {
printf(" ");
}
}
printf(" ");
ch = payload;
for(i = 0; i < len; i++) {
if (isprint(*ch))
printf("%c", *ch);
else
printf(".");
ch++;
}
printf("\n");
return;
}
void
print_payload(const u_char *payload, int len)
{
int len_rem = len;
int line_width = 16;
int line_len;
int offset = 0;
const u_char *ch = payload;
if (len <= 0)
return;
if (len <= line_width) {
print_hex_ascii_line(ch, len, offset);
return;
}
for ( ;; ) {
line_len = line_width % len_rem;
print_hex_ascii_line(ch, line_len, offset);
len_rem = len_rem - line_len;
ch = ch + line_len;
offset = offset + line_width;
if (len_rem <= line_width) {
print_hex_ascii_line(ch, len_rem, offset);
break;
}
}
return;
}
void
got_packet(u_char *args, const struct pcap_pkthdr *header, const u_char *packet)
{
pcap_breakloop(handle);
static int count = 1;
const struct sniff_ethernet *ethernet;
const struct sniff_ip *ip;
const struct sniff_tcp *tcp;
const char *payload;
int size_ip;
int size_tcp;
int size_payload;
printf("\nPacket number %d:\n", count);
count++;
ethernet = (struct sniff_ethernet*)(packet);
ip = (struct sniff_ip*)(packet + SIZE_ETHERNET);
size_ip = IP_HL(ip)*4;
if (size_ip < 20) {
printf(" * Invalid IP header length: %u bytes\n", size_ip);
return;
}
printf(" From: %s\n", inet_ntoa(ip->ip_src));
printf(" To: %s\n", inet_ntoa(ip->ip_dst));
switch(ip->ip_p) {
case IPPROTO_TCP:
printf(" Protocol: TCP\n");
break;
case IPPROTO_UDP:
printf(" Protocol: UDP\n");
return;
case IPPROTO_ICMP:
printf(" Protocol: ICMP\n");
return;
case IPPROTO_IP:
printf(" Protocol: IP\n");
return;
default:
printf(" Protocol: unknown\n");
return;
}
tcp = (struct sniff_tcp*)(packet + SIZE_ETHERNET + size_ip);
size_tcp = TH_OFF(tcp)*4;
if (size_tcp < 20) {
printf(" * Invalid TCP header length: %u bytes\n", size_tcp);
return;
}
printf(" Src port: %d\n", ntohs(tcp->th_sport));
printf(" Dst port: %d\n", ntohs(tcp->th_dport));
payload = (u_char *)(packet + SIZE_ETHERNET + size_ip + size_tcp);
size_payload = ntohs(ip->ip_len) - (size_ip + size_tcp);
if (size_payload > 0) {
printf(" Payload (%d bytes):\n", size_payload);
print_payload(payload, size_payload);
}
return;
}
int main(int argc, char **argv)
{
char *dev = NULL;
char errbuf[PCAP_ERRBUF_SIZE];
char filter_exp[] = "ip";
struct bpf_program fp;
bpf_u_int32 mask;
bpf_u_int32 net;
int num_packets = 10;
print_app_banner();
if (argc == 2) {
dev = argv[1];
}
else if (argc > 2) {
fprintf(stderr, "error: unrecognized command-line options\n\n");
print_app_usage();
exit(EXIT_FAILURE);
}
else {
dev = pcap_lookupdev(errbuf);
if (dev == NULL) {
fprintf(stderr, "Couldn't find default device: %s\n",
errbuf);
exit(EXIT_FAILURE);
}
}
if (pcap_lookupnet(dev, &net, &mask, errbuf) == -1) {
fprintf(stderr, "Couldn't get netmask for device %s: %s\n",
dev, errbuf);
net = 0;
mask = 0;
}
printf("Device: %s\n", dev);
printf("Number of packets: %d\n", num_packets);
printf("Filter expression: %s\n", filter_exp);
handle = pcap_open_live(dev, SNAP_LEN, 1, 1000, errbuf);
if (handle == NULL) {
fprintf(stderr, "Couldn't open device %s: %s\n", dev, errbuf);
exit(EXIT_FAILURE);
}
if (pcap_datalink(handle) != DLT_EN10MB) {
fprintf(stderr, "%s is not an Ethernet\n", dev);
exit(EXIT_FAILURE);
}
if (pcap_compile(handle, &fp, filter_exp, 0, net) == -1) {
fprintf(stderr, "Couldn't parse filter %s: %s\n",
filter_exp, pcap_geterr(handle));
exit(EXIT_FAILURE);
}
if (pcap_setfilter(handle, &fp) == -1) {
fprintf(stderr, "Couldn't install filter %s: %s\n",
filter_exp, pcap_geterr(handle));
exit(EXIT_FAILURE);
}
pcap_loop(handle, num_packets, got_packet, NULL);
pcap_freecode(&fp);
pcap_close(handle);
printf("\nCapture complete.\n");
return 0;
}
diff from source sniffex and modified newuffsex codes:
209a210,211
> pcap_t *handle;
>
420a423,424
> pcap_breakloop(handle);
>
508d511
< pcap_t *handle;
Valgrind message for multithreaded code:
==2734==
==2734== HEAP SUMMARY:
==2734== in use at exit: 8 bytes in 1 blocks
==2734== total heap usage: 96 allocs, 95 frees, 82,123 bytes allocated
==2734==
==2734== LEAK SUMMARY:
==2734== definitely lost: 0 bytes in 0 blocks
==2734== indirectly lost: 0 bytes in 0 blocks
==2734== possibly lost: 0 bytes in 0 blocks
==2734== still reachable: 8 bytes in 1 blocks
==2734== suppressed: 0 bytes in 0 blocks
==2734== Rerun with
==2734==
==2734== For counts of detected and suppressed errors, rerun with: -v
==2734== Use
==2734== ERROR SUMMARY: 9 errors from 9 contexts (suppressed: 0 from 0)
Valgrind message for modified newuffex code:
==2756==
==2756== HEAP SUMMARY:
==2756== in use at exit: 8 bytes in 1 blocks
==2756== total heap usage: 97 allocs, 96 frees, 83,427 bytes allocated
==2756==
==2756== LEAK SUMMARY:
==2756== definitely lost: 0 bytes in 0 blocks
==2756== indirectly lost: 0 bytes in 0 blocks
==2756== possibly lost: 0 bytes in 0 blocks
==2756== still reachable: 8 bytes in 1 blocks
==2756== suppressed: 0 bytes in 0 blocks
==2756== Rerun with
==2756==
==2756== For counts of detected and suppressed errors, rerun with: -v
==2756== Use
==2756== ERROR SUMMARY: 9 errors from 9 contexts (suppressed: 0 from 0)