Class: ExtremeZip

Inherits:
Object
  • Object
show all
Defined in:
lib/extremezip.zzaqsv.rb

Overview

def checkMemoryUsage

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ExtremeZip

Returns a new instance of ExtremeZip.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/extremezip.zzaqsv.rb', line 20

def initialize
    @wholeCbor = {} # 整个CBOR结构
    @vfsDataList = [] # 数据块压缩块列表
    @filePartCounter = 0 # 文件分块计数器
    @responsePipeList = [] # 任务回复管道列表
    @processIdList = [] # 子进程编号列表。
    @processTimestamp = Time.new.to_i # 记录进程启动的时间戳。

    @maxSubProcessAmount = Etc.nprocessors # 获取最大的子进程个数

    @dataBlockLength = 33554432 # 数据块单元长度， 32MiB

    @clipDownloader = VictoriaFresh.new # 创建下载器。

    @clipDownloader.diskFlush = true # 向磁盘写入缓存
    @clipDownloader.diskMultiFile = true # 写多个磁盘文件
    @clipDownloader.diskFileName = 'victoriafreshdata.v.' # 磁盘文件名前缀
    @clipDownloader.diskFlushSize = @dataBlockLength # 磁盘文件大小
    @clipDownloader.ignoreFileName= '.exzignore' # 设置用于指定忽略文件列表的文件名。
end

Instance Method Details

#addBasicFileInformation ⇒ Object

加入基本文件信息



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/extremezip.zzaqsv.rb', line 52

def addBasicFileInformation
    @wholeCbor['version'] = 251 # 文件格式版本号

    uuid = UUID.new # 获取生成器
    @wholeCbor['uuid'] = uuid.generate # 指定本个压缩包的唯一编号
    
    @wholeCbor['website']='https://rubygems.org/gems/EXtremeZip' # 加入网站地址
    
    @wholeCbor['vfsDataListStart']=198910 # 压缩 VFS 数据列表起始位置。
end

#appendVfsDataList(victoriaFresh) ⇒ Object

追加压缩块列表数据。



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
 
# File 'lib/extremezip.zzaqsv.rb', line 182

def appendVfsDataList (victoriaFresh)
  extremeZipOutputFile = File.new("#{victoriaFresh['name']}.exz", 'ab') # 打开文件
    
  processCounter=0 # 块计数器。
    
  @wholeCbor['vfsDataList'].each do
    #extremeZipOutputFile = File.new("comressed.#{processCounter}.cex", 'wb') # 创建文件

    currentBlockFile = File.new("comressed.#{processCounter}.cex", 'rb') # 打开文件

    wholeFileContent = currentBlockFile.read # 读取全部内容

    currentBlockFile.close # 关闭文件
    File.delete(currentBlockFile) # 删除数据块文件

      #wholeFileContent=File.read("comressed.#{processCounter}.cex", 'rb') # 读取压缩块。
      
    puts "wirte file contetn length: #{wholeFileContent.length}" # Debghu
      
    extremeZipOutputFile.syswrite(wholeFileContent) # 写入文件
      
    processCounter += 1 # 计数
  end
    
  extremeZipOutputFile.close # 关闭文件
end

#compressInSubProcess(currentBlockData, currentResponsePipe) ⇒ Object

在子进程中具体执行的压缩代码



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/extremezip.zzaqsv.rb', line 291

def compressInSubProcess(currentBlockData, currentResponsePipe)
    checkMemoryUsage(115) # Debug
    currentBlockDataToCompress = currentBlockData # 读取数据块

    currentCompressedVfsData = LZMA.compress(currentBlockDataToCompress) # 压缩当前块

    checkMemoryUsage(120)
    puts("compressed data length: #{currentCompressedVfsData.bytesize}") # Debug.

    currentResponsePipe.put currentCompressedVfsData # 将压缩后的数据块写入到回复管道中

    puts("finished #{Process.pid}") # Debug
end

#compressVfsMenu(victoriaFresh) ⇒ Object

压缩目录数据。



42
43
44
45
46
47
48
49
 
# File 'lib/extremezip.zzaqsv.rb', line 42

def compressVfsMenu(victoriaFresh)
    replyByteArray = victoriaFresh.to_cbor # #打包成字节数组。

    # 压缩目录数据并放入CBOR：
    compressedVfsMenu = LZMA.compress(replyByteArray) # 压缩目录数据

    @wholeCbor['vfsMenu'] = compressedVfsMenu # 加入目录
end

#exz(rootPath) ⇒ Object

压缩



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
 
# File 'lib/extremezip.zzaqsv.rb', line 122

def exz(rootPath)
  timestampTHreshold, fileExists=loadStamp(rootPath) # 读取时间戳阈值。
  
  #陈欣
  
  if (timestampTHreshold > 0) # 有效的时间戳
    @clipDownloader.timestampThreshold=timestampTHreshold # 设置文件时间戳阈值。
  end #if (timestampTHreshold > 0) # 有效的时间戳
  
  if fileExists # 存在文件，则表明将要发生增量压缩
    @wholeCbor['incremental']=true # 是增量压缩。
    
  end # if fileExists # 存在文件，则表明用户要求增量压缩

  @wholeCbor['timestamp']=@processTimestamp # 记录进程启动的时间戳。
  
  victoriaFresh, = @clipDownloader.checkOnce(rootPath) # 打包该目录树。

  @filePartAmount = @clipDownloader.currentDiskFlushSuffix # 获取文件个数

  compressVfsMenu(victoriaFresh) # 压缩目录数据。

  addBasicFileInformation # 加入基本文件信息

  processIdList, responsePipeList = launchSubProcesses # 启动子进程。

  receiveCompressedVfsDataList(processIdList, responsePipeList) # 接收压缩后的数据块列表

  checkMemoryUsage(155)
  @wholeCbor['vfsDataList'] = @vfsDataList # 加入数据

  wholeFileContent = 'exz' + "\0" + @wholeCbor.to_cbor # 追加CBOR字节数组
    
  vfsDataListStart=wholeFileContent.length # 按照现在的序列化情况，计算出来的起始位置。
    
  while (vfsDataListStart!=@wholeCbor['vfsDataListStart']) # 计算出的偏移不一致
    @wholeCbor['vfsDataListStart']=vfsDataListStart # 使用新的值
    wholeFileContent = 'exz' + "\0" + @wholeCbor.to_cbor # 追加CBOR字节数组
    vfsDataListStart=wholeFileContent.length # 按照现在的序列化情况，计算出来的起始位置。          
  end

  # 写入文件：
  writeFile(wholeFileContent, victoriaFresh) # 写入文件内容
    
  appendVfsDataList victoriaFresh # 追加压缩块列表数据。
  
  if fileExists # 存在文件，则表明将要发生增量压缩
    writeStamp # 更新时间戳文件
  end # if fileExists # 存在文件，则表明用户要求增量压缩
  
end

#launchSubProcesses ⇒ Object

启动子进程。



282
283
284
285
286
287
288
 
# File 'lib/extremezip.zzaqsv.rb', line 282

def launchSubProcesses
    while ((@filePartCounter < @filePartAmount) && (@filePartCounter<@maxSubProcessAmount)) # 未处理完毕，并且未达到最大子进程个数
        currentResponsePipe, p1 = schedule1Block(@filePartCounter) # 计划一个块的压缩计算
    end # while processDataLength < victoriaFreshData.byte_size do #未处理完毕

    [@processIdList, @responsePipeList]
end

#loadStamp(rootPath) ⇒ Object

writeStamp # 更新时间戳文件



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
 
# File 'lib/extremezip.zzaqsv.rb', line 80

def loadStamp(rootPath) # 读取时间戳阈值。
  stamp=0 # 默认值。
  fileExists=false # 文件是否存在
  
  directoryPathName=Pathname.new(rootPath) #构造路径名字对象。
    
  isFile=directoryPathName.file? #是否是文件。

  unless isFile #是文件就跳过。 
    #陈欣
    
    datastore=  "#{directoryPathName.expand_path}/.exzstamp"  # 配置文件路径
    puts "reading stamp file: #{datastore}" # Debug
    
    begin # 尝试读取。
      
      #陈欣
      
      currentBlockFile = File.new(datastore, 'rb') # 打开文件
      
      fileExists=true # 文件存在

      stampFileContent = currentBlockFile.read # 读取全部内容

      currentBlockFile.close # 关闭文件
      
      options = {:tolerant => true}

      wholeCbor = CBOR.decode(stampFileContent, options) # 解码
        
      stamp = wholeCbor['timestamp'] # 获取时间戳
    rescue Errno::ENOENT

    end

    
  end #unless isFile #是文件就跳过。 
  
  return stamp, fileExists # 返回时间戳。
end

#readBlockFile(filePartCounter) ⇒ Object

读取块文件内容



245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/extremezip.zzaqsv.rb', line 245

def readBlockFile(filePartCounter)
    currentBlockFile = File.new(@clipDownloader.diskFileName + filePartCounter.to_s, 'rb') # 打开文件

    currentBlockData = currentBlockFile.read # 读取全部内容

    currentBlockFile.close # 关闭文件

    File.delete(currentBlockFile) # 删除数据块文件

    currentBlockData
end

#receiveCompressedVfsDataList(processIdList, responsePipeList) ⇒ Object

接收压缩后的数据块列表



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/extremezip.zzaqsv.rb', line 217

def receiveCompressedVfsDataList(processIdList, responsePipeList)
    processCounter = 0 # 子进程计数器
    
    while (processCounter<@filePartAmount) # 并不是所有分块都被处理完毕了。
        currentSubProcess=processIdList[processCounter] # 获取子进程对象
    #processIdList.each do |currentSubProcess|
        compressed = receiveFromSubProcess(currentSubProcess, responsePipeList, processCounter) # 从子进程中读取数据，并终止子进程
        
        #写入当前压缩块到文件系统中去作为缓存。陈欣
        writeCompressBlock(compressed, processCounter) # 写入压缩块文件
        
        blockInfo={} # 块信息
        blockInfo['length']=compressed.length # 记录长度
        
        puts "block length: #{blockInfo['length']}" # Debug

        @vfsDataList << blockInfo # 加入数据块列表中
        checkMemoryUsage(150)

        processCounter += 1 # 子进程计数
        
        if (@filePartCounter<@filePartAmount) # 还有一些分块尚未交给子进程进行处理
            schedule1Block(@filePartCounter) # 再启动一个子进程
        end # if (@filePartCounter<@filePartAmount) # 还有一些分块尚未交给子进程进行处理
    end # processIdList.each do |currentSubProcess|
end

#receiveFromSubProcess(currentSubProcess, responsePipeList, processCounter) ⇒ Object

从子进程中读取数据，并终止子进程



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/extremezip.zzaqsv.rb', line 306

def receiveFromSubProcess(currentSubProcess, responsePipeList, processCounter)
    puts("waiting #{currentSubProcess}") # Debug
    checkMemoryUsage(140)

    currentResponsePipe = responsePipeList[processCounter] # 任务回复管道

    currentCompressedVfsDataFromSubProcess = currentResponsePipe.get # 读取压缩后数据
    checkMemoryUsage(145)

    Process.waitpid(currentSubProcess) # 等待该个子进程

    currentCompressedVfsDataFromSubProcess
end

#schedule1Block(filePartCounter) ⇒ Object

计划一个块的压缩计算



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/extremezip.zzaqsv.rb', line 258

def schedule1Block(filePartCounter)
    currentBlockData = readBlockFile(filePartCounter) # 读取块文件内容

    currentResponsePipe = Cod.pipe # 任务回复管道

    p1 = fork do # 复制出子进程
        compressInSubProcess(currentBlockData, currentResponsePipe) # 在子进程中具体执行的压缩代码
    end # p1 = fork do #复制出子进程

    # processDataLength += @dataBlockLength # 计数
    checkMemoryUsage(130)

                # 记录管道：
        # taskPipeList << currentTaskPipe
        @responsePipeList << currentResponsePipe # 记录回复管道

        @processIdList << p1 # 记录到子进程列表中

        @filePartCounter += 1 # 计数

    [currentResponsePipe, p1]
end

#writeCompressBlock(compressed, processCounter) ⇒ Object

写入压缩块文件



175
176
177
178
179
 
# File 'lib/extremezip.zzaqsv.rb', line 175

def writeCompressBlock(compressed, processCounter) 
  extremeZipOutputFile = File.new("comressed.#{processCounter}.cex", 'wb') # 创建文件
  extremeZipOutputFile.syswrite(compressed) # 写入文件
  extremeZipOutputFile.close # 关闭文件
end

#writeFile(wholeFileContent, victoriaFresh) ⇒ Object

写入文件内容



210
211
212
213
214
 
# File 'lib/extremezip.zzaqsv.rb', line 210

def writeFile(wholeFileContent, victoriaFresh)
    extremeZipOutputFile = File.new("#{victoriaFresh['name']}.exz", 'wb') # 创建文件
    extremeZipOutputFile.syswrite(wholeFileContent) # 写入文件
    extremeZipOutputFile.close # 关闭文件
end

#writeStamp(rootPath) ⇒ Object

addBasicFileInformation # 加入基本文件信息



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/extremezip.zzaqsv.rb', line 63

def writeStamp(rootPath) # 更新时间戳文件
  directoryPathName=Pathname.new(rootPath) #构造路径名字对象。
  datastore=  "#{directoryPathName.expand_path}/.exzstamp"  # 配置文件路径
  puts "writing stamp file: #{datastore}" # Debug
  
  #stamp = wholeCbor['timestamp'] # 获取时间戳
  stampCbor={} # 时间戳对象。
  stampCbor['timestamp']= @processTimestamp # 设置时间戳。
  
  compressed= stampCbor.to_cbor  
  
  extremeZipOutputFile = File.new(datastore, 'wb') # 创建文件
  extremeZipOutputFile.syswrite(compressed) # 写入文件
  extremeZipOutputFile.close # 关闭文件
  
end