summaryrefslogtreecommitdiffstats
path: root/README
blob: c8b05790348c56d855e0ec150b433b636f0a42b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
Redundancy file operation library (librefop)

Redundancy file operation library is a another implementation for the backup 
manager of AGL base system.  It aim to tiny implementation.


Configure option :
  --enable-address-sanitizer
    Enable address sanitizer in build time (for debug, default is no)

  --enable-gcov
    Enable gcov in build time (for debug, default is no)

  --enable-test
    Enable unit test build (requir to gtest and gmock, default is no)


File operation algorithm :

New data write - case 1..

1-0. Initial state.

 --------   
| latest |  
|  file  |  
 --------   

1-1. Create new file.

 --------   
|  New   |  
|  file  |  
 --------   

 --------   
| latest |  
|  file  |  
 --------   

1-2. Rename from latest file to backup file.

 --------   
|  New   |  
|  file  |  
 --------   

                   --------   
             -->  | backup |  
           rename |  file  |  
                   --------   

1-3. Create new data file.

    | rename from new to latest
 --------          --------   
| latest |        | backup |  
|  file  |        |  file  |  
 --------          --------   

1-4. Done.


New data write - case 2.

2-0. Initial state.

 --------          --------   
| latest |        | backup |  
|  file  |        |  file  |  
 --------          --------   

2-1. Create new file.

 --------   
|  New   |  
|  file  |  
 --------   

 --------          --------   
| latest |        | backup |  
|  file  |        |  file  |  
 --------          --------   

2-2. Remove backup file.

 --------   
|  New   |  
|  file  |  
 --------   

 --------                     
| latest |        remove      
|  file  |        backup file 
 --------                     

2-3. Rename from latest file to backup file.

 --------   
|  New   |  
|  file  |  
 --------   

                   --------   
             -->  | backup |  
           rename |  file  |  
                   --------   

2-4. Create new data file.

    | rename from new to latest
 --------          --------   
| latest |        | backup |  
|  file  |        |  file  |  
 --------          --------   

2-5. Done.


Recovery from abnormal conditions.

Note. 'p1,p2' is a file selection priority.  [High pri.] p1 > p2 [Low pri.]

ac1. Nodata

Return a no data.


ac2. Latest file only.

 --------   
| latest |  
|  file  |  
 --------   
    p1

Return data from a latest file.


ac3. Backup file only.

                   --------   
                  | backup |  
                  |  file  |  
                   --------   
                      p1

Return data from a backup file.


ac4. Have a two file (normal condition).

 --------          --------   
| latest |        | backup |  
|  file  |        |  file  |  
 --------          --------   
    p1                p2

Return data from a latest file.


ac5. Latest file and new file.

 --------   
|  New   |  
|  file  |  
 --------   

 --------                      
| latest |                     
|  file  |                     
 --------                      
    p1                         

Return data from a latest file.  Typically new file may not completed write operation.


ac6. Backup file and new file.

 --------   
|  New   |  
|  file  |  
 --------   

                   --------    
                  | backup |   
                  |  file  |   
                   --------    
                      p1       

Return data from a backup file.  Typically new file may not completed write operation.


ac7. Latest file and backup file and new file.

 --------   
|  New   |  
|  file  |  
 --------   

 --------          --------    
| latest |        | backup |   
|  file  |        |  file  |   
 --------          --------    
    p1                p2       

Return data from a latest file.  Typically new file may not completed write operation.

When the data block of high priority file was broken, this library select next priority file.