mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
synced 2025-01-16 21:35:07 +00:00
net/tipc: fix all function Return: notation
Fix Return: kernel-doc notation in all net/tipc/ source files. Also keep ReST list notation intact for output formatting. Fix a few typos in comments. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Randy Dunlap
Jakub Kicinski
parent
f172f4b81a
commit
637b77fdca
@ -132,7 +132,7 @@ int tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a)
|
||||
* @name: ptr to bearer name string
|
||||
* @name_parts: ptr to area for bearer name components (or NULL if not needed)
|
||||
*
|
||||
* Returns 1 if bearer name is valid, otherwise 0.
|
||||
* Return: 1 if bearer name is valid, otherwise 0.
|
||||
*/
|
||||
static int bearer_name_validate(const char *name,
|
||||
struct tipc_bearer_names *name_parts)
|
||||
|
||||
@ -721,9 +721,9 @@ static void *tipc_aead_mem_alloc(struct crypto_aead *tfm,
|
||||
* @__dnode: TIPC dest node if "known"
|
||||
*
|
||||
* Return:
|
||||
* 0 : if the encryption has completed
|
||||
* -EINPROGRESS/-EBUSY : if a callback will be performed
|
||||
* < 0 : the encryption has failed
|
||||
* * 0 : if the encryption has completed
|
||||
* * -EINPROGRESS/-EBUSY : if a callback will be performed
|
||||
* * < 0 : the encryption has failed
|
||||
*/
|
||||
static int tipc_aead_encrypt(struct tipc_aead *aead, struct sk_buff *skb,
|
||||
struct tipc_bearer *b,
|
||||
@ -877,9 +877,9 @@ static void tipc_aead_encrypt_done(struct crypto_async_request *base, int err)
|
||||
* @b: TIPC bearer where the message has been received
|
||||
*
|
||||
* Return:
|
||||
* 0 : if the decryption has completed
|
||||
* -EINPROGRESS/-EBUSY : if a callback will be performed
|
||||
* < 0 : the decryption has failed
|
||||
* * 0 : if the decryption has completed
|
||||
* * -EINPROGRESS/-EBUSY : if a callback will be performed
|
||||
* * < 0 : the decryption has failed
|
||||
*/
|
||||
static int tipc_aead_decrypt(struct net *net, struct tipc_aead *aead,
|
||||
struct sk_buff *skb, struct tipc_bearer *b)
|
||||
@ -1008,7 +1008,7 @@ static inline int tipc_ehdr_size(struct tipc_ehdr *ehdr)
|
||||
* tipc_ehdr_validate - Validate an encryption message
|
||||
* @skb: the message buffer
|
||||
*
|
||||
* Returns "true" if this is a valid encryption message, otherwise "false"
|
||||
* Return: "true" if this is a valid encryption message, otherwise "false"
|
||||
*/
|
||||
bool tipc_ehdr_validate(struct sk_buff *skb)
|
||||
{
|
||||
@ -1681,12 +1681,12 @@ static inline void tipc_crypto_clone_msg(struct net *net, struct sk_buff *_skb,
|
||||
* Otherwise, the skb is freed!
|
||||
*
|
||||
* Return:
|
||||
* 0 : the encryption has succeeded (or no encryption)
|
||||
* -EINPROGRESS/-EBUSY : the encryption is ongoing, a callback will be made
|
||||
* -ENOKEK : the encryption has failed due to no key
|
||||
* -EKEYREVOKED : the encryption has failed due to key revoked
|
||||
* -ENOMEM : the encryption has failed due to no memory
|
||||
* < 0 : the encryption has failed due to other reasons
|
||||
* * 0 : the encryption has succeeded (or no encryption)
|
||||
* * -EINPROGRESS/-EBUSY : the encryption is ongoing, a callback will be made
|
||||
* * -ENOKEK : the encryption has failed due to no key
|
||||
* * -EKEYREVOKED : the encryption has failed due to key revoked
|
||||
* * -ENOMEM : the encryption has failed due to no memory
|
||||
* * < 0 : the encryption has failed due to other reasons
|
||||
*/
|
||||
int tipc_crypto_xmit(struct net *net, struct sk_buff **skb,
|
||||
struct tipc_bearer *b, struct tipc_media_addr *dst,
|
||||
@ -1806,12 +1806,12 @@ exit:
|
||||
* cluster key(s) can be taken for decryption (- recursive).
|
||||
*
|
||||
* Return:
|
||||
* 0 : the decryption has successfully completed
|
||||
* -EINPROGRESS/-EBUSY : the decryption is ongoing, a callback will be made
|
||||
* -ENOKEY : the decryption has failed due to no key
|
||||
* -EBADMSG : the decryption has failed due to bad message
|
||||
* -ENOMEM : the decryption has failed due to no memory
|
||||
* < 0 : the decryption has failed due to other reasons
|
||||
* * 0 : the decryption has successfully completed
|
||||
* * -EINPROGRESS/-EBUSY : the decryption is ongoing, a callback will be made
|
||||
* * -ENOKEY : the decryption has failed due to no key
|
||||
* * -EBADMSG : the decryption has failed due to bad message
|
||||
* * -ENOMEM : the decryption has failed due to no memory
|
||||
* * < 0 : the decryption has failed due to other reasons
|
||||
*/
|
||||
int tipc_crypto_rcv(struct net *net, struct tipc_crypto *rx,
|
||||
struct sk_buff **skb, struct tipc_bearer *b)
|
||||
|
||||
@ -342,7 +342,7 @@ exit:
|
||||
* @dest: destination address for request messages
|
||||
* @skb: pointer to created frame
|
||||
*
|
||||
* Returns 0 if successful, otherwise -errno.
|
||||
* Return: 0 if successful, otherwise -errno.
|
||||
*/
|
||||
int tipc_disc_create(struct net *net, struct tipc_bearer *b,
|
||||
struct tipc_media_addr *dest, struct sk_buff **skb)
|
||||
|
||||
@ -488,7 +488,7 @@ u32 tipc_link_state(struct tipc_link *l)
|
||||
* @self: local unicast link id
|
||||
* @peer_id: 128-bit ID of peer
|
||||
*
|
||||
* Returns true if link was created, otherwise false
|
||||
* Return: true if link was created, otherwise false
|
||||
*/
|
||||
bool tipc_link_create(struct net *net, char *if_name, int bearer_id,
|
||||
int tolerance, char net_plane, u32 mtu, int priority,
|
||||
@ -567,7 +567,7 @@ bool tipc_link_create(struct net *net, char *if_name, int bearer_id,
|
||||
* @peer_caps: bitmap describing peer node capabilities
|
||||
* @bc_sndlink: the namespace global link used for broadcast sending
|
||||
*
|
||||
* Returns true if link was created, otherwise false
|
||||
* Return: true if link was created, otherwise false
|
||||
*/
|
||||
bool tipc_link_bc_create(struct net *net, u32 ownnode, u32 peer, u8 *peer_id,
|
||||
int mtu, u32 min_win, u32 max_win, u16 peer_caps,
|
||||
@ -822,7 +822,7 @@ static void link_profile_stats(struct tipc_link *l)
|
||||
* tipc_link_too_silent - check if link is "too silent"
|
||||
* @l: tipc link to be checked
|
||||
*
|
||||
* Returns true if the link 'silent_intv_cnt' is about to reach the
|
||||
* Return: true if the link 'silent_intv_cnt' is about to reach the
|
||||
* 'abort_limit' value, otherwise false
|
||||
*/
|
||||
bool tipc_link_too_silent(struct tipc_link *l)
|
||||
@ -1024,8 +1024,8 @@ void tipc_link_reset(struct tipc_link *l)
|
||||
* @xmitq: returned list of packets to be sent by caller
|
||||
*
|
||||
* Consumes the buffer chain.
|
||||
* Returns 0 if success, or errno: -ELINKCONG, -EMSGSIZE or -ENOBUFS
|
||||
* Messages at TIPC_SYSTEM_IMPORTANCE are always accepted
|
||||
* Return: 0 if success, or errno: -ELINKCONG, -EMSGSIZE or -ENOBUFS
|
||||
*/
|
||||
int tipc_link_xmit(struct tipc_link *l, struct sk_buff_head *list,
|
||||
struct sk_buff_head *xmitq)
|
||||
|
||||
@ -60,7 +60,7 @@ static unsigned int align(unsigned int i)
|
||||
* @size: message size (including TIPC header)
|
||||
* @gfp: memory allocation flags
|
||||
*
|
||||
* Returns a new buffer with data pointers set to the specified size.
|
||||
* Return: a new buffer with data pointers set to the specified size.
|
||||
*
|
||||
* NOTE:
|
||||
* Headroom is reserved to allow prepending of a data link header.
|
||||
@ -209,8 +209,9 @@ err:
|
||||
* @m: the data to be appended
|
||||
* @mss: max allowable size of buffer
|
||||
* @dlen: size of data to be appended
|
||||
* @txq: queue to appand to
|
||||
* Returns the number og 1k blocks appended or errno value
|
||||
* @txq: queue to append to
|
||||
*
|
||||
* Return: the number of 1k blocks appended or errno value
|
||||
*/
|
||||
int tipc_msg_append(struct tipc_msg *_hdr, struct msghdr *m, int dlen,
|
||||
int mss, struct sk_buff_head *txq)
|
||||
@ -314,7 +315,7 @@ bool tipc_msg_validate(struct sk_buff **_skb)
|
||||
* @pktmax: max size of a fragment incl. the header
|
||||
* @frags: returned fragment skb list
|
||||
*
|
||||
* Returns 0 if the fragmentation is successful, otherwise: -EINVAL
|
||||
* Return: 0 if the fragmentation is successful, otherwise: -EINVAL
|
||||
* or -ENOMEM
|
||||
*/
|
||||
int tipc_msg_fragment(struct sk_buff *skb, const struct tipc_msg *hdr,
|
||||
@ -377,7 +378,7 @@ error:
|
||||
* Note that the recursive call we are making here is safe, since it can
|
||||
* logically go only one further level down.
|
||||
*
|
||||
* Returns message data size or errno: -ENOMEM, -EFAULT
|
||||
* Return: message data size or errno: -ENOMEM, -EFAULT
|
||||
*/
|
||||
int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m, int offset,
|
||||
int dsz, int pktmax, struct sk_buff_head *list)
|
||||
@ -488,7 +489,7 @@ error:
|
||||
* @msg: message to be appended
|
||||
* @max: max allowable size for the bundle buffer
|
||||
*
|
||||
* Returns "true" if bundling has been performed, otherwise "false"
|
||||
* Return: "true" if bundling has been performed, otherwise "false"
|
||||
*/
|
||||
static bool tipc_msg_bundle(struct sk_buff *bskb, struct tipc_msg *msg,
|
||||
u32 max)
|
||||
@ -585,7 +586,7 @@ bundle:
|
||||
* @pos: position in outer message of msg to be extracted.
|
||||
* Returns position of next msg.
|
||||
* Consumes outer buffer when last packet extracted
|
||||
* Returns true when there is an extracted buffer, otherwise false
|
||||
* Return: true when there is an extracted buffer, otherwise false
|
||||
*/
|
||||
bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos)
|
||||
{
|
||||
@ -629,7 +630,7 @@ none:
|
||||
* @skb: buffer containing message to be reversed; will be consumed
|
||||
* @err: error code to be set in message, if any
|
||||
* Replaces consumed buffer with new one when successful
|
||||
* Returns true if success, otherwise false
|
||||
* Return: true if success, otherwise false
|
||||
*/
|
||||
bool tipc_msg_reverse(u32 own_node, struct sk_buff **skb, int err)
|
||||
{
|
||||
@ -705,7 +706,7 @@ bool tipc_msg_skb_clone(struct sk_buff_head *msg, struct sk_buff_head *cpy)
|
||||
* @skb: the buffer containing the message.
|
||||
* @err: error code to be used by caller if lookup fails
|
||||
* Does not consume buffer
|
||||
* Returns true if a destination is found, false otherwise
|
||||
* Return: true if a destination is found, false otherwise
|
||||
*/
|
||||
bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, int *err)
|
||||
{
|
||||
|
||||
@ -287,7 +287,7 @@ void tipc_publ_notify(struct net *net, struct list_head *nsub_list,
|
||||
* @dtype: name distributor message type
|
||||
*
|
||||
* tipc_nametbl_lock must be held.
|
||||
* Returns the publication item if successful, otherwise NULL.
|
||||
* Return: the publication item if successful, otherwise NULL.
|
||||
*/
|
||||
static bool tipc_update_nametbl(struct net *net, struct distr_item *i,
|
||||
u32 node, u32 dtype)
|
||||
|
||||
@ -1552,7 +1552,7 @@ static void node_lost_contact(struct tipc_node *n,
|
||||
* @linkname: link name output buffer
|
||||
* @len: size of @linkname output buffer
|
||||
*
|
||||
* Returns 0 on success
|
||||
* Return: 0 on success
|
||||
*/
|
||||
int tipc_node_get_linkname(struct net *net, u32 bearer_id, u32 addr,
|
||||
char *linkname, size_t len)
|
||||
@ -1671,7 +1671,7 @@ static void tipc_lxc_xmit(struct net *peer_net, struct sk_buff_head *list)
|
||||
* @dnode: address of destination node
|
||||
* @selector: a number used for deterministic link selection
|
||||
* Consumes the buffer chain.
|
||||
* Returns 0 if success, otherwise: -ELINKCONG,-EHOSTUNREACH,-EMSGSIZE,-ENOBUF
|
||||
* Return: 0 if success, otherwise: -ELINKCONG,-EHOSTUNREACH,-EMSGSIZE,-ENOBUF
|
||||
*/
|
||||
int tipc_node_xmit(struct net *net, struct sk_buff_head *list,
|
||||
u32 dnode, int selector)
|
||||
@ -1908,7 +1908,7 @@ static void tipc_node_bc_rcv(struct net *net, struct sk_buff *skb, int bearer_id
|
||||
* @skb: TIPC packet
|
||||
* @bearer_id: identity of bearer delivering the packet
|
||||
* @xmitq: queue for messages to be xmited on
|
||||
* Returns true if state and msg are ok, otherwise false
|
||||
* Return: true if state and msg are ok, otherwise false
|
||||
*/
|
||||
static bool tipc_node_check_state(struct tipc_node *n, struct sk_buff *skb,
|
||||
int bearer_id, struct sk_buff_head *xmitq)
|
||||
|
||||
@ -458,7 +458,7 @@ static int tipc_sk_sock_err(struct socket *sock, long *timeout)
|
||||
* This routine creates additional data structures used by the TIPC socket,
|
||||
* initializes them, and links them together.
|
||||
*
|
||||
* Returns 0 on success, errno otherwise
|
||||
* Return: 0 on success, errno otherwise
|
||||
*/
|
||||
static int tipc_sk_create(struct net *net, struct socket *sock,
|
||||
int protocol, int kern)
|
||||
@ -623,7 +623,7 @@ static void __tipc_shutdown(struct socket *sock, int error)
|
||||
* are returned or discarded according to the "destination droppable" setting
|
||||
* specified for the message by the sender.
|
||||
*
|
||||
* Returns 0 on success, errno otherwise
|
||||
* Return: 0 on success, errno otherwise
|
||||
*/
|
||||
static int tipc_release(struct socket *sock)
|
||||
{
|
||||
@ -670,7 +670,7 @@ static int tipc_release(struct socket *sock)
|
||||
* a negative scope value unbinds the specified name. Specifying no name
|
||||
* (i.e. a socket address length of 0) unbinds all names from the socket.
|
||||
*
|
||||
* Returns 0 on success, errno otherwise
|
||||
* Return: 0 on success, errno otherwise
|
||||
*
|
||||
* NOTE: This routine doesn't need to take the socket lock since it doesn't
|
||||
* access any non-constant socket information.
|
||||
@ -731,7 +731,7 @@ static int tipc_bind(struct socket *sock, struct sockaddr *skaddr, int alen)
|
||||
* @uaddr: area for returned socket address
|
||||
* @peer: 0 = own ID, 1 = current peer ID, 2 = current/former peer ID
|
||||
*
|
||||
* Returns 0 on success, errno otherwise
|
||||
* Return: 0 on success, errno otherwise
|
||||
*
|
||||
* NOTE: This routine doesn't need to take the socket lock since it only
|
||||
* accesses socket information that is unchanging (or which changes in
|
||||
@ -770,7 +770,7 @@ static int tipc_getname(struct socket *sock, struct sockaddr *uaddr,
|
||||
* @sock: socket for which to calculate the poll bits
|
||||
* @wait: ???
|
||||
*
|
||||
* Returns pollmask value
|
||||
* Return: pollmask value
|
||||
*
|
||||
* COMMENTARY:
|
||||
* It appears that the usual socket locking mechanisms are not useful here
|
||||
@ -832,7 +832,7 @@ static __poll_t tipc_poll(struct file *file, struct socket *sock,
|
||||
* @timeout: timeout to wait for wakeup
|
||||
*
|
||||
* Called from function tipc_sendmsg(), which has done all sanity checks
|
||||
* Returns the number of bytes sent on success, or errno
|
||||
* Return: the number of bytes sent on success, or errno
|
||||
*/
|
||||
static int tipc_sendmcast(struct socket *sock, struct tipc_service_range *seq,
|
||||
struct msghdr *msg, size_t dlen, long timeout)
|
||||
@ -948,7 +948,7 @@ static int tipc_send_group_msg(struct net *net, struct tipc_sock *tsk,
|
||||
* @timeout: timeout to wait for wakeup
|
||||
*
|
||||
* Called from function tipc_sendmsg(), which has done all sanity checks
|
||||
* Returns the number of bytes sent on success, or errno
|
||||
* Return: the number of bytes sent on success, or errno
|
||||
*/
|
||||
static int tipc_send_group_unicast(struct socket *sock, struct msghdr *m,
|
||||
int dlen, long timeout)
|
||||
@ -992,7 +992,7 @@ static int tipc_send_group_unicast(struct socket *sock, struct msghdr *m,
|
||||
* @timeout: timeout to wait for wakeup
|
||||
*
|
||||
* Called from function tipc_sendmsg(), which has done all sanity checks
|
||||
* Returns the number of bytes sent on success, or errno
|
||||
* Return: the number of bytes sent on success, or errno
|
||||
*/
|
||||
static int tipc_send_group_anycast(struct socket *sock, struct msghdr *m,
|
||||
int dlen, long timeout)
|
||||
@ -1077,7 +1077,7 @@ static int tipc_send_group_anycast(struct socket *sock, struct msghdr *m,
|
||||
* @timeout: timeout to wait for wakeup
|
||||
*
|
||||
* Called from function tipc_sendmsg(), which has done all sanity checks
|
||||
* Returns the number of bytes sent on success, or errno
|
||||
* Return: the number of bytes sent on success, or errno
|
||||
*/
|
||||
static int tipc_send_group_bcast(struct socket *sock, struct msghdr *m,
|
||||
int dlen, long timeout)
|
||||
@ -1151,7 +1151,7 @@ static int tipc_send_group_bcast(struct socket *sock, struct msghdr *m,
|
||||
* @timeout: timeout to wait for wakeup
|
||||
*
|
||||
* Called from function tipc_sendmsg(), which has done all sanity checks
|
||||
* Returns the number of bytes sent on success, or errno
|
||||
* Return: the number of bytes sent on success, or errno
|
||||
*/
|
||||
static int tipc_send_group_mcast(struct socket *sock, struct msghdr *m,
|
||||
int dlen, long timeout)
|
||||
@ -1397,7 +1397,7 @@ exit:
|
||||
* and for 'SYN' messages on SOCK_SEQPACKET and SOCK_STREAM connections.
|
||||
* (Note: 'SYN+' is prohibited on SOCK_STREAM.)
|
||||
*
|
||||
* Returns the number of bytes sent on success, or errno otherwise
|
||||
* Return: the number of bytes sent on success, or errno otherwise
|
||||
*/
|
||||
static int tipc_sendmsg(struct socket *sock,
|
||||
struct msghdr *m, size_t dsz)
|
||||
@ -1542,7 +1542,7 @@ static int __tipc_sendmsg(struct socket *sock, struct msghdr *m, size_t dlen)
|
||||
*
|
||||
* Used for SOCK_STREAM data.
|
||||
*
|
||||
* Returns the number of bytes sent on success (or partial success),
|
||||
* Return: the number of bytes sent on success (or partial success),
|
||||
* or errno if no data sent
|
||||
*/
|
||||
static int tipc_sendstream(struct socket *sock, struct msghdr *m, size_t dsz)
|
||||
@ -1650,7 +1650,7 @@ static int __tipc_sendstream(struct socket *sock, struct msghdr *m, size_t dlen)
|
||||
*
|
||||
* Used for SOCK_SEQPACKET messages.
|
||||
*
|
||||
* Returns the number of bytes sent on success, or errno otherwise
|
||||
* Return: the number of bytes sent on success, or errno otherwise
|
||||
*/
|
||||
static int tipc_send_packet(struct socket *sock, struct msghdr *m, size_t dsz)
|
||||
{
|
||||
@ -1735,7 +1735,7 @@ static void tipc_sk_set_orig_addr(struct msghdr *m, struct sk_buff *skb)
|
||||
*
|
||||
* Note: Ancillary data is not captured if not requested by receiver.
|
||||
*
|
||||
* Returns 0 if successful, otherwise errno
|
||||
* Return: 0 if successful, otherwise errno
|
||||
*/
|
||||
static int tipc_sk_anc_data_recv(struct msghdr *m, struct sk_buff *skb,
|
||||
struct tipc_sock *tsk)
|
||||
@ -1893,7 +1893,7 @@ static int tipc_wait_for_rcvmsg(struct socket *sock, long *timeop)
|
||||
* Used for SOCK_DGRAM, SOCK_RDM, and SOCK_SEQPACKET messages.
|
||||
* If the complete message doesn't fit in user area, truncate it.
|
||||
*
|
||||
* Returns size of returned message data, errno otherwise
|
||||
* Return: size of returned message data, errno otherwise
|
||||
*/
|
||||
static int tipc_recvmsg(struct socket *sock, struct msghdr *m,
|
||||
size_t buflen, int flags)
|
||||
@ -2002,7 +2002,7 @@ exit:
|
||||
* Used for SOCK_STREAM messages only. If not enough data is available
|
||||
* will optionally wait for more; never truncates data.
|
||||
*
|
||||
* Returns size of returned message data, errno otherwise
|
||||
* Return: size of returned message data, errno otherwise
|
||||
*/
|
||||
static int tipc_recvstream(struct socket *sock, struct msghdr *m,
|
||||
size_t buflen, int flags)
|
||||
@ -2180,7 +2180,7 @@ static void tipc_sk_proto_rcv(struct sock *sk,
|
||||
* @tsk: TIPC socket
|
||||
* @skb: pointer to message buffer.
|
||||
* @xmitq: for Nagle ACK if any
|
||||
* Returns true if message should be added to receive queue, false otherwise
|
||||
* Return: true if message should be added to receive queue, false otherwise
|
||||
*/
|
||||
static bool tipc_sk_filter_connect(struct tipc_sock *tsk, struct sk_buff *skb,
|
||||
struct sk_buff_head *xmitq)
|
||||
@ -2294,7 +2294,7 @@ static bool tipc_sk_filter_connect(struct tipc_sock *tsk, struct sk_buff *skb,
|
||||
* TIPC_HIGH_IMPORTANCE (8 MB)
|
||||
* TIPC_CRITICAL_IMPORTANCE (16 MB)
|
||||
*
|
||||
* Returns overload limit according to corresponding message importance
|
||||
* Return: overload limit according to corresponding message importance
|
||||
*/
|
||||
static unsigned int rcvbuf_limit(struct sock *sk, struct sk_buff *skb)
|
||||
{
|
||||
@ -2323,7 +2323,6 @@ static unsigned int rcvbuf_limit(struct sock *sk, struct sk_buff *skb)
|
||||
* disconnect indication for a connected socket.
|
||||
*
|
||||
* Called with socket lock already taken
|
||||
*
|
||||
*/
|
||||
static void tipc_sk_filter_rcv(struct sock *sk, struct sk_buff *skb,
|
||||
struct sk_buff_head *xmitq)
|
||||
@ -2559,7 +2558,7 @@ static bool tipc_sockaddr_is_sane(struct sockaddr_tipc *addr)
|
||||
* @destlen: size of socket address data structure
|
||||
* @flags: file-related flags associated with socket
|
||||
*
|
||||
* Returns 0 on success, errno otherwise
|
||||
* Return: 0 on success, errno otherwise
|
||||
*/
|
||||
static int tipc_connect(struct socket *sock, struct sockaddr *dest,
|
||||
int destlen, int flags)
|
||||
@ -2652,7 +2651,7 @@ exit:
|
||||
* @sock: socket structure
|
||||
* @len: (unused)
|
||||
*
|
||||
* Returns 0 on success, errno otherwise
|
||||
* Return: 0 on success, errno otherwise
|
||||
*/
|
||||
static int tipc_listen(struct socket *sock, int len)
|
||||
{
|
||||
@ -2706,7 +2705,7 @@ static int tipc_wait_for_accept(struct socket *sock, long timeo)
|
||||
* @flags: file-related flags associated with socket
|
||||
* @kern: caused by kernel or by userspace?
|
||||
*
|
||||
* Returns 0 on success, errno otherwise
|
||||
* Return: 0 on success, errno otherwise
|
||||
*/
|
||||
static int tipc_accept(struct socket *sock, struct socket *new_sock, int flags,
|
||||
bool kern)
|
||||
@ -2785,7 +2784,7 @@ exit:
|
||||
*
|
||||
* Terminates connection (if necessary), then purges socket's receive queue.
|
||||
*
|
||||
* Returns 0 on success, errno otherwise
|
||||
* Return: 0 on success, errno otherwise
|
||||
*/
|
||||
static int tipc_shutdown(struct socket *sock, int how)
|
||||
{
|
||||
@ -3128,7 +3127,7 @@ static int tipc_sk_leave(struct tipc_sock *tsk)
|
||||
* For stream sockets only, accepts and ignores all IPPROTO_TCP options
|
||||
* (to ease compatibility).
|
||||
*
|
||||
* Returns 0 on success, errno otherwise
|
||||
* Return: 0 on success, errno otherwise
|
||||
*/
|
||||
static int tipc_setsockopt(struct socket *sock, int lvl, int opt,
|
||||
sockptr_t ov, unsigned int ol)
|
||||
@ -3222,7 +3221,7 @@ static int tipc_setsockopt(struct socket *sock, int lvl, int opt,
|
||||
* For stream sockets only, returns 0 length result for all IPPROTO_TCP options
|
||||
* (to ease compatibility).
|
||||
*
|
||||
* Returns 0 on success, errno otherwise
|
||||
* Return: 0 on success, errno otherwise
|
||||
*/
|
||||
static int tipc_getsockopt(struct socket *sock, int lvl, int opt,
|
||||
char __user *ov, int __user *ol)
|
||||
@ -3426,7 +3425,7 @@ static struct proto tipc_proto = {
|
||||
/**
|
||||
* tipc_socket_init - initialize TIPC socket interface
|
||||
*
|
||||
* Returns 0 on success, errno otherwise
|
||||
* Return: 0 on success, errno otherwise
|
||||
*/
|
||||
int tipc_socket_init(void)
|
||||
{
|
||||
@ -3829,7 +3828,7 @@ int tipc_nl_publ_dump(struct sk_buff *skb, struct netlink_callback *cb)
|
||||
* @sysctl_tipc_sk_filter is used as the socket tuple for filtering:
|
||||
* (portid, sock type, name type, name lower, name upper)
|
||||
*
|
||||
* Returns true if the socket meets the socket tuple data
|
||||
* Return: true if the socket meets the socket tuple data
|
||||
* (value 0 = 'any') or when there is no tuple set (all = 0),
|
||||
* otherwise false
|
||||
*/
|
||||
@ -3894,7 +3893,7 @@ u32 tipc_sock_get_portid(struct sock *sk)
|
||||
* @sk: tipc sk to be checked
|
||||
* @skb: tipc msg to be checked
|
||||
*
|
||||
* Returns true if the socket rx queue allocation is > 90%, otherwise false
|
||||
* Return: true if the socket rx queue allocation is > 90%, otherwise false
|
||||
*/
|
||||
|
||||
bool tipc_sk_overlimit1(struct sock *sk, struct sk_buff *skb)
|
||||
@ -3912,7 +3911,7 @@ bool tipc_sk_overlimit1(struct sock *sk, struct sk_buff *skb)
|
||||
* @sk: tipc sk to be checked
|
||||
* @skb: tipc msg to be checked
|
||||
*
|
||||
* Returns true if the socket rx queue allocation is > 90%, otherwise false
|
||||
* Return: true if the socket rx queue allocation is > 90%, otherwise false
|
||||
*/
|
||||
|
||||
bool tipc_sk_overlimit2(struct sock *sk, struct sk_buff *skb)
|
||||
|
||||
@ -61,7 +61,7 @@ static void tipc_sub_send_event(struct tipc_subscription *sub,
|
||||
* @found_lower: lower value to test
|
||||
* @found_upper: upper value to test
|
||||
*
|
||||
* Returns 1 if there is overlap, otherwise 0.
|
||||
* Return: 1 if there is overlap, otherwise 0.
|
||||
*/
|
||||
int tipc_sub_check_overlap(struct tipc_service_range *seq, u32 found_lower,
|
||||
u32 found_upper)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user