1/*
2 * OSPF Sending and Receiving OSPF Packets.
3 * Copyright (C) 1999 Toshiaki Takada
4 *
5 * This file is part of GNU Zebra.
6 *
7 * GNU Zebra is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2, or (at your option) any
10 * later version.
11 *
12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Zebra; see the file COPYING.  If not, write to the Free
19 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20 * 02111-1307, USA.
21 */
22
23#ifndef _ZEBRA_OSPF_PACKET_H
24#define _ZEBRA_OSPF_PACKET_H
25
26#define OSPF_HEADER_SIZE         24
27#define OSPF_AUTH_SIMPLE_SIZE     8
28#define OSPF_AUTH_MD5_SIZE       16
29
30#define OSPF_MAX_PACKET_SIZE  65535   /* includes IP Header size. */
31#define OSPF_HELLO_MIN_SIZE      20   /* not including neighbors */
32#define OSPF_DB_DESC_MIN_SIZE     8
33#define OSPF_LS_REQ_MIN_SIZE      0
34#define OSPF_LS_UPD_MIN_SIZE      4
35#define OSPF_LS_ACK_MIN_SIZE      0
36
37#define OSPF_MSG_HELLO         1  /* OSPF Hello Message. */
38#define OSPF_MSG_DB_DESC       2  /* OSPF Database Descriptoin Message. */
39#define OSPF_MSG_LS_REQ        3  /* OSPF Link State Request Message. */
40#define OSPF_MSG_LS_UPD        4  /* OSPF Link State Update Message. */
41#define OSPF_MSG_LS_ACK        5  /* OSPF Link State Acknoledgement Message. */
42
43#define OSPF_SEND_PACKET_DIRECT         1
44#define OSPF_SEND_PACKET_INDIRECT       2
45
46#ifdef HAVE_NSSA
47#define OSPF_SEND_PACKET_LOOP           3
48#endif /* HAVE_NSSA */
49
50#define OSPF_HELLO_REPLY_DELAY          1
51
52struct ospf_packet
53{
54  struct ospf_packet *next;
55
56  /* Pointer to data stream. */
57  struct stream *s;
58
59  /* IP destination address. */
60  struct in_addr dst;
61
62  /* OSPF packet length. */
63  u_int16_t length;
64};
65
66/* OSPF packet queue structure. */
67struct ospf_fifo
68{
69  unsigned long count;
70
71  struct ospf_packet *head;
72  struct ospf_packet *tail;
73};
74
75/* OSPF packet header structure. */
76struct ospf_header
77{
78  u_char version;                       /* OSPF Version. */
79  u_char type;                          /* Packet Type. */
80  u_int16_t length;                     /* Packet Length. */
81  struct in_addr router_id;             /* Router ID. */
82  struct in_addr area_id;               /* Area ID. */
83  u_int16_t checksum;                   /* Check Sum. */
84  u_int16_t auth_type;                  /* Authentication Type. */
85  /* Authentication Data. */
86  union
87  {
88    /* Simple Authentication. */
89    u_char auth_data [OSPF_AUTH_SIMPLE_SIZE];
90    /* Cryptographic Authentication. */
91    struct
92    {
93      u_int16_t zero;                   /* Should be 0. */
94      u_char key_id;                    /* Key ID. */
95      u_char auth_data_len;             /* Auth Data Length. */
96      u_int32_t crypt_seqnum;           /* Cryptographic Sequence Number. */
97    } crypt;
98  } u;
99};
100
101/* OSPF Hello body format. */
102struct ospf_hello
103{
104  struct in_addr network_mask;
105  u_int16_t hello_interval;
106  u_char options;
107  u_char priority;
108  u_int32_t dead_interval;
109  struct in_addr d_router;
110  struct in_addr bd_router;
111  struct in_addr neighbors[1];
112};
113
114/* OSPF Database Description body format. */
115struct ospf_db_desc
116{
117  u_int16_t mtu;
118  u_char options;
119  u_char flags;
120  u_int32_t dd_seqnum;
121};
122
123
124/* Macros. */
125#define OSPF_PACKET_MAX(oi)     ospf_packet_max (oi)
126/*
127#define OSPF_PACKET_MAX(oi)     (((oi)->ifp->mtu - ((oi)->auth_md5 ? OSPF_AUTH_MD5_SIZE : 0)) - 88)
128*/
129
130#define OSPF_OUTPUT_PNT(S)      ((S)->data + (S)->putp)
131#define OSPF_OUTPUT_LENGTH(S)   ((S)->endp)
132
133#define IS_SET_DD_MS(X)         ((X) & OSPF_DD_FLAG_MS)
134#define IS_SET_DD_M(X)          ((X) & OSPF_DD_FLAG_M)
135#define IS_SET_DD_I(X)          ((X) & OSPF_DD_FLAG_I)
136#define IS_SET_DD_ALL(X)        ((X) & OSPF_DD_FLAG_ALL)
137
138/* Prototypes. */
139void ospf_output_forward (struct stream *, int);
140struct ospf_packet *ospf_packet_new (size_t);
141void ospf_packet_free (struct ospf_packet *);
142struct ospf_fifo *ospf_fifo_new ();
143void ospf_fifo_push (struct ospf_fifo *, struct ospf_packet *);
144struct ospf_packet *ospf_fifo_pop (struct ospf_fifo *);
145struct ospf_packet *ospf_fifo_head (struct ospf_fifo *);
146void ospf_fifo_flush (struct ospf_fifo *);
147void ospf_fifo_free (struct ospf_fifo *);
148void ospf_packet_add (struct ospf_interface *, struct ospf_packet *);
149void ospf_packet_delete (struct ospf_interface *);
150struct stream *ospf_stream_dup (struct stream *);
151struct ospf_packet *ospf_packet_dup (struct ospf_packet *);
152
153int ospf_read (struct thread *);
154void ospf_hello_send (struct ospf_interface *);
155void ospf_db_desc_send (struct ospf_neighbor *);
156void ospf_db_desc_resend (struct ospf_neighbor *);
157void ospf_ls_req_send (struct ospf_neighbor *);
158void ospf_ls_upd_send_lsa (struct ospf_neighbor *, struct ospf_lsa *, int);
159void ospf_ls_upd_send (struct ospf_neighbor *, list, int);
160void ospf_ls_ack_send (struct ospf_neighbor *, struct ospf_lsa *);
161void ospf_ls_ack_send_delayed (struct ospf_interface *);
162void ospf_ls_retransmit (struct ospf_interface *, struct ospf_lsa *);
163void ospf_ls_req_event (struct ospf_neighbor *);
164
165int ospf_ls_upd_timer (struct thread *);
166int ospf_ls_ack_timer (struct thread *);
167int ospf_poll_timer (struct thread *);
168int ospf_hello_reply_timer (struct thread *);
169void ospf_hello_send_sub (struct ospf_interface *, struct in_addr *);
170
171#endif /* _ZEBRA_OSPF_PACKET_H */
172