Re: [RFC PATCH v4 08/17] af_vsock: update comments for stream sockets

[Stefano Garzarella]

On Sun, Feb 07, 2021 at 06:16:29PM +0300, Arseny Krasnov wrote:
> This replaces 'stream' to 'connect oriented' in comments as SEQPACKET is
> also connect oriented.

I'm not a native speaker but maybe is better 'connection oriented' or 
looking at socket(2) man page 'connection-based' is also fine.

Thanks,
Stefano

> Signed-off-by: Arseny Krasnov <arseny.krasnov@xxxxxxxxxxxxx>
> ---
> net/vmw_vsock/af_vsock.c | 31 +++++++++++++++++--------------
> 1 file changed, 17 insertions(+), 14 deletions(-)
>
> diff --git a/net/vmw_vsock/af_vsock.c b/net/vmw_vsock/af_vsock.c
> index c77998a14018..6e5e192cb703 100644
> --- a/net/vmw_vsock/af_vsock.c
> +++ b/net/vmw_vsock/af_vsock.c
> @@ -415,8 +415,8 @@ static void vsock_deassign_transport(struct vsock_sock *vsk)
>
> /* Assign a transport to a socket and call the .init transport callback.
>  *
> - * Note: for stream socket this must be called when vsk->remote_addr is set
> - * (e.g. during the connect() or when a connection request on a listener
> + * Note: for connect oriented socket this must be called when vsk->remote_addr
> + * is set (e.g. during the connect() or when a connection request on a listener
>  * socket is received).
>  * The vsk->remote_addr is used to decide which transport to use:
>  *  - remote CID == VMADDR_CID_LOCAL or g2h->local_cid or VMADDR_CID_HOST if
> @@ -479,10 +479,10 @@ int vsock_assign_transport(struct vsock_sock *vsk, struct vsock_sock *psk)
> 			return 0;
>
> 		/* transport->release() must be called with sock lock acquired.
> -		 * This path can only be taken during vsock_stream_connect(),
> -		 * where we have already held the sock lock.
> -		 * In the other cases, this function is called on a new socket
> -		 * which is not assigned to any transport.
> +		 * This path can only be taken during vsock_connect(), where we
> +		 * have already held the sock lock. In the other cases, this
> +		 * function is called on a new socket which is not assigned to
> +		 * any transport.
> 		 */
> 		vsk->transport->release(vsk);
> 		vsock_deassign_transport(vsk);
> @@ -659,9 +659,10 @@ static int __vsock_bind_connectible(struct vsock_sock *vsk,
>
> 	vsock_addr_init(&vsk->local_addr, new_addr.svm_cid, new_addr.svm_port);
>
> -	/* Remove stream sockets from the unbound list and add them to the hash
> -	 * table for easy lookup by its address.  The unbound list is simply an
> -	 * extra entry at the end of the hash table, a trick used by AF_UNIX.
> +	/* Remove connect oriented sockets from the unbound list and add them
> +	 * to the hash table for easy lookup by its address.  The unbound list
> +	 * is simply an extra entry at the end of the hash table, a trick used
> +	 * by AF_UNIX.
> 	 */
> 	__vsock_remove_bound(vsk);
> 	__vsock_insert_bound(vsock_bound_sockets(&vsk->local_addr), vsk);
> @@ -952,10 +953,10 @@ static int vsock_shutdown(struct socket *sock, int mode)
> 	if ((mode & ~SHUTDOWN_MASK) || !mode)
> 		return -EINVAL;
>
> -	/* If this is a STREAM socket and it is not connected then bail out
> -	 * immediately.  If it is a DGRAM socket then we must first kick the
> -	 * socket so that it wakes up from any sleeping calls, for example
> -	 * recv(), and then afterwards return the error.
> +	/* If this is a connect oriented socket and it is not connected then
> +	 * bail out immediately.  If it is a DGRAM socket then we must first
> +	 * kick the socket so that it wakes up from any sleeping calls, for
> +	 * example recv(), and then afterwards return the error.
> 	 */
>
> 	sk = sock->sk;
> @@ -1786,7 +1787,9 @@ static int vsock_connectible_sendmsg(struct socket *sock, struct msghdr *msg,
>
> 	transport = vsk->transport;
>
> -	/* Callers should not provide a destination with stream sockets. */
> +	/* Callers should not provide a destination with connect oriented
> +	 * sockets.
> +	 */
> 	if (msg->msg_namelen) {
> 		err = sk->sk_state == TCP_ESTABLISHED ? -EISCONN : -EOPNOTSUPP;
> 		goto out;
> --
> 2.25.1