[AX.25]: Fix potencial memory hole.
[linux-2.6.git] / include / net / ax25.h
1 /*
2  *      Declarations of AX.25 type objects.
3  *
4  *      Alan Cox (GW4PTS)       10/11/93
5  */
6 #ifndef _AX25_H
7 #define _AX25_H 
8
9 #include <linux/config.h>
10 #include <linux/ax25.h>
11 #include <linux/spinlock.h>
12 #include <linux/timer.h>
13 #include <linux/list.h>
14 #include <asm/atomic.h>
15
16 #define AX25_T1CLAMPLO                  1
17 #define AX25_T1CLAMPHI                  (30 * HZ)
18
19 #define AX25_BPQ_HEADER_LEN             16
20 #define AX25_KISS_HEADER_LEN            1
21
22 #define AX25_HEADER_LEN                 17
23 #define AX25_ADDR_LEN                   7
24 #define AX25_DIGI_HEADER_LEN            (AX25_MAX_DIGIS * AX25_ADDR_LEN)
25 #define AX25_MAX_HEADER_LEN             (AX25_HEADER_LEN + AX25_DIGI_HEADER_LEN)
26
27 /* AX.25 Protocol IDs */
28 #define AX25_P_ROSE                     0x01
29 #define AX25_P_VJCOMP                   0x06    /* Compressed TCP/IP packet   */
30                                                 /* Van Jacobsen (RFC 1144)    */
31 #define AX25_P_VJUNCOMP                 0x07    /* Uncompressed TCP/IP packet */
32                                                 /* Van Jacobsen (RFC 1144)    */
33 #define AX25_P_SEGMENT                  0x08    /* Segmentation fragment      */
34 #define AX25_P_TEXNET                   0xc3    /* TEXTNET datagram protocol  */
35 #define AX25_P_LQ                       0xc4    /* Link Quality Protocol      */
36 #define AX25_P_ATALK                    0xca    /* Appletalk                  */
37 #define AX25_P_ATALK_ARP                0xcb    /* Appletalk ARP              */
38 #define AX25_P_IP                       0xcc    /* ARPA Internet Protocol     */
39 #define AX25_P_ARP                      0xcd    /* ARPA Adress Resolution     */
40 #define AX25_P_FLEXNET                  0xce    /* FlexNet                    */
41 #define AX25_P_NETROM                   0xcf    /* NET/ROM                    */
42 #define AX25_P_TEXT                     0xF0    /* No layer 3 protocol impl.  */
43
44 /* AX.25 Segment control values */
45 #define AX25_SEG_REM                    0x7F
46 #define AX25_SEG_FIRST                  0x80
47
48 #define AX25_CBIT                       0x80    /* Command/Response bit */
49 #define AX25_EBIT                       0x01    /* HDLC Address Extension bit */
50 #define AX25_HBIT                       0x80    /* Has been repeated bit */
51
52 #define AX25_SSSID_SPARE                0x60    /* Unused bits in SSID for standard AX.25 */
53 #define AX25_ESSID_SPARE                0x20    /* Unused bits in SSID for extended AX.25 */
54 #define AX25_DAMA_FLAG                  0x20    /* Well, it is *NOT* unused! (dl1bke 951121 */
55
56 #define AX25_COND_ACK_PENDING           0x01
57 #define AX25_COND_REJECT                0x02
58 #define AX25_COND_PEER_RX_BUSY          0x04
59 #define AX25_COND_OWN_RX_BUSY           0x08
60 #define AX25_COND_DAMA_MODE             0x10
61
62 #ifndef _LINUX_NETDEVICE_H
63 #include <linux/netdevice.h>
64 #endif
65
66 /* Upper sub-layer (LAPB) definitions */
67
68 /* Control field templates */
69 #define AX25_I                  0x00    /* Information frames */
70 #define AX25_S                  0x01    /* Supervisory frames */
71 #define AX25_RR                 0x01    /* Receiver ready */
72 #define AX25_RNR                0x05    /* Receiver not ready */
73 #define AX25_REJ                0x09    /* Reject */
74 #define AX25_U                  0x03    /* Unnumbered frames */
75 #define AX25_SABM               0x2f    /* Set Asynchronous Balanced Mode */
76 #define AX25_SABME              0x6f    /* Set Asynchronous Balanced Mode Extended */
77 #define AX25_DISC               0x43    /* Disconnect */
78 #define AX25_DM                 0x0f    /* Disconnected mode */
79 #define AX25_UA                 0x63    /* Unnumbered acknowledge */
80 #define AX25_FRMR               0x87    /* Frame reject */
81 #define AX25_UI                 0x03    /* Unnumbered information */
82 #define AX25_XID                0xaf    /* Exchange information */
83 #define AX25_TEST               0xe3    /* Test */
84
85 #define AX25_PF                 0x10    /* Poll/final bit for standard AX.25 */
86 #define AX25_EPF                0x01    /* Poll/final bit for extended AX.25 */
87
88 #define AX25_ILLEGAL            0x100   /* Impossible to be a real frame type */
89
90 #define AX25_POLLOFF            0
91 #define AX25_POLLON             1
92
93 /* AX25 L2 C-bit */
94 #define AX25_COMMAND            1
95 #define AX25_RESPONSE           2
96
97 /* Define Link State constants. */
98
99 enum { 
100         AX25_STATE_0,                   /* Listening */
101         AX25_STATE_1,                   /* SABM sent */
102         AX25_STATE_2,                   /* DISC sent */
103         AX25_STATE_3,                   /* Established */
104         AX25_STATE_4                    /* Recovery */
105 };
106
107 #define AX25_MODULUS            8       /*  Standard AX.25 modulus */
108 #define AX25_EMODULUS           128     /*  Extended AX.25 modulus */
109
110 enum {
111         AX25_PROTO_STD_SIMPLEX,
112         AX25_PROTO_STD_DUPLEX,
113 #ifdef CONFIG_AX25_DAMA_SLAVE
114         AX25_PROTO_DAMA_SLAVE,
115 #ifdef CONFIG_AX25_DAMA_MASTER
116         AX25_PROTO_DAMA_MASTER,
117 #define AX25_PROTO_MAX AX25_PROTO_DAMA_MASTER
118 #endif
119 #endif
120         __AX25_PROTO_MAX,
121         AX25_PROTO_MAX = __AX25_PROTO_MAX -1
122 };
123
124 enum {
125         AX25_VALUES_IPDEFMODE,  /* 0=DG 1=VC */
126         AX25_VALUES_AXDEFMODE,  /* 0=Normal 1=Extended Seq Nos */
127         AX25_VALUES_BACKOFF,    /* 0=None 1=Linear 2=Exponential */
128         AX25_VALUES_CONMODE,    /* Allow connected modes - 0=No 1=no "PID text" 2=all PIDs */
129         AX25_VALUES_WINDOW,     /* Default window size for standard AX.25 */
130         AX25_VALUES_EWINDOW,    /* Default window size for extended AX.25 */
131         AX25_VALUES_T1,         /* Default T1 timeout value */
132         AX25_VALUES_T2,         /* Default T2 timeout value */
133         AX25_VALUES_T3,         /* Default T3 timeout value */
134         AX25_VALUES_IDLE,       /* Connected mode idle timer */
135         AX25_VALUES_N2,         /* Default N2 value */
136         AX25_VALUES_PACLEN,     /* AX.25 MTU */
137         AX25_VALUES_PROTOCOL,   /* Std AX.25, DAMA Slave, DAMA Master */
138         AX25_VALUES_DS_TIMEOUT, /* DAMA Slave timeout */
139         AX25_MAX_VALUES         /* THIS MUST REMAIN THE LAST ENTRY OF THIS LIST */
140 };
141
142 #define AX25_DEF_IPDEFMODE      0                       /* Datagram */
143 #define AX25_DEF_AXDEFMODE      0                       /* Normal */
144 #define AX25_DEF_BACKOFF        1                       /* Linear backoff */
145 #define AX25_DEF_CONMODE        2                       /* Connected mode allowed */
146 #define AX25_DEF_WINDOW         2                       /* Window=2 */
147 #define AX25_DEF_EWINDOW        32                      /* Module-128 Window=32 */
148 #define AX25_DEF_T1             (10 * HZ)               /* T1=10s */
149 #define AX25_DEF_T2             (3 * HZ)                /* T2=3s  */
150 #define AX25_DEF_T3             (300 * HZ)              /* T3=300s */
151 #define AX25_DEF_N2             10                      /* N2=10 */
152 #define AX25_DEF_IDLE           (0 * 60 * HZ)           /* Idle=None */
153 #define AX25_DEF_PACLEN         256                     /* Paclen=256 */
154 #define AX25_DEF_PROTOCOL       AX25_PROTO_STD_SIMPLEX  /* Standard AX.25 */
155 #define AX25_DEF_DS_TIMEOUT     (3 * 60 * HZ)           /* DAMA timeout 3 minutes */
156
157 typedef struct ax25_uid_assoc {
158         struct hlist_node       uid_node;
159         atomic_t                refcount;
160         uid_t                   uid;
161         ax25_address            call;
162 } ax25_uid_assoc;
163
164 #define ax25_uid_for_each(__ax25, node, list) \
165         hlist_for_each_entry(__ax25, node, list, uid_node)
166
167 #define ax25_uid_hold(ax25) \
168         atomic_inc(&((ax25)->refcount))
169
170 static inline void ax25_uid_put(ax25_uid_assoc *assoc)
171 {
172         if (atomic_dec_and_test(&assoc->refcount)) {
173                 kfree(assoc);
174         }
175 }
176
177 typedef struct {
178         ax25_address            calls[AX25_MAX_DIGIS];
179         unsigned char           repeated[AX25_MAX_DIGIS];
180         unsigned char           ndigi;
181         signed char             lastrepeat;
182 } ax25_digi;
183
184 typedef struct ax25_route {
185         struct ax25_route       *next;
186         atomic_t                ref;
187         ax25_address            callsign;
188         struct net_device       *dev;
189         ax25_digi               *digipeat;
190         char                    ip_mode;
191         struct timer_list       timer;
192 } ax25_route;
193
194 typedef struct {
195         char                    slave;                  /* slave_mode?   */
196         struct timer_list       slave_timer;            /* timeout timer */
197         unsigned short          slave_timeout;          /* when? */
198 } ax25_dama_info;
199
200 struct ctl_table;
201
202 typedef struct ax25_dev {
203         struct ax25_dev         *next;
204         struct net_device       *dev;
205         struct net_device       *forward;
206         struct ctl_table        *systable;
207         int                     values[AX25_MAX_VALUES];
208 #if defined(CONFIG_AX25_DAMA_SLAVE) || defined(CONFIG_AX25_DAMA_MASTER)
209         ax25_dama_info          dama;
210 #endif
211 } ax25_dev;
212
213 typedef struct ax25_cb {
214         struct hlist_node       ax25_node;
215         ax25_address            source_addr, dest_addr;
216         ax25_digi               *digipeat;
217         ax25_dev                *ax25_dev;
218         unsigned char           iamdigi;
219         unsigned char           state, modulus, pidincl;
220         unsigned short          vs, vr, va;
221         unsigned char           condition, backoff;
222         unsigned char           n2, n2count;
223         struct timer_list       t1timer, t2timer, t3timer, idletimer;
224         unsigned long           t1, t2, t3, idle, rtt;
225         unsigned short          paclen, fragno, fraglen;
226         struct sk_buff_head     write_queue;
227         struct sk_buff_head     reseq_queue;
228         struct sk_buff_head     ack_queue;
229         struct sk_buff_head     frag_queue;
230         unsigned char           window;
231         struct timer_list       timer, dtimer;
232         struct sock             *sk;            /* Backlink to socket */
233         atomic_t                refcount;
234 } ax25_cb;
235
236 #define ax25_sk(__sk) ((ax25_cb *)(__sk)->sk_protinfo)
237
238 #define ax25_for_each(__ax25, node, list) \
239         hlist_for_each_entry(__ax25, node, list, ax25_node)
240
241 #define ax25_cb_hold(__ax25) \
242         atomic_inc(&((__ax25)->refcount))
243
244 static __inline__ void ax25_cb_put(ax25_cb *ax25)
245 {
246         if (atomic_dec_and_test(&ax25->refcount)) {
247                 kfree(ax25->digipeat);
248                 kfree(ax25);
249         }
250 }
251
252 static inline __be16 ax25_type_trans(struct sk_buff *skb, struct net_device *dev)
253 {
254         skb->dev      = dev;
255         skb->pkt_type = PACKET_HOST;
256         skb->mac.raw  = skb->data;
257         return htons(ETH_P_AX25);
258 }
259
260 /* af_ax25.c */
261 extern struct hlist_head ax25_list;
262 extern spinlock_t ax25_list_lock;
263 extern void ax25_cb_add(ax25_cb *);
264 struct sock *ax25_find_listener(ax25_address *, int, struct net_device *, int);
265 struct sock *ax25_get_socket(ax25_address *, ax25_address *, int);
266 extern ax25_cb *ax25_find_cb(ax25_address *, ax25_address *, ax25_digi *, struct net_device *);
267 extern void ax25_send_to_raw(ax25_address *, struct sk_buff *, int);
268 extern void ax25_destroy_socket(ax25_cb *);
269 extern ax25_cb *ax25_create_cb(void);
270 extern void ax25_fillin_cb(ax25_cb *, ax25_dev *);
271 extern struct sock *ax25_make_new(struct sock *, struct ax25_dev *);
272
273 /* ax25_addr.c */
274 extern ax25_address null_ax25_address;
275 extern char *ax2asc(char *buf, ax25_address *);
276 extern void asc2ax(ax25_address *addr, char *callsign);
277 extern int  ax25cmp(ax25_address *, ax25_address *);
278 extern int  ax25digicmp(ax25_digi *, ax25_digi *);
279 extern unsigned char *ax25_addr_parse(unsigned char *, int, ax25_address *, ax25_address *, ax25_digi *, int *, int *);
280 extern int  ax25_addr_build(unsigned char *, ax25_address *, ax25_address *, ax25_digi *, int, int);
281 extern int  ax25_addr_size(ax25_digi *);
282 extern void ax25_digi_invert(ax25_digi *, ax25_digi *);
283
284 /* ax25_dev.c */
285 extern ax25_dev *ax25_dev_list;
286 extern spinlock_t ax25_dev_lock;
287
288 static inline ax25_dev *ax25_dev_ax25dev(struct net_device *dev)
289 {
290         return dev->ax25_ptr;
291 }
292
293 extern ax25_dev *ax25_addr_ax25dev(ax25_address *);
294 extern void ax25_dev_device_up(struct net_device *);
295 extern void ax25_dev_device_down(struct net_device *);
296 extern int  ax25_fwd_ioctl(unsigned int, struct ax25_fwd_struct *);
297 extern struct net_device *ax25_fwd_dev(struct net_device *);
298 extern void ax25_dev_free(void);
299
300 /* ax25_ds_in.c */
301 extern int  ax25_ds_frame_in(ax25_cb *, struct sk_buff *, int);
302
303 /* ax25_ds_subr.c */
304 extern void ax25_ds_nr_error_recovery(ax25_cb *);
305 extern void ax25_ds_enquiry_response(ax25_cb *);
306 extern void ax25_ds_establish_data_link(ax25_cb *);
307 extern void ax25_dev_dama_off(ax25_dev *);
308 extern void ax25_dama_on(ax25_cb *);
309 extern void ax25_dama_off(ax25_cb *);
310
311 /* ax25_ds_timer.c */
312 extern void ax25_ds_set_timer(ax25_dev *);
313 extern void ax25_ds_del_timer(ax25_dev *);
314 extern void ax25_ds_timer(ax25_cb *);
315 extern void ax25_ds_t1_timeout(ax25_cb *);
316 extern void ax25_ds_heartbeat_expiry(ax25_cb *);
317 extern void ax25_ds_t3timer_expiry(ax25_cb *);
318 extern void ax25_ds_idletimer_expiry(ax25_cb *);
319
320 /* ax25_iface.c */
321 extern int  ax25_protocol_register(unsigned int, int (*)(struct sk_buff *, ax25_cb *));
322 extern void ax25_protocol_release(unsigned int);
323 extern int  ax25_linkfail_register(void (*)(ax25_cb *, int));
324 extern void ax25_linkfail_release(void (*)(ax25_cb *, int));
325 extern int  ax25_listen_register(ax25_address *, struct net_device *);
326 extern void ax25_listen_release(ax25_address *, struct net_device *);
327 extern int  (*ax25_protocol_function(unsigned int))(struct sk_buff *, ax25_cb *);
328 extern int  ax25_listen_mine(ax25_address *, struct net_device *);
329 extern void ax25_link_failed(ax25_cb *, int);
330 extern int  ax25_protocol_is_registered(unsigned int);
331
332 /* ax25_in.c */
333 extern int  ax25_rx_iframe(ax25_cb *, struct sk_buff *);
334 extern int  ax25_kiss_rcv(struct sk_buff *, struct net_device *, struct packet_type *, struct net_device *);
335
336 /* ax25_ip.c */
337 extern int  ax25_hard_header(struct sk_buff *, struct net_device *, unsigned short, void *, void *, unsigned int);
338 extern int  ax25_rebuild_header(struct sk_buff *);
339
340 /* ax25_out.c */
341 extern ax25_cb *ax25_send_frame(struct sk_buff *, int, ax25_address *, ax25_address *, ax25_digi *, struct net_device *);
342 extern void ax25_output(ax25_cb *, int, struct sk_buff *);
343 extern void ax25_kick(ax25_cb *);
344 extern void ax25_transmit_buffer(ax25_cb *, struct sk_buff *, int);
345 extern void ax25_queue_xmit(struct sk_buff *skb, struct net_device *dev);
346 extern int  ax25_check_iframes_acked(ax25_cb *, unsigned short);
347
348 /* ax25_route.c */
349 extern void ax25_rt_device_down(struct net_device *);
350 extern int  ax25_rt_ioctl(unsigned int, void __user *);
351 extern struct file_operations ax25_route_fops;
352 extern int  ax25_rt_autobind(ax25_cb *, ax25_address *);
353 extern ax25_route *ax25_rt_find_route(ax25_route *, ax25_address *,
354         struct net_device *);
355 extern struct sk_buff *ax25_rt_build_path(struct sk_buff *, ax25_address *, ax25_address *, ax25_digi *);
356 extern void ax25_rt_free(void);
357
358 static inline void ax25_put_route(ax25_route *ax25_rt)
359 {
360         atomic_dec(&ax25_rt->ref);
361 }
362
363 /* ax25_std_in.c */
364 extern int  ax25_std_frame_in(ax25_cb *, struct sk_buff *, int);
365
366 /* ax25_std_subr.c */
367 extern void ax25_std_nr_error_recovery(ax25_cb *);
368 extern void ax25_std_establish_data_link(ax25_cb *);
369 extern void ax25_std_transmit_enquiry(ax25_cb *);
370 extern void ax25_std_enquiry_response(ax25_cb *);
371 extern void ax25_std_timeout_response(ax25_cb *);
372
373 /* ax25_std_timer.c */
374 extern void ax25_std_heartbeat_expiry(ax25_cb *);
375 extern void ax25_std_t1timer_expiry(ax25_cb *);
376 extern void ax25_std_t2timer_expiry(ax25_cb *);
377 extern void ax25_std_t3timer_expiry(ax25_cb *);
378 extern void ax25_std_idletimer_expiry(ax25_cb *);
379
380 /* ax25_subr.c */
381 extern void ax25_clear_queues(ax25_cb *);
382 extern void ax25_frames_acked(ax25_cb *, unsigned short);
383 extern void ax25_requeue_frames(ax25_cb *);
384 extern int  ax25_validate_nr(ax25_cb *, unsigned short);
385 extern int  ax25_decode(ax25_cb *, struct sk_buff *, int *, int *, int *);
386 extern void ax25_send_control(ax25_cb *, int, int, int);
387 extern void ax25_return_dm(struct net_device *, ax25_address *, ax25_address *, ax25_digi *);
388 extern void ax25_calculate_t1(ax25_cb *);
389 extern void ax25_calculate_rtt(ax25_cb *);
390 extern void ax25_disconnect(ax25_cb *, int);
391
392 /* ax25_timer.c */
393 extern void ax25_start_heartbeat(ax25_cb *);
394 extern void ax25_start_t1timer(ax25_cb *);
395 extern void ax25_start_t2timer(ax25_cb *);
396 extern void ax25_start_t3timer(ax25_cb *);
397 extern void ax25_start_idletimer(ax25_cb *);
398 extern void ax25_stop_heartbeat(ax25_cb *);
399 extern void ax25_stop_t1timer(ax25_cb *);
400 extern void ax25_stop_t2timer(ax25_cb *);
401 extern void ax25_stop_t3timer(ax25_cb *);
402 extern void ax25_stop_idletimer(ax25_cb *);
403 extern int  ax25_t1timer_running(ax25_cb *);
404 extern unsigned long ax25_display_timer(struct timer_list *);
405
406 /* ax25_uid.c */
407 extern int  ax25_uid_policy;
408 extern ax25_uid_assoc *ax25_findbyuid(uid_t);
409 extern int  ax25_uid_ioctl(int, struct sockaddr_ax25 *);
410 extern struct file_operations ax25_uid_fops;
411 extern void ax25_uid_free(void);
412
413 /* sysctl_net_ax25.c */
414 #ifdef CONFIG_SYSCTL
415 extern void ax25_register_sysctl(void);
416 extern void ax25_unregister_sysctl(void);
417 #else
418 static inline void ax25_register_sysctl(void) {};
419 static inline void ax25_unregister_sysctl(void) {};
420 #endif /* CONFIG_SYSCTL */
421
422 #endif