]> arthur.barton.de Git - bup.git/blob - cmd/midx-cmd.py
Move .idx file writing to C
[bup.git] / cmd / midx-cmd.py
1 #!/usr/bin/env python
2 import sys, math, struct, glob, resource
3 import tempfile
4 from bup import options, git, _helpers
5 from bup.helpers import *
6
7 PAGE_SIZE=4096
8 SHA_PER_PAGE=PAGE_SIZE/20.
9
10 optspec = """
11 bup midx [options...] <idxnames...>
12 --
13 o,output=  output midx filename (default: auto-generated)
14 a,auto     automatically create .midx from any unindexed .idx files
15 f,force    automatically create .midx from *all* .idx files
16 p,print    print names of generated midx files
17 max-files= maximum number of idx files to open at once [-1]
18 dir=       directory containing idx/midx files
19 """
20
21 def _group(l, count):
22     for i in xrange(0, len(l), count):
23         yield l[i:i+count]
24         
25         
26 def max_files():
27     mf = min(resource.getrlimit(resource.RLIMIT_NOFILE))
28     if mf > 32:
29         mf -= 20  # just a safety margin
30     else:
31         mf -= 6   # minimum safety margin
32     return mf
33
34 merge_into = _helpers.merge_into
35
36 def _do_midx(outdir, outfilename, infilenames, prefixstr):
37     if not outfilename:
38         assert(outdir)
39         sum = Sha1('\0'.join(infilenames)).hexdigest()
40         outfilename = '%s/midx-%s.midx' % (outdir, sum)
41     
42     inp = []
43     total = 0
44     allfilenames = []
45     for name in infilenames:
46         ix = git.open_idx(name)
47         inp.append((
48             ix.map,
49             len(ix),
50             ix.sha_ofs,
51             isinstance(ix, git.PackMidx) and ix.which_ofs or 0,
52             len(allfilenames),
53         ))
54         for n in ix.idxnames:
55             allfilenames.append(os.path.basename(n))
56         total += len(ix)
57     inp.sort(lambda x,y: cmp(str(y[0][y[2]:y[2]+20]),str(x[0][x[2]:x[2]+20])))
58
59     log('midx: %screating from %d files (%d objects).\n'
60         % (prefixstr, len(infilenames), total))
61     if (not opt.force and (total < 1024 and len(infilenames) < 3)) \
62        or len(infilenames) < 2 \
63        or (opt.force and not total):
64         debug1('midx: nothing to do.\n')
65         return
66
67     pages = int(total/SHA_PER_PAGE) or 1
68     bits = int(math.ceil(math.log(pages, 2)))
69     entries = 2**bits
70     debug1('midx: table size: %d (%d bits)\n' % (entries*4, bits))
71     
72     try:
73         os.unlink(outfilename)
74     except OSError:
75         pass
76     f = open(outfilename + '.tmp', 'w+b')
77     f.write('MIDX')
78     f.write(struct.pack('!II', git.MIDX_VERSION, bits))
79     assert(f.tell() == 12)
80
81     f.truncate(12 + 4*entries + 20*total + 4*total)
82
83     fmap = mmap_readwrite(f, close=False)
84
85     count = merge_into(fmap, bits, total, inp)
86     fmap.flush()
87     fmap.close()
88
89     f.seek(0, git.SEEK_END)
90     f.write('\0'.join(allfilenames))
91     f.close()
92     os.rename(outfilename + '.tmp', outfilename)
93
94     # this is just for testing
95     if 0:
96         p = git.PackMidx(outfilename)
97         assert(len(p.idxnames) == len(infilenames))
98         print p.idxnames
99         assert(len(p) == total)
100         for pe, e in p, git.idxmerge(inp, final_progress=False):
101             assert(i == pi.next())
102             assert(p.exists(i))
103
104     return total, outfilename
105
106
107 def do_midx(outdir, outfilename, infilenames, prefixstr):
108     rv = _do_midx(outdir, outfilename, infilenames, prefixstr)
109     if rv and opt['print']:
110         print rv[1]
111
112
113 def do_midx_dir(path):
114     already = {}
115     sizes = {}
116     if opt.force and not opt.auto:
117         midxs = []   # don't use existing midx files
118     else:
119         midxs = glob.glob('%s/*.midx' % path)
120         contents = {}
121         for mname in midxs:
122             m = git.open_idx(mname)
123             contents[mname] = [('%s/%s' % (path,i)) for i in m.idxnames]
124             sizes[mname] = len(m)
125                     
126         # sort the biggest midxes first, so that we can eliminate smaller
127         # redundant ones that come later in the list
128         midxs.sort(lambda x,y: -cmp(sizes[x], sizes[y]))
129         
130         for mname in midxs:
131             any = 0
132             for iname in contents[mname]:
133                 if not already.get(iname):
134                     already[iname] = 1
135                     any = 1
136             if not any:
137                 debug1('%r is redundant\n' % mname)
138                 unlink(mname)
139                 already[mname] = 1
140
141     midxs = [k for k in midxs if not already.get(k)]
142     idxs = [k for k in glob.glob('%s/*.idx' % path) if not already.get(k)]
143
144     for iname in idxs:
145         i = git.open_idx(iname)
146         sizes[iname] = len(i)
147
148     all = [(sizes[n],n) for n in (midxs + idxs)]
149     
150     # FIXME: what are the optimal values?  Does this make sense?
151     DESIRED_HWM = opt.force and 1 or 5
152     DESIRED_LWM = opt.force and 1 or 2
153     existed = dict((name,1) for sz,name in all)
154     debug1('midx: %d indexes; want no more than %d.\n' 
155            % (len(all), DESIRED_HWM))
156     if len(all) <= DESIRED_HWM:
157         debug1('midx: nothing to do.\n')
158     while len(all) > DESIRED_HWM:
159         all.sort()
160         part1 = [name for sz,name in all[:len(all)-DESIRED_LWM+1]]
161         part2 = all[len(all)-DESIRED_LWM+1:]
162         all = list(do_midx_group(path, part1)) + part2
163         if len(all) > DESIRED_HWM:
164             debug1('\nStill too many indexes (%d > %d).  Merging again.\n'
165                    % (len(all), DESIRED_HWM))
166
167     if opt['print']:
168         for sz,name in all:
169             if not existed.get(name):
170                 print name
171
172
173 def do_midx_group(outdir, infiles):
174     groups = list(_group(infiles, opt.max_files))
175     gprefix = ''
176     for n,sublist in enumerate(groups):
177         if len(groups) != 1:
178             gprefix = 'Group %d: ' % (n+1)
179         rv = _do_midx(path, None, sublist, gprefix)
180         if rv:
181             yield rv
182
183
184 handle_ctrl_c()
185
186 o = options.Options(optspec)
187 (opt, flags, extra) = o.parse(sys.argv[1:])
188
189 if extra and (opt.auto or opt.force):
190     o.fatal("you can't use -f/-a and also provide filenames")
191
192 git.check_repo_or_die()
193
194 if opt.max_files < 0:
195     opt.max_files = max_files()
196 assert(opt.max_files >= 5)
197
198 if extra:
199     do_midx(git.repo('objects/pack'), opt.output, extra, '')
200 elif opt.auto or opt.force:
201     if opt.dir:
202         paths = [opt.dir]
203     else:
204         paths = [git.repo('objects/pack')]
205         paths += glob.glob(git.repo('index-cache/*/.'))
206     for path in paths:
207         debug1('midx: scanning %s\n' % path)
208         do_midx_dir(path)
209         debug1('\n')
210 else:
211     o.fatal("you must use -f or -a or provide input filenames")