Class: Higgs::Storage

Inherits:
Object
  • Object
show all
Includes:
Exceptions, InitOptions
Defined in:
lib/higgs/storage.rb

Overview

transactional storage core

Defined Under Namespace

Modules: InitOptions Classes: ClientSideLocalhostCheckHandler, Error, NotWritableError, PanicError, ShutdownException

Constant Summary collapse

CVS_ID =

for ident(1)

'$Id: storage.rb 841 2008-12-24 09:23:20Z toki $'
PROPERTIES_CKSUM_TYPE = 
'SUM16'
PROPERTIES_CKSUM_BITS = 
16
DATA_HASH = 
{}
DATA_HASH_BIN = 
{}
VERIFY_VERBOSE_LIST = 
[
  [ 'hash_type', proc{|type| type } ],
  [ 'hash_value', proc{|value| value } ],
  [ 'created_time', proc{|t| t.strftime('%Y-%m-%d %H:%M:%S.') + format('%03d', Integer(t.to_f % 1000)) } ],
  [ 'changed_time', proc{|t| t.strftime('%Y-%m-%d %H:%M:%S.') + format('%03d', Integer(t.to_f % 1000)) } ],
  [ 'modified_time', proc{|t| t.strftime('%Y-%m-%d %H:%M:%S.') + format('%03d', Integer(t.to_f % 1000)) } ],
  [ 'string_only', proc{|flag| flag.to_s } ]
]

Instance Attribute Summary collapse

Attributes included from InitOptions

#data_hash_type, #jlog_hash_type, #jlog_rotate_max, #jlog_rotate_size, #jlog_sync, #number_of_read_io, #read_only

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ Storage

name is storage name. see Higgs::Storage::InitOptions for options.

storage is composed of the following 5 files.

name.log

event log. default logging level is WARN.

name.tar

data file compatible with unix TAR format.

name.idx

index snapshot. genuine index is Hash in memory. see Higgs::Index for detail.

name.jlog

transaction journal log. see Higgs::JournalLogger for detail.

name.lock

lock file for File#flock. see Higgs::FileLock for detail.



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
213
214
215
216
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/higgs/storage.rb', line 181

def initialize(name, options={})
  @name = name
  @log_name = "#{@name}.log"
  @tar_name = "#{@name}.tar"
  @idx_name = "#{@name}.idx"
  @jlog_name = "#{@name}.jlog"
  @lock_name = "#{@name}.lock"

  @commit_lock = Mutex.new
  @state_lock = Mutex.new
  @panic = false
  @shutdown = false

  @cnum_lock = Mutex.new
  @saved_change_number = nil

  init_options(options)

  init_completed = false
  read_only = @read_only && @read_only != :standby
  begin
    @flock = FileLock.new(@lock_name, read_only)
    if (read_only) then
      @flock.read_lock
    else
      @flock.write_lock
    end

    @logger = @Logger.call(@log_name)
    @logger.info("storage open start...")
    if (read_only) then
      @logger.info("get file lock for read")
    else
      @logger.info("get file lock for write")
    end

    @logger.info format('block format version: 0x%04X', Block::FMT_VERSION)
    @logger.info("journal log hash type: #{@jlog_hash_type}")
    @logger.info("index format version: #{Index::MAJOR_VERSION}.#{Index::MINOR_VERSION}")
    @logger.info("storage data hash type: #{@data_hash_type}")
    @logger.info("storage properties cksum type: #{PROPERTIES_CKSUM_TYPE}")

    @logger.info("properties cache type: #{@properties_cache.class}")
    @properties_cache = SharedWorkCache.new(@properties_cache) {|key|
      value = read_record_body(key, :p) and decode_properties(key, value)
    }

    unless (read_only) then
      begin
        w_io = File.open(@tar_name, File::WRONLY | File::CREAT | File::EXCL, 0660)
        @logger.info("create and open I/O handle for write: #{@tar_name}")
      rescue Errno::EEXIST
        @logger.info("open I/O handle for write: #{@tar_name}")
        w_io = File.open(@tar_name, File::WRONLY, 0660)
      end
      w_io.binmode
      @w_tar = Tar::ArchiveWriter.new(w_io)
    end

    @logger.info("build I/O handle pool for read.")
    @r_tar_pool = Pool.new(@number_of_read_io) {
      r_io = Tar::RawIO.open(@tar_name, File::RDONLY)
      @logger.info("open I/O handle for read: #{@tar_name}")
      Tar::ArchiveReader.new(r_io)
    }

    @index = Index.new
    if (File.exist? @idx_name) then
      @logger.info("load index: #{@idx_name}")
      @index.load(@idx_name)
      unless (@index.storage_id) then # for migration to new index format of version 0.2 from old version
        @index.storage_id = create_storage_id
        @logger.info("save storage id: #{@index.storage_id}")
        @index.save(@idx_name)
      end
    else
      @index.storage_id = create_storage_id
      @logger.info("save storage id: #{@index.storage_id}")
      @index.save(@idx_name)
    end
    if (JournalLogger.need_for_recovery? @jlog_name) then
      recover
    end
    unless (read_only) then
      @logger.info("journal log sync mode: #{@jlog_sync}")
      @logger.info("open journal log for write: #{@jlog_name}")
      @jlog = JournalLogger.open(@jlog_name, @jlog_sync, @jlog_hash_type)
    end

    init_completed = true
  ensure
    if (init_completed) then
      @logger.info("completed storage open.")
    else
      @panic = true

      if ($! && @logger) then
        begin
          @logger.error($!)
        rescue
          # ignore error
        end
      end

      if (@jlog_rotate_service) then
        begin
          @jlog_rotate_service.stop_service
        rescue
          # ignore error
        end
      end

      unless (read_only) then
        if (@jlog) then
          begin
            @jlog.close(false)
          rescue
            # ignore error
          end
        end
      end

      if (@r_tar_pool) then
        @r_tar_pool.shutdown{|r_tar|
          begin
            r_tar.close
          rescue
            # ignore errno
          end
        }
      end

      unless (read_only) then
        if (@w_tar) then
          begin
            @w_tar.close(false)
          rescue
            # ignore error
          end
        end
      end

      if (@logger) then
        begin
          @logger.fatal("abrot storage open.")
          @logger.close
        rescue
          # ignore error
        end
      end

      if (@flock) then
        begin
          @flock.close
        rescue
          # ignore error
        end
      end
    end
  end
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



442
443
444
 
# File 'lib/higgs/storage.rb', line 442

def name
  @name
end

Class Method Details

.apply_journal(w_tar, index, log) ⇒ Object 



791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/higgs/storage.rb', line 791

def self.apply_journal(w_tar, index, log)
  change_number, commit_log, storage_id = log

  if (storage_id) then # check for backward compatibility
    if (storage_id != index.storage_id) then
      raise PanicError, "unexpected storage id: expected <#{index.storage_id}> but was <#{storage_id}>"
    end
  end

  if (change_number - 1 < index.change_number) then
    # skip old jounal log
  elsif (change_number - 1 > index.change_number) then
    raise PanicError, "lost journal log (cnum: #{index.change_number + 1})"
  else # if (change_number - 1 == index.change_number) then
    for cmd in commit_log
      case (cmd[:ope])
      when :write
        yield(cmd[:key]) if block_given?
        name = "#{cmd[:key]}.#{cmd[:typ]}"[0, Tar::Block::MAX_LEN]
        w_tar.seek(cmd[:pos])
        w_tar.add(cmd[:nam], cmd[:val], :mtime => cmd[:mod])
        blocked_size = Tar::Block::BLKSIZ + Tar::Block.blocked_size(cmd[:val].length)
        if (i = index[cmd[:key]]) then
          i = i.dup
          if (j = i[cmd[:typ]]) then
            j = j.dup; i[cmd[:typ]] = j
            j[:pos] = cmd[:pos]
            j[:siz] = blocked_size
            j[:cnum] = index.change_number
          else
            i[cmd[:typ]] = { :pos => cmd[:pos], :siz => blocked_size, :cnum => index.change_number }
          end
          index[cmd[:key]] = i
        else
          index[cmd[:key]] = { cmd[:typ] => { :pos => cmd[:pos], :siz => blocked_size, :cnum => index.change_number } }
        end
      when :delete
        yield(cmd[:key]) if block_given?
        index.delete(cmd[:key])
      when :free_fetch
        index.free_fetch_at(cmd[:pos], cmd[:siz])
      when :free_store
        index.free_store(cmd[:pos], cmd[:siz])
        name = format('.free.%x', cmd[:pos] >> 9)
        w_tar.seek(cmd[:pos])
        w_tar.write_header(:name => name, :size => cmd[:siz] - Tar::Block::BLKSIZ, :mtime => cmd[:mod])
      when :eoa
        index.eoa = cmd[:pos]
        w_tar.seek(cmd[:pos])
        w_tar.write_EOA
      when :succ
        index.succ!
        if (index.change_number != cmd[:cnum]) then
          raise PanicError, "invalid journal log (succ: #{cmd[:cnum]})"
        end
      else
        raise "unknown operation: #{cmd[:ope]}"
      end
    end
  end

  nil
end

.load_conf(path) ⇒ Object 



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
 
# File 'lib/higgs/storage.rb', line 140

def self.load_conf(path)
  conf = YAML.load(IO.read(path))
  options = {}
  for name, value in conf
    case (name)
    when 'data_hash_type', 'jlog_hash_type'
      value = value.to_sym
    when 'properties_cache_limit_size', 'master_cache_limit_size'
      name = name.sub(/_limit_size$/, '')
      value = LRUCache.new(value)
    when 'logging_level'
      require 'logger'
      name = 'logger'
      level = case (value)
              when 'debug', 'info', 'warn', 'error', 'fatal'
                Logger.const_get(value.upcase)
              else
                raise "unknown logging level: #{value}"
              end
      value = proc{|path|
        logger = Logger.new(path, 1)
        logger.level = level
        logger
      }
    end
    options[name.to_sym] = value
  end
  options
end

.recover(name, out = nil, verbose_level = 1) ⇒ Object 



855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/higgs/storage.rb', line 855

def self.recover(name, out=nil, verbose_level=1)
  tar_name = "#{name}.tar"
  idx_name = "#{name}.idx"
  jlog_name = "#{name}.jlog"
  lock_name = "#{name}.lock"

  FileLock.open(lock_name) {|flock|
    flock.synchronize{
      begin
        w_io = File.open(tar_name, File::WRONLY | File::CREAT | File::EXCL, 0660)
      rescue Errno::EEXIST
        w_io = File.open(tar_name, File::WRONLY, 0660)
      end
      w_io.binmode
      w_tar = Tar::ArchiveWriter.new(w_io)

      index = Index.new
      index.load(idx_name) if (File.exist? idx_name)

      out << "recovery target: #{name}\n" if (out && verbose_level >= 1)
      jlog_list = rotated_entries(jlog_name)
      jlog_list << jlog_name if (File.exist? jlog_name)
      for curr_name in jlog_list
        begin
          JournalLogger.each_log(curr_name) do |log|
            change_number = log[0]
            out << "apply journal log: #{change_number}\n" if (out && verbose_level >= 1)
            apply_journal(w_tar, index, log)
          end
        rescue Block::BrokenError
          out << "warning: incompleted journal log and stopped at #{curr_name}\n" if out
        end
      end

      index.save(idx_name)
      w_tar.fsync
      w_tar.close(false)
    }
  }

  nil
end

.rotated_entries(name) ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/higgs/storage.rb', line 506

def self.rotated_entries(name)
  rotate_list = Dir["#{name}.*"].map{|nm|
    n = Integer(nm[(name.length + 1)..-1])
    [ nm, n ]
  }.sort{|a, b|
    a[1] <=> b[1]
  }.map{|nm, n|
    nm
  }
  rotate_list
end

Instance Method Details

#alive? ⇒ Boolean

Returns:

  • (Boolean) 


500
501
502
503
504
 
# File 'lib/higgs/storage.rb', line 500

def alive?
  @state_lock.synchronize{
    ! @shutdown && ! @panic
  }
end

#apply_journal_log(path) ⇒ Object 



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'lib/higgs/storage.rb', line 898

def apply_journal_log(path)
  @commit_lock.synchronize{
    @logger.info("start to apply journal log.")

    check_standby
    apply_completed = false
    begin
      JournalLogger.each_log(path) do |log|
        change_number, commit_log, storage_id = log

        if (storage_id) then # check for backward compatibility
          if (storage_id != @index.storage_id) then
            raise PanicError, "unexpected storage id: expected <#{@index.storage_id}> but was <#{storage_id}>"
          end
        end

        if (change_number - 1 < @index.change_number) then
          @logger.debug("skip journal log: #{change_number}") if @logger.debug?
        elsif (change_number - 1 > @index.change_number) then
          raise PanicError, "lost journal log (cnum: #{@index.change_number + 1})"
        else # if (change_number - 1 == @index.change_number) then
          @logger.debug("write journal log: #{change_number}") if @logger.debug?
          @jlog.write(log)

          @logger.debug("apply journal log: #{change_number}") if @logger.debug?
          Storage.apply_journal(@w_tar, @index, log) {|key|
            @properties_cache.delete(key)
            yield(key) if block_given?
          }

          if (@jlog_rotate_size > 0 && @jlog.size >= @jlog_rotate_size) then
            internal_rotate_journal_log(true)
          end
        end
      end

      @logger.debug("flush storage.")
      @w_tar.flush

      apply_completed = true
    ensure
      unless (apply_completed) then
        @state_lock.synchronize{ @panic = true }
        @logger.error("panic: failed to apply journal log.")
        @logger.error($!) if $!
      end
    end

    @logger.info("completed to apply journal log.")
  }

  nil
end

#change_number ⇒ Object 



1127
1128
1129
 
# File 'lib/higgs/storage.rb', line 1127

def change_number
  @cnum_lock.synchronize{ @saved_change_number || @index.change_number }
end

#data_change_number(key) ⇒ Object 



1131
1132
1133
 
# File 'lib/higgs/storage.rb', line 1131

def data_change_number(key)
  i = @index[key] and i[:d][:cnum] || -1
end

#each_key ⇒ Object 



1156
1157
1158
1159
1160
1161
1162
 
# File 'lib/higgs/storage.rb', line 1156

def each_key
  check_read
  @index.each_key do |key|
    yield(key)
  end
  self
end

#fetch(key) ⇒ Object 



1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/higgs/storage.rb', line 1100

def fetch(key)
  check_read
  value = read_record_body(key, :d) or return
  unless (properties = internal_fetch_properties(key)) then
    @state_lock.synchronize{ @panic = true }
    @logger.error("panic: failed to read properties: #{key}")
    raise PanicError, "failed to read properties: #{key}"
  end
  hash_type = properties['system_properties']['hash_type']
  unless (hash_proc = DATA_HASH_BIN[hash_type]) then
    @state_lock.synchronize{ @panic = true }
    @logger.error("panic: unknown data hash type: #{hash_type}")
    raise PanicError, "unknown data hash type: #{hash_type}"
  end
  hash_value = hash_proc.call(value)
  if (hash_value != properties['system_properties']['hash_value']) then
    @state_lock.synchronize{ @panic = true }
    @logger.error("panic: mismatch hash value at #{key}")
    raise PanicError, "mismatch hash value at #{key}"
  end
  value
end

#fetch_properties(key) ⇒ Object 



1095
1096
1097
1098
 
# File 'lib/higgs/storage.rb', line 1095

def fetch_properties(key)
  check_read
  internal_fetch_properties(key)
end

#identity(key) ⇒ Object 



1123
1124
1125
 
# File 'lib/higgs/storage.rb', line 1123

def identity(key)
  @index.identity(key)
end

#key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


1145
1146
1147
1148
 
# File 'lib/higgs/storage.rb', line 1145

def key?(key)
  check_read
  @index.key? key
end

#keys(order_by_pos = false) ⇒ Object 



1150
1151
1152
1153
1154
 
# File 'lib/higgs/storage.rb', line 1150

def keys(order_by_pos=false)
  keys = @index.keys
  keys.sort!{|a, b| @index[a][:d][:pos] <=> @index[b][:d][:pos] } if order_by_pos
  keys
end

#localhost_check ⇒ Object

check that client exists in localhost.



1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/higgs/storage.rb', line 1214

def localhost_check
  base_dir = File.dirname(@name)
  tmp_fname = File.join(base_dir, ".localhost_check.#{$$}")
  messg = (0...8).map{ rand(64) }.pack("C*").tr("\x00-\x3f", "A-Za-z0-9./")

  begin
    f = File.open(tmp_fname, File::WRONLY | File::CREAT | File::EXCL, 0644)
  rescue Errno::EEXIST
    tmp_fname.succ!
    retry
  end

  begin
    begin
      f.binmode
      f.write(messg)
    ensure
      f.close
    end
    yield(ClientSideLocalhostCheckHandler.new(tmp_fname, messg))
  ensure
    File.unlink(tmp_fname) if (File.exist? tmp_fname)
  end

  nil
end

#properties_change_number(key) ⇒ Object 



1135
1136
1137
 
# File 'lib/higgs/storage.rb', line 1135

def properties_change_number(key)
  i = @index[key] and i[:p][:cnum] || -1
end

#raw_write_and_commit(write_list, commit_time = Time.now) ⇒ Object 



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
 
# File 'lib/higgs/storage.rb', line 584

def raw_write_and_commit(write_list, commit_time=Time.now)
  @commit_lock.synchronize{
    @logger.debug("start raw_write_and_commit.") if @logger.debug?

    check_read_write
    commit_log = []
    commit_completed = false
    eoa = @index.eoa

    begin
      @cnum_lock.synchronize{ @saved_change_number = @index.change_number }
      @index.succ!
      @logger.debug("index succ: #{@index.change_number}") if @logger.debug?
      commit_log << { :ope => :succ, :cnum => @index.change_number }

      for ope, key, type, name, value in write_list
        case (ope)
        when :write
          @logger.debug("journal log for write: (key,type)=(#{key},#{type})") if @logger.debug?
          unless (value.kind_of? String) then
            raise TypeError, "can't convert #{value.class} (value) to String"
          end
          blocked_size = Tar::Block::BLKSIZ + Tar::Block.blocked_size(value.length)

          # recycle
          if (pos = @index.free_fetch(blocked_size)) then
            @logger.debug("write type of recycle free region: (pos,size)=(#{pos},#{blocked_size})") if @logger.debug?
            commit_log << {
              :ope => :free_fetch,
              :pos => pos,
              :siz => blocked_size
            }
            commit_log << {
              :ope => :write,
              :key => key,
              :pos => pos,
              :typ => type,
              :mod => commit_time,
              :nam => name,
              :val => value
            }
            if (i = @index[key]) then
i = i.dup
              if (j = i[type]) then
  j = j.dup; i[type] = j
                commit_log << {
                  :ope => :free_store,
                  :pos => j[:pos],
                  :siz => j[:siz],
                  :mod => commit_time
                }
                @index.free_store(j[:pos], j[:siz])
                j[:pos] = pos
                j[:siz] = blocked_size
                j[:cnum] = @index.change_number
              else
                i[type] = { :pos => pos, :siz => blocked_size, :cnum => @index.change_number }
              end
@index[key] = i
            else
              @index[key] = { type => { :pos => pos, :siz => blocked_size, :cnum => @index.change_number } }
            end
            next
          end

          # overwrite
          if (i = @index[key]) then
            if (j = i[type]) then
              if (j[:siz] >= blocked_size) then
                i = i.dup; j = j.dup; i[type] = j
                @logger.debug("write type of overwrite: (pos,size)=(#{j[:pos]},#{blocked_size})") if @logger.debug?
                commit_log << {
                  :ope => :write,
                  :key => key,
                  :pos => j[:pos],
                  :typ => type,
                  :mod => commit_time,
                  :nam => name,
                  :val => value
                }
                j[:cnum] = @index.change_number
                if (j[:siz] > blocked_size) then
                  commit_log << {
                    :ope => :free_store,
                    :pos => j[:pos] + blocked_size,
                    :siz => j[:siz] - blocked_size,
                    :mod => commit_time
                  }
                  @logger.debug("tail free region: (pos,size)=(#{commit_log[-1][:pos]},#{commit_log[-1][:siz]})") if @logger.debug?
                  @index.free_store(commit_log.last[:pos], commit_log.last[:siz])
                  j[:siz] = blocked_size
                end
                @index[key] = i
                next
              end
            end
          end

          # append
          @logger.debug("write type of append: (pos,size)=(#{eoa},#{blocked_size})")
          commit_log << {
            :ope => :write,
            :key => key,
            :pos => eoa,
            :typ => type,
            :mod => commit_time,
            :nam => name,
            :val => value
          }
          if (i = @index[key]) then
            i = i.dup
            if (j = i[type]) then
              j = j.dup; i[type] = j
              commit_log << {
                :ope => :free_store,
                :pos => j[:pos],
                :siz => j[:siz],
                :mod => commit_time
              }
              @index.free_store(j[:pos], j[:siz])
              j[:pos] = eoa
              j[:siz] = blocked_size
              j[:cnum] = @index.change_number
            else
              i[type] = { :pos => eoa, :siz => blocked_size, :cnum => @index.change_number }
            end
            @index[key] = i
          else
            @index[key] = { type => { :pos => eoa, :siz => blocked_size, :cnum => @index.change_number } }
          end
          eoa += blocked_size
          commit_log << {
            :ope => :eoa,
            :pos => eoa
          }
        when :delete
          @logger.debug("journal log for delete: #{key}") if @logger.debug?
          if (i = @index.delete(key)) then
            commit_log << {
              :ope => :delete,
              :key => key
            }
            i.each_value{|j|
              commit_log << {
                :ope => :free_store,
                :pos => j[:pos],
                :siz => j[:siz],
                :mod => commit_time
              }
              @index.free_store(j[:pos], j[:siz])
            }
          end
        else
          raise ArgumentError, "unknown operation: #{cmd[:ope]}"
        end
      end

      @logger.debug("write journal log: #{@index.change_number}") if @logger.debug?
      @jlog.write([ @index.change_number, commit_log, @index.storage_id ])

      for cmd in commit_log
        case (cmd[:ope])
        when :write
          name = cmd[:nam][0, Tar::Block::MAX_LEN]
          @logger.debug("write data to storage: (name,pos,size)=(#{name},#{cmd[:pos]},#{cmd[:val].size})") if @logger.debug?
          @w_tar.seek(cmd[:pos])
          @w_tar.add(name, cmd[:val], :mtime => cmd[:mod])
        when :free_store
          @logger.debug("write free region to storage: (pos,size)=(#{cmd[:pos]},#{cmd[:siz]})") if @logger.debug?
          name = format('.free.%x', cmd[:pos] >> 9)
          @w_tar.seek(cmd[:pos])
          @w_tar.write_header(:name => name, :size => cmd[:siz] - Tar::Block::BLKSIZ, :mtime => cmd[:mod])
        when :delete, :eoa, :free_fetch, :succ
          # nothing to do.
        else
          raise "unknown operation: #{cmd[:ope]}"
        end
      end
      if (@index.eoa != eoa) then
        @logger.debug("write EOA to storage: #{eoa}")
        @index.eoa = eoa
        @w_tar.seek(eoa)
        @w_tar.write_EOA
      end
      @logger.debug("flush storage.")
      @w_tar.flush

      if (@jlog_rotate_size > 0 && @jlog.size >= @jlog_rotate_size) then
        internal_rotate_journal_log(true)
      end

      commit_completed = true
    ensure
      unless (commit_completed) then
        @state_lock.synchronize{ @panic = true }
        @logger.error("panic: failed to commit.")
        @logger.error($!) if $!
      end
      @cnum_lock.synchronize{ @saved_change_number = nil }
    end

    @logger.debug("completed raw_write_and_commit.") if @logger.debug?
  }

  nil
end

#rotate_journal_log(save_index = true) ⇒ Object 



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/higgs/storage.rb', line 565

def rotate_journal_log(save_index=true)
  @commit_lock.synchronize{
    check_read_write
    rotate_completed = false
    begin
      internal_rotate_journal_log(save_index)
      rotate_completed = true
    ensure
      unless (rotate_completed) then
        @state_lock.synchronize{ @panic = true }
        @logger.error("panic: failed to rotate journal log.")
        @logger.error($!) if $!
      end
    end
  }

  nil
end

#shutdown ⇒ Object 



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/higgs/storage.rb', line 444

def shutdown
  @commit_lock.synchronize{
    @state_lock.synchronize{
      read_only = @read_only && @read_only != :standby

      if (@shutdown) then
        raise ShutdownException, 'storage shutdown'
      end
      @logger.info("shutdown start...")
      @shutdown = true

      if (@jlog_rotate_service) then
        @logger.info("stop journal log rotation service: #{@jlog_rotate_service}")
        @jlog_rotate_service.stop_service
      end

      unless (read_only) then
        if (@panic) then
          @logger.warn("abort journal log: #{@jlog_name}")
          @jlog.close(false)
        else
          @logger.info("close journal log: #{@jlog_name}")
          @jlog.close
        end
      end

      if (! @panic && ! read_only) then
        @logger.info("save index: #{@idx_name}")
        @index.save(@idx_name)
      end

      @r_tar_pool.shutdown{|r_tar|
        @logger.info("close I/O handle for read: #{@tar_name}")
        r_tar.close
      }
      unless (read_only) then
        @logger.info("sync write data: #{@tar_name}")
        @w_tar.fsync
        @logger.info("close I/O handle for write: #{@tar_name}")
        @w_tar.close(false)
      end

      @logger.info("unlock: #{@lock_name}")
      @flock.close

      @logger.info("completed shutdown.")
      @logger.close
    }
  }
  nil
end

#shutdown? ⇒ Boolean

Returns:

  • (Boolean) 


496
497
498
 
# File 'lib/higgs/storage.rb', line 496

def shutdown?
  @state_lock.synchronize{ @shutdown }
end

#switch_to_write ⇒ Object 



952
953
954
955
956
957
958
959
960
 
# File 'lib/higgs/storage.rb', line 952

def switch_to_write
  @state_lock.synchronize{
    if (@read_only != :standby) then
      raise "not standby mode: #{@read_only}"
    end
    @read_only = false
  }
  nil
end

#unique_data_id(key) ⇒ Object 



1139
1140
1141
1142
1143
 
# File 'lib/higgs/storage.rb', line 1139

def unique_data_id(key)
  id = identity(key) or return
  cnum = data_change_number(key) or return
  "#{id}\t#{cnum}"
end

#verify(out = nil, verbose_level = 1) ⇒ Object 



1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/higgs/storage.rb', line 1173

def verify(out=nil, verbose_level=1)
  check_read
  for key in keys(true)
    if (out && verbose_level >= 1) then
      out << "check #{key}\n"
    end
    data = fetch(key)
    if (out && verbose_level >= 2) then
      out << "  #{data.length} bytes\n"
      properties = fetch_properties(key) or raise PanicError, "not exist properties at key: #{key}"
      for key, format in VERIFY_VERBOSE_LIST
        value = properties['system_properties'][key]
        out << '  ' << key << ': ' << format.call(value) << "\n"
      end
    end
  end
  nil
end

#write_and_commit(write_list, commit_time = Time.now) ⇒ Object 



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
 
# File 'lib/higgs/storage.rb', line 962

def write_and_commit(write_list, commit_time=Time.now)
  check_read_write

  raw_write_list = []
  deleted_entries = {}
  update_properties = {}

  for ope, key, value in write_list
    case (ope)
    when :write
      unless (value.kind_of? String) then
        raise TypeError, "can't convert #{value.class} (value) to String"
      end
      raw_write_list << [ :write, key, :d, key.to_s, value ]
      deleted_entries[key] = false
      if (properties = update_properties[key]) then
        # nothing to do.
      elsif (properties = internal_fetch_properties(key)) then
        update_properties[key] = properties
      else
        # new properties
        properties = {
          'system_properties' => {
            'hash_type' => @data_hash_type.to_s,
            'hash_value' => nil,
            'created_time' => commit_time,
            'changed_time' => commit_time,
            'modified_time' => nil,
            'string_only' => false
          },
          'custom_properties' => {}
        }
        update_properties[key] = properties
      end
      properties['system_properties']['hash_value'] = DATA_HASH[@data_hash_type].call(value)
      properties['system_properties']['modified_time'] = commit_time
      @properties_cache.delete(key)
    when :delete
      raw_write_list << [ :delete, key ]
      deleted_entries[key] = true
      update_properties.delete(key)
      @properties_cache.delete(key)
    when :custom_properties, :system_properties
      if (deleted_entries[key]) then
        raise IndexError, "not exist properties at key: #{key}"
      end
      if (properties = update_properties[key]) then
        # nothing to do.
      elsif (properties = internal_fetch_properties(key)) then
        update_properties[key] = properties
      else
        raise IndexError, "not exist properties at key: #{key}"
      end
      properties['system_properties']['changed_time'] = commit_time
      case (ope)
      when :custom_properties
        properties['custom_properties'] = value
      when :system_properties
        if (value.key? 'string_only') then
          properties['system_properties']['string_only'] = value['string_only'] ? true : false
        end
      else
        raise ArgumentError, "unknown operation: #{ope}"
      end
      @properties_cache.delete(key)
    else
      raise ArgumentError, "unknown operation: #{ope}"
    end
  end

  for key, properties in update_properties
    raw_write_list << [ :write, key, :p, "#{key}.p", encode_properties(properties) ]
  end

  raw_write_and_commit(raw_write_list, commit_time)

  nil
end