[linux.git] / include / net / af_rxrpc.h

/* RxRPC kernel service interface definitions
 *
 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells ([email protected])
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

#ifndef _NET_RXRPC_H
#define _NET_RXRPC_H

#include <linux/rxrpc.h>
#include <linux/ktime.h>

struct key;
struct sock;
struct socket;
struct rxrpc_call;

/*
 * Call completion condition (state == RXRPC_CALL_COMPLETE).
 */
enum rxrpc_call_completion {
	RXRPC_CALL_SUCCEEDED,		/* - Normal termination */
	RXRPC_CALL_REMOTELY_ABORTED,	/* - call aborted by peer */
	RXRPC_CALL_LOCALLY_ABORTED,	/* - call aborted locally on error or close */
	RXRPC_CALL_LOCAL_ERROR,		/* - call failed due to local error */
	RXRPC_CALL_NETWORK_ERROR,	/* - call terminated by network error */
	NR__RXRPC_CALL_COMPLETIONS
};

/*
 * Debug ID counter for tracing.
 */
extern atomic_t rxrpc_debug_id;

typedef void (*rxrpc_notify_rx_t)(struct sock *, struct rxrpc_call *,
				  unsigned long);
typedef void (*rxrpc_notify_end_tx_t)(struct sock *, struct rxrpc_call *,
				      unsigned long);
typedef void (*rxrpc_notify_new_call_t)(struct sock *, struct rxrpc_call *,
					unsigned long);
typedef void (*rxrpc_discard_new_call_t)(struct rxrpc_call *, unsigned long);
typedef void (*rxrpc_user_attach_call_t)(struct rxrpc_call *, unsigned long);

void rxrpc_kernel_new_call_notification(struct socket *,
					rxrpc_notify_new_call_t,
					rxrpc_discard_new_call_t);
struct rxrpc_call *rxrpc_kernel_begin_call(struct socket *,
					   struct sockaddr_rxrpc *,
					   struct key *,
					   unsigned long,
					   s64,
					   gfp_t,
					   rxrpc_notify_rx_t,
					   bool,
					   unsigned int);
int rxrpc_kernel_send_data(struct socket *, struct rxrpc_call *,
			   struct msghdr *, size_t,
			   rxrpc_notify_end_tx_t);
int rxrpc_kernel_recv_data(struct socket *, struct rxrpc_call *,
			   struct iov_iter *, bool, u32 *, u16 *);
bool rxrpc_kernel_abort_call(struct socket *, struct rxrpc_call *,
			     u32, int, const char *);
void rxrpc_kernel_end_call(struct socket *, struct rxrpc_call *);
void rxrpc_kernel_get_peer(struct socket *, struct rxrpc_call *,
			   struct sockaddr_rxrpc *);
u64 rxrpc_kernel_get_rtt(struct socket *, struct rxrpc_call *);
int rxrpc_kernel_charge_accept(struct socket *, rxrpc_notify_rx_t,
			       rxrpc_user_attach_call_t, unsigned long, gfp_t,
			       unsigned int);
void rxrpc_kernel_set_tx_length(struct socket *, struct rxrpc_call *, s64);
int rxrpc_kernel_retry_call(struct socket *, struct rxrpc_call *,
			    struct sockaddr_rxrpc *, struct key *);
int rxrpc_kernel_check_call(struct socket *, struct rxrpc_call *,
			    enum rxrpc_call_completion *, u32 *);
u32 rxrpc_kernel_check_life(const struct socket *, const struct rxrpc_call *);
void rxrpc_kernel_probe_life(struct socket *, struct rxrpc_call *);
u32 rxrpc_kernel_get_epoch(struct socket *, struct rxrpc_call *);
bool rxrpc_kernel_get_reply_time(struct socket *, struct rxrpc_call *,
				 ktime_t *);

#endif /* _NET_RXRPC_H */
Commit	Line	Data
651350d1	1	/* RxRPC kernel service interface definitions
17926a79	2	*
651350d1	3	* Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
17926a79 DH	4	* Written by David Howells ([email protected])
	5	*
	6	* This program is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU General Public License
	8	* as published by the Free Software Foundation; either version
	9	* 2 of the License, or (at your option) any later version.
	10	*/
	11
	12	#ifndef _NET_RXRPC_H
	13	#define _NET_RXRPC_H
	14
	15	#include <linux/rxrpc.h>
2070a3e4	16	#include <linux/ktime.h>
17926a79	17
4de48af6 DH	18	struct key;
	19	struct sock;
	20	struct socket;
651350d1 DH	21	struct rxrpc_call;
651350d1 DH	22
c038a58c DH	23	/*
	24	* Call completion condition (state == RXRPC_CALL_COMPLETE).
	25	*/
	26	enum rxrpc_call_completion {
	27	RXRPC_CALL_SUCCEEDED, /* - Normal termination */
	28	RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
	29	RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
	30	RXRPC_CALL_LOCAL_ERROR, /* - call failed due to local error */
	31	RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
	32	NR__RXRPC_CALL_COMPLETIONS
	33	};
	34
a25e21f0 DH	35	/*
	36	* Debug ID counter for tracing.
	37	*/
	38	extern atomic_t rxrpc_debug_id;
	39
d001648e DH	40	typedef void (rxrpc_notify_rx_t)(struct sock , struct rxrpc_call *,
d001648e DH	41	unsigned long);
e833251a DH	42	typedef void (rxrpc_notify_end_tx_t)(struct sock , struct rxrpc_call *,
e833251a DH	43	unsigned long);
00e90712 DH	44	typedef void (rxrpc_notify_new_call_t)(struct sock , struct rxrpc_call *,
	45	unsigned long);
	46	typedef void (rxrpc_discard_new_call_t)(struct rxrpc_call , unsigned long);
	47	typedef void (rxrpc_user_attach_call_t)(struct rxrpc_call , unsigned long);
651350d1	48
d001648e	49	void rxrpc_kernel_new_call_notification(struct socket *,
00e90712 DH	50	rxrpc_notify_new_call_t,
00e90712 DH	51	rxrpc_discard_new_call_t);
cd2cf63a JP	52	struct rxrpc_call rxrpc_kernel_begin_call(struct socket ,
	53	struct sockaddr_rxrpc *,
	54	struct key *,
	55	unsigned long,
e754eba6	56	s64,
d001648e	57	gfp_t,
a68f4a27	58	rxrpc_notify_rx_t,
a25e21f0 DH	59	bool,
a25e21f0 DH	60	unsigned int);
4de48af6	61	int rxrpc_kernel_send_data(struct socket , struct rxrpc_call ,
e833251a DH	62	struct msghdr *, size_t,
e833251a DH	63	rxrpc_notify_end_tx_t);
d001648e	64	int rxrpc_kernel_recv_data(struct socket , struct rxrpc_call ,
eb9950eb	65	struct iov_iter , bool, u32 , u16 *);
84a4c09c	66	bool rxrpc_kernel_abort_call(struct socket , struct rxrpc_call ,
5a42976d	67	u32, int, const char *);
4de48af6	68	void rxrpc_kernel_end_call(struct socket , struct rxrpc_call );
8324f0bc DH	69	void rxrpc_kernel_get_peer(struct socket , struct rxrpc_call ,
8324f0bc DH	70	struct sockaddr_rxrpc *);
f4d15fb6	71	u64 rxrpc_kernel_get_rtt(struct socket , struct rxrpc_call );
00e90712	72	int rxrpc_kernel_charge_accept(struct socket *, rxrpc_notify_rx_t,
a25e21f0 DH	73	rxrpc_user_attach_call_t, unsigned long, gfp_t,
a25e21f0 DH	74	unsigned int);
e754eba6	75	void rxrpc_kernel_set_tx_length(struct socket , struct rxrpc_call , s64);
c038a58c DH	76	int rxrpc_kernel_retry_call(struct socket , struct rxrpc_call ,
	77	struct sockaddr_rxrpc , struct key );
	78	int rxrpc_kernel_check_call(struct socket , struct rxrpc_call ,
	79	enum rxrpc_call_completion , u32 );
7150ceaa DH	80	u32 rxrpc_kernel_check_life(const struct socket , const struct rxrpc_call );
7150ceaa DH	81	void rxrpc_kernel_probe_life(struct socket , struct rxrpc_call );
e908bcf4	82	u32 rxrpc_kernel_get_epoch(struct socket , struct rxrpc_call );
2070a3e4 DH	83	bool rxrpc_kernel_get_reply_time(struct socket , struct rxrpc_call ,
2070a3e4 DH	84	ktime_t *);
651350d1	85
17926a79	86	#endif /* _NET_RXRPC_H */