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
89 # xxx missing: something that outputs raw python stuff like
91 # that would belong in the export to OF
93 @$(foreach id,$(ALL_NODE_IDS),echo $(id)=$(call display,$(id)) has ip/network set to $(IP_$(id));)
95 @$(foreach link,$(LINKS), echo $(call display,$(call leftnode,$(link))) '====>' $(call display,$(call rightnode,$(link)));)
97 @$(foreach id,$(ALL_NODE_IDS), echo $(call display,$(id)) has controller $(call default,CONTROLLER,$(id));)
98 .PHONY: shownodes showhostnames showips showlinks showcontrollers
100 sshchecks: $(foreach id,$(ALL_NODE_IDS),sshcheck-$(id))
102 ovsversions: $(foreach id,$(ALL_NODE_IDS),ovsversion-$(id))
104 # more general form; run with make sshs SSH-COMMAND="bla bla bla"
105 sshs: $(foreach id,$(ALL_NODE_IDS),ssh-$(id))
107 showdpids: $(foreach id,$(ALL_NODE_IDS),showdpid-$(id))
109 showmacs: $(foreach id,$(ALL_NODE_IDS),showmac-$(id))
111 showports: $(foreach id,$(ALL_NODE_IDS),showports-$(id))
114 DBS=$(foreach id,$(ALL_NODE_IDS),cache/db.$(id))
118 SWITCHS=$(foreach id,$(ALL_NODE_IDS),cache/switch.$(id))
125 stop:$(foreach id,$(ALL_NODE_IDS),cache/stop.$(id))
128 status:$(foreach id,$(ALL_NODE_IDS),cache/status.$(id))
131 BRIDGES=$(foreach id,$(ALL_NODE_IDS),cache/bridge.$(id))
135 CONTROLLERS=$(foreach id,$(ALL_NODE_IDS),cache/controller.$(id))
136 controllers: $(CONTROLLERS)
139 del-controllers: $(foreach id,$(ALL_NODE_IDS),del-controller-$(id))
140 .PHONY: del-controllers
142 ### node-oriented targets
143 # check ssh connectivity
145 @if $(SSH) $(HOST_$*) hostname &> /dev/null; then echo "ssh on" $(call display,$*) "OK" ; \
146 else echo "ssh on" $(call display,$*) "KO !!!"; fi
149 @OVSVERSION=$$($(SSH) $(HOST_$*) rpm -q sliver-openvswitch); echo $(call display,$*) has $$OVSVERSION
152 @$(SSH) $(HOST_$*) $(SUDO) $(SSH-COMMAND)
155 @echo $*_DPID=0x$$( $(SSH) $(HOST_$*) $(SUDO) ovs-vsctl get bridge $(BRIDGE) datapath_id | sed -e 's,",,g')
158 @echo $*_MAC=\"$$( $(SSH) $(HOST_$*) $(SUDO) sliver-ovs show-mac)\"
161 @$(SSH) $(HOST_$*) $(SUDO) ovs-ofctl show $(BRIDGE) \
162 | perl -nle '/(\d+)\(L(.*?)\Q$(SEP)\E(.*?)\):/ && \
163 print "PORT_".("$$2" eq "$*" ? "$$2_$$3" : "$$3_$$2")."=$$1"'
164 # should probably replace sshcheck
165 cache/status.%: FORCE
166 @echo "=== DB and SWITCH processes on $(call display,$*)"
167 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs status ||:
170 @echo "IP lookup for $(call display,$*)"
171 @host $(HOST_$*) | sed -n 's/^.*has address *//p' > $@
174 @echo "Starting db server on $(call display,$*) - logs in $(call log,$@)"
175 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs start-db &> $(call log,$@) && touch $@
177 cache/switch.%: | cache/db.%
178 @echo "Starting vswitchd on $(call display,$*) - logs in $(call log,$@)"
179 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs start-switch &> $(call log,$@) && touch $@
181 cache/bridge.%: | cache/db.%
182 @echo "Creating bridge on $(call display,$*) - logs in $(call log,$@)"
183 @$(SSH) $(HOST_$*) $(SUDO) \
184 sliver-ovs create-bridge $(BRIDGE) $(IP_$*) $(call default,BROPTIONS,$*) &> $(call log,$@) \
185 && { echo "IP_$*=$(IP_$*)"; echo "BROPTIONS_$*=$(call default,BROPTIONS,$*)"; } > $@
187 cache/controller.%: cache/bridge.%
188 @echo "Setting controller $(call default,CONTROLLER,$*) on $(call display,$*) - logs in $(call log,$@)"
189 @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl set-controller $(BRIDGE) $(call default,CONTROLLER,$*) &> $(call log,$@) \
190 && echo "CONTROLLER_$*=$(call default,CONTROLLER,$*)" > $@
192 # xxx this probably needs a more thorough cleanup in cache/
193 cache/stop.%: del-bridge.%
194 @echo "Stopping switch & db on $(call display,$*)"
195 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop && rm cache/switch.$* cache/db.$*
197 ### link-oriented targets
198 # L/<nodeid1>-<node_id2>:
199 # Establish a link between nodes <node_id1> and <node_id2>
200 L/%: cache/endpoint.%@1 cache/endpoint.%@2
202 @echo "Link $* is up"
204 # U/<node_id1>-<node_id2>
205 # Tear down the link between nodes <node_id1> and <node_id2>
206 U/%: del-iface.%@1 del-iface.%@2
208 @echo "Deleted link $*"
210 # del-bridge.<node_id>: Delete the bridge on node <node_id>.
212 # We can do this only if the db on node <node_id> is running, but
213 # we don't need to re-delete if the db is restarted (hence the
214 # order-only dependency).
216 # Deleting a bridge also deletes all interfaces of the bridge
217 # as a side effect. This in turn invalidates local tunnel
218 # port numbers and endpoint info on both sides of each affected tunnel.
219 # The corresponding links obviously go down.
220 # Controller information is also lost.
221 # We invalidate the cache accordingly.
222 del-bridge.%: | cache/db.%
223 @echo "Deleting bridge on $(call display,$*)"
224 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs del-bridge $(BRIDGE);
225 @rm -f cache/bridge.$* \
226 cache/iface.$*$(SEP)*@1 cache/iface.*$(SEP)$*@2 \
227 cache/port.$*$(SEP)*@1 cache/port.*$(SEP)$*@2 \
228 cache/endpoint.$*$(SEP)*@? cache/endpoint.*$(SEP)$*@? \
229 L/$*$(SEP)* L/*$(SEP)$* \
232 # del-switch.<node_id>: Stops the switch daemon on <node_id>.
234 # As a side effect, the local port numbers of the tunnels
235 # are no longer valid (they will change when the daemon is restarted)
236 # and, therefore, the endpoint info on the remote side of
237 # the tunnels must be invalidated. The links also go down.
238 # Controller information is also lost.
239 # We invalidate the cache accordingly.
241 @echo "Shutting down switch on $(call display,$*)"
242 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop-switch
243 @rm -f cache/switch.$* \
244 cache/port.$*$(SEP)*@1 cache/port.*$(SEP)$*@2 \
245 cache/endpoint.$*$(SEP)*@2 cache/endpoint.*$(SEP)$*@1 \
246 L/$*$(SEP)* L/*$(SEP)$* \
249 # del-db.<node_id>: Stops the db daemon on <node_id>.
251 # This has no additional side effects.
253 @echo "Shutting down db on $(call display,$*)"
254 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop-db
257 # del-controller.<node_id>:
258 # Detaches <node_id> from the controller.
260 # This has no additional side effects.
261 del-controller-%: | cache/db.%
262 @echo "Removing controller for $(call display,$*)"
263 @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs del-controller $(BRIDGE)
264 @rm -f cache/controller.$*
266 # del-links: Shortcut to delete all currently up links.
267 del-links: $(addprefix U/,$(notdir $(wildcard L/*)))
269 # del-switchs: Shortcut to stop all currently running switch daemons.
270 del-switchs: $(addprefix del-,$(notdir $(wildcard cache/switch.*)))
272 # del-dbs: Shortcut to stop all currently running db daemona.s
273 del-dbs: $(addprefix del-,$(notdir $(wildcard cache/db.*)))
275 # shutdown: Shortcut to stop all currently running daemons.
276 shutdown: del-switchs del-dbs
278 .PHONY: del-links del-switchs del-dbs shutdown
283 @echo BRIDGE=$(BRIDGE)
284 @cat cache/bridge.* 2>/dev/null || :
285 @cat cache/controller.* 2>/dev/null || :
286 @ls L | sed 's/^/LINKS += /'
288 remote-snapshot: remote-snapshot-ips remote-snapshot-links
291 remote-snapshot-ips: $(addprefix cache/rsnap.ip.,$(CONF_NODE_IDS))
294 remote-snapshot-links: $(addprefix cache/rsnap.links.,$(CONF_NODE_IDS))
295 @sort -u /dev/null $^
297 .PHONY: remote-snapshot remote-snapshot-ips remote-snapshot-links
300 cache/rsnap.ip.%: FORCE
301 @$(SSH) $(HOST_$*) $(SUDO) \
302 sliver-ovs get-local-ip $(BRIDGE) | sed 's/^/IP_$*=/' > $@ \
303 || { rm $@; exit 1; }
305 cache/rsnap.links.%: FORCE
306 @$(SSH) $(HOST_$*) $(SUDO) \
307 sliver-ovs get-local-links $(BRIDGE) | sed -n 's/^L/LINKS += /p' > $@ \
308 || { rm $@; exit 1; }
310 ### update sliver-ovs
311 update: $(addprefix update-,$(CONF_NODE_IDS))
315 @[ -n "$(SLIVER_OVS)" ] || { echo "SLIVER_OVS not set" >&2; exit 1; }
316 @[ -f "$(SLIVER_OVS)" ] || { echo "$(SLIVER_OVS) not found" >&2; exit 1; }
317 @echo "Sending $(SLIVER_OVS) to $(call display,$*)"
318 @scp $(SSH_KEY_OPTION) -q $(SLIVER_OVS) $(SLICE)@$(call solve,$*):
319 @$(SSH) $(call solve,$*) $(SUDO) mv $(notdir $(SLIVER_OVS)) /usr/sbin/sliver-ovs
323 # del-iface.<node_id>-<node_id>@<endpoint>:
324 # Deletes the interface of link <node_id1>-<node_id2> on either
325 # <node_id1> or <node_id2>, according to <endpoint>.
327 # We need a running db daemon to do this, but we do not have to
328 # redo the delete if the db daemon is restarted.
330 # This also invalidates the local port of the tunnel and the endpoint
331 # info on both sides of the tunnel. The link goes down.
332 del-iface.%: | cache/db.$$(call get,%)
333 @echo "Removing interface for link $(call linkpart,$*) from $(call get,$*)"
334 @$(SSH) $(HOST_$(call get,$*)) \
335 $(SUDO) sliver-ovs del-port L$(call linkpart,$*)
336 @rm -f cache/iface.$* \
337 cache/port.$* cache/endpoint.$* cache/endpoint.$(call opp,$*) \
338 L/$(call linkpart,$*)
341 ### '%' here is leftid-rightid@{1,2}
342 # we retrieve % as $(*F)
343 #linkid=$(call linkpart,%)
344 #nodeid=$(call get,%)
345 #bridgefile=cache/bridge.$(nodeid)
347 # cache/iface.<node_id1>-<node_id2>@<endpoint>:
348 # Creates the interface for link <node_id1>-<node_id2> on
349 # <node_id<endpoint>>.
351 # The bridge of the local node must already exist, and we need to create
352 # the interface again if the bridge is re-created.
353 # We also need a running db daemon, but we do not need to do anything
354 # if the db daemon is restarted.
355 cache/iface.%: cache/bridge.$$(call get,%) | cache/db.$$(call get,%)
356 @echo "Creating interface for link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
357 @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) sliver-ovs create-port $(BRIDGE) \
358 L$(call linkpart,$(*F)) &> $(call log,$@) \
361 # cache/port.<node_id1>-<node_id2>@<endpoint>:
362 # Retrieves the local port of link <node_id1>-<node_id2> on
363 # node <node_id<endpoint>>.
365 # The local interface must have been created already and the
366 # switch daemon must be running. We need to retrieve the port
367 # number again if the interface is re-created, or the switch
368 # daemon is restarted.
369 cache/port.%: cache/iface.% cache/switch.$$(call get,%)
370 @echo "Getting port number for link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
371 @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) \
372 sliver-ovs get-local-endpoint L$(call linkpart,$(*F)) > $@ 2> $(call log,$@) \
373 || { rm $@; exit 1; }
376 # linkid=$(call linkpart,%)
377 # nodeid=$(call get,%)
378 # iface1=cache/iface.%
379 # iface2=cache/iface.$(call opp,%)
381 # cache/endpoint.<node_id1>-<node_id2>@<endpoint>:
382 # Sets the other side (IP address, UDP port) info for link <node_id1>-<node_id2>
383 # on <node_id<endpoint>>.
385 # We need the IP address and the UDP port of the other side and the interace of this side.
386 # We need to set the info again if any of these change.
387 cache/endpoint.%: cache/host.$$(call rget,%) cache/port.$$(call opp,%) cache/iface.%
388 @echo "Setting port number of link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
389 @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) sliver-ovs set-remote-endpoint L$(call linkpart,$(*F)) \
390 $$(cat cache/host.$(call rget,$(*F))) \
391 $$(cat cache/port.$(call opp,$(*F))) 2> $(call log,$@) \
395 CLEANTARGETS=$(addprefix del-,$(notdir $(wildcard cache/bridge.*)))
396 clean: $(CLEANTARGETS)
399 .PHONY: clean distclean
403 ( echo "digraph $(SLICE) {"; ls L | sed 's/$(SEP)/->/;s/$$/;/'; echo "}" ) > $@
410 # GMAP_SERVER, the hostname that runs an ndnmap instance
411 # GMAP_PROBES, a list of tuples of the form
412 # <linkid>=<nodeid>=<internal_linkid>=<frequency>
414 # SENDER-MUX=SENDER=3=0.5
415 # which would mean, the link 'SENDER-MUX' should be monitored at the 'SENDER' node and is coded
416 # in links.json with id=3, every half second
417 # sliver-ovs gmap-probe is designed to run in background,
418 # and so that a new run will kill any previously running instance
419 gprobes: $(foreach probe,$(GMAP_PROBES),gprobe-$(probe))
422 $(SSH) -n $(call solve,$(word 2,$(subst @, ,$(*F)))) $(SUDO) \
423 sliver-ovs gmap-probe L$(word 1,$(subst @, ,$(*F))) $(GMAP_SERVER) $(word 3,$(subst @, ,$(*F))) $(word 4,$(subst @, ,$(*F)))
425 jsons: routers.json links.json geocode.json
428 routers.json: $(CONF)
431 for n in $(CONF_NODE_IDS); do \
432 echo " $$sep\"$$n\""; \
438 links.json: $(foreach l,$(LINKS),cache/json.$(l))
440 cat $^ | sed '2,$$s/^/, /'; \
444 cache/json.%: $(CONF)
445 @echo "{\"id\": $($*_linkid), \"start\": \"$(call get,$*@1)\", \"end\": \"$(call get,$*@2)\"}" > $@
447 geocode.json: $(foreach n,$(CONF_NODE_IDS),cache/geocode.$(n))
458 cache/geocode.%: cache/loc.% $(CONF)
459 @{ echo "\"$*\": {"; \
460 echo " \"name\": \"$(HOST_$*)\","; \
461 echo " \"shortname\": \"$*\","; \
462 echo " \"site\": \"\","; \
463 echo " \"backbone\": false,"; \
464 echo " \"position\": [ $(shell cat cache/loc.$*) ]"; \
469 @wget -O - 'http://freegeoip.net/csv/$(HOST_$*)' | \
470 awk -F, '{ printf "%s, %s\n", $$8, $$9 }' > $@
473 # 'virtual' targets in that there's no real file attached
474 define node_shortcuts
475 sshcheck.$(1): sshcheck-$(1) FORCE
476 db.$(1): cache/db.$(1) FORCE
477 switch.$(1): cache/switch.$(1) FORCE
478 start.$(1): cache/start.$(1) FORCE
479 stop.$(1): cache/stop.$(1) FORCE
480 status.$(1): cache/status.$(1) FORCE
481 bridge.$(1): cache/bridge.$(1) FORCE
482 host.$(1): cache/host.$(1) FORCE
483 controller.$(1): cache/controller.$(1) FORCE
484 # switch already depends on db, but well
485 cache/start.$(1): cache/db.$(1) cache/switch.$(1) FORCE
488 $(foreach id,$(ALL_NODE_IDS), $(eval $(call node_shortcuts,$(id))))
490 define link_shortcuts
491 iface.%: cache/iface.%
492 endpoint.%: cache/endpoint.%
495 $(foreach id,$(ALL_LINK_IDS), $(eval $(call link_shortcuts,$(id))))
500 #################### convenience, for debugging only
501 # make +foo : prints the value of $(foo)
502 # make ++foo : idem but verbose, i.e. foo=$(foo)
503 ++%: varname=$(subst +,,$@)
505 @echo "$(varname)=$($(varname))"
506 +%: varname=$(subst +,,$@)
508 @echo "$($(varname))"