-
Notifications
You must be signed in to change notification settings - Fork 36
/
fabricate.py
executable file
·1654 lines (1471 loc) · 66 KB
/
fabricate.py
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
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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
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
790
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
854
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
897
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
951
952
953
954
955
956
957
958
959
960
961
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
#!/usr/bin/env python
"""Build tool that finds dependencies automatically for any language.
fabricate is a build tool that finds dependencies automatically for any
language. It's small and just works. No hidden stuff behind your back. It was
inspired by Bill McCloskey's make replacement, memoize, but fabricate works on
Windows as well as Linux.
Read more about how to use it and how it works on the project page:
https://github.com/brushtechnology/fabricate/
Like memoize, fabricate is released under a "New BSD license". fabricate is
copyright (c) 2009 Brush Technology. Full text of the license is here:
https://github.com/brushtechnology/fabricate/wiki/License
To get help on fabricate functions:
from fabricate import *
help(function)
"""
from __future__ import with_statement, print_function, unicode_literals
# fabricate version number
__version__ = '1.29.3'
# if version of .deps file has changed, we know to not use it
deps_version = 2
import atexit
import optparse
import os
import platform
import re
import shlex
import stat
import subprocess
import sys
import tempfile
import time
import threading # NB uses old camelCase names for backward compatibility
import traceback
# multiprocessing module only exists on Python >= 2.6
try:
import multiprocessing
except ImportError:
class MultiprocessingModule(object):
def __getattr__(self, name):
raise NotImplementedError("multiprocessing module not available, can't do parallel builds")
multiprocessing = MultiprocessingModule()
# compatibility
PY3 = sys.version_info[0] >= 3
if PY3:
string_types = str
threading_condition = threading.Condition
else:
string_types = basestring
try:
threading_condition = threading._Condition
except (ImportError, AttributeError):
threading_condition = threading.Condition
# so you can do "from fabricate import *" to simplify your build script
__all__ = ['setup', 'run', 'autoclean', 'main', 'shell', 'fabricate_version',
'memoize', 'outofdate', 'parse_options', 'after',
'ExecutionError', 'md5_hasher', 'mtime_hasher',
'Runner', 'AtimesRunner', 'StraceRunner', 'AlwaysRunner',
'SmartRunner', 'Builder']
import textwrap
__doc__ += "Exported functions are:\n" + ' ' + '\n '.join(textwrap.wrap(', '.join(__all__), 80))
FAT_atime_resolution = 24*60*60 # resolution on FAT filesystems (seconds)
FAT_mtime_resolution = 2
# NTFS resolution is < 1 ms
# We assume this is considerably more than time to run a new process
NTFS_atime_resolution = 0.0002048 # resolution on NTFS filesystems (seconds)
NTFS_mtime_resolution = 0.0002048 # is actually 0.1us but python's can be
# as low as 204.8us due to poor
# float precision when storing numbers
# as big as NTFS file times can be
# (float has 52-bit precision and NTFS
# FILETIME has 63-bit precision, so
# we've lost 11 bits = 2048)
# So we can use md5func in old and new versions of Python without warnings
try:
import hashlib
md5func = hashlib.md5
except ImportError:
import md5
md5func = md5.new
# Use json, or pickle on older Python versions if simplejson not installed
try:
import json
except ImportError:
try:
import simplejson as json
except ImportError:
import cPickle
# needed to ignore the indent= argument for pickle's dump()
class PickleJson:
def load(self, f):
return cPickle.load(f)
def dump(self, obj, f, indent=None, sort_keys=None):
return cPickle.dump(obj, f)
json = PickleJson()
def printerr(message):
""" Print given message to stderr with a line feed. """
print(message, file=sys.stderr)
class PathError(Exception):
pass
class ExecutionError(Exception):
""" Raised by shell() and run() if command returns non-zero exit code. """
pass
def args_to_list(args):
""" Return a flat list of the given arguments for shell(). """
arglist = []
for arg in args:
if arg is None:
continue
if isinstance(arg, (list, tuple)):
arglist.extend(args_to_list(arg))
else:
if not isinstance(arg, string_types):
arg = str(arg)
arglist.append(arg)
return arglist
def shell(*args, **kwargs):
r""" Run a command: program name is given in first arg and command line
arguments in the rest of the args. Iterables (lists and tuples) in args
are recursively converted to separate arguments, non-string types are
converted with str(arg), and None is ignored. For example:
>>> def tail(input, n=3, flags=None):
>>> args = ['-n', n]
>>> return shell('tail', args, flags, input=input)
>>> tail('a\nb\nc\nd\ne\n')
'c\nd\ne\n'
>>> tail('a\nb\nc\nd\ne\n', 2, ['-v'])
'==> standard input <==\nd\ne\n'
Keyword arguments kwargs are interpreted as follows:
"input" is a string to pass standard input into the process (or the
default of None to use parent's stdin, eg: the keyboard)
"silent" is True (default) to return process's standard output as a
string, or False to print it as it comes out
"shell" set to True will run the command via the shell (/bin/sh or
COMSPEC) instead of running the command directly (the default)
"ignore_status" set to True means ignore command status code -- i.e.,
don't raise an ExecutionError on nonzero status code
Any other kwargs are passed directly to subprocess.Popen
Raises ExecutionError(message, output, status) if the command returns
a non-zero status code. """
try:
return _shell(args, **kwargs)
finally:
sys.stderr.flush()
sys.stdout.flush()
def _shell(args, input=None, silent=True, shell=False, ignore_status=False, **kwargs):
if input:
stdin = subprocess.PIPE
else:
stdin = None
if silent:
stdout = subprocess.PIPE
else:
stdout = None
arglist = args_to_list(args)
if not arglist:
raise TypeError('shell() takes at least 1 argument (0 given)')
if shell:
# handle subprocess.Popen quirk where subsequent args are passed
# to bash instead of to our command
command = subprocess.list2cmdline(arglist)
else:
command = arglist
try:
proc = subprocess.Popen(command, stdin=stdin, stdout=stdout,
stderr=subprocess.STDOUT, shell=shell, **kwargs)
except OSError as e:
# Work around the problem that Windows Popen doesn't say what file it couldn't find
if platform.system() == 'Windows' and e.errno == 2 and e.filename is None:
e.filename = arglist[0]
raise e
output, stderr = proc.communicate(input)
status = proc.wait()
if status and not ignore_status:
raise ExecutionError('%r exited with status %d'
% (os.path.basename(arglist[0]), status),
output, status)
if silent:
return output
def md5_hasher(filename):
""" Return MD5 hash of given filename if it is a regular file or
a symlink with a hashable target, or the MD5 hash of the
target_filename if it is a symlink without a hashable target,
or the MD5 hash of the filename if it is a directory, or None
if file doesn't exist.
Note: Pyhton versions before 3.2 do not support os.readlink on
Windows so symlinks without a hashable target fall back to
a hash of the filename if the symlink target is a directory,
or None if the symlink is broken"""
if not isinstance(filename, bytes):
filename = filename.encode('utf-8')
try:
f = open(filename, 'rb')
try:
return md5func(f.read()).hexdigest()
finally:
f.close()
except IOError:
if hasattr(os, 'readlink') and os.path.islink(filename):
return md5func(os.readlink(filename)).hexdigest()
elif os.path.isdir(filename):
return md5func(filename).hexdigest()
return None
def mtime_hasher(filename):
""" Return modification time of file, or None if file doesn't exist. """
try:
st = os.stat(filename)
return repr(st.st_mtime)
except (IOError, OSError):
return None
class RunnerUnsupportedException(Exception):
""" Exception raise by Runner constructor if it is not supported
on the current platform."""
pass
class Runner(object):
def __call__(self, *args, **kwargs):
""" Run command and return (dependencies, outputs), where
dependencies is a list of the filenames of files that the
command depended on, and output is a list of the filenames
of files that the command modified. The input is passed
to shell()"""
raise NotImplementedError("Runner subclass called but subclass didn't define __call__")
def actual_runner(self):
""" Return the actual runner object (overriden in SmartRunner). """
return self
def ignore(self, name):
return self._builder.ignore.search(name)
class AtimesRunner(Runner):
def __init__(self, builder):
self._builder = builder
self.atimes = AtimesRunner.has_atimes(self._builder.dirs)
if self.atimes == 0:
raise RunnerUnsupportedException(
'atimes are not supported on this platform')
@staticmethod
def access_file(filename):
""" Access (read a byte from) file to try to update its access time. """
f = open(filename)
f.read(1)
f.close()
@staticmethod
def file_has_atimes(filename):
return AtimesRunner.fs_item_has_atimes(filename, AtimesRunner.access_file)
@staticmethod
def access_dir(dir):
os.walk(dir)
@staticmethod
def dir_has_atimes(dir):
return AtimesRunner.fs_item_has_atimes(dir, AtimesRunner.access_dir)
@staticmethod
def fs_item_has_atimes(filename, changer):
""" Return whether the given filesystem supports access time updates for
this file. Return:
- 0 if no a/mtimes not updated
- 1 if the atime resolution is at least one day and
the mtime resolution at least 2 seconds (as on FAT filesystems)
- 2 if the atime and mtime resolutions are both < ms
(NTFS filesystem has 100 ns resolution). """
def access_file(filename):
""" Access (read a byte from) file to try to update its access time. """
f = open(filename)
f.read(1)
f.close()
initial = os.stat(filename)
os.utime(filename, (
initial.st_atime-FAT_atime_resolution,
initial.st_mtime-FAT_mtime_resolution))
adjusted = os.stat(filename)
changer(filename)
after = os.stat(filename)
# Check that a/mtimes actually moved back by at least resolution and
# updated by a file access.
# add NTFS_atime_resolution to account for float resolution factors
# Comment on resolution/2 in atimes_runner()
if initial.st_atime-adjusted.st_atime > FAT_atime_resolution+NTFS_atime_resolution or \
initial.st_mtime-adjusted.st_mtime > FAT_mtime_resolution+NTFS_atime_resolution or \
initial.st_atime==adjusted.st_atime or \
initial.st_mtime==adjusted.st_mtime or \
not after.st_atime-FAT_atime_resolution/2 > adjusted.st_atime:
return 0
os.utime(filename, (
initial.st_atime-NTFS_atime_resolution,
initial.st_mtime-NTFS_mtime_resolution))
adjusted = os.stat(filename)
# Check that a/mtimes actually moved back by at least resolution
# Note: != comparison here fails due to float rounding error
# double NTFS_atime_resolution to account for float resolution factors
if initial.st_atime-adjusted.st_atime > NTFS_atime_resolution*2 or \
initial.st_mtime-adjusted.st_mtime > NTFS_mtime_resolution*2 or \
initial.st_atime==adjusted.st_atime or \
initial.st_mtime==adjusted.st_mtime:
return 1
return 2
@staticmethod
def exists(path):
if not os.path.exists(path):
# Note: in linux, error may not occur: strace runner doesn't check
raise PathError("build dirs specified a non-existant path '%s'" % path)
@staticmethod
def has_atimes(paths):
""" Return whether a file created in each path supports atimes and mtimes.
Return value is the same as used by file_has_atimes
Note: for speed, this only tests files created at the top directory
of each path. A safe assumption in most build environments.
In the unusual case that any sub-directories are mounted
on alternate file systems that don't support atimes, the build may
fail to identify a dependency """
atimes = 2 # start by assuming we have best atimes
for path in paths:
AtimesRunner.exists(path)
handle, filename = tempfile.mkstemp(dir=path)
try:
try:
f = os.fdopen(handle, 'wb')
except:
os.close(handle)
raise
try:
f.write(b'x') # need a byte in the file for access test
finally:
f.close()
atimes = min(atimes, AtimesRunner.file_has_atimes(filename))
finally:
os.remove(filename)
dir = tempfile.mkdtemp(dir=path)
try:
atimes = min(atimes, AtimesRunner.dir_has_atimes(dir))
finally:
os.rmdir(dir)
return atimes
def _file_times(self, path, depth):
""" Helper function for file_times().
Return a dict of file times, recursing directories that don't
start with self._builder.ignoreprefix """
AtimesRunner.exists(path)
names = os.listdir(path)
times = {}
ignoreprefix = self._builder.ignoreprefix
for name in names:
if ignoreprefix and name.startswith(ignoreprefix):
continue
if path == '.':
fullname = name
else:
fullname = os.path.join(path, name)
st = os.stat(fullname)
if stat.S_ISDIR(st.st_mode):
if depth > 1:
times.update(self._file_times(fullname, depth-1))
elif stat.S_ISREG(st.st_mode):
times[fullname] = st.st_atime, st.st_mtime
return times
def file_times(self):
""" Return a dict of "filepath: (atime, mtime)" entries for each file
in self._builder.dirs. "filepath" is the absolute path, "atime" is
the access time, "mtime" the modification time.
Recurse directories that don't start with
self._builder.ignoreprefix and have depth less than
self._builder.dirdepth. """
times = {}
for path in self._builder.dirs:
times.update(self._file_times(path, self._builder.dirdepth))
return times
def _utime(self, filename, atime, mtime):
""" Call os.utime but ignore permission errors """
try:
os.utime(filename, (atime, mtime))
except OSError as e:
# ignore permission errors -- we can't build with files
# that we can't access anyway
if e.errno != 1:
raise
def _age_atimes(self, filetimes):
""" Age files' atimes and mtimes to be at least FAT_xx_resolution old.
Only adjust if the given filetimes dict says it isn't that old,
and return a new dict of filetimes with the ages adjusted. """
adjusted = {}
now = time.time()
for filename, entry in filetimes.items():
if now-entry[0] < FAT_atime_resolution or now-entry[1] < FAT_mtime_resolution:
entry = entry[0] - FAT_atime_resolution, entry[1] - FAT_mtime_resolution
self._utime(filename, entry[0], entry[1])
adjusted[filename] = entry
return adjusted
def __call__(self, *args, **kwargs):
""" Run command and return its dependencies and outputs, using before
and after access times to determine dependencies. """
# For Python pre-2.5, ensure os.stat() returns float atimes
old_stat_float = os.stat_float_times()
os.stat_float_times(True)
originals = self.file_times()
if self.atimes == 2:
befores = originals
atime_resolution = 0
mtime_resolution = 0
else:
befores = self._age_atimes(originals)
atime_resolution = FAT_atime_resolution
mtime_resolution = FAT_mtime_resolution
shell_keywords = dict(silent=False)
shell_keywords.update(kwargs)
shell(*args, **shell_keywords)
afters = self.file_times()
deps = []
outputs = []
for name in afters:
if name in befores:
# if file exists before+after && mtime changed, add to outputs
# Note: Can't just check that atimes > than we think they were
# before because os might have rounded them to a later
# date than what we think we set them to in befores.
# So we make sure they're > by at least 1/2 the
# resolution. This will work for anything with a
# resolution better than FAT.
if afters[name][1]-mtime_resolution/2 > befores[name][1]:
if not self.ignore(name):
outputs.append(name)
elif afters[name][0]-atime_resolution/2 > befores[name][0]:
# otherwise add to deps if atime changed
if not self.ignore(name):
deps.append(name)
else:
# file created (in afters but not befores), add as output
if not self.ignore(name):
outputs.append(name)
if self.atimes < 2:
# Restore atimes of files we didn't access: not for any functional
# reason -- it's just to preserve the access time for the user's info
for name in deps:
originals.pop(name)
for name in originals:
original = originals[name]
if original != afters.get(name, None):
self._utime(name, original[0], original[1])
os.stat_float_times(old_stat_float) # restore stat_float_times value
return deps, outputs
class StraceProcess(object):
def __init__(self, cwd='.', delayed=False):
self.cwd = cwd
self.deps = set()
self.outputs = set()
self.delayed = delayed
self.delayed_lines = []
def add_dep(self, dep):
self.deps.add(dep)
def add_output(self, output):
self.outputs.add(output)
def add_delayed_line(self, line):
self.delayed_lines.append(line)
def __str__(self):
return '<StraceProcess cwd=%s deps=%s outputs=%s>' % \
(self.cwd, self.deps, self.outputs)
def _call_strace(self, *args, **kwargs):
""" Top level function call for Strace that can be run in parallel """
return self(*args, **kwargs)
class StraceRunner(Runner):
keep_temps = False
def __init__(self, builder, build_dir=None):
self.strace_system_calls = StraceRunner.get_strace_system_calls()
if self.strace_system_calls is None:
raise RunnerUnsupportedException('strace is not available')
self._builder = builder
self.temp_count = 0
self.build_dir = os.path.abspath(build_dir or os.getcwd())
@staticmethod
def get_strace_system_calls():
""" Return None if this system doesn't have strace, otherwise
return a comma seperated list of system calls supported by strace. """
if platform.system() == 'Windows':
# even if windows has strace, it's probably a dodgy cygwin one
return None
possible_system_calls = ['open','openat','stat', 'stat64', 'lstat', 'lstat64',
'execve','exit_group','chdir','mkdir','rename','clone','vfork',
'fork','symlink','creat']
valid_system_calls = []
try:
# check strace is installed and if it supports each type of call
for system_call in possible_system_calls:
proc = subprocess.Popen(['strace', '-e', 'trace=' + system_call], stderr=subprocess.PIPE)
stdout, stderr = proc.communicate()
proc.wait()
if b'invalid system call' not in stderr:
valid_system_calls.append(system_call)
except OSError:
return None
return ','.join(valid_system_calls)
# Regular expressions for parsing of strace log
_open_re = re.compile(r'(?P<pid>\d+)\s+open\("(?P<name>[^"]*)", (?P<mode>[^,)]*)')
_openat_re = re.compile(r'(?P<pid>\d+)\s+openat\([^,]*, "(?P<name>[^"]*)", (?P<mode>[^,)]*)')
_stat_re = re.compile(r'(?P<pid>\d+)\s+l?stat(?:64)?\("(?P<name>[^"]*)", .*') # stat,lstat,stat64,lstat64
_execve_re = re.compile(r'(?P<pid>\d+)\s+execve\("(?P<name>[^"]*)", .*')
_creat_re = re.compile(r'(?P<pid>\d+)\s+creat\("(?P<name>[^"]*)", .*')
_mkdir_re = re.compile(r'(?P<pid>\d+)\s+mkdir\("(?P<name>[^"]*)", .*\)\s*=\s(?P<result>-?[0-9]*).*')
_rename_re = re.compile(r'(?P<pid>\d+)\s+rename\("[^"]*", "(?P<name>[^"]*)"\)')
_symlink_re = re.compile(r'(?P<pid>\d+)\s+symlink\("[^"]*", "(?P<name>[^"]*)"\)')
_kill_re = re.compile(r'(?P<pid>\d+)\s+killed by.*')
_chdir_re = re.compile(r'(?P<pid>\d+)\s+chdir\("(?P<cwd>[^"]*)"\)')
_exit_group_re = re.compile(r'(?P<pid>\d+)\s+exit_group\((?P<status>.*)\).*')
_clone_re = re.compile(r'(?P<pid_clone>\d+)\s+(clone|fork|vfork)\(.*\)\s*=\s*(?P<pid>\d*)')
# Regular expressions for detecting interrupted lines in strace log
# 3618 clone( <unfinished ...>
# 3618 <... clone resumed> child_stack=0, flags=CLONE, child_tidptr=0x7f83deffa780) = 3622
_unfinished_start_re = re.compile(r'(?P<pid>\d+)(?P<body>.*)<unfinished ...>$')
_unfinished_end_re = re.compile(r'(?P<pid>\d+)\s+\<\.\.\..*\>(?P<body>.*)')
def _do_strace(self, args, kwargs, outfile, outname):
""" Run strace on given command args/kwargs, sending output to file.
Return (status code, list of dependencies, list of outputs). """
shell_keywords = dict(silent=False)
shell_keywords.update(kwargs)
try:
shell('strace', '-fo', outname, '-e',
'trace=' + self.strace_system_calls,
args, **shell_keywords)
except ExecutionError as e:
# if strace failed to run, re-throw the exception
# we can tell this happend if the file is empty
outfile.seek(0, os.SEEK_END)
if outfile.tell() == 0:
raise e
else:
# reset the file postion for reading
outfile.seek(0)
self.status = 0
processes = {} # dictionary of processes (key = pid)
unfinished = {} # list of interrupted entries in strace log
for line in outfile:
self._match_line(line, processes, unfinished)
# collect outputs and dependencies from all processes
deps = set()
outputs = set()
for pid, process in processes.items():
deps = deps.union(process.deps)
outputs = outputs.union(process.outputs)
return self.status, list(deps), list(outputs)
def _match_line(self, line, processes, unfinished):
# look for split lines
unfinished_start_match = self._unfinished_start_re.match(line)
unfinished_end_match = self._unfinished_end_re.match(line)
if unfinished_start_match:
pid = unfinished_start_match.group('pid')
body = unfinished_start_match.group('body')
unfinished[pid] = pid + ' ' + body
return
elif unfinished_end_match:
pid = unfinished_end_match.group('pid')
body = unfinished_end_match.group('body')
if pid not in unfinished:
# Looks like we need to hande an strace bug here
# I think it is safe to ignore as I have only seen futex calls which strace should not output
printerr('fabricate: Warning: resume without unfinished in strace output (strace bug?), \'%s\'' % line.strip())
return
line = unfinished[pid] + body
del unfinished[pid]
is_output = False
open_match = self._open_re.match(line)
openat_match = self._openat_re.match(line)
stat_match = self._stat_re.match(line)
execve_match = self._execve_re.match(line)
creat_match = self._creat_re.match(line)
mkdir_match = self._mkdir_re.match(line)
symlink_match = self._symlink_re.match(line)
rename_match = self._rename_re.match(line)
clone_match = self._clone_re.match(line)
kill_match = self._kill_re.match(line)
if kill_match:
return None, None, None
match = None
if execve_match:
pid = execve_match.group('pid')
match = execve_match # Executables can be dependencies
if pid not in processes and len(processes) == 0:
# This is the first process so create dict entry
processes[pid] = StraceProcess()
elif clone_match:
pid = clone_match.group('pid')
pid_clone = clone_match.group('pid_clone')
if pid not in processes:
# Simple case where there are no delayed lines
processes[pid] = StraceProcess(processes[pid_clone].cwd)
else:
# Some line processing was delayed due to an interupted clone_match
processes[pid].cwd = processes[pid_clone].cwd # Set the correct cwd
processes[pid].delayed = False # Set that matching is no longer delayed
for delayed_line in processes[pid].delayed_lines:
# Process all the delayed lines
self._match_line(delayed_line, processes, unfinished)
processes[pid].delayed_lines = [] # Clear the lines
elif open_match:
match = open_match
mode = match.group('mode')
if 'O_WRONLY' in mode or 'O_RDWR' in mode:
# it's an output file if opened for writing
is_output = True
elif openat_match:
match = openat_match
mode = match.group('mode')
if 'O_WRONLY' in mode or 'O_RDWR' in mode:
# it's an output file if opened for writing
is_output = True
elif stat_match:
match = stat_match
elif creat_match:
match = creat_match
# a created file is an output file
is_output = True
elif mkdir_match:
match = mkdir_match
if match.group('result') == '0':
# a created directory is an output file
is_output = True
elif symlink_match:
match = symlink_match
# the created symlink is an output file
is_output = True
elif rename_match:
match = rename_match
# the destination of a rename is an output file
is_output = True
if match:
name = match.group('name')
pid = match.group('pid')
if not self._matching_is_delayed(processes, pid, line):
cwd = processes[pid].cwd
if cwd != '.':
name = os.path.join(cwd, name)
# normalise path name to ensure files are only listed once
name = os.path.normpath(name)
# if it's an absolute path name under the build directory,
# make it relative to build_dir before saving to .deps file
if os.path.isabs(name) and name.startswith(self.build_dir):
name = name[len(self.build_dir):]
name = name.lstrip(os.path.sep)
if (self._builder._is_relevant(name)
and not self.ignore(name)
and os.path.lexists(name)):
if is_output:
processes[pid].add_output(name)
else:
processes[pid].add_dep(name)
match = self._chdir_re.match(line)
if match:
pid = match.group('pid')
if not self._matching_is_delayed(processes, pid, line):
processes[pid].cwd = os.path.join(processes[pid].cwd, match.group('cwd'))
match = self._exit_group_re.match(line)
if match:
self.status = int(match.group('status'))
def _matching_is_delayed(self, processes, pid, line):
# Check if matching is delayed and cache a delayed line
if pid not in processes:
processes[pid] = StraceProcess(delayed=True)
process = processes[pid]
if process.delayed:
process.add_delayed_line(line)
return True
else:
return False
def __call__(self, *args, **kwargs):
""" Run command and return its dependencies and outputs, using strace
to determine dependencies (by looking at what files are opened or
modified). """
ignore_status = kwargs.pop('ignore_status', False)
if self.keep_temps:
outname = 'strace%03d.txt' % self.temp_count
self.temp_count += 1
handle = os.open(outname, os.O_CREAT)
else:
handle, outname = tempfile.mkstemp()
try:
try:
outfile = os.fdopen(handle, 'r')
except:
os.close(handle)
raise
try:
status, deps, outputs = self._do_strace(args, kwargs, outfile, outname)
if status is None:
raise ExecutionError(
'%r was killed unexpectedly' % args[0], '', -1)
finally:
outfile.close()
finally:
if not self.keep_temps:
os.remove(outname)
if status and not ignore_status:
raise ExecutionError('%r exited with status %d'
% (os.path.basename(args[0]), status),
'', status)
return list(deps), list(outputs)
class AlwaysRunner(Runner):
def __init__(self, builder):
pass
def __call__(self, *args, **kwargs):
""" Runner that always runs given command, used as a backup in case
a system doesn't have strace or atimes. """
shell_keywords = dict(silent=False)
shell_keywords.update(kwargs)
shell(*args, **shell_keywords)
return None, None
class SmartRunner(Runner):
""" Smart command runner that uses StraceRunner if it can,
otherwise AtimesRunner if available, otherwise AlwaysRunner. """
def __init__(self, builder):
self._builder = builder
try:
self._runner = StraceRunner(self._builder)
except RunnerUnsupportedException:
try:
self._runner = AtimesRunner(self._builder)
except RunnerUnsupportedException:
self._runner = AlwaysRunner(self._builder)
def actual_runner(self):
return self._runner
def __call__(self, *args, **kwargs):
return self._runner(*args, **kwargs)
class _running(object):
""" Represents a task put on the parallel pool
and its results when complete """
def __init__(self, async_result, command):
""" "async_result" is the AsyncResult object returned from pool.apply_async
"command" is the command that was run """
self.async_result = async_result
self.command = command
self.results = None
class _after(object):
""" Represents something waiting on completion of some previous commands """
def __init__(self, afters, do):
""" "afters" is a group id or a iterable of group ids to wait on
"do" is either a tuple representing a command (group, command,
arglist, kwargs) or a threading.Condition to be released """
self.afters = afters
self.do = do
self.done = False
class _Groups(object):
""" Thread safe mapping object whose values are lists of _running
or _after objects and a count of how many have *not* completed """
class value(object):
""" the value type in the map """
def __init__(self, val=None):
self.count = 0 # count of items not yet completed.
# This also includes count_in_false number
self.count_in_false = 0 # count of commands which is assigned
# to False group, but will be moved
# to this group.
self.items = [] # items in this group
if val is not None:
self.items.append(val)
self.ok = True # True if no error from any command in group so far
def __init__(self):
self.groups = {False: self.value()}
self.lock = threading.Lock()
def item_list(self, id):
""" Return copy of the value list """
with self.lock:
return self.groups[id].items[:]
def remove(self, id):
""" Remove the group """
with self.lock:
del self.groups[id]
def remove_item(self, id, val):
with self.lock:
self.groups[id].items.remove(val)
def add(self, id, val):
with self.lock:
if id in self.groups:
self.groups[id].items.append(val)
else:
self.groups[id] = self.value(val)
self.groups[id].count += 1
def ensure(self, id):
"""if id does not exit, create it without any value"""
with self.lock:
if not id in self.groups:
self.groups[id] = self.value()
def get_count(self, id):
with self.lock:
if id not in self.groups:
return 0
return self.groups[id].count
def dec_count(self, id):
with self.lock:
c = self.groups[id].count - 1
if c < 0:
raise ValueError
self.groups[id].count = c
return c
def get_ok(self, id):
with self.lock:
return self.groups[id].ok
def set_ok(self, id, to):
with self.lock:
self.groups[id].ok = to
def ids(self):
with self.lock:
return self.groups.keys()
# modification to reserve blocked commands to corresponding groups
def inc_count_for_blocked(self, id):
with self.lock:
if not id in self.groups:
self.groups[id] = self.value()
self.groups[id].count += 1
self.groups[id].count_in_false += 1
def add_for_blocked(self, id, val):
# modification of add(), in order to move command from False group
# to actual group
with self.lock:
# id must be registered before
self.groups[id].items.append(val)
# count does not change (already considered
# in inc_count_for_blocked), but decrease count_in_false.
c = self.groups[id].count_in_false - 1
if c < 0:
raise ValueError
self.groups[id].count_in_false = c
# pool of processes to run parallel jobs, must not be part of any object that
# is pickled for transfer to these processes, ie it must be global
_pool = None
# object holding results, must also be global
_groups = _Groups()
# results collecting thread
_results = None
_stop_results = threading.Event()
class _todo(object):
""" holds the parameters for commands waiting on others """
def __init__(self, group, command, arglist, kwargs):
self.group = group # which group it should run as
self.command = command # string command
self.arglist = arglist # command arguments
self.kwargs = kwargs # keywork args for the runner
def _results_handler( builder, delay=0.01):
""" Body of thread that stores results in .deps and handles 'after'
conditions
"builder" the builder used """
try:
while not _stop_results.isSet():
# go through the lists and check any results available
for id in _groups.ids():
if id is False: continue # key of False is _afters not _runnings
for r in _groups.item_list(id):
if r.results is None and r.async_result.ready():
try:
d, o = r.async_result.get()
except ExecutionError as e:
r.results = e
_groups.set_ok(id, False)
message, data, status = e
printerr("fabricate: " + message)
else:
builder.done(r.command, d, o) # save deps
r.results = (r.command, d, o)
_groups.dec_count(id)
# check if can now schedule things waiting on the after queue
for a in _groups.item_list(False):
still_to_do = sum(_groups.get_count(g) for g in a.afters)
no_error = all(_groups.get_ok(g) for g in a.afters)
if False in a.afters:
still_to_do -= 1 # don't count yourself of course
if still_to_do == 0:
if isinstance(a.do, _todo):
if no_error:
async_result = _pool.apply_async(_call_strace, a.do.arglist,
a.do.kwargs)
_groups.add_for_blocked(a.do.group, _running(async_result, a.do.command))
else:
# Mark the command as not done due to errors
r = _running(None, a.do.command)
_groups.add_for_blocked(a.do.group, r)
r.results = False
_groups.set_ok(a.do.group, False)
_groups.dec_count(a.do.group)
elif isinstance(a.do, threading_condition):
# is this only for threading_condition in after()?
a.do.acquire()
# only mark as done if there is no error
a.done = no_error
a.do.notify()
a.do.release()
# else: #are there other cases?
_groups.remove_item(False, a)
_groups.dec_count(False)
_stop_results.wait(delay)