docs: Use newer Ubuntu LTS in tutorial
[vpp.git] / src / plugins / dhcp / dhcp4_packet.h
1 #ifndef included_vnet_dhcp4_packet_h
2 #define included_vnet_dhcp4_packet_h
3
4 /*
5  * DHCP packet format
6  *
7  * Copyright (c) 2013 Cisco and/or its affiliates.
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at:
11  *
12  *     http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  */
20 #include <vnet/ip/ip4_packet.h>
21
22 typedef struct
23 {
24   u8 option;
25   u8 length;
26   union
27   {
28     u8 data[0];
29     u32 data_as_u32[0];
30   };
31 } __attribute__ ((packed)) dhcp_option_t;
32
33 typedef struct
34 {
35   u8 opcode;                    /* 1 = request, 2 = reply */
36   u8 hardware_type;             /* 1 = ethernet */
37   u8 hardware_address_length;
38   u8 hops;
39   u32 transaction_identifier;
40   u16 seconds;
41   u16 flags;
42 #define DHCP_FLAG_BROADCAST (1<<15)
43   ip4_address_t client_ip_address;
44   ip4_address_t your_ip_address;        /* use this one */
45   ip4_address_t server_ip_address;
46   ip4_address_t gateway_ip_address;     /* use option 3, not this one */
47   u8 client_hardware_address[16];
48   u8 server_name[64];
49   u8 boot_filename[128];
50   ip4_address_t magic_cookie;
51   dhcp_option_t options[0];
52 } dhcp_header_t;
53
54 extern u8 *format_dhcp_header (u8 * s, va_list * args);
55
56 typedef enum
57 {
58   DHCP_PACKET_DISCOVER = 1,
59   DHCP_PACKET_OFFER,
60   DHCP_PACKET_REQUEST,
61   DHCP_PACKET_ACK = 5,
62   DHCP_PACKET_NAK,
63 } dhcp_packet_type_t;
64
65 extern u8 *format_dhcp_packet_type (u8 * s, va_list * args);
66
67 typedef enum dhcp_packet_option_t_
68 {
69   DHCP_PACKET_OPTION_MSG_TYPE = 53,
70   DHCP_PACKET_OPTION_END = 0xff,
71 } dhcp_packet_option_t;
72
73 /* charming antique: 99.130.83.99 is the dhcp magic cookie */
74 #define DHCP_MAGIC (clib_host_to_net_u32(0x63825363))
75
76 #endif /* included_vnet_dhcp4_packet_h */
77
78 /*
79  * fd.io coding-style-patch-verification: ON
80  *
81  * Local Variables:
82  * eval: (c-set-style "gnu")
83  * End:
84  */