Changeset 38305 in vbox for trunk

Timestamp:

Aug 4, 2011 8:18:54 AM (13 years ago)

Author:

vboxsync

Message:

Addressed some todos.

File:

• trunk/src/VBox/Runtime/common/misc/circbuf.cpp (modified) (11 diffs)

trunk/src/VBox/Runtime/common/misc/circbuf.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2010 Oracle Corporation
+ * Copyright (C) 2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -39 +39 @@
 *   Structures and Typedefs                                                    *
 *******************************************************************************/
-/** @todo r=bird: this is missing docs and magic. uXPos should be offX.
- *        cbBufSize should be cbBuf. */
+/** @todo r=bird: this is missing docs and magic. */
 typedef struct RTCIRCBUF
 {
     /** The current read position in the buffer. */
-    size_t          uReadPos;
+    size_t          offRead;
     /** The current write position in the buffer. */
-    size_t          uWritePos;
+    size_t          offWrite;
     /** How much space of the buffer is currently in use. */
-    volatile size_t cbBufUsed;
+    volatile size_t cbUsed;
     /** How big is the buffer. */
-    size_t          cbBufSize;
+    size_t          cbBuf;
     /** The buffer itself. */
     void           *pvBuf;
-} RTCIRCBUF;
-
+} RTCIRCBUF, *PRTCIRCBUF;
 
 
@@ -71 +69 @@
     if (pTmpBuf->pvBuf)
     {
-        pTmpBuf->cbBufSize = cbSize;
+        pTmpBuf->cbBuf = cbSize;
         *ppBuf = pTmpBuf;
         return VINF_SUCCESS;
@@ -97 +95 @@
     AssertPtr(pBuf);
 
-    pBuf->uReadPos  = 0;
-    pBuf->uWritePos = 0;
-    pBuf->cbBufUsed = 0;
+    pBuf->offRead  = 0;
+    pBuf->offWrite = 0;
+    pBuf->cbUsed = 0;
 }
 
@@ -108 +106 @@
     AssertPtrReturn(pBuf, 0);
 
-    return pBuf->cbBufSize - ASMAtomicReadZ(&pBuf->cbBufUsed);
+    return pBuf->cbBuf - ASMAtomicReadZ(&pBuf->cbUsed);
 }
 
@@ -117 +115 @@
     AssertPtrReturn(pBuf, 0);
 
-    return ASMAtomicReadZ(&pBuf->cbBufUsed);
+    return ASMAtomicReadZ(&pBuf->cbUsed);
 }
 
@@ -126 +124 @@
     AssertPtrReturn(pBuf, 0);
 
-    return pBuf->cbBufSize;
+    return pBuf->cbBuf;
 }
 
@@ -142 +140 @@
 
     /* How much is in use? */
-    size_t cbUsed = ASMAtomicReadZ(&pBuf->cbBufUsed);
+    size_t cbUsed = ASMAtomicReadZ(&pBuf->cbUsed);
     if (cbUsed > 0)
     {
         /* Get the size out of the requested size, the read block till the end
          * of the buffer & the currently used size. */
-        size_t cbSize = RT_MIN(cbReqSize, RT_MIN(pBuf->cbBufSize - pBuf->uReadPos, cbUsed));
+        size_t cbSize = RT_MIN(cbReqSize, RT_MIN(pBuf->cbBuf - pBuf->offRead, cbUsed));
         if (cbSize > 0)
         {
             /* Return the pointer address which point to the current read
              * position. */
-            *ppvStart = (char *)pBuf->pvBuf + pBuf->uReadPos;
+            *ppvStart = (char *)pBuf->pvBuf + pBuf->offRead;
             *pcbSize = cbSize;
         }
@@ -165 +163 @@
 
     /* Split at the end of the buffer. */
-    pBuf->uReadPos = (pBuf->uReadPos + cbSize) % pBuf->cbBufSize;
-
-    ASMAtomicSubZ(&pBuf->cbBufUsed, cbSize);
+    pBuf->offRead = (pBuf->offRead + cbSize) % pBuf->cbBuf;
+
+    ASMAtomicSubZ(&pBuf->cbUsed, cbSize);
 }
 
@@ -183 +181 @@
 
     /* How much is free? */
-    size_t cbFree = pBuf->cbBufSize - ASMAtomicReadZ(&pBuf->cbBufUsed);
+    size_t cbFree = pBuf->cbBuf - ASMAtomicReadZ(&pBuf->cbUsed);
     if (cbFree > 0)
     {
         /* Get the size out of the requested size, the write block till the end
          * of the buffer & the currently free size. */
-        size_t cbSize = RT_MIN(cbReqSize, RT_MIN(pBuf->cbBufSize - pBuf->uWritePos, cbFree));
+        size_t cbSize = RT_MIN(cbReqSize, RT_MIN(pBuf->cbBuf - pBuf->offWrite, cbFree));
         if (cbSize > 0)
         {
             /* Return the pointer address which point to the current write
              * position. */
-            *ppvStart = (char*)pBuf->pvBuf + pBuf->uWritePos;
+            *ppvStart = (char*)pBuf->pvBuf + pBuf->offWrite;
             *pcbSize = cbSize;
         }
@@ -206 +204 @@
 
     /* Split at the end of the buffer. */
-    pBuf->uWritePos = (pBuf->uWritePos + cbSize) % pBuf->cbBufSize;
+    pBuf->offWrite = (pBuf->offWrite + cbSize) % pBuf->cbBuf;
 
     size_t cbOldIgnored = 0;
-    ASMAtomicAddZ(&pBuf->cbBufUsed, cbSize);
-}
-
+    ASMAtomicAddZ(&pBuf->cbUsed, cbSize);
+}
+