source: lib/format_linux_common.c @ ee6e802

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivendag_formatrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since ee6e802 was ee6e802, checked in by Shane Alcock <salcock@…>, 5 years ago

Updated copyright blurb on all source files

In some cases, this meant adding copyright blurbs to files that
had never had them before.

  • Property mode set to 100644
File size: 18.3 KB
Line 
1/*
2 *
3 * Copyright (c) 2007-2016 The University of Waikato, Hamilton, New Zealand.
4 * All rights reserved.
5 *
6 * This file is part of libtrace.
7 *
8 * This code has been developed by the University of Waikato WAND
9 * research group. For further information please see http://www.wand.net.nz/
10 *
11 * libtrace is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation; either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * libtrace is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 * GNU Lesser General Public License for more details.
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23 *
24 *
25 */
26
27/* This file contains the common functions used by both the ring and int
28 * formats.
29 *
30 * Typically these deal with the socket descriptor or common conversions.
31 */
32
33#include "config.h"
34#include "libtrace.h"
35#include "libtrace_int.h"
36#include "format_helper.h"
37#include "libtrace_arphrd.h"
38#include <stdlib.h>
39#include <errno.h>
40#include <unistd.h>
41#include <string.h>
42#include <assert.h>
43
44#ifdef HAVE_INTTYPES_H
45#  include <inttypes.h>
46#else
47# error "Can't find inttypes.h"
48#endif
49
50#include "format_linux_common.h"
51
52#ifdef HAVE_NETPACKET_PACKET_H
53
54int linuxcommon_probe_filename(const char *filename)
55{
56        /* Is this an interface? */
57        return (if_nametoindex(filename) != 0);
58}
59
60/* Compiles a libtrace BPF filter for use with a linux native socket */
61static int linuxnative_configure_bpf(libtrace_t *libtrace,
62                libtrace_filter_t *filter) {
63#ifdef HAVE_LIBPCAP
64        struct ifreq ifr;
65        unsigned int arphrd;
66        libtrace_dlt_t dlt;
67        libtrace_filter_t *f;
68        int sock;
69        pcap_t *pcap;
70
71        /* Take a copy of the filter object as it was passed in */
72        f = (libtrace_filter_t *) malloc(sizeof(libtrace_filter_t));
73        memcpy(f, filter, sizeof(libtrace_filter_t));
74
75        /* If we are passed a filter with "flag" set to zero, then we must
76         * compile the filterstring before continuing. This involves
77         * determining the linktype, passing the filterstring to libpcap to
78         * compile, and saving the result for trace_start() to push into the
79         * kernel.
80         * If flag is set to one, then the filter was probably generated using
81         * trace_create_filter_from_bytecode() and so we don't need to do
82         * anything (we've just copied it above).
83         */
84        if (f->flag == 0) {
85                sock = socket(PF_INET, SOCK_STREAM, 0);
86                memset(&ifr, 0, sizeof(struct ifreq));
87                strncpy(ifr.ifr_name, libtrace->uridata, IF_NAMESIZE);
88                if (ioctl(sock, SIOCGIFHWADDR, &ifr) != 0) {
89                        perror("Can't get HWADDR for interface");
90                        return -1;
91                }
92                close(sock);
93
94                arphrd = ifr.ifr_hwaddr.sa_family;
95                dlt = libtrace_to_pcap_dlt(arphrd_type_to_libtrace(arphrd));
96
97                pcap = pcap_open_dead(dlt,
98                                FORMAT_DATA->snaplen);
99
100                if (pcap_compile(pcap, &f->filter, f->filterstring, 0, 0) == -1) {
101                        /* Filter didn't compile, set flag to 0 so we can
102                         * detect this when trace_start() is called and
103                         * produce a useful error
104                         */
105                        f->flag = 0;
106                        trace_set_err(libtrace, TRACE_ERR_INIT_FAILED,
107                                      "Failed to compile BPF filter (%s): %s",
108                                      f->filterstring, pcap_geterr(pcap));
109                } else {
110                        /* Set the "flag" to indicate that the filterstring
111                         * has been compiled
112                         */
113                        f->flag = 1;
114                }
115
116                pcap_close(pcap);
117
118        }
119
120        if (FORMAT_DATA->filter != NULL)
121                free(FORMAT_DATA->filter);
122
123        FORMAT_DATA->filter = f;
124
125        return 0;
126#else
127        return -1
128#endif
129}
130
131int linuxcommon_config_input(libtrace_t *libtrace,
132                trace_option_t option,
133                void *data)
134{
135        switch(option) {
136                case TRACE_OPTION_SNAPLEN:
137                        FORMAT_DATA->snaplen=*(int*)data;
138                        return 0;
139                case TRACE_OPTION_PROMISC:
140                        FORMAT_DATA->promisc=*(int*)data;
141                        return 0;
142                case TRACE_OPTION_FILTER:
143                        return linuxnative_configure_bpf(libtrace,
144                                        (libtrace_filter_t *) data);
145                case TRACE_OPTION_HASHER:
146                        switch (*((enum hasher_types *)data)) {
147                                case HASHER_BALANCE:
148                                        // Do fanout
149                                        FORMAT_DATA->fanout_flags = PACKET_FANOUT_LB;
150                                        // Or we could balance to the CPU
151                                        return 0;
152                                case HASHER_BIDIRECTIONAL:
153                                case HASHER_UNIDIRECTIONAL:
154                                        FORMAT_DATA->fanout_flags = PACKET_FANOUT_HASH;
155                                        return 0;
156                                case HASHER_CUSTOM:
157                                        return -1;
158                        }
159                        break;
160                case TRACE_OPTION_META_FREQ:
161                        /* No meta-data for this format */
162                        break;
163                case TRACE_OPTION_EVENT_REALTIME:
164                        /* Live captures are always going to be in trace time */
165                        break;
166                /* Avoid default: so that future options will cause a warning
167                 * here to remind us to implement it, or flag it as
168                 * unimplementable
169                 */
170        }
171
172        /* Don't set an error - trace_config will try to deal with the
173         * option and will set an error if it fails */
174        return -1;
175}
176
177int linuxcommon_init_input(libtrace_t *libtrace)
178{
179        struct linux_per_stream_t stream_data = ZERO_LINUX_STREAM;
180
181        libtrace->format_data = (struct linux_format_data_t *)
182                malloc(sizeof(struct linux_format_data_t));
183        assert(libtrace->format_data != NULL);
184
185        FORMAT_DATA->per_stream =
186                libtrace_list_init(sizeof(stream_data));
187        assert(FORMAT_DATA->per_stream != NULL);
188
189        libtrace_list_push_back(FORMAT_DATA->per_stream, &stream_data);
190
191        FORMAT_DATA->promisc = -1;
192        FORMAT_DATA->snaplen = LIBTRACE_PACKET_BUFSIZE;
193        FORMAT_DATA->filter = NULL;
194        FORMAT_DATA->stats_valid = 0;
195        FORMAT_DATA->stats.tp_drops = 0;
196        FORMAT_DATA->stats.tp_packets = 0;
197        FORMAT_DATA->max_order = MAX_ORDER;
198        FORMAT_DATA->fanout_flags = PACKET_FANOUT_LB;
199        /* Some examples use pid for the group however that would limit a single
200         * application to use only int/ring format, instead using rand */
201        FORMAT_DATA->fanout_group = (uint16_t) rand();
202        return 0;
203}
204
205int linuxcommon_init_output(libtrace_out_t *libtrace)
206{
207        libtrace->format_data = (struct linux_format_data_out_t*)
208                malloc(sizeof(struct linux_format_data_out_t));
209        assert(libtrace->format_data != NULL);
210
211        FORMAT_DATA_OUT->fd = -1;
212        FORMAT_DATA_OUT->tx_ring = NULL;
213        FORMAT_DATA_OUT->txring_offset = 0;
214        FORMAT_DATA_OUT->queue = 0;
215        FORMAT_DATA_OUT->max_order = MAX_ORDER;
216        return 0;
217}
218
219/* Close an input stream, this is safe to be called part way through
220 * initilisation as a cleanup function assuming streams were set to
221 * ZERO_LINUX_STREAM to begin with.
222 *
223 * This works correctly with both int and ring
224 */
225void linuxcommon_close_input_stream(libtrace_t *libtrace,
226                                    struct linux_per_stream_t *stream) {
227        if (stream->fd != -1)
228                close(stream->fd);
229        stream->fd = -1;
230        if (stream->rx_ring != MAP_FAILED)
231                munmap(stream->rx_ring,
232                       stream->req.tp_block_size *
233                       stream->req.tp_block_nr);
234        stream->rx_ring = MAP_FAILED;
235        stream->rxring_offset = 0;
236        FORMAT_DATA->dev_stats.if_name[0] = 0;
237}
238
239#define REPEAT_16(x) x x x x x x x x x x x x x x x x
240#define xstr(s) str(s)
241#define str(s) #s
242
243/* These don't typically reset however an interface does exist to reset them */
244static int linuxcommon_get_dev_statisitics(libtrace_t *libtrace, struct linux_dev_stats *stats) {
245        FILE *file;
246        char line[1024];
247        struct linux_dev_stats tmp_stats;
248
249        file = fopen("/proc/net/dev","r");
250        if (file == NULL) {
251                return -1;
252        }
253
254        /* Skip 2 header lines */
255        fgets(line, sizeof(line), file);
256        fgets(line, sizeof(line), file);
257
258        while (!(feof(file)||ferror(file))) {
259                int tot;
260                fgets(line, sizeof(line), file);
261                tot = sscanf(line, " %"xstr(IF_NAMESIZE)"[^:]:" REPEAT_16(" %"SCNd64),
262                             tmp_stats.if_name,
263                             &tmp_stats.rx_bytes,
264                             &tmp_stats.rx_packets,
265                             &tmp_stats.rx_errors,
266                             &tmp_stats.rx_drops,
267                             &tmp_stats.rx_fifo,
268                             &tmp_stats.rx_frame,
269                             &tmp_stats.rx_compressed,
270                             &tmp_stats.rx_multicast,
271                             &tmp_stats.tx_bytes,
272                             &tmp_stats.tx_packets,
273                             &tmp_stats.tx_errors,
274                             &tmp_stats.tx_drops,
275                             &tmp_stats.tx_fifo,
276                             &tmp_stats.tx_colls,
277                             &tmp_stats.tx_carrier,
278                             &tmp_stats.tx_compressed);
279                if (tot != 17)
280                        continue;
281                if (strncmp(tmp_stats.if_name, libtrace->uridata, IF_NAMESIZE) == 0) {
282                        *stats = tmp_stats;
283                        fclose(file);
284                        return 0;
285                }
286        }
287        fclose(file);
288        return -1;
289}
290
291/* Start an input stream
292 * - Opens the file descriptor
293 * - Sets promiscuous correctly
294 * - Sets socket option
295 * - Add BPF filter
296 *
297 * The output is ready for int directly, for ring the conversion to ring still
298 * needs to take place.
299 */
300int linuxcommon_start_input_stream(libtrace_t *libtrace,
301                                   struct linux_per_stream_t *stream)
302{
303        struct sockaddr_ll addr;
304        const int one = 1;
305        memset(&addr,0,sizeof(addr));
306        libtrace_filter_t *filter = FORMAT_DATA->filter;
307
308        /* Create a raw socket for reading packets on */
309        stream->fd = socket(PF_PACKET, SOCK_RAW, htons(ETH_P_ALL));
310        if (stream->fd==-1) {
311                trace_set_err(libtrace, errno, "Could not create raw socket");
312                return -1;
313        }
314
315        /* Bind to the capture interface */
316        addr.sll_family = AF_PACKET;
317        addr.sll_protocol = htons(ETH_P_ALL);
318        if (strlen(libtrace->uridata)) {
319                addr.sll_ifindex = if_nametoindex(libtrace->uridata);
320                if (addr.sll_ifindex == 0) {
321                        linuxcommon_close_input_stream(libtrace, stream);
322                        trace_set_err(libtrace, TRACE_ERR_INIT_FAILED,
323                                      "Failed to find interface %s",
324                                      libtrace->uridata);
325                        return -1;
326                }
327        } else {
328                addr.sll_ifindex = 0;
329        }
330        if (bind(stream->fd,
331                 (struct sockaddr*)&addr,
332                 (socklen_t)sizeof(addr))==-1) {
333                linuxcommon_close_input_stream(libtrace, stream);
334                trace_set_err(libtrace, errno,
335                              "Failed to bind to interface %s",
336                              libtrace->uridata);
337                return -1;
338        }
339
340        /* If promisc hasn't been specified, set it to "true" if we're
341         * capturing on one interface, or "false" if we're capturing on
342         * all interfaces.
343         */
344        if (FORMAT_DATA->promisc==-1) {
345                if (addr.sll_ifindex!=0)
346                        FORMAT_DATA->promisc=1;
347                else
348                        FORMAT_DATA->promisc=0;
349        }
350
351        /* Enable promiscuous mode, if requested */
352        if (FORMAT_DATA->promisc) {
353                struct packet_mreq mreq;
354                socklen_t socklen = sizeof(mreq);
355                memset(&mreq,0,sizeof(mreq));
356                mreq.mr_ifindex = addr.sll_ifindex;
357                mreq.mr_type = PACKET_MR_PROMISC;
358                if (setsockopt(stream->fd,
359                               SOL_PACKET,
360                               PACKET_ADD_MEMBERSHIP,
361                               &mreq,
362                               socklen)==-1) {
363                        perror("setsockopt(PROMISC)");
364                }
365        }
366
367        /* Set the timestamp option on the socket - aim for the most detailed
368         * clock resolution possible */
369#ifdef SO_TIMESTAMPNS
370        if (setsockopt(stream->fd,
371                       SOL_SOCKET,
372                       SO_TIMESTAMPNS,
373                       &one,
374                       (socklen_t)sizeof(one))!=-1) {
375                FORMAT_DATA->timestamptype = TS_TIMESPEC;
376        }
377        else
378        /* DANGER: This is a dangling else to only do the next setsockopt()
379         * if we fail the first! */
380#endif
381                if (setsockopt(stream->fd,
382                               SOL_SOCKET,
383                               SO_TIMESTAMP,
384                               &one,
385                               (socklen_t)sizeof(one))!=-1) {
386                        FORMAT_DATA->timestamptype = TS_TIMEVAL;
387                }
388                else
389                        FORMAT_DATA->timestamptype = TS_NONE;
390
391        /* Push BPF filter into the kernel. At this stage we can safely assume
392         * that the filterstring has been compiled, or the filter was supplied
393         * pre-compiled.
394         */
395        if (filter != NULL) {
396                /* Check if the filter was successfully compiled. If not,
397                 * it is probably a bad filter and we should return an error
398                 * before the caller tries to read any packets */
399                if (filter->flag == 0) {
400                        linuxcommon_close_input_stream(libtrace, stream);
401                        trace_set_err(libtrace, TRACE_ERR_BAD_FILTER,
402                                      "Cannot attach a bad filter to %s",
403                                      libtrace->uridata);
404                        return -1;
405                }
406
407                if (setsockopt(stream->fd,
408                               SOL_SOCKET,
409                               SO_ATTACH_FILTER,
410                               &filter->filter,
411                               sizeof(filter->filter)) == -1) {
412                        perror("setsockopt(SO_ATTACH_FILTER)");
413                }
414        }
415
416        /* Consume any buffered packets that were received before the socket
417         * was properly setup, including those which missed the filter and
418         * bind()ing to an interface.
419         *
420         * If packet rate is high this could therotically hang forever. 4K
421         * should be a large enough limit.
422         */
423        int count = 0;
424        void *buf = malloc((size_t)LIBTRACE_PACKET_BUFSIZE);
425        while(count < 4096 &&
426                recv(stream->fd,
427                   buf,
428                   (size_t)LIBTRACE_PACKET_BUFSIZE,
429                   MSG_DONTWAIT) != -1) { count++; }
430        free(buf);
431
432        /* Mark that the stats are valid and apply an offset */
433        FORMAT_DATA->stats_valid = 1;
434        /* Offset by number we ate for each stream and reset stats after pause */
435        FORMAT_DATA->stats.tp_packets = -count;
436        FORMAT_DATA->stats.tp_drops = 0;
437
438        if (linuxcommon_get_dev_statisitics(libtrace, &FORMAT_DATA->dev_stats) != 0) {
439                /* Mark this as bad */
440                FORMAT_DATA->dev_stats.if_name[0] = 0;
441        }
442
443        return 0;
444}
445
446int linuxcommon_pause_input(libtrace_t *libtrace)
447{
448        size_t i;
449
450        /* Stop and detach each stream */
451        for (i = 0; i < libtrace_list_get_size(FORMAT_DATA->per_stream); ++i) {
452                struct linux_per_stream_t *stream;
453                stream = libtrace_list_get_index(FORMAT_DATA->per_stream, i)->data;
454                linuxcommon_close_input_stream(libtrace, stream);
455        }
456
457        return 0;
458}
459
460int linuxcommon_fin_input(libtrace_t *libtrace)
461{
462        if (libtrace->format_data) {
463                if (FORMAT_DATA->filter != NULL)
464                        free(FORMAT_DATA->filter);
465
466                if (FORMAT_DATA->per_stream)
467                        libtrace_list_deinit(FORMAT_DATA->per_stream);
468
469                free(libtrace->format_data);
470        }
471
472        return 0;
473}
474
475int linuxcommon_pregister_thread(libtrace_t *libtrace,
476                                 libtrace_thread_t *t,
477                                 bool reading) {
478        if (reading) {
479                /* XXX TODO remove this oneday make sure hasher thread still works */
480                struct linux_per_stream_t *stream;
481                stream = libtrace_list_get_index(FORMAT_DATA->per_stream,
482                                                 t->perpkt_num)->data;
483                t->format_data = stream;
484                if (!stream) {
485                        /* This should never happen and indicates an
486                         * internal libtrace bug */
487                        trace_set_err(libtrace, TRACE_ERR_INIT_FAILED,
488                                      "Failed to attached thread %d to a stream",
489                                      t->perpkt_num);
490                        return -1;
491                }
492        }
493        return 0;
494}
495
496/* These counters reset with each read */
497static void linuxcommon_update_socket_statistics(libtrace_t *libtrace) {
498        struct tpacket_stats stats;
499        size_t i;
500        socklen_t len = sizeof(stats);
501
502        for (i = 0; i < libtrace_list_get_size(FORMAT_DATA->per_stream); ++i) {
503                struct linux_per_stream_t *stream;
504                stream = libtrace_list_get_index(FORMAT_DATA->per_stream, i)->data;
505                if (stream->fd != -1) {
506                        if (getsockopt(stream->fd,
507                                   SOL_PACKET,
508                                   PACKET_STATISTICS,
509                                   &stats,
510                                   &len) == 0) {
511                                if (FORMAT_DATA->stats_valid==0) {
512                                        FORMAT_DATA->stats.tp_drops = stats.tp_drops;
513                                        FORMAT_DATA->stats.tp_packets = stats.tp_packets;
514                                        FORMAT_DATA->stats_valid = 1;
515                                } else {
516                                        FORMAT_DATA->stats.tp_drops += stats.tp_drops;
517                                        FORMAT_DATA->stats.tp_packets += stats.tp_packets;
518                                }
519                        } else {
520                                perror("getsockopt PACKET_STATISTICS failed");
521                        }
522                }
523        }
524}
525
526#define DEV_DIFF(x) (dev_stats.x - FORMAT_DATA->dev_stats.x)
527/* Note these statistics come from two different sources, the socket itself and
528 * the linux device. As such this means it is highly likely that their is some
529 * margin of error in the returned statisitics, we perform basic sanitising so
530 * that these are not too noticable.
531 */
532void linuxcommon_get_statistics(libtrace_t *libtrace, libtrace_stat_t *stat) {
533        struct linux_dev_stats dev_stats;
534        if (libtrace->format_data == NULL)
535                return;
536        /* Do we need to consider the case after the trace is closed? */
537        if (FORMAT_DATA_FIRST->fd == -1) {
538                /* This is probably a 'dead' trace so obviously we can't query
539                 * the socket for capture counts, can we? */
540                return;
541        }
542
543        dev_stats.if_name[0] = 0; /* This will be set if we retrive valid stats */
544        /* Do we have starting stats to compare to? */
545        if (FORMAT_DATA->dev_stats.if_name[0] != 0) {
546                linuxcommon_get_dev_statisitics(libtrace, &dev_stats);
547        }
548        linuxcommon_update_socket_statistics(libtrace);
549
550        /* filtered count == dev received - socket received */
551        if (FORMAT_DATA->filter != NULL &&
552            FORMAT_DATA->stats_valid &&
553            dev_stats.if_name[0]) {
554                uint64_t filtered = DEV_DIFF(rx_packets) -
555                                    FORMAT_DATA->stats.tp_packets;
556                /* Check the value is sane, due to timing it could be below 0 */
557                if (filtered < UINT64_MAX - 100000) {
558                        stat->filtered += filtered;
559                }
560        }
561
562        /* dropped count == socket dropped + dev dropped */
563        if (FORMAT_DATA->stats_valid) {
564                stat->dropped_valid = 1;
565                stat->dropped = FORMAT_DATA->stats.tp_drops;
566                if (dev_stats.if_name[0]) {
567                        stat->dropped += DEV_DIFF(rx_drops);
568                }
569        }
570
571        /* received count - All good packets even those dropped or filtered */
572        if (dev_stats.if_name[0]) {
573                stat->received_valid = 1;
574                stat->received = DEV_DIFF(rx_packets) + DEV_DIFF(rx_drops);
575        }
576
577        /* captured count - received and but not dropped */
578        if (dev_stats.if_name[0] && FORMAT_DATA->stats_valid) {
579                stat->captured_valid = 1;
580                stat->captured = DEV_DIFF(rx_packets) - FORMAT_DATA->stats.tp_drops;
581        }
582
583        /* errors */
584        if (dev_stats.if_name[0]) {
585                stat->errors_valid = 1;
586                stat->errors = DEV_DIFF(rx_errors);
587        }
588
589}
590
591int linuxcommon_get_fd(const libtrace_t *libtrace) {
592        if (libtrace->format_data == NULL)
593                return -1;
594        return FORMAT_DATA_FIRST->fd;
595}
596
597int linuxcommon_pstart_input(libtrace_t *libtrace,
598                             int (*start_stream)(libtrace_t *, struct linux_per_stream_t*)) {
599        int i = 0;
600        int tot = libtrace->perpkt_thread_count;
601        int iserror = 0;
602        struct linux_per_stream_t empty_stream = ZERO_LINUX_STREAM;
603
604        for (i = 0; i < tot; ++i)
605        {
606                struct linux_per_stream_t *stream;
607                /* Add storage for another stream */
608                if (libtrace_list_get_size(FORMAT_DATA->per_stream) <= (size_t) i)
609                        libtrace_list_push_back(FORMAT_DATA->per_stream, &empty_stream);
610
611                stream = libtrace_list_get_index(FORMAT_DATA->per_stream, i)->data;
612                if (start_stream(libtrace, stream) != 0) {
613                        iserror = 1;
614                        break;
615                }
616                if (linuxcommon_to_packet_fanout(libtrace, stream) != 0)
617                {
618                        iserror = 1;
619                        close(stream->fd);
620                        stream->fd = -1;
621                        break;
622                }
623        }
624
625        if (iserror) {
626                /* Free those that succeeded */
627                for (i = i - 1; i >= 0; i--) {
628                        struct linux_per_stream_t *stream;
629                        stream = libtrace_list_get_index(FORMAT_DATA->per_stream, i)->data;
630                        linuxcommon_close_input_stream(libtrace, stream);
631                }
632                return -1;
633        }
634
635        return 0;
636}
637
638#else /* HAVE_NETPACKET_PACKET_H */
639
640/* No NETPACKET - So this format is not live */
641void linuxcommon_get_statistics(libtrace_t *libtrace UNUSED,
642                                libtrace_stat_t *stat UNUSED) {
643        return;
644}
645
646#endif /* HAVE_NETPACKET_PACKET_H */
647
Note: See TracBrowser for help on using the repository browser.