planetlab/exp-tool/Makefile

   1 # see README
   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
   5
   6 # run make CONF=anotherconfig.mk if you need several configs
   7
   8 CONF ?= conf.mk
   9 include $(CONF)
  10
  11 # if undefined in the conf file, use single dash
  12 SEP?=-
  13
  14 # bridge name (XXX the same on all nodes)
  15 BRIDGE?=$(SLICE)
  16
  17 ### helper functions
  18 # flip(1) = 2
  19 # flip(2) = 1
  20 flip=$(if $(findstring 1,$(1)),2,1)
  21 # cutsep (x-y)-> x y
  22 cutsep=$(subst $(SEP), ,$(1))
  23 # leftnode (x-y) -> x
  24 leftnode=$(word 1,$(call cutsep,$(1)))
  25 # rightnode (x-y) -> y
  26 rightnode=$(word 2,$(call cutsep,$(1)))
  27 # linkpart(x@y) = x
  28 linkpart=$(word 1,$(subst @, ,$(1)))
  29 # endpart(x@y) = y
  30 endpart=$(word 2,$(subst @, ,$(1)))
  31 # get(x-y@1) = x
  32 # get(x-y@2) = y
  33 get=$(word $(call endpart,$(1)),$(call cutsep,$(call linkpart,$(1))))
  34 # opp(x-y@1) = x-y@2
  35 # opp(x-y@2) = x-y@1
  36 opp=$(call linkpart,$(1))@$(call flip,$(call endpart,$(1)))
  37 # rget(x-y@1) = y
  38 # rget(x-y@2) = x
  39 rget=$(call get,$(call opp,$(1)))
  40 ###
  41 default=$(if $($(1)_$(2)),$($(1)_$(2)),$($(1)))
  42 solve=$(HOST_$(1))
  43 solve_ip=$(IP_$(1))
  44 # can be redefined in conf.mk if that's not the expected behaviour
  45 display?=host $(1) aka $(call solve,$(1))
  46
  47 # log file name
  48 log=$(addprefix log/,$(notdir $(1)))
  49
  50 #################### set variables after conf.mk
  51 ifeq "$(SSH_KEY)" ""
  52 SSH_KEY_OPTION ?=
  53 else
  54 SSH_KEY_OPTION ?= -i $(SSH_KEY)
  55 endif
  56
  57 SSH_OPTIONS ?= $(SSH_KEY_OPTION) -l $(SLICE)
  58 SSH = ssh $(SSH_OPTIONS)
  59
  60 SUDO ?= sudo -S
  61
  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)))
  66
  67 ####################
  68 init_all: init all
  69 init:
  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)
  73 .PHONY: init_all init
  74
  75 FORCE:
  76
  77 .SECONDARY:
  78
  79 LINKTARGETS=$(addprefix L/,$(LINKS))
  80 all: $(LINKTARGETS)
  81 .PHONY: all
  82
  83 # could also do make ++SLICE
  84 showslice: ++SLICE FORCE
  85
  86 shownodes:
  87         @$(foreach id,$(ALL_NODE_IDS),echo $(id)=$(call display,$(id));)
  88 showhostnames: ++ALL_NODE_HOSTS
  89 showips:
  90         @$(foreach id,$(ALL_NODE_IDS),echo $(id)=$(call display,$(id)) has ip/network set to $(IP_$(id));)
  91 showlinks:
  92         @$(foreach link,$(LINKS), echo $(call display,$(call leftnode,$(link))) '====>' $(call display,$(call rightnode,$(link)));)
  93 showcontrollers:
  94         @$(foreach id,$(ALL_NODE_IDS), echo $(call display,$(id)) has controller $(call default,CONTROLLER,$(id));)
  95 .PHONY: shownodes showhostnames showips showlinks showcontrollers
  96
  97 sshchecks: $(foreach id,$(ALL_NODE_IDS),sshcheck-$(id))
  98 .PHONY: sshchecks
  99 ovsversions: $(foreach id,$(ALL_NODE_IDS),ovsversion-$(id))
 100 .PHONY: ovsversions
 101 # more general form; run with  make sshs SSH-COMMAND="bla bla bla"
 102 sshs: $(foreach id,$(ALL_NODE_IDS),ssh-$(id))
 103 .PHONY: sshs
 104 showdpids: $(foreach id,$(ALL_NODE_IDS),showdpid-$(id))
 105 .PHONY: showdpids
 106
 107 DBS=$(foreach id,$(ALL_NODE_IDS),cache/db.$(id))
 108 dbs: $(DBS)
 109 .PHONY: dbs
 110
 111 SWITCHS=$(foreach id,$(ALL_NODE_IDS),cache/switch.$(id))
 112 switchs: $(SWITCHS)
 113 .PHONY: switchs
 114
 115 start: dbs switchs
 116 .PHONY: start
 117
 118 stop:$(foreach id,$(ALL_NODE_IDS),cache/stop.$(id))
 119 .PHONY: stop
 120
 121 status:$(foreach id,$(ALL_NODE_IDS),cache/status.$(id))
 122 .PHONY: status
 123
 124 BRIDGES=$(foreach id,$(ALL_NODE_IDS),cache/bridge.$(id))
 125 bridges: $(BRIDGES)
 126 .PHONY: bridges
 127
 128 CONTROLLERS=$(foreach id,$(ALL_NODE_IDS),cache/controller.$(id))
 129 controllers: $(CONTROLLERS)
 130 .PHONY: controllers
 131
 132 del-controllers: $(foreach id,$(ALL_NODE_IDS),del-controller-$(id))
 133 .PHONY: del-controllers
 134
 135 ### node-oriented targets
 136 # check ssh connectivity
 137 sshcheck-%: FORCE
 138         @if $(SSH) $(HOST_$*) hostname &> /dev/null; then echo "ssh on" $(call display,$*) "OK" ; \
 139          else echo "ssh on" $(call display,$*) "KO !!!"; fi
 140
 141 ovsversion-%: FORCE
 142         @OVSVERSION=$$($(SSH) $(HOST_$*) rpm -q sliver-openvswitch); echo $(call display,$*) has $$OVSVERSION
 143
 144 ssh-%: FORCE
 145         @$(SSH) $(HOST_$*) $(SUDO) $(SSH-COMMAND)
 146
 147 showdpid-%: FORCE
 148         @echo $*_DPID=0x$$( $(SSH) $(HOST_$*) $(SUDO) ovs-vsctl get bridge $(BRIDGE) datapath_id | sed -e 's,",,g')
 149
 150 # should probably replace sshcheck
 151 cache/status.%: FORCE
 152         @echo "=== DB and SWITCH processes on $(call display,$*)"
 153         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs status ||:
 154
 155 cache/host.%:
 156         @echo "IP lookup for $(call display,$*)"
 157         @host $(HOST_$*) | sed -n 's/^.*has address *//p' > $@
 158
 159 cache/db.%:
 160         @echo "Starting db server on $(call display,$*) - logs in $(call log,$@)"
 161         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs start-db &> $(call log,$@) && touch $@
 162
 163 cache/switch.%: | cache/db.%
 164         @echo "Starting vswitchd on $(call display,$*) - logs in $(call log,$@)"
 165         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs start-switch &> $(call log,$@) && touch $@
 166
 167 cache/bridge.%: | cache/db.%
 168         @echo "Creating bridge on $(call display,$*) - logs in $(call log,$@)"
 169         @$(SSH) $(HOST_$*) $(SUDO) \
 170                 sliver-ovs create-bridge $(BRIDGE) $(IP_$*) $(call default,BROPTIONS,$*) &> $(call log,$@) \
 171          && touch $@
 172
 173 cache/controller.%: cache/bridge.%
 174         @echo "Setting controller $(call default,CONTROLLER,$*) on $(call display,$*) - logs in $(call log,$@)"
 175         @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl set-controller $(BRIDGE) $(call default,CONTROLLER,$*) &> $(call log,$@) \
 176          && touch $@
 177
 178 # xxx this probably needs a more thorough cleanup in cache/
 179 cache/stop.%: del-bridge.%
 180         @echo "Stopping switch & db on $(call display,$*)"
 181         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop && rm cache/switch.$* cache/db.$*
 182
 183 ### link-oriented targets
 184 # L/<nodeid1>-<node_id2>:
 185 #       Establish a link between nodes <node_id1> and <node_id2>
 186 L/%: cache/endpoint.%@1 cache/endpoint.%@2
 187         @touch $@
 188         @echo "Link $* is up"
 189
 190 # U/<node_id1>-<node_id2>
 191 #       Tear down the link between nodes <node_id1> and <node_id2>
 192 U/%: del-iface.%@1 del-iface.%@2
 193         @rm -f L/$*
 194         @echo "Deleted link $*"
 195
 196 # del-bridge.<node_id>: Delete the bridge on node <node_id>.
 197 #
 198 # We can do this only if the db on node <node_id> is running, but
 199 # we don't need to re-delete if the db is restarted (hence the
 200 # order-only dependency).
 201 #
 202 # Deleting a bridge also deletes all interfaces of the bridge
 203 # as a side effect. This in turn invalidates local tunnel
 204 # port numbers and endpoint info on both sides of each affected tunnel.
 205 # The corresponding links obviously go down.
 206 # Controller information is also lost.
 207 # We invalidate the cache accordingly.
 208 del-bridge.%: | cache/db.%
 209         @echo "Deleting bridge on $(call display,$*)"
 210         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs del-bridge $(BRIDGE);
 211         @rm -f cache/bridge.$* \
 212               cache/iface.$*$(SEP)*@1 cache/iface.*$(SEP)$*@2 \
 213               cache/port.$*$(SEP)*@1  cache/port.*$(SEP)$*@2  \
 214               cache/endpoint.$*$(SEP)*@?  cache/endpoint.*$(SEP)$*@?  \
 215               L/$*$(SEP)*             L/*$(SEP)$* \
 216               cache/controller.$*
 217
 218 # del-switch.<node_id>: Stops the switch daemon on <node_id>.
 219 #
 220 # As a side effect, the local port numbers of the tunnels
 221 # are no longer valid (they will change when the daemon is restarted)
 222 # and, therefore, the endpoint info on the remote side of
 223 # the tunnels must be invalidated. The links also go down.
 224 # Controller information is also lost.
 225 # We invalidate the cache accordingly.
 226 del-switch.%:
 227         @echo "Shutting down switch on $(call display,$*)"
 228         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop-switch
 229         @rm -f cache/switch.$* \
 230                cache/port.$*$(SEP)*@1  cache/port.*$(SEP)$*@2  \
 231                cache/endpoint.$*$(SEP)*@2  cache/endpoint.*$(SEP)$*@1  \
 232                L/$*$(SEP)*            L/*$(SEP)$* \
 233                cache/controller.$*
 234
 235 # del-db.<node_id>: Stops the db daemon on <node_id>.
 236 #
 237 # This has no additional side effects.
 238 del-db.%:
 239         @echo "Shutting down db on $(call display,$*)"
 240         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop-db
 241         @rm -f cache/db.$*
 242
 243 # del-controller.<node_id>:
 244 #       Detaches <node_id> from the controller.
 245 #
 246 # This has no additional side effects.
 247 del-controller-%: | cache/db.%
 248         @echo "Removing controller for $(call display,$*)"
 249         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs del-controller $(BRIDGE)
 250         @rm -f cache/controller.$*
 251
 252 # del-links: Shortcut to delete all currently up links.
 253 del-links: $(addprefix U/,$(notdir $(wildcard L/*)))
 254
 255 # del-switchs: Shortcut to stop all currently running switch daemons.
 256 del-switchs: $(addprefix del-,$(notdir $(wildcard cache/switch.*)))
 257
 258 # del-dbs: Shortcut to stop all currently running db daemona.s
 259 del-dbs: $(addprefix del-,$(notdir $(wildcard cache/db.*)))
 260
 261 # shutdown: Shortcut to stop all currently running daemons.
 262 shutdown: del-switchs del-dbs
 263
 264 .PHONY: del-links del-switchs del-dbs shutdown
 265
 266
 267 ### snapshots
 268 remote-snapshot: remote-snapshot-ips remote-snapshot-links
 269         @true
 270
 271 remote-snapshot-ips: $(addprefix cache/rsnap.ip.,$(CONF_NODE_IDS))
 272         @cat /dev/null $^
 273
 274 remote-snapshot-links: $(addprefix cache/rsnap.links.,$(CONF_NODE_IDS))
 275         @sort -u /dev/null $^
 276
 277 ### update sliver-ovs
 278 update: $(addprefix update-,$(CONF_NODE_IDS))
 279         @true
 280
 281 update-%: FORCE
 282         @[ -n "$(SLIVER_OVS)" ] || { echo "SLIVER_OVS not set" >&2; exit 1; }
 283         @[ -f "$(SLIVER_OVS)" ] || { echo "$(SLIVER_OVS) not found" >&2; exit 1; }
 284         @echo "Sending $(SLIVER_OVS) to $(call display,$*)"
 285         @scp -q $(SLIVER_OVS) $(SLICE)@$(call solve,$*):
 286         @$(SSH) $(call solve,$*) $(SUDO) mv $(notdir $(SLIVER_OVS)) /usr/sbin/sliver-ovs
 287
 288 .PHONY: remote-snapshot remote-snapshot-ips remote-snapshot-links
 289
 290 cache/rsnap.ip.%:
 291         @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl -- \
 292                 get interface $(BRIDGE) options:local_ip options:local_netmask |\
 293                 sed -n 's|"||g;1h;2{G;s|\(.*\)\n\(.*\)|IP_$* = \2/\1|p}' > $@ || \
 294          { rm $@; exit 1; }
 295
 296 cache/rsnap.links.%:
 297         @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl list-ifaces $(BRIDGE) | \
 298          sed -n 's/^L/LINKS += /p' > $@ || \
 299          { rm $@; exit 1; }
 300
 301 .SECONDEXPANSION:
 302
 303 # del-iface.<node_id>-<node_id>@<endpoint>:
 304 #       Deletes the interface of link <node_id1>-<node_id2> on either
 305 #       <node_id1> or <node_id2>, according to <endpoint>.
 306 #
 307 # We need a running db daemon to do this, but we do not have to
 308 # redo the delete if the db daemon is restarted.
 309 #
 310 # This also invalidates the local port of the tunnel and the endpoint
 311 # info on both sides of the tunnel. The link goes down.
 312 del-iface.%: | cache/db.$$(call get,%)
 313         @echo "Removing interface for link $(call linkpart,$*) from $(call get,$*)"
 314         @$(SSH) $(HOST_$(call get,$*)) \
 315                 $(SUDO) sliver-ovs del-port L$(call linkpart,$*)
 316         @rm -f cache/iface.$* \
 317                cache/port.$* cache/endpoint.$* cache/endpoint.$(call opp,$*) \
 318                L/$(call linkpart,$*)
 319
 320
 321 ### '%' here is leftid-rightid@{1,2}
 322 # we retrieve % as $(*F)
 323 #linkid=$(call linkpart,%)
 324 #nodeid=$(call get,%)
 325 #bridgefile=cache/bridge.$(nodeid)
 326
 327 # cache/iface.<node_id1>-<node_id2>@<endpoint>:
 328 #       Creates the interface for link <node_id1>-<node_id2> on
 329 #       <node_id<endpoint>>.
 330 #
 331 # The bridge of the local node must already exist, and we need to create
 332 # the interface again if the bridge is re-created.
 333 # We also need a running db daemon, but we do not need to do anything
 334 # if the db daemon is restarted.
 335 cache/iface.%: cache/bridge.$$(call get,%) | cache/db.$$(call get,%)
 336         @echo "Creating interface for link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
 337         @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) sliver-ovs create-port $(BRIDGE) \
 338                 L$(call linkpart,$(*F)) &> $(call log,$@) \
 339          && touch $@
 340
 341 # cache/port.<node_id1>-<node_id2>@<endpoint>:
 342 #       Retrieves the local port of link <node_id1>-<node_id2> on
 343 #       node <node_id<endpoint>>.
 344 #
 345 # The local interface must have been created already and the
 346 # switch daemon must be running. We need to retrieve the port
 347 # number again if the interface is re-created, or the switch
 348 # daemon is restarted.
 349 cache/port.%: cache/iface.% cache/switch.$$(call get,%)
 350         @echo "Getting port number for link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
 351         @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) \
 352                 sliver-ovs get-local-endpoint L$(call linkpart,$(*F)) > $@ 2> $(call log,$@) \
 353          || { rm $@; exit 1; }
 354
 355
 356 # linkid=$(call linkpart,%)
 357 # nodeid=$(call get,%)
 358 # iface1=cache/iface.%
 359 # iface2=cache/iface.$(call opp,%)
 360
 361 # cache/endpoint.<node_id1>-<node_id2>@<endpoint>:
 362 #       Sets the other side (IP address, UDP port) info for link <node_id1>-<node_id2>
 363 #       on <node_id<endpoint>>.
 364 #
 365 # We need the IP address and the UDP port of the other side and the interace of this side.
 366 # We need to set the info again if any of these change.
 367 cache/endpoint.%: cache/host.$$(call rget,%) cache/port.$$(call opp,%) cache/iface.%
 368         @echo "Setting port number of link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
 369         @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) sliver-ovs set-remote-endpoint L$(call linkpart,$(*F)) \
 370                         $$(cat cache/host.$(call rget,$(*F))) \
 371                         $$(cat cache/port.$(call opp,$(*F))) 2> $(call log,$@) \
 372          && touch $@
 373
 374 ####################
 375 CLEANTARGETS=$(addprefix del-,$(notdir $(wildcard cache/bridge.*)))
 376 clean: $(CLEANTARGETS)
 377 distclean:
 378         rm -rf L log cache
 379 .PHONY: clean distclean
 380
 381 ####################
 382 graph.dot:
 383         ( echo "digraph $(SLICE) {"; ls L | sed 's/$(SEP)/->/;s/$$/;/'; echo "}" ) > $@
 384 graph.ps: graph.dot
 385         dot -Tps < $^ > $@
 386
 387 ####################
 388 # googlemap stuff
 389 # Uses:
 390 # GMAP_SERVER, the hostname that runs an ndnmap instance
 391 # GMAP_PROBES, a list of tuples of the form
 392 # <linkid>=<nodeid>=<internal_linkid>=<frequency>
 393 # e.g.
 394 # SENDER-MUX=SENDER=3=0.5
 395 # which would mean, the link 'SENDER-MUX' should be monitored at the 'SENDER' node and is coded
 396 # in links.json with id=3, every half second
 397 # sliver-ovs gmap-probe is designed to run in background,
 398 # and so that a new run will kill any previously running instance
 399 gprobes: $(foreach probe,$(GMAP_PROBES),gprobe-$(probe))
 400
 401 gprobe-%: FORCE
 402         $(SSH) -n $(call solve,$(word 2,$(subst @, ,$(*F)))) $(SUDO) \
 403         sliver-ovs gmap-probe L$(word 1,$(subst @, ,$(*F))) $(GMAP_SERVER) $(word 3,$(subst @, ,$(*F))) $(word 4,$(subst @, ,$(*F)))
 404
 405 ####################
 406 # 'virtual' targets in that there's no real file attached
 407 define node_shortcuts
 408 sshcheck.$(1): sshcheck-$(1) FORCE
 409 db.$(1): cache/db.$(1) FORCE
 410 switch.$(1): cache/switch.$(1) FORCE
 411 start.$(1): cache/start.$(1) FORCE
 412 stop.$(1): cache/stop.$(1) FORCE
 413 status.$(1): cache/status.$(1) FORCE
 414 bridge.$(1): cache/bridge.$(1) FORCE
 415 host.$(1): cache/host.$(1) FORCE
 416 controller.$(1): cache/controller.$(1) FORCE
 417 # switch already depends on db, but well
 418 cache/start.$(1): cache/db.$(1) cache/switch.$(1) FORCE
 419 endef
 420
 421 $(foreach id,$(ALL_NODE_IDS), $(eval $(call node_shortcuts,$(id))))
 422
 423 define link_shortcuts
 424 iface.%: cache/iface.%
 425 endpoint.%: cache/endpoint.%
 426 endef
 427
 428 $(foreach id,$(ALL_LINK_IDS), $(eval $(call link_shortcuts,$(id))))
 429
 430 help:
 431         @cat Makefile.help
 432
 433 #################### convenience, for debugging only
 434 # make +foo : prints the value of $(foo)
 435 # make ++foo : idem but verbose, i.e. foo=$(foo)
 436 ++%: varname=$(subst +,,$@)
 437 ++%:
 438         @echo "$(varname)=$($(varname))"
 439 +%: varname=$(subst +,,$@)
 440 +%:
 441         @echo "$($(varname))"