[mirror_ubuntu-jammy-kernel.git] / net / tipc / socket.h

/* net/tipc/socket.h: Include file for TIPC socket code
 *
 * Copyright (c) 2014-2016, Ericsson AB
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the names of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _TIPC_SOCK_H
#define _TIPC_SOCK_H

#include <net/sock.h>
#include <net/genetlink.h>

/* Compatibility values for deprecated message based flow control */
#define FLOWCTL_MSG_WIN 512
#define FLOWCTL_MSG_LIM ((FLOWCTL_MSG_WIN * 2 + 1) * SKB_TRUESIZE(MAX_MSG_SIZE))

#define FLOWCTL_BLK_SZ 1024

/* Socket receive buffer sizes */
#define RCVBUF_MIN  (FLOWCTL_BLK_SZ * 512)
#define RCVBUF_DEF  (FLOWCTL_BLK_SZ * 1024 * 2)
#define RCVBUF_MAX  (FLOWCTL_BLK_SZ * 1024 * 16)

struct tipc_sock;

int tipc_socket_init(void);
void tipc_socket_stop(void);
void tipc_sk_rcv(struct net *net, struct sk_buff_head *inputq);
void tipc_sk_mcast_rcv(struct net *net, struct sk_buff_head *arrvq,
		       struct sk_buff_head *inputq);
void tipc_sk_reinit(struct net *net);
int tipc_sk_rht_init(struct net *net);
void tipc_sk_rht_destroy(struct net *net);
int tipc_nl_sk_dump(struct sk_buff *skb, struct netlink_callback *cb);
int tipc_nl_publ_dump(struct sk_buff *skb, struct netlink_callback *cb);
int tipc_sk_fill_sock_diag(struct sk_buff *skb, struct netlink_callback *cb,
			   struct tipc_sock *tsk, u32 sk_filter_state,
			   u64 (*tipc_diag_gen_cookie)(struct sock *sk));
int tipc_nl_sk_walk(struct sk_buff *skb, struct netlink_callback *cb,
		    int (*skb_handler)(struct sk_buff *skb,
				       struct netlink_callback *cb,
				       struct tipc_sock *tsk));
int tipc_dump_start(struct netlink_callback *cb);
int __tipc_dump_start(struct netlink_callback *cb, struct net *net);
int tipc_dump_done(struct netlink_callback *cb);
u32 tipc_sock_get_portid(struct sock *sk);
bool tipc_sk_overlimit1(struct sock *sk, struct sk_buff *skb);
bool tipc_sk_overlimit2(struct sock *sk, struct sk_buff *skb);
int tipc_sk_bind(struct socket *sock, struct sockaddr *skaddr, int alen);
int tsk_set_importance(struct sock *sk, int imp);

#endif
Commit	Line	Data
8826cde6 JPM	1	/* net/tipc/socket.h: Include file for TIPC socket code
8826cde6 JPM	2	*
10724cc7	3	* Copyright (c) 2014-2016, Ericsson AB
8826cde6 JPM	4	* All rights reserved.
	5	*
	6	* Redistribution and use in source and binary forms, with or without
	7	* modification, are permitted provided that the following conditions are met:
	8	*
	9	* 1. Redistributions of source code must retain the above copyright
	10	* notice, this list of conditions and the following disclaimer.
	11	* 2. Redistributions in binary form must reproduce the above copyright
	12	* notice, this list of conditions and the following disclaimer in the
	13	* documentation and/or other materials provided with the distribution.
	14	* 3. Neither the names of the copyright holders nor the names of its
	15	* contributors may be used to endorse or promote products derived from
	16	* this software without specific prior written permission.
	17	*
	18	* Alternatively, this software may be distributed under the terms of the
	19	* GNU General Public License ("GPL") version 2 as published by the Free
	20	* Software Foundation.
	21	*
	22	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
	23	* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	24	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	25	* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
	26	* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	27	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	28	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	29	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	30	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	31	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	32	* POSSIBILITY OF SUCH DAMAGE.
	33	*/
	34
	35	#ifndef _TIPC_SOCK_H
	36	#define _TIPC_SOCK_H
	37
8826cde6	38	#include <net/sock.h>
34b78a12	39	#include <net/genetlink.h>
8826cde6	40
10724cc7 JPM	41	/* Compatibility values for deprecated message based flow control */
	42	#define FLOWCTL_MSG_WIN 512
	43	#define FLOWCTL_MSG_LIM ((FLOWCTL_MSG_WIN * 2 + 1) * SKB_TRUESIZE(MAX_MSG_SIZE))
	44
	45	#define FLOWCTL_BLK_SZ 1024
	46
	47	/* Socket receive buffer sizes */
	48	#define RCVBUF_MIN (FLOWCTL_BLK_SZ * 512)
	49	#define RCVBUF_DEF (FLOWCTL_BLK_SZ * 1024 * 2)
	50	#define RCVBUF_MAX (FLOWCTL_BLK_SZ * 1024 * 16)
	51
c30b70de GM	52	struct tipc_sock;
c30b70de GM	53
859fc7c0 YX	54	int tipc_socket_init(void);
859fc7c0 YX	55	void tipc_socket_stop(void);
cda3696d	56	void tipc_sk_rcv(struct net net, struct sk_buff_head inputq);
cb1b7280 JPM	57	void tipc_sk_mcast_rcv(struct net net, struct sk_buff_head arrvq,
cb1b7280 JPM	58	struct sk_buff_head *inputq);
e05b31f4 YX	59	void tipc_sk_reinit(struct net *net);
	60	int tipc_sk_rht_init(struct net *net);
	61	void tipc_sk_rht_destroy(struct net *net);
34b78a12	62	int tipc_nl_sk_dump(struct sk_buff skb, struct netlink_callback cb);
1a1a143d	63	int tipc_nl_publ_dump(struct sk_buff skb, struct netlink_callback cb);
e41f0548 CW	64	int tipc_sk_fill_sock_diag(struct sk_buff skb, struct netlink_callback cb,
e41f0548 CW	65	struct tipc_sock *tsk, u32 sk_filter_state,
c30b70de GM	66	u64 (tipc_diag_gen_cookie)(struct sock sk));
	67	int tipc_nl_sk_walk(struct sk_buff skb, struct netlink_callback cb,
	68	int (skb_handler)(struct sk_buff skb,
	69	struct netlink_callback *cb,
	70	struct tipc_sock *tsk));
9a07efa9	71	int tipc_dump_start(struct netlink_callback *cb);
8f5c5fcf	72	int __tipc_dump_start(struct netlink_callback cb, struct net net);
9a07efa9	73	int tipc_dump_done(struct netlink_callback *cb);
b4b9771b	74	u32 tipc_sock_get_portid(struct sock *sk);
01e661eb TL	75	bool tipc_sk_overlimit1(struct sock sk, struct sk_buff skb);
01e661eb TL	76	bool tipc_sk_overlimit2(struct sock sk, struct sk_buff skb);
72671b35	77	int tipc_sk_bind(struct socket sock, struct sockaddr skaddr, int alen);
095ae612 CH	78	int tsk_set_importance(struct sock *sk, int imp);
095ae612 CH	79
8826cde6	80	#endif