This is an automated email from the ASF dual-hosted git repository.

paziz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/master by this push:
     new 7bda058  More documentation for internal cache data structures
7bda058 is described below

commit 7bda0584678d1d8873950921435b00847dc291b7
Author: Syeda Persia Aziz <persia.a...@yahoo.com>
AuthorDate: Wed Feb 7 20:06:01 2018 -0600

    More documentation for internal cache data structures
---
 doc/developer-guide/api/functions/TSTypes.en.rst   |   2 +
 doc/developer-guide/api/types/CoreTypes.en.rst     |   2 +
 .../cache-architecture/data-structures.en.rst      | 119 ++++++++++++++++++++-
 doc/developer-guide/index.en.rst                   |   1 +
 4 files changed, 119 insertions(+), 5 deletions(-)

diff --git a/doc/developer-guide/api/functions/TSTypes.en.rst 
b/doc/developer-guide/api/functions/TSTypes.en.rst
index ae47cf0..ef6c2f7 100644
--- a/doc/developer-guide/api/functions/TSTypes.en.rst
+++ b/doc/developer-guide/api/functions/TSTypes.en.rst
@@ -170,6 +170,8 @@ more widely. Those are described on this page.
 
     An anchor for a double linked instrusive list of instance of :arg:`T`.
 
+.. cpp:class:: template<typename T> Queue
+
 .. type:: TSAcceptor
 
 .. type:: TSNextProtocolSet
diff --git a/doc/developer-guide/api/types/CoreTypes.en.rst 
b/doc/developer-guide/api/types/CoreTypes.en.rst
index 9d14852..e0e8a89 100644
--- a/doc/developer-guide/api/types/CoreTypes.en.rst
+++ b/doc/developer-guide/api/types/CoreTypes.en.rst
@@ -38,6 +38,8 @@ These types are provided by the compiler ("built-in") or from 
a required operati
 .. cpp:type:: uint24_t
 .. cpp:type:: DLL
 .. cpp:type:: INK_MD5
+.. cpp:type:: Queue
+.. cpp:type:: LINK
 
 .. cpp:class:: VersionNumber
 
diff --git a/doc/developer-guide/cache-architecture/data-structures.en.rst 
b/doc/developer-guide/cache-architecture/data-structures.en.rst
index c0d3b2c..1c23896 100644
--- a/doc/developer-guide/cache-architecture/data-structures.en.rst
+++ b/doc/developer-guide/cache-architecture/data-structures.en.rst
@@ -121,9 +121,6 @@ Data Structures
          from :arg:`low` to :arg:`high`. Return ``0`` if no evacuation was 
started,
          non-zero otherwise.
 
-.. class:: CacheVol
-
-   A :term:`cache volume` as described in :file:`volume.config`.
 
 .. class:: Doc
 
@@ -231,11 +228,11 @@ Data Structures
 
 .. class:: DiskVolBlock
 
-   A description of a span block. This is a serialized data structure.
+   A description of a span stripe (Vol) block . This is a serialized data 
structure.
 
    .. member:: uint64_t offset
 
-      Offset in the span of the start of the span block, in bytes.
+      Offset in the span of the start of the span stripe (Vol) block, in bytes.
 
    .. member:: uint64_t len
 
@@ -301,6 +298,118 @@ Data Structures
       An array of directory entry indices. Each element is the directory entry 
of the start of the free list
       for a segment, in the same order as the segments in the directory.
 
+
+.. class:: DiskVolBlockQueue
+
+   .. member:: DiskVolBlock* b
+   
+   .. member:: int new_block
+
+      Indicates if this is a new stripe rather than an existing one. In case a 
stripe is new ATS decides to clear that stripe(:class:`Vol`)
+
+   .. member:: LINK(DiskVolBlockQueue, link)
+
+
+.. class:: DiskVol
+
+   Describes the Disk that contains the stripe identified by vol_number. This 
class also contains the queue
+   containing all the DiskVolBlock
+
+   .. member:: int num_volblocks
+
+      Number of blocks in the stripe identified by vol_number
+
+   .. member:: int vol_number
+
+      Identification number of the stripe (:class:`Vol`)
+
+   .. member:: uint64_t size
+
+      Size of the stripe
+
+   .. member:: CacheDisk* disk
+
+      The disk containing the stripe
+
+   .. member:: Queue<DiskVolBlockQueue> dpb_queue
+      
+
+.. class:: CacheVol
+
+   A :term:`cache volume` as described in :file:`volume.config`. This class 
represents a single volume. :class:`CacheVol` comprises of stripes spread 
across Spans(disks)
+
+   .. member:: int volume_number
+      
+      indentification number of this volume
+
+   .. member:: int scheme
+
+      scheme: HTTP or Stream
+
+   .. member:: off_t size
+
+
+   .. member:: int num_vols
+
+      Number of stripes(:class:`Vol`) contained in this volume
+
+   .. member:: Vol** vols
+      
+      :class:`Vol` represents a single stripe in the disk. vols contains all 
the stripes this volume is made up of
+   
+   .. member:: DiskVol** disk_vols
+
+      disk_vols contain references to the disks of all the stripes in this 
volume
+      
+   .. member:: LINK(CacheVol, link)
+
+   .. member:: RecRawStatBlock vol_rsb
+      
+      per volume stat
+
+
+.. class:: ConfigVol
+
+   This class represents an individual volume.
+
+   .. member:: int number
+
+      Identification number of the volume
+
+   .. member:: CacheType scheme
+
+      scheme : HTTP or STREAM
+
+   .. member:: off_t size
+   
+   .. member:: bool in_percent
+
+      Used as an indicator if the volume is part of the overall volumes 
created by ATS
+
+   .. member:: int percent
+
+      
+   .. member:: CacheVol* cachep
+
+      
+   .. member:: LINK(ConfigVol, link)
+
+.. class:: ConfigVolumes
+
+    .. member:: int num_volumes
+
+       Total number of volumes specified in volume.config
+
+    .. member:: int num_http_volumes
+
+       Total number of volumes scpecified in volume.config for HTTP scheme
+
+    .. member:: int num_stream_volumes
+
+       Total number of volumes scpecified in volume.config for stream
+
+    .. member:: Queue<ConfigVol> cp_queue
+
 .. rubric:: Footnotes
 
 .. [#fragment-offset-table]
diff --git a/doc/developer-guide/index.en.rst b/doc/developer-guide/index.en.rst
index b1399c6..8f2fed8 100644
--- a/doc/developer-guide/index.en.rst
+++ b/doc/developer-guide/index.en.rst
@@ -52,5 +52,6 @@ duplicate bugs is encouraged, but not required.
    api/index.en
    continuous-integration/index.en
    documentation/index.en
+   Statistics/index.en
    host-resolution-proposal.en
    client-session-architecture.en

-- 
To stop receiving notification emails like this one, please contact
pa...@apache.org.

Reply via email to