Skip to main content

Lazy GNU make variables

GNU make has two 'flavors' of variable: simple and recursive. Everyone is familiar the the recursive style (which uses = for definition):

    BAR = banana
    FOO = one $(BAR), two $(BAR)s
    BAR = guava

The value of FOO is determined each time FOO is used. In a large Makefile that can mean that FOO is expanded over and over again. If expanding FOO is an expensive operation then determining its value each time can slow down the Makefile. For example,

    TODAY = $(shell date +%d/%m/%y)

would be very expensive is it would shell out to run date every time TODAY is used (and might have the strange effect of returning different dates if you run your make near midnight).

(I've written about that before and in my book on GNU make)

The other flavor of make variable is simple: its value is fixed the moment it's defined:

    BAR = banana
    FOO := one $(BAR), two $(BAR)s
    BAR = guava

There FOO is set to one banana, two bananas and not one guava, two guavas (as was the case above) because the right hand side of the := is expanded when FOO is being defined and BAR has the value banana at that point.

But suppose you wanted a mixture of the two: a variable that is only ever expanded once and only expanded if it is used. This might be useful if the variable was used rarely as part of the build and was expensive to expand.

You can concoct a recipe for that like this. Suppose you want to define a variable FOO to have value expensive-to-calculate then you can use the following pattern:

    FOO = $(eval FOO := expensive-to-evaluate)$(FOO)

It's initially a recursive variable and so the right-hand side is not expanded until it is used. But the first time it is used FOO is redefined (by the $(eval)) and becomes a simple variable with the value of expensive-to-evaluate.

Having become a simple variable it's possible to return its value (note that if FOO was still recursive it would not be allowed to reference itself like that).

You can see that in action with the following Makefile. To make it clear when NOW is actually expanded I've added a call to $(info). And calls to $(flavor) to show when NOW changes from recursive to simple.

    $(info Start Parse)

    NOW = $(eval NOW := $(info Expand NOW)$(shell date -u))$(NOW)

    .PHONY: all foo
    all: foo ; @echo "[email protected] /    $(flavor NOW) / $(NOW) / $(flavor NOW)"
    foo: ; @echo "[email protected] / $(flavor NOW) / $(NOW) / $(flavor NOW)" && sleep 1

    $(info End Parse)

Which will output

    Start Parse
    End Parse
    Expand NOW
    foo / recursive / Sat Jul 23 15:01:15 UTC 2016 / simple
    all /    simple / Sat Jul 23 15:01:15 UTC 2016 / simple

The one gotcha with this is that you need to be sure that when NOW is expanded any variable it depends on have the values you expect.

It's possible to wrap that up in a function like this:

    $(info Start Parse)

    make-lazy = $(eval $1 = $​$(eval $1 := $(value $(1)))$​$($1))

    NOW = $(info Expand NOW)$(shell date -u)
    $(call make-lazy,NOW)

    .PHONY: all foo
    all: foo ; @echo "[email protected] /    $(flavor NOW) / $(NOW) / $(flavor NOW)"

    foo: ; @echo "[email protected] / $(flavor NOW) / $(NOW) / $(flavor NOW)" && sleep 1

    $(info End Parse)

Just $(call) make-lazy on any recursive variable to make it lazy.

Comments

Anonymous said…
I ran in to problems with GNU make sometimes crashing if I recursively modified a variable from within the variable.

I've ended up with the following macro:
cache = $(eval $1 = \
$$(if $$(cache.$1),,$$(eval cache.$1 := $(value 2)))$$(cache.$1))


Using it needs doubled $ signs, e.g:

$(call cache,LDSTDCXX,$$(realpath $$(shell g++ --print-file-name=libstdc++.so)))


My original macro that caused GNU make to crash sometimes was just:

cache = $(eval $1 = $$(eval $1 := $(value 2))$$($1))
Anonymous said…
I Wonder if this could this break make -j parallelism one day
Victor Shih said…
I use this technique frequently, having seen it here.

This tended to segfault in GNU make around version 3.81 though, due this bug. This has been fixed in more recent versions, and there is even a patch for 3.81 mentioned.

One situation I haven't found a solution for is, is there a way to do this for pattern-specific variables?

Popular posts from this blog

Your last name contains invalid characters

My last name is "Graham-Cumming". But here's a typical form response when I enter it: Does the web site have any idea how rude it is to claim that my last name contains invalid characters? Clearly not. What they actually meant is: our web site will not accept that hyphen in your last name. But do they say that? No, of course not. They decide to shove in my face the claim that there's something wrong with my name. There's nothing wrong with my name, just as there's nothing wrong with someone whose first name is Jean-Marie, or someone whose last name is O'Reilly. What is wrong is that way this is being handled. If the system can't cope with non-letters and spaces it needs to say that. How about the following error message: Our system is unable to process last names that contain non-letters, please replace them with spaces. Don't blame me for having a last name that your system doesn't like, whose fault is that? Saying "Your

All the symmetrical watch faces (and code to generate them)

If you ever look at pictures of clocks and watches in advertising they are set to roughly 10:10 which is meant to be the most attractive (smiling!) position for the hands . They are actually set to 10:09.14 if the hands are truly symmetrical. CC BY 2.0 image by Shinji I wanted to know what all the possible symmetrical watch faces are and so I wrote some code using Processing. Here's the output (there's one watch face missing, 00:00 or 12:00, because it's very boring): The key to writing this is to figure out the relationship between the hour and minute hands when the watch face is symmetrical. In an hour the minute hand moves through 360° and the hour hand moves through 30° (12 hours are shown on the watch face and 360/12 = 30). The core loop inside the program is this:   for (int h = 0; h <= 12; h++) {     float m = (360-30*float(h))*2/13;     int s = round(60*(m-floor(m)));     int col = h%6;     int row = floor(h/6);     draw_clock((r+f)*(2*col+1), (r+f)*(row*2+1),

The Elevator Button Problem

User interface design is hard. It's hard because people perceive apparently simple things very differently. For example, take a look at this interface to an elevator: From flickr Now imagine the following situation. You are on the third floor of this building and you wish to go to the tenth. The elevator is on the fifth floor and there's an indicator that tells you where it is. Which button do you press? Most people probably say: "press up" since they want to go up. Not long ago I watched someone do the opposite and questioned them about their behavior. They said: "well the elevator is on the fifth floor and I am on the third, so I want it to come down to me". Much can be learnt about the design of user interfaces by considering this, apparently, simple interface. If you think about the elevator button problem you'll find that something so simple has hidden depths. How do people learn about elevator calling? What's the right amount of