2 * Connection oriented routing
3 * Copyright (C) 2007-2008 Michael Blizek
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 #include <asm/atomic.h>
23 #include <linux/types.h>
24 #include <linux/netdevice.h>
25 #include <linux/skbuff.h>
26 #include <linux/spinlock.h>
27 #include <linux/workqueue.h>
33 #define PIDOUT_NEWCONN 16
34 #define PIDOUT_SENDDEF_THRES 8
35 #define PIDOUT_SENDDEF_COUNT 16
39 #define ETH_P_COR 0x1022
43 #define SOCKADDRTYPE_PORT 1
52 #define MAX_CONN_CMD_LEN 4096
55 #define PACKET_TYPE_ANNOUNCE 1
56 #define PACKET_TYPE_DATA 2
59 * Kernel packet data - these commands are sent by the neighbor
60 * The end nodes may cause these commands to be sent, but they see them beyond
67 /* KP_[N]ACK[1] sent_conn_id[4] seqno[4]
69 * sent_conn_id means that this is *not* the conn_id we use if we sent something
70 * through this conn, but the conn_id that the neighbor used to send us the
76 * KP_SPEED[1] conn_id[4] speedinfo[2]
79 * buffer_state_value = speedinfo % 181
80 * speed_value = speedinfo / 181
82 * buffer_state = 1024 * pow(2, buffer_state_value/3.0)
83 * speed = 1024 * pow(2, speed_value/12.0)
86 * This has to be done either with floating points (which is no so nice) or
88 * buffer_state = pow(2, value/3) *
89 * 1024 * pow(pow(2, 1.0/3), buffer_state_value%3)
90 * where 1024 * pow(pow(2, 1.0/4), value%3) can be just a table lookup
91 * (the "1024" should be part of the value in the table, because it increases
94 * you can do the same with the speed
97 * Some values have special meanings:
98 * if speedinfo is the highest possible value(65535), it means both values
100 * if buffer_state_value if > 91, you have to subtract 90 and make the
101 * resulting buffer_state negative
105 /* NOTE on connection ids:
106 * connection ids we send are used for the receive channel
107 * connection ids we receive are used for the send channel
111 * incoming connection
112 * KP_CONNECT[1] conn_id[4]
117 * incoming connection successful,
118 * the first conn_id is the same as previously sent/received in KP_CONNECT
119 * the second conn_id is generated by us and used for the other direction
120 * KP_CONNECT_SUCCESS[1] conn_id[4] conn_id[4]
122 #define KP_CONNECT_SUCCESS 5
124 /* KP_CONN_DATA[1] conn_id[4] seqno[4] length[4] data[length] */
125 #define KP_CONN_DATA 6
128 * { KP_RESET_CONN[1] conn_id[4] }
129 * We send this, if there is an established connection we want to close.
131 #define KP_RESET_CONN 7
135 * Connection data which in interpreted when connection has no target yet
136 * These commands are sent by the end node.
139 * cmd[2] length[4] parameter[length]
140 * unrecogniced commands are ignored
141 * parameters which are longer than expected are ignored as well
144 /* outgoing connection: CD_CONNECT_NB[2] length[4]
145 * addrtypelen[2] addrlen[2] addrtype[addrtypelen] addr[addrlen] */
146 #define CD_CONNECT_NB 1
148 /* connection to local open part: CD_CONNECT_PORT[2] length[4] port[8] */
149 #define CD_CONNECT_PORT 2
152 * CD_LIST_NEIGH sends CDR_BINDATA if the command was successful. The response
155 * totalneighs[4] response_rows[4]
157 * numaddr[2] (addrtypelen[2] addrlen[2] addrtype[addrtypelen] addr[addrlen]
160 * Neighbors have to be sorted by uptime, new neighbors first. This is so that
161 * the routing daemon can easily find out whether there are new neighbors. It
162 * only needs to send a query with offset 0. If the totalneighs stays the same
163 * while new were added, a connection to another neighbor was lost.
166 /* list connected neighbors: CD_LIST_NEIGH[2] length[4] limit[4] offset[4] */
167 #define CD_LIST_NEIGH 3
170 * Connection data response
171 * Format is the same as with connection data
175 * {CDR_EXECOK[2] || CDR_EXECFAILED[2]}
176 * reasoncode[2] reasontextlength[2] reasontext[reasontextlength]
177 * reasontextlength may be 0
179 #define CDR_EXECOK 32768
180 #define CDR_EXECOK_OK 33024
182 #define CDR_EXECFAILED 32769
183 #define CDR_EXECFAILED_UNKNOWN_COMMAND 33280
184 #define CDR_EXECFAILED_PERMISSION_DENIED 33281
185 #define CDR_EXECFAILED_TEMPORARILY_OUT_OF_RESSOURCES 33282
186 #define CDR_EXECFAILED_CMD_TOO_SHORT 33283
187 #define CDR_EXECFAILED_CMD_TOO_LONG 33284
188 #define CDR_EXECFAILED_TARGETADDRTYPE_UNKNOWN 33285
189 #define CDR_EXECFAILED_TARGETADDR_DOESNTEXIST 33286
190 #define CDR_EXECFAILED_TARGETADDR_PORTCLOSED 33287
191 #define CDR_EXECFAILED_LISTENERQUEUE_FULL 33288
194 * must be sent after CDR_EXEC{OK|FAILED}
195 * CDR_EXEOK_BINDATA[2] bindatalen[4] bindata[bindatalen] */
196 #define CDR_BINDATA 32770
199 /* result codes for rcv.c/proc_packet */
201 #define RC_FINISHED 1
203 #define RC_RCV1_ANNOUNCE 2
204 #define RC_RCV1_KERNEL 3
205 #define RC_RCV1_CONN 4
209 struct ref_counter_def
{
211 * implemented by user, frees struct containing the mem_counter when
214 void (*free
)(struct ref_counter
*cnt
);
220 /* initialised with 1 */
223 /* initialised with 1, if 0 deny mem_counter_incr */
226 /* should be a pointer to a global variable */
227 struct ref_counter_def
*def
;
231 /* start of next element, *not* next htab_entry */
236 struct htab_entry
**htable
;
241 int (*matches
)(void *htentry
, void *searcheditem
);
244 __u32 ref_counter_offset
;
248 struct list_head nb_list
;
250 struct ref_counter refs
;
252 struct net_device
*dev
;
253 char mac
[MAX_ADDR_LEN
];
258 struct delayed_work cmsg_timer
;
259 struct mutex cmsg_lock
;
260 struct list_head control_msgs_out
;
263 atomic_t kpacket_seqno
;
265 atomic_t ooo_packets
;
270 * connecions which receive data from/send data to this node
271 * used when terminating all connections of a neighbor
273 struct mutex conn_list_lock
;
274 struct list_head rcv_conn_list
;
275 struct list_head snd_conn_list
;
278 * the timer has to be inited when adding the neighbor
279 * init_timer(struct timer_list * timer);
280 * add_timer(struct timer_list * timer);
282 spinlock_t retrans_lock
;
283 struct timer_list retrans_timer
;
286 * next_retransmit are linked with
287 * skb_procstate->funcstate.retransmit_queue
288 * because the sk_buff next/prev fields are needed by the hashtable
290 struct sk_buff_head retrans_list
;
292 struct conn
*firstboundconn
;
295 struct cor_sched_data
{
297 struct list_head conn_list
;
298 struct sk_buff_head requeue_queue
;
304 struct data_buf_item
{
305 struct list_head buf_list
;
321 struct list_head items
;
322 struct data_buf_item
*lastread
;
327 __u32 read_remaining
;
329 __u32 last_read_offset
;
338 struct connlistener
*owner
;
342 #define SOCKSTATE_LISTENER 1
343 #define SOCKSTATE_CONN 2
346 /* The first member of connlistener/conn (see sock.c) */
350 struct connlistener
{
351 /* The first member has to be the same as in conn (see sock.c) */
357 struct list_head conn_queue
;
358 wait_queue_head_t wait
;
363 * There are 2 conn objects per bi-directional connection. They refer to each
364 * other with in the reversedir field. To distinguish them, the variables on
365 * the stack are usually called rconn and sconn. rconn refers to the conn object
366 * which has received a command. sconn is the other conn object. This means that
367 * in send functions rconn means the connection we want to send the command to.
371 /* The first member has to be the same as in connlistener (see sock.c)*/
374 #define SOURCE_NONE 0
376 #define SOURCE_SOCK 2
378 #define TARGET_UNCONNECTED 0
380 #define TARGET_SOCK 2
386 struct list_head queue_list
;
388 /* todo: convert to kref */
389 struct ref_counter refs
;
391 struct mutex rcv_lock
;
402 /* list of all connections from this neighbor */
403 struct list_head nb_list
;
405 struct sk_buff_head reorder_queue
;
407 struct htab_entry htab_entry
;
414 struct list_head cl_list
;
415 wait_queue_head_t wait
;
430 /* has to be first (because it is first in target
434 /* list of all connections to this neighbor */
435 struct list_head nb_list
;
442 wait_queue_head_t wait
;
448 struct conn
*reversedir
;
452 struct skb_procstate
{
457 struct work_struct work
;
470 struct htab_entry htab_entry
;
471 struct ref_counter refs
;
472 unsigned long timeout
;
481 extern void ref_counter_decr(struct ref_counter
*cnt
);
483 extern int ref_counter_incr(struct ref_counter
*cnt
);
485 extern void ref_counter_init(struct ref_counter
*cnt
,
486 struct ref_counter_def
*def
);
488 extern char *htable_get(struct htable
*ht
, __u32 key
, void *searcheditem
);
490 extern int htable_delete(struct htable
*ht
, __u32 key
, void *searcheditem
);
492 extern void htable_insert(struct htable
*ht
, char *newelement
, __u32 key
);
494 extern void htable_init(struct htable
*ht
, int (*matches
)(void *htentry
,
495 void *searcheditem
), __u32 entry_offset
,
496 __u32 ref_counter_offset
);
498 extern struct conn
*get_conn(__u32 conn_id
);
500 extern int conn_init_out(struct conn
*rconn
, struct neighbor
*nb
);
502 extern void conn_init_sock_source(struct conn
*conn
);
503 extern void conn_init_sock_target(struct conn
*conn
);
505 extern void close_port(struct connlistener
*listener
);
507 extern struct connlistener
*open_port(__be64 port
);
509 extern int connect_port(struct conn
*rconn
, __be64 port
);
511 extern int connect_neigh(struct conn
*rconn
,
512 __u16 addrtypelen
, __u8
*addrtype
,
513 __u16 addrlen
, __u8
*addr
);
515 extern struct conn
* alloc_conn(gfp_t allocflags
);
517 extern void reset_conn(struct conn
*conn
);
520 extern struct neighbor
*get_neigh_by_mac(struct sk_buff
*skb
);
522 extern struct neighbor
*find_neigh(__u16 addrtypelen
, __u8
*addrtype
,
523 __u16 addrlen
, __u8
*addr
);
525 extern __u32
generate_neigh_list(char *buf
, __u32 buflen
, __u32 limit
,
528 extern void rcv_announce(struct sk_buff
*skb
);
530 extern int __init
cor_neighbor_init(void);
533 extern void drain_ooo_queue(struct conn
*rconn
);
535 extern void conn_rcv_buildskb(char *data
, __u32 datalen
, __u32 conn_id
,
538 extern int __init
cor_rcv_init(void);
540 /* kpacket_parse.c */
541 extern void kernel_packet(struct neighbor
*nb
, struct sk_buff
*skb
, __u32 seqno
);
544 extern void schedule_controlmsg_timerfunc(struct neighbor
*nb
);
546 struct control_msg_out
;
548 extern struct control_msg_out
*alloc_control_msg(void);
550 extern void free_control_msg(struct control_msg_out
*cm
);
552 extern void send_reset_conn(struct control_msg_out
*cm
, struct neighbor
*nb
,
555 extern void send_ack(struct control_msg_out
*cm
, struct neighbor
*nb
,
556 __u32 conn_id
, __u32 seqno
);
558 extern void send_connect_success(struct control_msg_out
*cm
,
559 struct neighbor
*nb
, __u32 rcvd_conn_id
, __u32 gen_conn_id
);
561 extern void send_connect_nb(struct control_msg_out
*cm
, struct neighbor
*nb
,
564 extern void send_conndata(struct control_msg_out
*cm
, struct neighbor
*nb
,
565 __u32 connid
, __u32 seqno
, char *data_orig
, char *data
,
568 /* cpacket_parse.c */
569 extern void parse(struct conn
*rconn
);
572 extern void retransmit_timerfunc(unsigned long arg
);
574 extern struct sk_buff
*create_packet_conn(struct conn
*target
, int size
,
577 extern struct sk_buff
*create_packet_kernel(struct neighbor
*nb
, int size
,
580 extern void send_conn_flushdata(struct conn
*rconn
, char *data
, __u32 datalen
);
582 extern void send_packet(struct sk_buff
*skb
, struct neighbor
*nb
);
584 extern void ack_received(struct neighbor
*nb
, __u32 conn_id
, __u32 seqno
);
586 extern void flush_out(struct conn
*rconn
);
588 extern int __init
cor_snd_init(void);
591 extern void databuf_pull(struct data_buf
*data
, char *dst
, int len
);
593 extern size_t databuf_pulluser(struct conn
*sconn
, struct msghdr
*msg
);
595 extern void databuf_ack(struct data_buf
*buf
, __u64 pos
);
597 extern void databuf_ackread(struct data_buf
*buf
);
599 extern int databuf_maypush(struct data_buf
*buf
);
601 extern void databuf_free(struct data_buf
*data
);
603 extern void databuf_init(struct data_buf
*data
);
605 extern int receive_userbuf(struct conn
*rconn
, struct msghdr
*msg
);
607 extern void receive_buf(struct conn
*rconn
, char *buf
, int len
);
609 extern int receive_skb(struct conn
*rconn
, struct sk_buff
*skb
);
611 extern void wake_sender(struct conn
*rconn
);
613 extern void forward_init(void);
617 static inline struct skb_procstate
*skb_pstate(struct sk_buff
*skb
)
619 return (struct skb_procstate
*) &(skb
->cb
[0]);
622 static inline struct sk_buff
*skb_from_pstate(struct skb_procstate
*ps
)
624 return (struct sk_buff
*) (((char *)ps
) - offsetof(struct sk_buff
,cb
));
628 static inline __u32
mss(struct neighbor
*nb
)
630 return nb
->dev
->mtu
- LL_RESERVED_SPACE(nb
->dev
) - 9;
634 static inline void put_u64(char *dst
, __u64 value
, int convbo
)
636 char *p_value
= (char *) &value
;
639 value
= cpu_to_be64(value
);
651 static inline void put_u32(char *dst
, __u32 value
, int convbo
)
653 char *p_value
= (char *) &value
;
656 value
= cpu_to_be32(value
);
664 static inline void put_u16(char *dst
, __u16 value
, int convbo
)
666 char *p_value
= (char *) &value
;
669 value
= cpu_to_be16(value
);
675 static inline char *cor_pull_skb(struct sk_buff
*skb
, unsigned int len
)
677 char *ptr
= skb_pull(skb
, len
);