2 * net/tipc/msg.c: TIPC message header routines
4 * Copyright (c) 2000-2006, 2014-2015, Ericsson AB
5 * Copyright (c) 2005, 2010-2011, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the names of the copyright holders nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
20 * Alternatively, this software may be distributed under the terms of the
21 * GNU General Public License ("GPL") version 2 as published by the Free
22 * Software Foundation.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
41 #include "name_table.h"
43 #define MAX_FORWARD_SIZE 1024
44 #define BUF_HEADROOM (LL_MAX_HEADER + 48)
45 #define BUF_TAILROOM 16
47 static unsigned int align(unsigned int i
)
53 * tipc_buf_acquire - creates a TIPC message buffer
54 * @size: message size (including TIPC header)
56 * Returns a new buffer with data pointers set to the specified size.
58 * NOTE: Headroom is reserved to allow prepending of a data link header.
59 * There may also be unrequested tailroom present at the buffer's end.
61 struct sk_buff
*tipc_buf_acquire(u32 size
, gfp_t gfp
)
64 unsigned int buf_size
= (BUF_HEADROOM
+ size
+ 3) & ~3u;
66 skb
= alloc_skb_fclone(buf_size
, gfp
);
68 skb_reserve(skb
, BUF_HEADROOM
);
75 void tipc_msg_init(u32 own_node
, struct tipc_msg
*m
, u32 user
, u32 type
,
80 msg_set_user(m
, user
);
81 msg_set_hdr_sz(m
, hsize
);
82 msg_set_size(m
, hsize
);
83 msg_set_prevnode(m
, own_node
);
84 msg_set_type(m
, type
);
85 if (hsize
> SHORT_H_SIZE
) {
86 msg_set_orignode(m
, own_node
);
87 msg_set_destnode(m
, dnode
);
91 struct sk_buff
*tipc_msg_create(uint user
, uint type
,
92 uint hdr_sz
, uint data_sz
, u32 dnode
,
93 u32 onode
, u32 dport
, u32 oport
, int errcode
)
98 buf
= tipc_buf_acquire(hdr_sz
+ data_sz
, GFP_ATOMIC
);
103 tipc_msg_init(onode
, msg
, user
, type
, hdr_sz
, dnode
);
104 msg_set_size(msg
, hdr_sz
+ data_sz
);
105 msg_set_origport(msg
, oport
);
106 msg_set_destport(msg
, dport
);
107 msg_set_errcode(msg
, errcode
);
108 if (hdr_sz
> SHORT_H_SIZE
) {
109 msg_set_orignode(msg
, onode
);
110 msg_set_destnode(msg
, dnode
);
115 /* tipc_buf_append(): Append a buffer to the fragment list of another buffer
116 * @*headbuf: in: NULL for first frag, otherwise value returned from prev call
117 * out: set when successful non-complete reassembly, otherwise NULL
118 * @*buf: in: the buffer to append. Always defined
119 * out: head buf after successful complete reassembly, otherwise NULL
120 * Returns 1 when reassembly complete, otherwise 0
122 int tipc_buf_append(struct sk_buff
**headbuf
, struct sk_buff
**buf
)
124 struct sk_buff
*head
= *headbuf
;
125 struct sk_buff
*frag
= *buf
;
126 struct sk_buff
*tail
= NULL
;
127 struct tipc_msg
*msg
;
136 fragid
= msg_type(msg
);
138 skb_pull(frag
, msg_hdr_sz(msg
));
140 if (fragid
== FIRST_FRAGMENT
) {
143 if (unlikely(skb_unclone(frag
, GFP_ATOMIC
)))
145 head
= *headbuf
= frag
;
147 TIPC_SKB_CB(head
)->tail
= NULL
;
148 if (skb_is_nonlinear(head
)) {
149 skb_walk_frags(head
, tail
) {
150 TIPC_SKB_CB(head
)->tail
= tail
;
153 skb_frag_list_init(head
);
161 if (skb_try_coalesce(head
, frag
, &headstolen
, &delta
)) {
162 kfree_skb_partial(frag
, headstolen
);
164 tail
= TIPC_SKB_CB(head
)->tail
;
165 if (!skb_has_frag_list(head
))
166 skb_shinfo(head
)->frag_list
= frag
;
169 head
->truesize
+= frag
->truesize
;
170 head
->data_len
+= frag
->len
;
171 head
->len
+= frag
->len
;
172 TIPC_SKB_CB(head
)->tail
= frag
;
175 if (fragid
== LAST_FRAGMENT
) {
176 TIPC_SKB_CB(head
)->validated
= false;
177 if (unlikely(!tipc_msg_validate(head
)))
180 TIPC_SKB_CB(head
)->tail
= NULL
;
189 *buf
= *headbuf
= NULL
;
193 /* tipc_msg_validate - validate basic format of received message
195 * This routine ensures a TIPC message has an acceptable header, and at least
196 * as much data as the header indicates it should. The routine also ensures
197 * that the entire message header is stored in the main fragment of the message
198 * buffer, to simplify future access to message header fields.
200 * Note: Having extra info present in the message header or data areas is OK.
201 * TIPC will ignore the excess, under the assumption that it is optional info
202 * introduced by a later release of the protocol.
204 bool tipc_msg_validate(struct sk_buff
*skb
)
206 struct tipc_msg
*msg
;
209 if (unlikely(TIPC_SKB_CB(skb
)->validated
))
211 if (unlikely(!pskb_may_pull(skb
, MIN_H_SIZE
)))
214 hsz
= msg_hdr_sz(buf_msg(skb
));
215 if (unlikely(hsz
< MIN_H_SIZE
) || (hsz
> MAX_H_SIZE
))
217 if (unlikely(!pskb_may_pull(skb
, hsz
)))
221 if (unlikely(msg_version(msg
) != TIPC_VERSION
))
225 if (unlikely(msz
< hsz
))
227 if (unlikely((msz
- hsz
) > TIPC_MAX_USER_MSG_SIZE
))
229 if (unlikely(skb
->len
< msz
))
232 TIPC_SKB_CB(skb
)->validated
= true;
237 * tipc_msg_build - create buffer chain containing specified header and data
238 * @mhdr: Message header, to be prepended to data
240 * @dsz: Total length of user data
241 * @pktmax: Max packet size that can be used
242 * @list: Buffer or chain of buffers to be returned to caller
244 * Returns message data size or errno: -ENOMEM, -EFAULT
246 int tipc_msg_build(struct tipc_msg
*mhdr
, struct msghdr
*m
,
247 int offset
, int dsz
, int pktmax
, struct sk_buff_head
*list
)
249 int mhsz
= msg_hdr_sz(mhdr
);
250 int msz
= mhsz
+ dsz
;
255 struct tipc_msg pkthdr
;
260 msg_set_size(mhdr
, msz
);
262 /* No fragmentation needed? */
263 if (likely(msz
<= pktmax
)) {
264 skb
= tipc_buf_acquire(msz
, GFP_KERNEL
);
268 __skb_queue_tail(list
, skb
);
269 skb_copy_to_linear_data(skb
, mhdr
, mhsz
);
270 pktpos
= skb
->data
+ mhsz
;
271 if (copy_from_iter_full(pktpos
, dsz
, &m
->msg_iter
))
277 /* Prepare reusable fragment header */
278 tipc_msg_init(msg_prevnode(mhdr
), &pkthdr
, MSG_FRAGMENTER
,
279 FIRST_FRAGMENT
, INT_H_SIZE
, msg_destnode(mhdr
));
280 msg_set_size(&pkthdr
, pktmax
);
281 msg_set_fragm_no(&pkthdr
, pktno
);
282 msg_set_importance(&pkthdr
, msg_importance(mhdr
));
284 /* Prepare first fragment */
285 skb
= tipc_buf_acquire(pktmax
, GFP_KERNEL
);
289 __skb_queue_tail(list
, skb
);
291 skb_copy_to_linear_data(skb
, &pkthdr
, INT_H_SIZE
);
292 pktpos
+= INT_H_SIZE
;
293 pktrem
-= INT_H_SIZE
;
294 skb_copy_to_linear_data_offset(skb
, INT_H_SIZE
, mhdr
, mhsz
);
302 if (!copy_from_iter_full(pktpos
, pktrem
, &m
->msg_iter
)) {
311 /* Prepare new fragment: */
312 if (drem
< (pktmax
- INT_H_SIZE
))
313 pktsz
= drem
+ INT_H_SIZE
;
316 skb
= tipc_buf_acquire(pktsz
, GFP_KERNEL
);
322 __skb_queue_tail(list
, skb
);
323 msg_set_type(&pkthdr
, FRAGMENT
);
324 msg_set_size(&pkthdr
, pktsz
);
325 msg_set_fragm_no(&pkthdr
, ++pktno
);
326 skb_copy_to_linear_data(skb
, &pkthdr
, INT_H_SIZE
);
327 pktpos
= skb
->data
+ INT_H_SIZE
;
328 pktrem
= pktsz
- INT_H_SIZE
;
331 msg_set_type(buf_msg(skb
), LAST_FRAGMENT
);
334 __skb_queue_purge(list
);
335 __skb_queue_head_init(list
);
340 * tipc_msg_bundle(): Append contents of a buffer to tail of an existing one
341 * @skb: the buffer to append to ("bundle")
342 * @msg: message to be appended
343 * @mtu: max allowable size for the bundle buffer
344 * Consumes buffer if successful
345 * Returns true if bundling could be performed, otherwise false
347 bool tipc_msg_bundle(struct sk_buff
*skb
, struct tipc_msg
*msg
, u32 mtu
)
349 struct tipc_msg
*bmsg
;
351 unsigned int msz
= msg_size(msg
);
353 u32 max
= mtu
- INT_H_SIZE
;
355 if (likely(msg_user(msg
) == MSG_FRAGMENTER
))
360 bsz
= msg_size(bmsg
);
364 if (unlikely(msg_user(msg
) == TUNNEL_PROTOCOL
))
366 if (unlikely(msg_user(msg
) == BCAST_PROTOCOL
))
368 if (unlikely(msg_user(bmsg
) != MSG_BUNDLER
))
370 if (unlikely(skb_tailroom(skb
) < (pad
+ msz
)))
372 if (unlikely(max
< (start
+ msz
)))
374 if ((msg_importance(msg
) < TIPC_SYSTEM_IMPORTANCE
) &&
375 (msg_importance(bmsg
) == TIPC_SYSTEM_IMPORTANCE
))
378 skb_put(skb
, pad
+ msz
);
379 skb_copy_to_linear_data_offset(skb
, start
, msg
, msz
);
380 msg_set_size(bmsg
, start
+ msz
);
381 msg_set_msgcnt(bmsg
, msg_msgcnt(bmsg
) + 1);
386 * tipc_msg_extract(): extract bundled inner packet from buffer
387 * @skb: buffer to be extracted from.
388 * @iskb: extracted inner buffer, to be returned
389 * @pos: position in outer message of msg to be extracted.
390 * Returns position of next msg
391 * Consumes outer buffer when last packet extracted
392 * Returns true when when there is an extracted buffer, otherwise false
394 bool tipc_msg_extract(struct sk_buff
*skb
, struct sk_buff
**iskb
, int *pos
)
396 struct tipc_msg
*msg
;
400 if (unlikely(skb_linearize(skb
)))
404 offset
= msg_hdr_sz(msg
) + *pos
;
405 if (unlikely(offset
> (msg_size(msg
) - MIN_H_SIZE
)))
408 *iskb
= skb_clone(skb
, GFP_ATOMIC
);
409 if (unlikely(!*iskb
))
411 skb_pull(*iskb
, offset
);
412 imsz
= msg_size(buf_msg(*iskb
));
413 skb_trim(*iskb
, imsz
);
414 if (unlikely(!tipc_msg_validate(*iskb
)))
426 * tipc_msg_make_bundle(): Create bundle buf and append message to its tail
427 * @list: the buffer chain, where head is the buffer to replace/append
428 * @skb: buffer to be created, appended to and returned in case of success
429 * @msg: message to be appended
430 * @mtu: max allowable size for the bundle buffer, inclusive header
431 * @dnode: destination node for message. (Not always present in header)
432 * Returns true if success, otherwise false
434 bool tipc_msg_make_bundle(struct sk_buff
**skb
, struct tipc_msg
*msg
,
437 struct sk_buff
*_skb
;
438 struct tipc_msg
*bmsg
;
439 u32 msz
= msg_size(msg
);
440 u32 max
= mtu
- INT_H_SIZE
;
442 if (msg_user(msg
) == MSG_FRAGMENTER
)
444 if (msg_user(msg
) == TUNNEL_PROTOCOL
)
446 if (msg_user(msg
) == BCAST_PROTOCOL
)
451 _skb
= tipc_buf_acquire(max
, GFP_ATOMIC
);
455 skb_trim(_skb
, INT_H_SIZE
);
456 bmsg
= buf_msg(_skb
);
457 tipc_msg_init(msg_prevnode(msg
), bmsg
, MSG_BUNDLER
, 0,
460 msg_set_importance(bmsg
, TIPC_CRITICAL_IMPORTANCE
);
462 msg_set_importance(bmsg
, TIPC_SYSTEM_IMPORTANCE
);
463 msg_set_seqno(bmsg
, msg_seqno(msg
));
464 msg_set_ack(bmsg
, msg_ack(msg
));
465 msg_set_bcast_ack(bmsg
, msg_bcast_ack(msg
));
466 tipc_msg_bundle(_skb
, msg
, mtu
);
472 * tipc_msg_reverse(): swap source and destination addresses and add error code
473 * @own_node: originating node id for reversed message
474 * @skb: buffer containing message to be reversed; may be replaced.
475 * @err: error code to be set in message, if any
476 * Consumes buffer at failure
477 * Returns true if success, otherwise false
479 bool tipc_msg_reverse(u32 own_node
, struct sk_buff
**skb
, int err
)
481 struct sk_buff
*_skb
= *skb
;
482 struct tipc_msg
*hdr
;
483 struct tipc_msg ohdr
;
486 if (skb_linearize(_skb
))
489 dlen
= min_t(uint
, msg_data_sz(hdr
), MAX_FORWARD_SIZE
);
490 if (msg_dest_droppable(hdr
))
492 if (msg_errcode(hdr
))
495 /* Take a copy of original header before altering message */
496 memcpy(&ohdr
, hdr
, msg_hdr_sz(hdr
));
498 /* Never return SHORT header; expand by replacing buffer if necessary */
499 if (msg_short(hdr
)) {
500 *skb
= tipc_buf_acquire(BASIC_H_SIZE
+ dlen
, GFP_ATOMIC
);
503 memcpy((*skb
)->data
+ BASIC_H_SIZE
, msg_data(hdr
), dlen
);
507 memcpy(hdr
, &ohdr
, BASIC_H_SIZE
);
508 msg_set_hdr_sz(hdr
, BASIC_H_SIZE
);
511 if (skb_cloned(_skb
) &&
512 pskb_expand_head(_skb
, BUF_HEADROOM
, BUF_TAILROOM
, GFP_ATOMIC
))
515 /* reassign after skb header modifications */
517 /* Now reverse the concerned fields */
518 msg_set_errcode(hdr
, err
);
519 msg_set_non_seq(hdr
, 0);
520 msg_set_origport(hdr
, msg_destport(&ohdr
));
521 msg_set_destport(hdr
, msg_origport(&ohdr
));
522 msg_set_destnode(hdr
, msg_prevnode(&ohdr
));
523 msg_set_prevnode(hdr
, own_node
);
524 msg_set_orignode(hdr
, own_node
);
525 msg_set_size(hdr
, msg_hdr_sz(hdr
) + dlen
);
526 skb_trim(_skb
, msg_size(hdr
));
536 * tipc_msg_lookup_dest(): try to find new destination for named message
537 * @skb: the buffer containing the message.
538 * @err: error code to be used by caller if lookup fails
539 * Does not consume buffer
540 * Returns true if a destination is found, false otherwise
542 bool tipc_msg_lookup_dest(struct net
*net
, struct sk_buff
*skb
, int *err
)
544 struct tipc_msg
*msg
= buf_msg(skb
);
546 u32 onode
= tipc_own_addr(net
);
548 if (!msg_isdata(msg
))
552 if (msg_errcode(msg
))
554 *err
= TIPC_ERR_NO_NAME
;
555 if (skb_linearize(skb
))
558 if (msg_reroute_cnt(msg
))
560 dnode
= addr_domain(net
, msg_lookup_scope(msg
));
561 dport
= tipc_nametbl_translate(net
, msg_nametype(msg
),
562 msg_nameinst(msg
), &dnode
);
565 msg_incr_reroute_cnt(msg
);
567 msg_set_prevnode(msg
, onode
);
568 msg_set_destnode(msg
, dnode
);
569 msg_set_destport(msg
, dport
);
574 /* tipc_msg_reassemble() - clone a buffer chain of fragments and
575 * reassemble the clones into one message
577 bool tipc_msg_reassemble(struct sk_buff_head
*list
, struct sk_buff_head
*rcvq
)
579 struct sk_buff
*skb
, *_skb
;
580 struct sk_buff
*frag
= NULL
;
581 struct sk_buff
*head
= NULL
;
584 /* Copy header if single buffer */
585 if (skb_queue_len(list
) == 1) {
586 skb
= skb_peek(list
);
587 hdr_len
= skb_headroom(skb
) + msg_hdr_sz(buf_msg(skb
));
588 _skb
= __pskb_copy(skb
, hdr_len
, GFP_ATOMIC
);
591 __skb_queue_tail(rcvq
, _skb
);
595 /* Clone all fragments and reassemble */
596 skb_queue_walk(list
, skb
) {
597 frag
= skb_clone(skb
, GFP_ATOMIC
);
601 if (tipc_buf_append(&head
, &frag
))
606 __skb_queue_tail(rcvq
, frag
);
609 pr_warn("Failed do clone local mcast rcv buffer\n");
614 bool tipc_msg_pskb_copy(u32 dst
, struct sk_buff_head
*msg
,
615 struct sk_buff_head
*cpy
)
617 struct sk_buff
*skb
, *_skb
;
619 skb_queue_walk(msg
, skb
) {
620 _skb
= pskb_copy(skb
, GFP_ATOMIC
);
622 __skb_queue_purge(cpy
);
625 msg_set_destnode(buf_msg(_skb
), dst
);
626 __skb_queue_tail(cpy
, _skb
);
631 /* tipc_skb_queue_sorted(); sort pkt into list according to sequence number
632 * @list: list to be appended to
633 * @seqno: sequence number of buffer to add
634 * @skb: buffer to add
636 void __tipc_skb_queue_sorted(struct sk_buff_head
*list
, u16 seqno
,
639 struct sk_buff
*_skb
, *tmp
;
641 if (skb_queue_empty(list
) || less(seqno
, buf_seqno(skb_peek(list
)))) {
642 __skb_queue_head(list
, skb
);
646 if (more(seqno
, buf_seqno(skb_peek_tail(list
)))) {
647 __skb_queue_tail(list
, skb
);
651 skb_queue_walk_safe(list
, _skb
, tmp
) {
652 if (more(seqno
, buf_seqno(_skb
)))
654 if (seqno
== buf_seqno(_skb
))
656 __skb_queue_before(list
, _skb
, skb
);