vnet/vnet/ip/format.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16  * ip/format.h: ip 4 and/or 6 formatting
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #ifndef included_ip_format_h
  41 #define included_ip_format_h
  42
  43 /* IP4 or IP6. */
  44
  45 format_function_t format_ip_protocol;
  46 unformat_function_t unformat_ip_protocol;
  47
  48 format_function_t format_tcp_udp_port;
  49 unformat_function_t unformat_tcp_udp_port;
  50
  51 format_function_t format_ip_adjacency;
  52 format_function_t format_ip_adjacency_packet_data;
  53
  54 format_function_t format_ip46_address;
  55
  56 typedef enum {
  57   IP46_TYPE_ANY,
  58   IP46_TYPE_IP4,
  59   IP46_TYPE_IP6
  60 } ip46_type_t;
  61 /* unformat_ip46_address expects arguments (ip46_address_t *, ip46_type_t)
  62  * The type argument is used to enforce a particular IP version. */
  63 unformat_function_t unformat_ip46_address;
  64
  65 /* IP4 */
  66
  67 /* Parse an IP4 address %d.%d.%d.%d. */
  68 unformat_function_t unformat_ip4_address;
  69
  70 /* Format an IP4 address. */
  71 format_function_t format_ip4_address;
  72 format_function_t format_ip4_address_and_length;
  73
  74 /* Parse an IP4 header. */
  75 unformat_function_t unformat_ip4_header;
  76
  77 /* Format an IP4 header. */
  78 format_function_t format_ip4_header;
  79
  80 /* Parse an IP packet matching pattern. */
  81 unformat_function_t unformat_ip4_match;
  82
  83 unformat_function_t unformat_pg_ip4_header;
  84
  85 /* IP6 */
  86 unformat_function_t unformat_ip6_address;
  87 format_function_t format_ip6_address;
  88 format_function_t format_ip6_address_and_length;
  89 unformat_function_t unformat_ip6_header;
  90 format_function_t format_ip6_header;
  91 unformat_function_t unformat_pg_ip6_header;
  92
  93 /* Format a TCP/UDP headers. */
  94 format_function_t format_tcp_header, format_udp_header;
  95
  96 unformat_function_t unformat_pg_tcp_header, unformat_pg_udp_header;
  97
  98 #endif /* included_ip_format_h */