contrib/libpcap/pcap_compile.3pcap.in

   1 .\" Copyright (c) 1994, 1996, 1997
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that: (1) source code distributions
   6 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   7 .\" distributions including binary code include the above copyright notice and
   8 .\" this paragraph in its entirety in the documentation or other materials
   9 .\" provided with the distribution, and (3) all advertising materials mentioning
  10 .\" features or use of this software display the following acknowledgement:
  11 .\" ``This product includes software developed by the University of California,
  12 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  13 .\" the University nor the names of its contributors may be used to endorse
  14 .\" or promote products derived from this software without specific prior
  15 .\" written permission.
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  17 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  18 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19 .\"
  20 .TH PCAP_COMPILE 3PCAP "22 August 2018"
  21 .SH NAME
  22 pcap_compile \- compile a filter expression
  23 .SH SYNOPSIS
  24 .nf
  25 .ft B
  26 #include <pcap/pcap.h>
  27 .ft
  28 .LP
  29 .ft B
  30 int pcap_compile(pcap_t *p, struct bpf_program *fp,
  31 .ti +8
  32 const char *str, int optimize, bpf_u_int32 netmask);
  33 .ft
  34 .fi
  35 .SH DESCRIPTION
  36 .B pcap_compile()
  37 is used to compile the string
  38 .I str
  39 into a filter program.  See
  40 .BR pcap-filter (@MAN_MISC_INFO@)
  41 for the syntax of that string.
  42 .I program
  43 is a pointer to a
  44 .I bpf_program
  45 struct and is filled in by
  46 .BR pcap_compile() .
  47 .I optimize
  48 controls whether optimization on the resulting code is performed.
  49 .I netmask
  50 specifies the IPv4 netmask of the network on which packets are being
  51 captured; it is used only when checking for IPv4 broadcast addresses in
  52 the filter program.  If the netmask of the network on which packets are
  53 being captured isn't known to the program, or if packets are being
  54 captured on the Linux "any" pseudo-interface that can capture on more
  55 than one network, a value of
  56 .B PCAP_NETMASK_UNKNOWN
  57 can be supplied; tests
  58 for IPv4 broadcast addresses will fail to compile, but all other tests in
  59 the filter program will be OK.
  60 .LP
  61 NOTE: in libpcap 1.8.0 and later,
  62 .B pcap_compile()
  63 can be used in multiple threads within a single process.  However, in
  64 earlier versions of libpcap, it is
  65 .I not
  66 safe to use
  67 .B pcap_compile()
  68 in multiple threads in a single process without some form of mutual
  69 exclusion allowing only one thread to call it at any given time.
  70 .SH RETURN VALUE
  71 .B pcap_compile()
  72 returns 0 on success and
  73 .B PCAP_ERROR
  74 on failure. If
  75 .B PCAP_ERROR
  76 is returned,
  77 .B pcap_geterr(3PCAP)
  78 or
  79 .B pcap_perror(3PCAP)
  80 may be called with
  81 .I p
  82 as an argument to fetch or display the error text.
  83 .SH BACKWARD COMPATIBILITY
  84 .PP
  85 The
  86 .B PCAP_NETMASK_UNKNOWN
  87 constant became available in libpcap release 1.1.0.
  88 .SH SEE ALSO
  89 pcap(3PCAP), pcap_setfilter(3PCAP), pcap_freecode(3PCAP),