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
 105 DBS=$(foreach id,$(ALL_NODE_IDS),cache/db.$(id))
 106 dbs: $(DBS)
 107 .PHONY: dbs
 108
 109 SWITCHS=$(foreach id,$(ALL_NODE_IDS),cache/switch.$(id))
 110 switchs: $(SWITCHS)
 111 .PHONY: switchs
 112
 113 start: dbs switchs
 114 .PHONY: start
 115
 116 stop:$(foreach id,$(ALL_NODE_IDS),cache/stop.$(id))
 117 .PHONY: stop
 118
 119 status:$(foreach id,$(ALL_NODE_IDS),cache/status.$(id))
 120 .PHONY: status
 121
 122 BRIDGES=$(foreach id,$(ALL_NODE_IDS),cache/bridge.$(id))
 123 bridges: $(BRIDGES)
 124 .PHONY: bridges
 125
 126 CONTROLLERS=$(foreach id,$(ALL_NODE_IDS),cache/controller.$(id))
 127 controllers: $(CONTROLLERS)
 128 .PHONY: controllers
 129
 130 del-controllers: $(foreach id,$(ALL_NODE_IDS),del-controller-$(id))
 131 .PHONY: del-controllers
 132
 133 ### node-oriented targets
 134 # check ssh connectivity
 135 sshcheck-%: FORCE
 136         @if $(SSH) $(HOST_$*) hostname &> /dev/null; then echo "ssh on" $(call display,$*) "OK" ; \
 137          else echo "ssh on" $(call display,$*) "KO !!!"; fi
 138
 139 ovsversion-%: FORCE
 140         @OVSVERSION=$$($(SSH) $(HOST_$*) rpm -q sliver-openvswitch); echo $(call display,$*) has $$OVSVERSION
 141
 142 ssh-%: FORCE
 143         @$(SSH) $(HOST_$*) $(SUDO) $(SSH-COMMAND)
 144
 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 ||:
 149
 150 cache/host.%:
 151         @echo "IP lookup for $(call display,$*)"
 152         @host $(HOST_$*) | sed -n 's/^.*has address *//p' > $@
 153
 154 cache/db.%:
 155         @echo "Starting db server on $(call display,$*) - logs in $(call log,$@)"
 156         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs start-db &> $(call log,$@) && touch $@
 157
 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 $@
 161
 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,$@) \
 166          && touch $@
 167
 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,$@) \
 171          && touch $@
 172
 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.$*
 177
 178 ### link-oriented targets
 179 # L/<nodeid>-<node_id>
 180 L/%: cache/endpoint.%@1 cache/endpoint.%@2
 181         @touch $@
 182         @echo "Link $* is up"
 183
 184 U/%: del-iface.%@1 del-iface.%@2
 185         @rm -f L/$*
 186         @echo "Deleted link $*"
 187
 188 del-bridge.%: | cache/db.%
 189         @echo "Deleting bridge on $(call display,$*)"
 190         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs del-bridge $(BRIDGE);
 191         @rm -f cache/bridge.$* \
 192               cache/iface.$*$(SEP)*@1 cache/iface.*$(SEP)$*@2 \
 193               cache/port.$*$(SEP)*@1  cache/port.*$(SEP)$*@2  \
 194               cache/endpoint.$*$(SEP)*@?  cache/endpoint.*$(SEP)$*@?  \
 195               L/$*$(SEP)*             L/*$(SEP)$*
 196
 197 del-switch.%:
 198         @echo "Shutting down switch on $(call display,$*)"
 199         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop-switch
 200         @rm -f cache/switch.$* \
 201                cache/port.$*$(SEP)*@1  cache/port.*$(SEP)$*@2  \
 202                cache/endpoint.$*$(SEP)*@2  cache/endpoint.*$(SEP)$*@1  \
 203                L/$*$(SEP)*            L/*$(SEP)$*
 204
 205 del-db.%:
 206         @echo "Shutting down db on $(call display,$*)"
 207         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop-db
 208         @rm -f cache/db.$*
 209
 210 del-controller-%: | cache/db.%
 211         @echo "Removing controller for $(call display,$*)"
 212         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs del-controller $(BRIDGE)
 213         @rm -f cache/controller.$*
 214
 215 del-links: $(addprefix U/,$(notdir $(wildcard L/*)))
 216
 217 del-switchs: $(addprefix del-,$(notdir $(wildcard cache/switch.*)))
 218
 219 del-dbs: $(addprefix del-,$(notdir $(wildcard cache/db.*)))
 220
 221 shutdown: del-switchs del-dbs
 222
 223 .PHONY: del-links del-switchs del-dbs shutdown
 224
 225
 226 ### snapshots
 227 remote-snapshot: remote-snapshot-ips remote-snapshot-links
 228         @true
 229
 230 remote-snapshot-ips: $(addprefix cache/rsnap.ip.,$(CONF_NODE_IDS))
 231         @cat /dev/null $^
 232
 233 remote-snapshot-links: $(addprefix cache/rsnap.links.,$(CONF_NODE_IDS))
 234         @sort -u /dev/null $^
 235
 236 ### update sliver-ovs
 237 update: $(addprefix update-,$(CONF_NODE_IDS))
 238         @true
 239
 240 update-%: FORCE
 241         @[ -n "$(SLIVER_OVS)" ] || { echo "SLIVER_OVS not set" >&2; exit 1; }
 242         @[ -f "$(SLIVER_OVS)" ] || { echo "$(SLIVER_OVS) not found" >&2; exit 1; }
 243         @echo "Sending $(SLIVER_OVS) to $(call display,$*)"
 244         @scp -q $(SLIVER_OVS) $(SLICE)@$(call solve,$*):
 245         @$(SSH) $(call solve,$*) $(SUDO) mv $(notdir $(SLIVER_OVS)) /usr/sbin/sliver-ovs
 246
 247 .PHONY: remote-snapshot remote-snapshot-ips remote-snapshot-links
 248
 249 cache/rsnap.ip.%:
 250         @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl -- \
 251                 get interface $(BRIDGE) options:local_ip options:local_netmask |\
 252                 sed -n 's|"||g;1h;2{G;s|\(.*\)\n\(.*\)|IP_$* = \2/\1|p}' > $@ || \
 253          { rm $@; exit 1; }
 254
 255 cache/rsnap.links.%:
 256         @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl list-ifaces $(BRIDGE) | \
 257          sed -n 's/^L/LINKS += /p' > $@ || \
 258          { rm $@; exit 1; }
 259
 260 .SECONDEXPANSION:
 261
 262 del-iface.%:
 263 del-iface.%: | cache/db.$$(call get,%)
 264         @echo "Removing interface for link $(call linkpart,$*) from $(call get,$*)"
 265         @$(SSH) $(HOST_$(call get,$*)) \
 266                 $(SUDO) sliver-ovs del-port L$(call linkpart,$*)
 267         @rm -f cache/iface.$* cache/port.$* cache/endpoint.$* cache/endpoint.$(call opp,$*)
 268
 269
 270 ### '%' here is leftid-rightid@{1,2}
 271 # we retrieve % as $(*F)
 272 #linkid=$(call linkpart,%)
 273 #nodeid=$(call get,%)
 274 #bridgefile=cache/bridge.$(nodeid)
 275 cache/iface.%: cache/bridge.$$(call get,%) | cache/db.$$(call get,%)
 276         @echo "Creating interface for link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
 277         @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) sliver-ovs create-port $(BRIDGE) \
 278                 L$(call linkpart,$(*F)) &> $(call log,$@) \
 279          && touch $@
 280
 281 cache/port.%: cache/iface.% cache/switch.$$(call get,%)
 282         @echo "Getting port number for link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
 283         @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) \
 284                 ovs-appctl netdev-tunnel/get-port L$(call linkpart,$(*F)) > $@ 2> $(call log,$@) \
 285          || { rm $@; exit 1; }
 286
 287
 288 # linkid=$(call linkpart,%)
 289 # nodeid=$(call get,%)
 290 # iface1=cache/iface.%
 291 # iface2=cache/iface.$(call opp,%)
 292 cache/endpoint.%: cache/host.$$(call rget,%) cache/port.$$(call opp,%) cache/iface.%
 293         @echo "Setting port number of link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
 294         @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) sliver-ovs set-remote-endpoint L$(call linkpart,$(*F)) \
 295                         $$(cat cache/host.$(call rget,$(*F))) \
 296                         $$(cat cache/port.$(call opp,$(*F))) 2> $(call log,$@) \
 297          && touch $@
 298
 299 ####################
 300 CLEANTARGETS=$(addprefix del-,$(notdir $(wildcard cache/bridge.*)))
 301 clean: $(CLEANTARGETS)
 302 distclean:
 303         rm -rf L log cache
 304 .PHONY: clean distclean
 305
 306 ####################
 307 graph.dot:
 308         ( echo "digraph $(SLICE) {"; ls L | sed 's/$(SEP)/->/;s/$$/;/'; echo "}" ) > $@
 309 graph.ps: graph.dot
 310         dot -Tps < $^ > $@
 311
 312 ####################
 313 # googlemap stuff
 314 # Uses:
 315 # GMAP_SERVER, the hostname that runs an ndnmap instance
 316 # GMAP_PROBES, a list of tuples of the form
 317 # <linkid>=<nodeid>=<internal_linkid>=<frequency>
 318 # e.g.
 319 # SENDER-MUX=SENDER=3=0.5
 320 # which would mean, the link 'SENDER-MUX' should be monitored at the 'SENDER' node and is coded
 321 # in links.json with id=3, every half second
 322 # sliver-ovs gmap-probe is designed to run in background,
 323 # and so that a new run will kill any previously running instance
 324 gprobes: $(foreach probe,$(GMAP_PROBES),gprobe-$(probe))
 325
 326 gprobe-%: FORCE
 327         $(SSH) -n $(call solve,$(word 2,$(subst @, ,$(*F)))) $(SUDO) \
 328         sliver-ovs gmap-probe L$(word 1,$(subst @, ,$(*F))) $(GMAP_SERVER) $(word 3,$(subst @, ,$(*F))) $(word 4,$(subst @, ,$(*F)))
 329
 330 ####################
 331 # 'virtual' targets in that there's no real file attached
 332 define node_shortcuts
 333 sshcheck.$(1): sshcheck-$(1) FORCE
 334 db.$(1): cache/db.$(1) FORCE
 335 switch.$(1): cache/switch.$(1) FORCE
 336 start.$(1): cache/start.$(1) FORCE
 337 stop.$(1): cache/stop.$(1) FORCE
 338 status.$(1): cache/status.$(1) FORCE
 339 bridge.$(1): cache/bridge.$(1) FORCE
 340 host.$(1): cache/host.$(1) FORCE
 341 # switch already depends on db, but well
 342 cache/start.$(1): cache/db.$(1) cache/switch.$(1) FORCE
 343 endef
 344
 345 $(foreach id,$(ALL_NODE_IDS), $(eval $(call node_shortcuts,$(id))))
 346
 347 define link_shortcuts
 348 iface.%: cache/iface.%
 349 endpoint.%: cache/endpoint.%
 350 endef
 351
 352 $(foreach id,$(ALL_LINK_IDS), $(eval $(call link_shortcuts,$(id))))
 353
 354 help:
 355         @cat Makefile.help
 356
 357 #################### convenience, for debugging only
 358 # make +foo : prints the value of $(foo)
 359 # make ++foo : idem but verbose, i.e. foo=$(foo)
 360 ++%: varname=$(subst +,,$@)
 361 ++%:
 362         @echo "$(varname)=$($(varname))"
 363 +%: varname=$(subst +,,$@)
 364 +%:
 365         @echo "$($(varname))"