Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 22 Jul 2016 03:30:00 +0000 (UTC)
From:      Sepherosa Ziehau <sephe@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org
Subject:   svn commit: r303178 - head/sys/dev/hyperv/vmbus
Message-ID:  <201607220330.u6M3U0PO082619@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: sephe
Date: Fri Jul 22 03:30:00 2016
New Revision: 303178
URL: https://svnweb.freebsd.org/changeset/base/303178

Log:
  hyperv/vmbus: Cosmetic bufring cleanup.
  
  MFC after:	1 week
  Sponsored by:	Microsoft OSTC
  Differential Revision:	https://reviews.freebsd.org/D7267

Modified:
  head/sys/dev/hyperv/vmbus/hv_ring_buffer.c

Modified: head/sys/dev/hyperv/vmbus/hv_ring_buffer.c
==============================================================================
--- head/sys/dev/hyperv/vmbus/hv_ring_buffer.c	Fri Jul 22 03:26:01 2016	(r303177)
+++ head/sys/dev/hyperv/vmbus/hv_ring_buffer.c	Fri Jul 22 03:30:00 2016	(r303178)
@@ -26,7 +26,6 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-
 #include <sys/param.h>
 #include <sys/lock.h>
 #include <sys/mutex.h>
@@ -35,8 +34,14 @@
 #include "hv_vmbus_priv.h"
 
 /* Amount of space to write to */
-#define	HV_BYTES_AVAIL_TO_WRITE(r, w, z) ((w) >= (r))? \
-				((z) - ((w) - (r))):((r) - (w))
+#define	HV_BYTES_AVAIL_TO_WRITE(r, w, z)	\
+	((w) >= (r)) ? ((z) - ((w) - (r))) : ((r) - (w))
+
+static uint32_t	copy_to_ring_buffer(hv_vmbus_ring_buffer_info *ring_info,
+		    uint32_t start_write_offset, const uint8_t *src,
+		    uint32_t src_len);
+static uint32_t copy_from_ring_buffer(hv_vmbus_ring_buffer_info *ring_info,
+		    char *dest, uint32_t dest_len, uint32_t start_read_offset);
 
 static int
 hv_rbi_sysctl_stats(SYSCTL_HANDLER_ARGS)
@@ -54,40 +59,30 @@ hv_rbi_sysctl_stats(SYSCTL_HANDLER_ARGS)
 	write_avail = HV_BYTES_AVAIL_TO_WRITE(read_index,
 			write_index, sz);
 	read_avail = sz - write_avail;
-	snprintf(rbi_stats, sizeof(rbi_stats),
-		"r_idx:%d "
-		"w_idx:%d "
-		"int_mask:%d "
-		"r_avail:%d "
-		"w_avail:%d",
-		read_index, write_index, interrupt_mask,
-		read_avail, write_avail);
 
-	return (sysctl_handle_string(oidp, rbi_stats,
-			sizeof(rbi_stats), req));
+	snprintf(rbi_stats, sizeof(rbi_stats),
+	    "r_idx:%d w_idx:%d int_mask:%d r_avail:%d w_avail:%d",
+	    read_index, write_index, interrupt_mask, read_avail, write_avail);
+	return sysctl_handle_string(oidp, rbi_stats, sizeof(rbi_stats), req);
 }
 
 void
-hv_ring_buffer_stat(
-	struct sysctl_ctx_list		*ctx,
-	struct sysctl_oid_list		*tree_node,
-	hv_vmbus_ring_buffer_info	*rbi,
-	const char			*desc)	
+hv_ring_buffer_stat(struct sysctl_ctx_list *ctx,
+    struct sysctl_oid_list *tree_node, hv_vmbus_ring_buffer_info *rbi,
+    const char *desc)
 {
 	SYSCTL_ADD_PROC(ctx, tree_node, OID_AUTO,
-	    "ring_buffer_stats",
-	    CTLTYPE_STRING|CTLFLAG_RD|CTLFLAG_MPSAFE, rbi, 0,
-	    hv_rbi_sysctl_stats, "A", desc);
+	    "ring_buffer_stats", CTLTYPE_STRING|CTLFLAG_RD|CTLFLAG_MPSAFE,
+	    rbi, 0, hv_rbi_sysctl_stats, "A", desc);
 }
+
 /**
  * @brief Get number of bytes available to read and to write to
  * for the specified ring buffer
  */
-static inline void
-get_ring_buffer_avail_bytes(
-	    hv_vmbus_ring_buffer_info*	rbi,
-	    uint32_t*			read,
-	    uint32_t*			write)
+static __inline void
+get_ring_buffer_avail_bytes(hv_vmbus_ring_buffer_info *rbi, uint32_t *read,
+    uint32_t *write)
 {
 	uint32_t read_loc, write_loc;
 
@@ -97,28 +92,26 @@ get_ring_buffer_avail_bytes(
 	read_loc = rbi->ring_buffer->read_index;
 	write_loc = rbi->ring_buffer->write_index;
 
-	*write = HV_BYTES_AVAIL_TO_WRITE(
-		read_loc, write_loc, rbi->ring_data_size);
+	*write = HV_BYTES_AVAIL_TO_WRITE(read_loc, write_loc,
+	    rbi->ring_data_size);
 	*read = rbi->ring_data_size - *write;
 }
 
 /**
  * @brief Get the next write location for the specified ring buffer
  */
-static inline uint32_t
-get_next_write_location(hv_vmbus_ring_buffer_info* ring_info) 
+static __inline uint32_t
+get_next_write_location(hv_vmbus_ring_buffer_info *ring_info)
 {
-	uint32_t next = ring_info->ring_buffer->write_index;
-	return (next);
+	return ring_info->ring_buffer->write_index;
 }
 
 /**
  * @brief Set the next write location for the specified ring buffer
  */
-static inline void
-set_next_write_location(
-	hv_vmbus_ring_buffer_info*	ring_info,
-	uint32_t			next_write_location)
+static __inline void
+set_next_write_location(hv_vmbus_ring_buffer_info *ring_info,
+    uint32_t next_write_location)
 {
 	ring_info->ring_buffer->write_index = next_write_location;
 }
@@ -126,23 +119,22 @@ set_next_write_location(
 /**
  * @brief Get the next read location for the specified ring buffer
  */
-static inline uint32_t
-get_next_read_location(hv_vmbus_ring_buffer_info* ring_info) 
+static __inline uint32_t
+get_next_read_location(hv_vmbus_ring_buffer_info *ring_info)
 {
-	uint32_t next = ring_info->ring_buffer->read_index;
-	return (next);
+	return ring_info->ring_buffer->read_index;
 }
 
 /**
  * @brief Get the next read location + offset for the specified ring buffer.
  * This allows the caller to skip.
  */
-static inline uint32_t
-get_next_read_location_with_offset(
-	hv_vmbus_ring_buffer_info*	ring_info,
-	uint32_t			offset)
+static __inline uint32_t
+get_next_read_location_with_offset(hv_vmbus_ring_buffer_info *ring_info,
+    uint32_t offset)
 {
 	uint32_t next = ring_info->ring_buffer->read_index;
+
 	next += offset;
 	next %= ring_info->ring_data_size;
 	return (next);
@@ -151,10 +143,9 @@ get_next_read_location_with_offset(
 /**
  * @brief Set the next read location for the specified ring buffer
  */
-static inline void
-set_next_read_location(
-	hv_vmbus_ring_buffer_info*	ring_info,
-	uint32_t			next_read_location)
+static __inline void
+set_next_read_location(hv_vmbus_ring_buffer_info *ring_info,
+    uint32_t next_read_location)
 {
 	ring_info->ring_buffer->read_index = next_read_location;
 }
@@ -162,17 +153,17 @@ set_next_read_location(
 /**
  * @brief Get the start of the ring buffer
  */
-static inline void *
-get_ring_buffer(hv_vmbus_ring_buffer_info* ring_info) 
+static __inline void *
+get_ring_buffer(hv_vmbus_ring_buffer_info *ring_info)
 {
-	return (void *) ring_info->ring_buffer->buffer;
+	return ring_info->ring_buffer->buffer;
 }
 
 /**
  * @brief Get the size of the ring buffer.
  */
-static inline uint32_t
-get_ring_buffer_size(hv_vmbus_ring_buffer_info* ring_info) 
+static __inline uint32_t
+get_ring_buffer_size(hv_vmbus_ring_buffer_info *ring_info)
 {
 	return ring_info->ring_data_size;
 }
@@ -180,25 +171,23 @@ get_ring_buffer_size(hv_vmbus_ring_buffe
 /**
  * Get the read and write indices as uint64_t of the specified ring buffer.
  */
-static inline uint64_t
-get_ring_buffer_indices(hv_vmbus_ring_buffer_info* ring_info) 
+static __inline uint64_t
+get_ring_buffer_indices(hv_vmbus_ring_buffer_info *ring_info)
 {
-	return (uint64_t) ring_info->ring_buffer->write_index << 32;
+	return ((uint64_t)ring_info->ring_buffer->write_index) << 32;
 }
 
 void
-hv_ring_buffer_read_begin(
-	hv_vmbus_ring_buffer_info*	ring_info)
+hv_ring_buffer_read_begin(hv_vmbus_ring_buffer_info *ring_info)
 {
 	ring_info->ring_buffer->interrupt_mask = 1;
 	mb();
 }
 
 uint32_t
-hv_ring_buffer_read_end(
-	hv_vmbus_ring_buffer_info*	ring_info)
+hv_ring_buffer_read_end(hv_vmbus_ring_buffer_info *ring_info)
 {
-	uint32_t read, write;	
+	uint32_t read, write;
 
 	ring_info->ring_buffer->interrupt_mask = 0;
 	mb();
@@ -209,7 +198,6 @@ hv_ring_buffer_read_end(
 	 * incoming messages.
 	 */
 	get_ring_buffer_avail_bytes(ring_info, &read, &write);
-
 	return (read);
 }
 
@@ -229,9 +217,8 @@ hv_ring_buffer_read_end(
  *	   arrived.
  */
 static boolean_t
-hv_ring_buffer_needsig_on_write(
-	uint32_t			old_write_location,
-	hv_vmbus_ring_buffer_info*	rbi)
+hv_ring_buffer_needsig_on_write(uint32_t old_write_location,
+    hv_vmbus_ring_buffer_info *rbi)
 {
 	mb();
 	if (rbi->ring_buffer->interrupt_mask)
@@ -249,35 +236,20 @@ hv_ring_buffer_needsig_on_write(
 	return (FALSE);
 }
 
-static uint32_t	copy_to_ring_buffer(
-			hv_vmbus_ring_buffer_info*	ring_info,
-			uint32_t			start_write_offset,
-			const uint8_t			*src,
-			uint32_t			src_len);
-
-static uint32_t copy_from_ring_buffer(
-			hv_vmbus_ring_buffer_info*	ring_info,
-			char*				dest,
-			uint32_t			dest_len,
-			uint32_t			start_read_offset);
-
 /**
  * @brief Initialize the ring buffer.
  */
 int
-hv_vmbus_ring_buffer_init(
-	hv_vmbus_ring_buffer_info*	ring_info,
-	void*				buffer,
-	uint32_t			buffer_len)
+hv_vmbus_ring_buffer_init(hv_vmbus_ring_buffer_info *ring_info, void *buffer,
+    uint32_t buffer_len)
 {
 	memset(ring_info, 0, sizeof(hv_vmbus_ring_buffer_info));
 
-	ring_info->ring_buffer = (hv_vmbus_ring_buffer*) buffer;
-	ring_info->ring_buffer->read_index =
-	    ring_info->ring_buffer->write_index = 0;
+	ring_info->ring_buffer = buffer;
+	ring_info->ring_buffer->read_index = 0;
+	ring_info->ring_buffer->write_index = 0;
 
 	ring_info->ring_data_size = buffer_len - sizeof(hv_vmbus_ring_buffer);
-
 	mtx_init(&ring_info->ring_lock, "vmbus ring buffer", NULL, MTX_SPIN);
 
 	return (0);
@@ -286,7 +258,8 @@ hv_vmbus_ring_buffer_init(
 /**
  * @brief Cleanup the ring buffer.
  */
-void hv_ring_buffer_cleanup(hv_vmbus_ring_buffer_info* ring_info) 
+void
+hv_ring_buffer_cleanup(hv_vmbus_ring_buffer_info *ring_info) 
 {
 	mtx_destroy(&ring_info->ring_lock);
 }
@@ -295,24 +268,19 @@ void hv_ring_buffer_cleanup(hv_vmbus_rin
  * @brief Write to the ring buffer.
  */
 int
-hv_ring_buffer_write(
-	hv_vmbus_ring_buffer_info*	out_ring_info,
-	const struct iovec		iov[],
-	uint32_t			iovlen,
-	boolean_t			*need_sig)
+hv_ring_buffer_write(hv_vmbus_ring_buffer_info *out_ring_info,
+    const struct iovec iov[], uint32_t iovlen, boolean_t *need_sig)
 {
 	int i = 0;
 	uint32_t byte_avail_to_write;
 	uint32_t byte_avail_to_read;
 	uint32_t old_write_location;
 	uint32_t total_bytes_to_write = 0;
-
 	volatile uint32_t next_write_location;
 	uint64_t prev_indices = 0;
 
-	for (i = 0; i < iovlen; i++) {
-	    total_bytes_to_write += iov[i].iov_len;
-	}
+	for (i = 0; i < iovlen; i++)
+		total_bytes_to_write += iov[i].iov_len;
 
 	total_bytes_to_write += sizeof(uint64_t);
 
@@ -326,11 +294,9 @@ hv_ring_buffer_write(
 	 * Otherwise, the next time around, we think the ring buffer
 	 * is empty since the read index == write index
 	 */
-
 	if (byte_avail_to_write <= total_bytes_to_write) {
-
-	    mtx_unlock_spin(&out_ring_info->ring_lock);
-	    return (EAGAIN);
+		mtx_unlock_spin(&out_ring_info->ring_lock);
+		return (EAGAIN);
 	}
 
 	/*
@@ -341,8 +307,8 @@ hv_ring_buffer_write(
 	old_write_location = next_write_location;
 
 	for (i = 0; i < iovlen; i++) {
-	    next_write_location = copy_to_ring_buffer(out_ring_info,
-		next_write_location, iov[i].iov_base, iov[i].iov_len);
+		next_write_location = copy_to_ring_buffer(out_ring_info,
+		    next_write_location, iov[i].iov_base, iov[i].iov_len);
 	}
 
 	/*
@@ -350,9 +316,8 @@ hv_ring_buffer_write(
 	 */
 	prev_indices = get_ring_buffer_indices(out_ring_info);
 
-	next_write_location = copy_to_ring_buffer(
-		out_ring_info, next_write_location,
-		(char *) &prev_indices, sizeof(uint64_t));
+	next_write_location = copy_to_ring_buffer(out_ring_info,
+	    next_write_location, (char *)&prev_indices, sizeof(uint64_t));
 
 	/*
 	 * Full memory barrier before upding the write index. 
@@ -376,10 +341,8 @@ hv_ring_buffer_write(
  * @brief Read without advancing the read index.
  */
 int
-hv_ring_buffer_peek(
-	hv_vmbus_ring_buffer_info*	in_ring_info,
-	void*				buffer,
-	uint32_t			buffer_len)
+hv_ring_buffer_peek(hv_vmbus_ring_buffer_info *in_ring_info, void *buffer,
+    uint32_t buffer_len)
 {
 	uint32_t bytesAvailToWrite;
 	uint32_t bytesAvailToRead;
@@ -388,14 +351,14 @@ hv_ring_buffer_peek(
 	mtx_lock_spin(&in_ring_info->ring_lock);
 
 	get_ring_buffer_avail_bytes(in_ring_info, &bytesAvailToRead,
-		&bytesAvailToWrite);
+	    &bytesAvailToWrite);
 
 	/*
 	 * Make sure there is something to read
 	 */
 	if (bytesAvailToRead < buffer_len) {
-	    mtx_unlock_spin(&in_ring_info->ring_lock);
-	    return (EAGAIN);
+		mtx_unlock_spin(&in_ring_info->ring_lock);
+		return (EAGAIN);
 	}
 
 	/*
@@ -403,8 +366,8 @@ hv_ring_buffer_peek(
 	 */
 	nextReadLocation = get_next_read_location(in_ring_info);
 
-	nextReadLocation = copy_from_ring_buffer(
-		in_ring_info, (char *)buffer, buffer_len, nextReadLocation);
+	nextReadLocation = copy_from_ring_buffer(in_ring_info,
+	    (char *)buffer, buffer_len, nextReadLocation);
 
 	mtx_unlock_spin(&in_ring_info->ring_lock);
 
@@ -415,11 +378,8 @@ hv_ring_buffer_peek(
  * @brief Read and advance the read index.
  */
 int
-hv_ring_buffer_read(
-	hv_vmbus_ring_buffer_info*	in_ring_info,
-	void*				buffer,
-	uint32_t			buffer_len,
-	uint32_t			offset)
+hv_ring_buffer_read(hv_vmbus_ring_buffer_info *in_ring_info, void *buffer,
+    uint32_t buffer_len, uint32_t offset)
 {
 	uint32_t bytes_avail_to_write;
 	uint32_t bytes_avail_to_read;
@@ -427,37 +387,29 @@ hv_ring_buffer_read(
 	uint64_t prev_indices = 0;
 
 	if (buffer_len <= 0)
-	    return (EINVAL);
+		return (EINVAL);
 
 	mtx_lock_spin(&in_ring_info->ring_lock);
 
-	get_ring_buffer_avail_bytes(
-	    in_ring_info, &bytes_avail_to_read,
+	get_ring_buffer_avail_bytes(in_ring_info, &bytes_avail_to_read,
 	    &bytes_avail_to_write);
 
 	/*
 	 * Make sure there is something to read
 	 */
 	if (bytes_avail_to_read < buffer_len) {
-	    mtx_unlock_spin(&in_ring_info->ring_lock);
-	    return (EAGAIN);
+		mtx_unlock_spin(&in_ring_info->ring_lock);
+		return (EAGAIN);
 	}
 
-	next_read_location = get_next_read_location_with_offset(
-	    in_ring_info,
+	next_read_location = get_next_read_location_with_offset(in_ring_info,
 	    offset);
 
-	next_read_location = copy_from_ring_buffer(
-	    in_ring_info,
-	    (char *) buffer,
-	    buffer_len,
-	    next_read_location);
-
-	next_read_location = copy_from_ring_buffer(
-	    in_ring_info,
-	    (char *) &prev_indices,
-	    sizeof(uint64_t),
-	    next_read_location);
+	next_read_location = copy_from_ring_buffer(in_ring_info, (char *)buffer,
+	    buffer_len, next_read_location);
+
+	next_read_location = copy_from_ring_buffer(in_ring_info,
+	    (char *)&prev_indices, sizeof(uint64_t), next_read_location);
 
 	/*
 	 * Make sure all reads are done before we update the read index since
@@ -482,23 +434,20 @@ hv_ring_buffer_read(
  * Assume there is enough room. Handles wrap-around in dest case only!
  */
 static uint32_t
-copy_to_ring_buffer(
-	hv_vmbus_ring_buffer_info*	ring_info,
-	uint32_t 			start_write_offset,
-	const uint8_t			*src,
-	uint32_t			src_len)
+copy_to_ring_buffer(hv_vmbus_ring_buffer_info *ring_info,
+    uint32_t start_write_offset, const uint8_t *src, uint32_t src_len)
 {
 	char *ring_buffer = get_ring_buffer(ring_info);
 	uint32_t ring_buffer_size = get_ring_buffer_size(ring_info);
 	uint32_t fragLen;
 
-	if (src_len > ring_buffer_size - start_write_offset)  {
-	    /* wrap-around detected! */
-	    fragLen = ring_buffer_size - start_write_offset;
-	    memcpy(ring_buffer + start_write_offset, src, fragLen);
-	    memcpy(ring_buffer, src + fragLen, src_len - fragLen);
+	if (src_len > ring_buffer_size - start_write_offset) {
+		/* wrap-around detected! */
+		fragLen = ring_buffer_size - start_write_offset;
+		memcpy(ring_buffer + start_write_offset, src, fragLen);
+		memcpy(ring_buffer, src + fragLen, src_len - fragLen);
 	} else {
-	    memcpy(ring_buffer + start_write_offset, src, src_len);
+		memcpy(ring_buffer + start_write_offset, src, src_len);
 	}
 
 	start_write_offset += src_len;
@@ -512,24 +461,21 @@ copy_to_ring_buffer(
  *
  * Assume there is enough room. Handles wrap-around in src case only!
  */
-uint32_t
-copy_from_ring_buffer(
-	hv_vmbus_ring_buffer_info*	ring_info,
-	char*				dest,
-	uint32_t			dest_len,
-	uint32_t			start_read_offset)
+static uint32_t
+copy_from_ring_buffer(hv_vmbus_ring_buffer_info *ring_info, char *dest,
+    uint32_t dest_len, uint32_t start_read_offset)
 {
 	uint32_t fragLen;
 	char *ring_buffer = get_ring_buffer(ring_info);
 	uint32_t ring_buffer_size = get_ring_buffer_size(ring_info);
 
 	if (dest_len > ring_buffer_size - start_read_offset) {
-	    /*  wrap-around detected at the src */
-	    fragLen = ring_buffer_size - start_read_offset;
-	    memcpy(dest, ring_buffer + start_read_offset, fragLen);
-	    memcpy(dest + fragLen, ring_buffer, dest_len - fragLen);
+		/* wrap-around detected at the src */
+		fragLen = ring_buffer_size - start_read_offset;
+		memcpy(dest, ring_buffer + start_read_offset, fragLen);
+		memcpy(dest + fragLen, ring_buffer, dest_len - fragLen);
 	} else {
-	    memcpy(dest, ring_buffer + start_read_offset, dest_len);
+		memcpy(dest, ring_buffer + start_read_offset, dest_len);
 	}
 
 	start_read_offset += dest_len;
@@ -537,4 +483,3 @@ copy_from_ring_buffer(
 
 	return (start_read_offset);
 }
-



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201607220330.u6M3U0PO082619>