2 # conf.mk is expected to define
3 # HOST_<id> and IP_<id> for all nodes involved, as well as
4 # LINKS as a list of <node_id>-<node_id> elements
6 # run make CONF=anotherconfig.mk if you need several configs
11 # if undefined in the conf file, use single dash
14 # bridge name (XXX the same on all nodes)
20 flip=$(if $(findstring 1,$(1)),2,1)
22 cutsep=$(subst $(SEP), ,$(1))
24 leftnode=$(word 1,$(call cutsep,$(1)))
25 # rightnode (x-y) -> y
26 rightnode=$(word 2,$(call cutsep,$(1)))
28 linkpart=$(word 1,$(subst @, ,$(1)))
30 endpart=$(word 2,$(subst @, ,$(1)))
33 get=$(word $(call endpart,$(1)),$(call cutsep,$(call linkpart,$(1))))
36 opp=$(call linkpart,$(1))@$(call flip,$(call endpart,$(1)))
39 rget=$(call get,$(call opp,$(1)))
41 default=$(if $($(1)_$(2)),$($(1)_$(2)),$($(1)))
44 # can be redefined in conf.mk if that's not the expected behaviour
45 display?=host $(1) aka $(call solve,$(1))
48 log=$(addprefix log/,$(notdir $(1)))
50 #################### set variables after conf.mk
54 SSH_KEY_OPTION ?= -i $(SSH_KEY)
57 SSH_OPTIONS ?= $(SSH_KEY_OPTION) -l $(SLICE)
58 SSH = ssh $(SSH_OPTIONS)
62 ALL_NODE_IDS=$(sort $(foreach link,$(LINKS),$(call leftnode,$(link))) $(foreach link,$(LINKS),$(call rightnode,$(link))))
63 ALL_NODE_HOSTS=$(foreach id,$(ALL_NODE_IDS),$(call solve,$(id)))
64 ALL_LINK_IDS=$(addsuffix @1,$(LINKS)) $(addsuffix @2,$(LINKS))
65 CONF_NODE_IDS=$(subst HOST_,,$(filter HOST_%,$(.VARIABLES)))
70 @[ -d L ] || ( echo Creating tmp dir L; mkdir L)
71 @[ -d log ] || (echo Creating tmp dir log; mkdir log)
72 @[ -d cache ] || ( echo Creating tmp dir cache; mkdir cache)
79 LINKTARGETS=$(addprefix L/,$(LINKS))
83 # could also do make ++SLICE
84 showslice: ++SLICE FORCE
87 @$(foreach id,$(ALL_NODE_IDS),echo $(id)=$(call display,$(id));)
88 showhostnames: ++ALL_NODE_HOSTS
90 @$(foreach id,$(ALL_NODE_IDS),echo $(id)=$(call display,$(id)) has ip/network set to $(IP_$(id));)
92 @$(foreach link,$(LINKS), echo $(call display,$(call leftnode,$(link))) '====>' $(call display,$(call rightnode,$(link)));)
94 @$(foreach id,$(ALL_NODE_IDS), echo $(call display,$(id)) has controller $(call default,CONTROLLER,$(id));)
95 .PHONY: shownodes showhostnames showips showlinks showcontrollers
97 sshchecks: $(foreach id,$(ALL_NODE_IDS),sshcheck-$(id))
99 ovsversions: $(foreach id,$(ALL_NODE_IDS),ovsversion-$(id))
101 # more general form; run with make sshs SSH-COMMAND="bla bla bla"
102 sshs: $(foreach id,$(ALL_NODE_IDS),ssh-$(id))
105 DBS=$(foreach id,$(ALL_NODE_IDS),cache/db.$(id))
109 SWITCHS=$(foreach id,$(ALL_NODE_IDS),cache/switch.$(id))
116 stop:$(foreach id,$(ALL_NODE_IDS),cache/stop.$(id))
119 status:$(foreach id,$(ALL_NODE_IDS),cache/status.$(id))
122 BRIDGES=$(foreach id,$(ALL_NODE_IDS),cache/bridge.$(id))
126 CONTROLLERS=$(foreach id,$(ALL_NODE_IDS),cache/controller.$(id))
127 controllers: $(CONTROLLERS)
130 del-controllers: $(foreach id,$(ALL_NODE_IDS),del-controller-$(id))
131 .PHONY: del-controllers
133 ### node-oriented targets
134 # check ssh connectivity
136 @if $(SSH) $(HOST_$*) hostname &> /dev/null; then echo "ssh on" $(call display,$*) "OK" ; \
137 else echo "ssh on" $(call display,$*) "KO !!!"; fi
140 @OVSVERSION=$$($(SSH) $(HOST_$*) rpm -q sliver-openvswitch); echo $(call display,$*) has $$OVSVERSION
143 @$(SSH) $(HOST_$*) $(SUDO) $(SSH-COMMAND)
145 # should probably replace sshcheck
146 cache/status.%: FORCE
147 @echo "=== DB and SWITCH processes on $(call display,$*)"
148 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs status ||:
151 @echo "IP lookup for $(call display,$*)"
152 @host $(HOST_$*) | sed -n 's/^.*has address *//p' > $@
155 @echo "Starting db server on $(call display,$*) - logs in $(call log,$@)"
156 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs start-db &> $(call log,$@) && touch $@
158 cache/switch.%: | cache/db.%
159 @echo "Starting vswitchd on $(call display,$*) - logs in $(call log,$@)"
160 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs start-switch &> $(call log,$@) && touch $@
162 cache/bridge.%: | cache/db.%
163 @echo "Creating bridge on $(call display,$*) - logs in $(call log,$@)"
164 @$(SSH) $(HOST_$*) $(SUDO) \
165 sliver-ovs create-bridge $(BRIDGE) $(IP_$*) $(call default,BROPTIONS,$*) &> $(call log,$@) \
168 cache/controller.%: cache/bridge.%
169 @echo "Setting controller $(call default,CONTROLLER,$*) on $(call display,$*) - logs in $(call log,$@)"
170 @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl set-controller $(BRIDGE) $(call default,CONTROLLER,$*) &> $(call log,$@) \
173 # xxx this probably needs a more thorough cleanup in cache/
174 cache/stop.%: del-bridge.%
175 @echo "Stopping switch & db on $(call display,$*)"
176 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop && rm cache/switch.$* cache/db.$*
178 ### link-oriented targets
179 # L/<nodeid1>-<node_id2>:
180 # Establish a link between nodes <node_id1> and <node_id2>
181 L/%: cache/endpoint.%@1 cache/endpoint.%@2
183 @echo "Link $* is up"
185 # U/<node_id1>-<node_id2>
186 # Tear down the link between nodes <node_id1> and <node_id2>
187 U/%: del-iface.%@1 del-iface.%@2
189 @echo "Deleted link $*"
191 # del-bridge.<node_id>: Delete the bridge on node <node_id>.
193 # We can do this only if the db on node <node_id> is running, but
194 # we don't need to re-delete if the db is restarted (hence the
195 # order-only dependency).
197 # Deleting a bridge also deletes all interfaces of the bridge
198 # as a side effect. This in turn invalidates local tunnel
199 # port numbers and endpoint info on both sides of each affected tunnel.
200 # The corresponding links obviously go down. We invalidate the
202 del-bridge.%: | cache/db.%
203 @echo "Deleting bridge on $(call display,$*)"
204 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs del-bridge $(BRIDGE);
205 @rm -f cache/bridge.$* \
206 cache/iface.$*$(SEP)*@1 cache/iface.*$(SEP)$*@2 \
207 cache/port.$*$(SEP)*@1 cache/port.*$(SEP)$*@2 \
208 cache/endpoint.$*$(SEP)*@? cache/endpoint.*$(SEP)$*@? \
209 L/$*$(SEP)* L/*$(SEP)$*
211 # del-switch.<node_id>: Stops the switch daemon on <node_id>.
213 # As a side effect, the local port numbers of the tunnels
214 # are no longer valid (they will change when the daemon is restarted)
215 # and, therefore, the endpoint info on the remote side of
216 # the tunnels must be invalidated. The links also go down.
217 # We invalidate the cache accordingly.
219 @echo "Shutting down switch on $(call display,$*)"
220 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop-switch
221 @rm -f cache/switch.$* \
222 cache/port.$*$(SEP)*@1 cache/port.*$(SEP)$*@2 \
223 cache/endpoint.$*$(SEP)*@2 cache/endpoint.*$(SEP)$*@1 \
224 L/$*$(SEP)* L/*$(SEP)$*
226 # del-db.<node_id>: Stops the db daemon on <node_id>.
228 # This has no additional side effects.
230 @echo "Shutting down db on $(call display,$*)"
231 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop-db
234 # del-controller.<node_id>:
235 # Detaches <node_id> from the controller.
237 # This has no additional side effects.
238 del-controller-%: | cache/db.%
239 @echo "Removing controller for $(call display,$*)"
240 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs del-controller $(BRIDGE)
241 @rm -f cache/controller.$*
243 # del-links: Shortcut to delete all currently up links.
244 del-links: $(addprefix U/,$(notdir $(wildcard L/*)))
246 # del-switchs: Shortcut to stop all currently running switch daemons.
247 del-switchs: $(addprefix del-,$(notdir $(wildcard cache/switch.*)))
249 # del-dbs: Shortcut to stop all currently running db daemona.s
250 del-dbs: $(addprefix del-,$(notdir $(wildcard cache/db.*)))
252 # shutdown: Shortcut to stop all currently running daemons.
253 shutdown: del-switchs del-dbs
255 .PHONY: del-links del-switchs del-dbs shutdown
259 remote-snapshot: remote-snapshot-ips remote-snapshot-links
262 remote-snapshot-ips: $(addprefix cache/rsnap.ip.,$(CONF_NODE_IDS))
265 remote-snapshot-links: $(addprefix cache/rsnap.links.,$(CONF_NODE_IDS))
266 @sort -u /dev/null $^
268 ### update sliver-ovs
269 update: $(addprefix update-,$(CONF_NODE_IDS))
273 @[ -n "$(SLIVER_OVS)" ] || { echo "SLIVER_OVS not set" >&2; exit 1; }
274 @[ -f "$(SLIVER_OVS)" ] || { echo "$(SLIVER_OVS) not found" >&2; exit 1; }
275 @echo "Sending $(SLIVER_OVS) to $(call display,$*)"
276 @scp -q $(SLIVER_OVS) $(SLICE)@$(call solve,$*):
277 @$(SSH) $(call solve,$*) $(SUDO) mv $(notdir $(SLIVER_OVS)) /usr/sbin/sliver-ovs
279 .PHONY: remote-snapshot remote-snapshot-ips remote-snapshot-links
282 @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl -- \
283 get interface $(BRIDGE) options:local_ip options:local_netmask |\
284 sed -n 's|"||g;1h;2{G;s|\(.*\)\n\(.*\)|IP_$* = \2/\1|p}' > $@ || \
288 @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl list-ifaces $(BRIDGE) | \
289 sed -n 's/^L/LINKS += /p' > $@ || \
294 # del-iface.<node_id>-<node_id>@<endpoint>:
295 # Deletes the interface of link <node_id1>-<node_id2> on either
296 # <node_id1> or <node_id2>, according to <endpoint>.
298 # We need a running db daemon to do this, but we do not have to
299 # redo the delete if the db daemon is restarted.
301 # This also invalidates the local port of the tunnel and the endpoint
302 # info on both sides of the tunnel. The link goes down.
303 del-iface.%: | cache/db.$$(call get,%)
304 @echo "Removing interface for link $(call linkpart,$*) from $(call get,$*)"
305 @$(SSH) $(HOST_$(call get,$*)) \
306 $(SUDO) sliver-ovs del-port L$(call linkpart,$*)
307 @rm -f cache/iface.$* \
308 cache/port.$* cache/endpoint.$* cache/endpoint.$(call opp,$*) \
309 L/$(call linkpart,$*)
312 ### '%' here is leftid-rightid@{1,2}
313 # we retrieve % as $(*F)
314 #linkid=$(call linkpart,%)
315 #nodeid=$(call get,%)
316 #bridgefile=cache/bridge.$(nodeid)
318 # cache/iface.<node_id1>-<node_id2>@<endpoint>:
319 # Creates the interface for link <node_id1>-<node_id2> on
320 # <node_id<endpoint>>.
322 # The bridge of the local node must already exist, and we need to create
323 # the interface again if the bridge is re-created.
324 # We also need a running db daemon, but we do not need to do anything
325 # if the db daemon is restarted.
326 cache/iface.%: cache/bridge.$$(call get,%) | cache/db.$$(call get,%)
327 @echo "Creating interface for link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
328 @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) sliver-ovs create-port $(BRIDGE) \
329 L$(call linkpart,$(*F)) &> $(call log,$@) \
332 # cache/port.<node_id1>-<node_id2>@<endpoint>:
333 # Retrieves the local port of link <node_id1>-<node_id2> on
334 # node <node_id<endpoint>>.
336 # The local interface must have been created already and the
337 # switch daemon must be running. We need to retrieve the port
338 # number again if the interface is re-created, or the switch
339 # daemon is restarted.
340 cache/port.%: cache/iface.% cache/switch.$$(call get,%)
341 @echo "Getting port number for link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
342 @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) \
343 ovs-appctl netdev-tunnel/get-port L$(call linkpart,$(*F)) > $@ 2> $(call log,$@) \
344 || { rm $@; exit 1; }
347 # linkid=$(call linkpart,%)
348 # nodeid=$(call get,%)
349 # iface1=cache/iface.%
350 # iface2=cache/iface.$(call opp,%)
352 # cache/endpoint.<node_id1>-<node_id2>@<endpoint>:
353 # Sets the other side (IP address, UDP port) info for link <node_id1>-<node_id2>
354 # on <node_id<endpoint>>.
356 # We need the IP address and the UDP port of the other side and the interace of this side.
357 # We need to set the info again if any of these change.
358 cache/endpoint.%: cache/host.$$(call rget,%) cache/port.$$(call opp,%) cache/iface.%
359 @echo "Setting port number of link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
360 @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) sliver-ovs set-remote-endpoint L$(call linkpart,$(*F)) \
361 $$(cat cache/host.$(call rget,$(*F))) \
362 $$(cat cache/port.$(call opp,$(*F))) 2> $(call log,$@) \
366 CLEANTARGETS=$(addprefix del-,$(notdir $(wildcard cache/bridge.*)))
367 clean: $(CLEANTARGETS)
370 .PHONY: clean distclean
374 ( echo "digraph $(SLICE) {"; ls L | sed 's/$(SEP)/->/;s/$$/;/'; echo "}" ) > $@
381 # GMAP_SERVER, the hostname that runs an ndnmap instance
382 # GMAP_PROBES, a list of tuples of the form
383 # <linkid>=<nodeid>=<internal_linkid>=<frequency>
385 # SENDER-MUX=SENDER=3=0.5
386 # which would mean, the link 'SENDER-MUX' should be monitored at the 'SENDER' node and is coded
387 # in links.json with id=3, every half second
388 # sliver-ovs gmap-probe is designed to run in background,
389 # and so that a new run will kill any previously running instance
390 gprobes: $(foreach probe,$(GMAP_PROBES),gprobe-$(probe))
393 $(SSH) -n $(call solve,$(word 2,$(subst @, ,$(*F)))) $(SUDO) \
394 sliver-ovs gmap-probe L$(word 1,$(subst @, ,$(*F))) $(GMAP_SERVER) $(word 3,$(subst @, ,$(*F))) $(word 4,$(subst @, ,$(*F)))
397 # 'virtual' targets in that there's no real file attached
398 define node_shortcuts
399 sshcheck.$(1): sshcheck-$(1) FORCE
400 db.$(1): cache/db.$(1) FORCE
401 switch.$(1): cache/switch.$(1) FORCE
402 start.$(1): cache/start.$(1) FORCE
403 stop.$(1): cache/stop.$(1) FORCE
404 status.$(1): cache/status.$(1) FORCE
405 bridge.$(1): cache/bridge.$(1) FORCE
406 host.$(1): cache/host.$(1) FORCE
407 # switch already depends on db, but well
408 cache/start.$(1): cache/db.$(1) cache/switch.$(1) FORCE
411 $(foreach id,$(ALL_NODE_IDS), $(eval $(call node_shortcuts,$(id))))
413 define link_shortcuts
414 iface.%: cache/iface.%
415 endpoint.%: cache/endpoint.%
418 $(foreach id,$(ALL_LINK_IDS), $(eval $(call link_shortcuts,$(id))))
423 #################### convenience, for debugging only
424 # make +foo : prints the value of $(foo)
425 # make ++foo : idem but verbose, i.e. foo=$(foo)
426 ++%: varname=$(subst +,,$@)
428 @echo "$(varname)=$($(varname))"
429 +%: varname=$(subst +,,$@)
431 @echo "$($(varname))"