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
|
# Copyright 2020 MongoDB Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
import math
import os
import re
import subprocess
import SCons
from pkg_resources import parse_version
# This is the oldest version of ccache that offers support for -gsplit-dwarf
_ccache_version_min = parse_version("3.2.3")
_ccache_version_found = None
def exists(env):
"""Look for a viable ccache implementation that meets our version requirements."""
# If we already generated, we definitely exist
if "CCACHE_VERSION" in env:
return True
ccache = env.get("CCACHE", False)
if not ccache:
return False
ccache = env.WhereIs(ccache)
if not ccache:
return False
pipe = SCons.Action._subproc(
env,
SCons.Util.CLVar(ccache) + ["--version"],
stdin="devnull",
stderr="devnull",
stdout=subprocess.PIPE,
)
if pipe.wait() != 0:
return False
validated = False
for line in pipe.stdout:
line = line.decode("utf-8")
if validated:
continue # consume all data
version_banner = re.search(r"^ccache version", line)
if not version_banner:
continue
ccache_version = re.split("ccache version (.+)", line)
if len(ccache_version) < 2:
continue
global _ccache_version_found
_ccache_version_found = parse_version(ccache_version[1])
if _ccache_version_found >= _ccache_version_min:
validated = True
return validated
def generate(env):
"""Add ccache support."""
# If we have already generated the tool, don't generate it again.
if "CCACHE_VERSION" in env:
return
# If we can't find ccache, or it is too old a version, don't
# generate.
if not exists(env):
return
# Propagate CCACHE related variables into the command environment
for var, host_value in os.environ.items():
if var.startswith("CCACHE_"):
env["ENV"][var] = host_value
# SERVER-48289: Adding roll-your-own CFLAGS and CXXFLAGS can cause some very "weird" issues
# with using icecc and ccache if they turn out not to be supported by the compiler. Rather
# than try to filter each and every flag someone might try for the ones we know don't
# work, we'll just let the compiler ignore them. A better approach might be to pre-filter
# flags coming in from the environment by passing them through the appropriate *IfSupported
# method, but that's a much larger effort.
if env.ToolchainIs("clang"):
env.AppendUnique(CCFLAGS=["-Qunused-arguments"])
# Record our found CCACHE_VERSION. Other tools that need to know
# about ccache (like iecc) should query this variable to determine
# if ccache is active. Looking at the CCACHE variable in the
# environment is not sufficient, since the user may have set it,
# but it doesn't work or is out of date.
env["CCACHE_VERSION"] = _ccache_version_found
# Set up a performant ccache configuration. Here, we don't use a second preprocessor and
# pass preprocessor arguments that deterministically expand source files so a stable
# hash can be calculated on them. This both reduces the amount of work ccache needs to
# do and increases the likelihood of a cache hit.
env["ENV"]["CCACHE_NOCPP2"] = 1
if env.ToolchainIs("clang"):
env.AppendUnique(CCFLAGS=["-frewrite-includes"])
elif env.ToolchainIs("gcc"):
env.AppendUnique(CCFLAGS=["-fdirectives-only"])
# Make a generator to expand to CCACHE in the case where we are
# not a conftest. We don't want to use ccache for configure tests
# because we don't want to use icecream for configure tests, but
# when icecream and ccache are combined we can't easily filter out
# configure tests for icecream since in that combination we use
# CCACHE_PREFIX to express the icecc tool, and at that point it is
# too late for us to meaningfully filter out conftests. So we just
# disable ccache for conftests entirely. Which feels safer
# somehow anyway.
def ccache_generator(target, source, env, for_signature):
if "conftest" not in str(target[0]):
return '$CCACHE'
return ''
env['CCACHE_GENERATOR'] = ccache_generator
# Add ccache to the relevant command lines. Wrap the reference to
# ccache in the $( $) pattern so that turning ccache on or off
# doesn't invalidate your build.
env["CCCOM"] = "$( $CCACHE_GENERATOR $)" + env["CCCOM"]
env["CXXCOM"] = "$( $CCACHE_GENERATOR $)" + env["CXXCOM"]
env["SHCCCOM"] = "$( $CCACHE_GENERATOR $)" + env["SHCCCOM"]
env["SHCXXCOM"] = "$( $CCACHE_GENERATOR $)" + env["SHCXXCOM"]
|
