Skip to content

Commit 4acf75b

Browse files
mazdermazder
committed
Fixed Documentation After Stephen Review
1 parent 691c79b commit 4acf75b

13 files changed

+118
-117
lines changed

‎CMakeLists.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
cmake_minimum_required(VERSION 3.2)
22

3-
project (TARCEGEN)
3+
project (TraceFileGen)
44

55
add_subdirectory (ObjectClasses)
66
add_subdirectory (Utils)
77

8-
add_executable (targetGen main.cpp)
8+
add_executable (TraceFileGen main.cpp)
99

10-
target_link_libraries (targetGen LINK_PUBLIC Utils ObjectClasses)
10+
target_link_libraries (TraceFileGen LINK_PUBLIC Utils ObjectClasses)

‎Documentation/html/_class_object_8h_source.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@
140140
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
141141
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="keyword">private</span>:</div>
142142
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">int</span> myId; </div>
143-
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">string</span> myName; <span class="comment">//</span></div>
144-
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="comment"></span> <span class="keywordtype">int</span> mySize;</div>
143+
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">string</span> myName; </div>
144+
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordtype">int</span> mySize;</div>
145145
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">int</span> pointerSize;</div>
146146
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordtype">int</span> nPrimitives;</div>
147147
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordtype">int</span> countFieldType[3];</div>

‎Documentation/html/classtrace_gen_1_1_class_object.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
<tr class="separator:aa4970d64056b748c4cd59b469dbed632"><td class="memSeparator" colspan="2">&#160;</td></tr>
166166
</table>
167167
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
168-
<div class="textblock"><p>A class of class object that is used to hold the class inforamtion of an object that is allocated. </p>
168+
<div class="textblock"><p>A class of class object that is used to hold the class information of an object that is allocated. </p>
169169
</div><hr/>The documentation for this class was generated from the following files:<ul>
170170
<li>ObjectClasses/<a class="el" href="_class_object_8h_source.html">ClassObject.h</a></li>
171171
<li>ObjectClasses/ClassObject.cpp</li>

‎Documentation/html/classtrace_gen_1_1_logger.html

+12-12
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@
168168
</tr>
169169
</table>
170170
</div><div class="memdoc">
171-
<p>This method writes inforamtion into the trace for writing reference of an object into the rootset of the thread </p>
171+
<p>This method writes information into the trace for writing reference of an object into the rootset of the thread </p>
172172

173173
</div>
174174
</div>
@@ -195,7 +195,7 @@
195195
</tr>
196196
</table>
197197
</div><div class="memdoc">
198-
<p>This method writes inforamtion into the trace for deleting a reference of an object from the thread root set </p>
198+
<p>This method writes information into the trace for deleting a reference of an object from the thread root set </p>
199199

200200
</div>
201201
</div>
@@ -222,7 +222,7 @@
222222
</tr>
223223
</table>
224224
</div><div class="memdoc">
225-
<p>This method writes inforamtion into the trace for deleting a reference from the thread root set for given slot (version 0.0) </p>
225+
<p>This method writes information into the trace for deleting a reference from the thread root set for given slot (version 0.0) </p>
226226

227227
</div>
228228
</div>
@@ -379,7 +379,7 @@
379379
</tr>
380380
</table>
381381
</div><div class="memdoc">
382-
<p>This fucntion is used to view the status of object graph at the end. </p>
382+
<p>This function is used to view the status of object graph at the end. </p>
383383

384384
</div>
385385
</div>
@@ -424,7 +424,7 @@
424424
</tr>
425425
</table>
426426
</div><div class="memdoc">
427-
<p>This method writes detail inforamtion into the trace for reading static primitive filed of a class </p>
427+
<p>This method writes detail information into the trace for reading static primitive filed of a class </p>
428428

429429
</div>
430430
</div>
@@ -469,7 +469,7 @@
469469
</tr>
470470
</table>
471471
</div><div class="memdoc">
472-
<p>This method writes detail inforamtion into the trace for reading primitive filed of an object </p>
472+
<p>This method writes detail information into the trace for reading primitive filed of an object </p>
473473

474474
</div>
475475
</div>
@@ -496,7 +496,7 @@
496496
</tr>
497497
</table>
498498
</div><div class="memdoc">
499-
<p>This method writes inforamtion into the trace for reading fileds from an object (version 0.0) </p>
499+
<p>This method writes information into the trace for reading fields from an object (version 0.0) </p>
500500

501501
</div>
502502
</div>
@@ -541,7 +541,7 @@
541541
</tr>
542542
</table>
543543
</div><div class="memdoc">
544-
<p>This method writes detail inforamtion into the trace for reading static reference of an object from the a class </p>
544+
<p>This method writes detail information into the trace for reading static reference of an object from the a class </p>
545545

546546
</div>
547547
</div>
@@ -586,7 +586,7 @@
586586
</tr>
587587
</table>
588588
</div><div class="memdoc">
589-
<p>This method writes detail inforamtion into the trace for reading reference of an object </p>
589+
<p>This method writes detail information into the trace for reading reference of an object </p>
590590

591591
</div>
592592
</div>
@@ -733,7 +733,7 @@
733733
</tr>
734734
</table>
735735
</div><div class="memdoc">
736-
<p>This method writes detail inforamtion into the trace for writing reference of an object into another object </p>
736+
<p>This method writes detail information into the trace for writing reference of an object into another object </p>
737737

738738
</div>
739739
</div>
@@ -778,7 +778,7 @@
778778
</tr>
779779
</table>
780780
</div><div class="memdoc">
781-
<p>This method writes detail inforamtion into the trace for writing static primitive filed of a class </p>
781+
<p>This method writes detail information into the trace for writing static primitive filed of a class </p>
782782

783783
</div>
784784
</div>
@@ -823,7 +823,7 @@
823823
</tr>
824824
</table>
825825
</div><div class="memdoc">
826-
<p>This method writes detail inforamtion into the trace for writing primitive filed of an object </p>
826+
<p>This method writes detail information into the trace for writing primitive filed of an object </p>
827827

828828
</div>
829829
</div>

‎Documentation/html/classtrace_gen_1_1_memory_manager.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@
303303
</tr>
304304
</table>
305305
</div><div class="memdoc">
306-
<p>This method allocate an object, object size is determined dynamically, add object reference to the rootset of the thread, and add object reference to the object list return object reference </p>
306+
<p>This method allocates an object, object size is determined dynamically, add object reference to the rootset of the thread, and add object reference to the object list return object reference </p>
307307

308308
</div>
309309
</div>
@@ -653,7 +653,7 @@
653653
</tr>
654654
</table>
655655
</div><div class="memdoc">
656-
<p>This method return true if the object reference is in the rootset of the thread </p>
656+
<p>This method returns true if the object reference is in the rootset of the thread </p>
657657

658658
</div>
659659
</div>
@@ -746,7 +746,7 @@
746746
</tr>
747747
</table>
748748
</div><div class="memdoc">
749-
<p>The method writes referece of targetObject into the pointer slot of startObject </p>
749+
<p>The method writes reference of targetObject into the pointer slot of startObject </p>
750750

751751
</div>
752752
</div>
@@ -806,7 +806,7 @@
806806
</tr>
807807
</table>
808808
</div><div class="memdoc">
809-
<p>This overloading method write reference of an object at top of the rootset of the thread </p>
809+
<p>This overloading method writes reference of an object at top of the rootset of the thread </p>
810810

811811
</div>
812812
</div>

‎Documentation/html/classtrace_gen_1_1_object.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@
288288
</tr>
289289
</table>
290290
</div><div class="memdoc">
291-
<p>This method writes the reference of the target object into the poniter slot of the object </p>
291+
<p>This method writes the reference of the target object into the pointer slot of the object </p>
292292

293293
</div>
294294
</div>

‎Documentation/html/md__r_e_a_d_m_e.html

+32-32
Original file line numberDiff line numberDiff line change
@@ -82,34 +82,34 @@
8282
<div class="contents">
8383
<div class="textblock"><p>The goal of this project is to design and develop a program that can automatically generate all types of basic memory management operations and write into trace files. Trace files can be used as further benchmarks for simulating Automatic Memory Management Systems (such as Garbage Collectors).</p>
8484
<h1>Trace File</h1>
85-
<p>A trace file is a collection of the following basic memory management operations in order to execute an application.</p><ul>
85+
<p>A trace file is a collection of the following basic memory management operations typically found in executing an application.</p><ul>
8686
<li>Allocation</li>
8787
<li>Store</li>
8888
<li>Read</li>
8989
</ul>
9090
<h1>Trace File Format and Specification</h1>
91-
<p>The trace file to be generated by traceGen has the following formats and meanings:</p>
91+
<p>The trace file generated by TraceFileGen has the following formats and meanings:</p>
9292
<table class="doxtable">
9393
<tr>
94-
<th>MM Operations </th><th>Notation </th></tr>
94+
<th>MM Operations </th><th>Notation </th><th>Usage </th></tr>
9595
<tr>
96-
<td>Allocation 'a' </td><td>a Ti Oj Sk Nl Cj </td></tr>
96+
<td>Allocation </td><td>a </td><td>Ti Oj Sk Nl Cj </td></tr>
9797
<tr>
98-
<td>Add a reference of an object to the rootset a threat '+' </td><td>+ Ti Oj </td></tr>
98+
<td>Add a reference of an object to the rootset a threat </td><td>+ </td><td>Ti Oj </td></tr>
9999
<tr>
100-
<td>Store/write a primitive field into an object 's' </td><td>s Ti Oj Ix(/Fm) Sn Vo </td></tr>
100+
<td>Store/write a primitive field into an object </td><td>s </td><td>Ti Oj Ix(/Fm) Sn Vo </td></tr>
101101
<tr>
102-
<td>Store/write a static primitive field into a class object 's' </td><td>s Ti Cj Ix(/Fm) Sn Vo </td></tr>
102+
<td>Store/write a static primitive field into a class object </td><td>s </td><td>Ti Cj Ix(/Fm) Sn Vo </td></tr>
103103
<tr>
104-
<td>Store/write an object reference field into an object 'w' </td><td>w Ti Pj #k Ol Fm Sn Vo </td></tr>
104+
<td>Store/write an object reference field into an object </td><td>w </td><td>Ti Pj #k Ol Fm Sn Vo </td></tr>
105105
<tr>
106-
<td>Store/write a static object reference field into a class object 'c' </td><td>c Ti Cj Ix(/Fm) Ol Sn Vo </td></tr>
106+
<td>Store/write a static object reference field into a class object </td><td>c </td><td>Ti Cj Ix(/Fm) Ol Sn Vo </td></tr>
107107
<tr>
108-
<td>Read a primitive or a reference field from an object 'r' </td><td>r Ti Oj Ix(/Fm) Sn Vo </td></tr>
108+
<td>Read a primitive or a reference field from an object </td><td>r </td><td>Ti Oj Ix(/Fm) Sn Vo </td></tr>
109109
<tr>
110-
<td>Read a static primitive or reference filed from a class object 'r' </td><td>r Ti Cj Ix(/Fm) Sn Vo </td></tr>
110+
<td>Read a static primitive or reference filed from a class object </td><td>r </td><td>Ti Cj Ix(/Fm) Sn Vo </td></tr>
111111
<tr>
112-
<td>Delete an object reference from the rootset of a thread '-' </td><td>- Ti Oj </td></tr>
112+
<td>Delete an object reference from the rootset of a thread </td><td>- </td><td>Ti Oj </td></tr>
113113
</table>
114114
<ul>
115115
<li>Ti: i is a thread id (i &gt;= 0)</li>
@@ -146,7 +146,7 @@ <h1>Overview of the Directories Structure</h1>
146146
<td>Documentation </td><td>documentation </td></tr>
147147
</table>
148148
<h1>Installing (Initial Build)</h1>
149-
<p>After downloading, followed by extracting or cloning, do the following:</p><ul>
149+
<p>After downloading, extracting or cloning, do the following:</p><ul>
150150
<li>$ cd TraceFileGen</li>
151151
<li>$ ./build.sh</li>
152152
</ul>
@@ -155,50 +155,50 @@ <h1>Compiling (After Initial Build)</h1>
155155
<li>$ cmake ..</li>
156156
<li>$ make</li>
157157
</ul>
158-
<h1>Running (targetGen - the executable in the build folder)</h1>
159-
<p>Usage: At least one argument must be provided to run targetGen</p><ul>
158+
<h1>Running (TraceFileGen - the executable in the build folder)</h1>
159+
<p>Usage: At least one argument must be provided to run TraceFileGen</p><ul>
160160
<li>The name of trace file to be generated (such as traceFile)</li>
161161
</ul>
162-
<p>Example: $./targetGen traceFile</p>
162+
<p>Example: $./TraceFileGen traceFile</p>
163163
<p>Options:</p>
164164
<table class="doxtable">
165165
<tr>
166166
<th>Argument </th><th>Short </th><th>Description </th></tr>
167167
<tr>
168-
<td>&ndash;operations x </td><td>-o x </td><td>x is an integer, number of total memory management operations to be created in a trace file (default: 100) </td></tr>
168+
<td>&ndash;operations x </td><td>-o x </td><td>x is the number of total memory management operations to be created in a trace file (default: 100) </td></tr>
169169
<tr>
170-
<td>&ndash;thread x </td><td>-t x </td><td>x is an integer, number of threads (default: 10) </td></tr>
170+
<td>&ndash;thread x </td><td>-t x </td><td>x is the number of threads (default: 10) </td></tr>
171171
<tr>
172-
<td>&ndash;class x </td><td>-c x </td><td>x is an integer, number of classes (default: 300) </td></tr>
172+
<td>&ndash;class x </td><td>-c x </td><td>x is the number of classes (default: 300) </td></tr>
173173
<tr>
174-
<td>&ndash;pointers x </td><td>-p x </td><td>x is an integer, maximum number of pointer fields in an object or static pointer fields in a class (default: 10) </td></tr>
174+
<td>&ndash;pointers x </td><td>-p x </td><td>x is the maximum number of pointer fields in an object or static pointer fields in a class (default: 10) </td></tr>
175175
<tr>
176-
<td>&ndash;primitives x </td><td>-pm x </td><td>x is an integer, maximum number of primitive fields in an object or static primitive fields in a class (default: 6) </td></tr>
176+
<td>&ndash;primitives x </td><td>-pm x </td><td>x is the maximum number of primitive fields in an object or static primitive fields in a class (default: 6) </td></tr>
177177
<tr>
178-
<td>&ndash;allocation x </td><td>-a x </td><td>x is an integer, ratio of allocation in total MM operations (default: 2) </td></tr>
178+
<td>&ndash;allocation x </td><td>-a x </td><td>x is the percentage of allocation in total MM operations (default: 1)* </td></tr>
179179
<tr>
180-
<td>&ndash;storeaccess x </td><td>-s x </td><td>x is an integer, ratio of store operations in total MM operations (default: 11) </td></tr>
180+
<td>&ndash;storeaccess x </td><td>-s x </td><td>x is the percentage of store operations in total MM operations (default: 8)* </td></tr>
181181
<tr>
182-
<td>&ndash;readaccess x </td><td>-r x </td><td>x is an integer, ratio of read operations in total MM operations (default: 88) </td></tr>
182+
<td>&ndash;readaccess x </td><td>-r x </td><td>x is the percentage of read operations in total MM operations (default: 80)* </td></tr>
183183
<tr>
184-
<td>&ndash;deleteroot x </td><td>-d x </td><td>x is an integer, ratio of root delete operations in total MM operations (default: 10) </td></tr>
184+
<td>&ndash;deleteroot x </td><td>-d x </td><td>x is the percentage of root delete operations in total MM operations (default: 11)* </td></tr>
185185
<tr>
186-
<td>&ndash;static x </td><td>-sf x </td><td>x is an integer, ratio of static field access (store/read) from a class(default: 30) </td></tr>
186+
<td>&ndash;static x </td><td>-sf x </td><td>x is the ratio of static field access (store/read) from a class(default: 30) </td></tr>
187187
<tr>
188-
<td>&ndash;prifaccess x </td><td>-pfa x </td><td>x is an integer, ratio of primitive field access (store/read) from either a object or a class (default: 70) </td></tr>
188+
<td>&ndash;prifaccess x </td><td>-pfa x </td><td>x is the ratio of primitive field access (store/read) from either a object or a class (default: 70) </td></tr>
189189
<tr>
190-
<td>&ndash;escape x </td><td>-e x </td><td>x is an integer, ratio of an object being escaped (default: 12) </td></tr>
190+
<td>&ndash;escape x </td><td>-e x </td><td>x is the ratio of an object being escaped (default: 12) </td></tr>
191191
<tr>
192-
<td>&ndash;esctopartner x </td><td>-etp x </td><td>x is an integer, ratio of an object being escaped to partner thread (default: 90) </td></tr>
192+
<td>&ndash;esctopartner x </td><td>-etp x </td><td>x is the ratio of an object being escaped to partner thread (default: 90) </td></tr>
193193
</table>
194-
<p>Some more options are given in this application</p>
195-
<h1>Output (After after running)</h1>
194+
<p>*100% distribution among them</p>
195+
<h1>Output (After running)</h1>
196196
<p>traceGen will generate three files</p><ul>
197197
<li>*.trace &mdash; containing a sequence of memory management operations</li>
198198
<li>*.cls &mdash; containing a lists of classes</li>
199199
<li>*.log &mdash; containing statistical data, where * is the name of the trace file specified on the command line (e.g., "traceFile")</li>
200200
</ul>
201-
<h1>Usages of Trace Files</h1>
201+
<h1>Usage of Trace Files</h1>
202202
<p>The obtained trace files can be used to simulate and analyse memory management operations by using TraceFileSim can be found in <a href="https://github.com/GarCoSim/TraceFileSim">https://github.com/GarCoSim/TraceFileSim</a> </p>
203203
</div></div><!-- contents -->
204204
<!-- start footer part -->

‎ObjectClasses/ClassObject.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ using namespace std;
3030
namespace traceGen {
3131

3232
/*! A class of class object that is
33-
* used to hold the class inforamtion
33+
* used to hold the class information
3434
* of an object that is allocated.
3535
*/
3636
class ClassObject {
@@ -86,7 +86,7 @@ class ClassObject {
8686
/// Class id
8787
int myId;
8888
/// Class name
89-
string myName; //
89+
string myName;
9090
/// Class size
9191
int mySize;
9292
/// No. of static reference fields

‎ObjectClasses/MemoryManager.h

+4-4
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,14 @@ class MemoryManager {
5757
*/
5858
int allocateObject(int size, int maxPointers, Object* creatorObject, int pointerIndex, int creationDate);
5959

60-
/** This method allocate an object, object size is determined
60+
/** This method allocates an object, object size is determined
6161
* dynamically, add object reference to the rootset of the thread,
6262
* and add object reference to the object list
6363
* return object reference
6464
*/
6565
Object* allocateObjectNew(int threadNumber, int maxPointers,int creationDate, int classID, int primField);
6666

67-
/** The method writes referece of targetObject into the pointer
67+
/** The method writes reference of targetObject into the pointer
6868
* slot of startObject
6969
*/
7070
int setPointer(Object* startObject, int pointerIndex, Object* targetObject);
@@ -74,7 +74,7 @@ class MemoryManager {
7474
*/
7575
int setRootPointer(int threadNumber, int rootSetNumber, Object* newObject);
7676

77-
/** This overloading method write reference of an object
77+
/** This overloading method writes reference of an object
7878
* at top of the rootset of the thread
7979
*/
8080
int setRootPointer(int threadNumber, Object* newObject);
@@ -150,7 +150,7 @@ class MemoryManager {
150150
*/
151151
void deleteFromRootset(int threadNumber);
152152

153-
/** This method return true if the object reference
153+
/** This method returns true if the object reference
154154
* is in the rootset of the thread
155155
*/
156156
bool isObjectInRoot(int thread, Object* obj);

‎ObjectClasses/Object.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ class Object {
6868
Object* getReferenceTo(int pointerNumber);
6969

7070
/** This method writes the reference of
71-
* the target object into the poniter slot of the object
71+
* the target object into the pointer slot of the object
7272
*/
7373
int setPointer(int pointerNumber, Object* target);
7474

0 commit comments

Comments
 (0)