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
 102 DBS=$(foreach id,$(ALL_NODE_IDS),cache/db.$(id))
 103 dbs: $(DBS)
 104 .PHONY: dbs
 105
 106 SWITCHS=$(foreach id,$(ALL_NODE_IDS),cache/switch.$(id))
 107 switchs: $(SWITCHS)
 108 .PHONY: switchs
 109
 110 start: dbs switchs
 111 .PHONY: start
 112
 113 stop:$(foreach id,$(ALL_NODE_IDS),cache/stop.$(id))
 114 .PHONY: stop
 115
 116 status:$(foreach id,$(ALL_NODE_IDS),cache/status.$(id))
 117 .PHONY: status
 118
 119 BRIDGES=$(foreach id,$(ALL_NODE_IDS),cache/bridge.$(id))
 120 bridges: $(BRIDGES)
 121 .PHONY: bridges
 122
 123 CONTROLLERS=$(foreach id,$(ALL_NODE_IDS),cache/controller.$(id))
 124 controllers: $(CONTROLLERS)
 125 .PHONY: controllers
 126
 127 ### node-oriented targets
 128 # check ssh connectivity
 129 sshcheck-%: FORCE
 130         @if $(SSH) $(HOST_$*) hostname &> /dev/null; then echo "ssh on" $(call display,$*) "OK" ; \
 131          else echo "ssh on" $(call display,$*) "KO !!!"; fi
 132
 133 ovsversion-%: FORCE
 134         @OVSVERSION=$$($(SSH) $(HOST_$*) rpm -q sliver-openvswitch); echo $(call display,$*) has $$OVSVERSION
 135
 136 # should probably replace sshcheck
 137 cache/status.%: FORCE
 138         @echo "=== DB and SWITCH processes on $(call display,$*)"
 139         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs status
 140
 141 cache/host.%:
 142         @echo "IP lookup for $(call display,$*)"
 143         @host $(HOST_$*) | sed -n 's/^.*has address *//p' > $@
 144
 145 cache/db.%:
 146         @echo "Starting db server on $(call display,$*) - logs in $(call log,$@)"
 147         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs start-db &> $(call log,$@) && touch $@
 148
 149 cache/switch.%: cache/db.%
 150         @echo "Starting vswitchd on $(call display,$*) - logs in $(call log,$@)"
 151         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs start-switch &> $(call log,$@) && touch $@
 152
 153 cache/bridge.%: cache/switch.%
 154         @echo "Creating bridge on $(call display,$*) - logs in $(call log,$@)"
 155         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs create-bridge $(BRIDGE) $(IP_$*) > $@ 2> $(call log,$@) || { rm $@; exit 1; }
 156         @echo Created bridge with tap $$(cat $@) on $(call display,$*)
 157
 158 cache/controller.%: cache/bridge.%
 159         @echo "Setting controller $(call default,CONTROLLER,$*) on $(call display,$*) - logs in $(call log,$@)"
 160         @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl set-controller $(BRIDGE) $(call default,CONTROLLER,$*) &> $(call log,$@) || { rm $@; exit 1; }
 161
 162 # xxx this probably needs a more thorough cleanup in cache/
 163 cache/stop.%: del-bridge.%
 164         @echo "Stopping switch & db on $(call display,$*)"
 165         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop && rm cache/switch.% cache/db.%
 166
 167 ### link-oriented targets
 168 # L/<nodeid>-<node_id>
 169 L/%: cache/link.%@1 cache/link.%@2
 170         @touch $@
 171         @echo "Created link $*"
 172
 173 U/%: del-iface.%@1 del-iface.%@2
 174         @rm -f L/$*
 175         @echo "Deleted link $*"
 176
 177 del-bridge.%: cache/db.%
 178         @echo "Deleting bridge on $(call display,$*)"
 179         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs del-bridge $(BRIDGE);
 180         @rm -f cache/bridge.$* \
 181               cache/iface.$*$(SEP)*@1 cache/iface.*$(SEP)$*@2 \
 182               cache/link.$*$(SEP)*@?  cache/link.*$(SEP)$*@?  \
 183               L/$*$(SEP)*             L/*$(SEP)$*
 184
 185 del-switch.%: del-bridge.%
 186         @echo "Shutting down switch on $(call display,$*)"
 187         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop-switch
 188         @rm -f cache/switch.$*
 189
 190 del-db.%:
 191         @echo "Shutting down db on $(call display,$*)"
 192         @$(SSH) $(HOST_$*) $(SUDO) sliver-ovs stop-db
 193         @rm -f cache/db.$*
 194
 195 del-links: $(addprefix U/,$(notdir $(filter-out %.log,$(wildcard L/*))))
 196
 197 del-switchs: $(addprefix del-,$(notdir $(filter-out %.log,$(wildcard cache/switch.*))))
 198
 199 del-dbs: $(addprefix del-,$(notdir $(filter-out %.log,$(wildcard cache/db.*))))
 200
 201 shutdown: del-switchs del-dbs
 202
 203 .PHONY: del-links del-switchs del-dbs shutdown
 204
 205
 206 ### snapshots
 207 remote-snapshot: remote-snapshot-ips remote-snapshot-links
 208         @true
 209
 210 remote-snapshot-ips: $(addprefix cache/rsnap.ip.,$(CONF_NODE_IDS))
 211         @cat /dev/null $^
 212
 213 remote-snapshot-links: $(addprefix cache/rsnap.links.,$(CONF_NODE_IDS))
 214         @sort -u /dev/null $^
 215
 216 ### update sliver-ovs
 217 update: $(addprefix update-,$(CONF_NODE_IDS))
 218         @true
 219
 220 update-%: FORCE
 221         @[ -n "$(SLIVER_OVS)" ] || { echo "SLIVER_OVS not set" >&2; exit 1; }
 222         @[ -f "$(SLIVER_OVS)" ] || { echo "$(SLIVER_OVS) not found" >&2; exit 1; }
 223         @echo "Sending $(SLIVER_OVS) to $(call display,$*)"
 224         @scp -q $(SLIVER_OVS) $(SLICE)@$(call solve,$*):
 225         @$(SSH) $(call solve,$*) $(SUDO) mv $(notdir $(SLIVER_OVS)) /usr/sbin/sliver-ovs
 226
 227 .PHONY: remote-snapshot remote-snapshot-ips remote-snapshot-links
 228
 229 cache/rsnap.ip.%:
 230         @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl -- \
 231                 get interface $(BRIDGE) options:local_ip options:local_netmask |\
 232                 sed -n 's|"||g;1h;2{G;s|\(.*\)\n\(.*\)|IP_$* = \2/\1|p}' > $@ || \
 233          { rm $@; exit 1; }
 234
 235 cache/rsnap.links.%:
 236         @$(SSH) $(HOST_$*) $(SUDO) ovs-vsctl list-ifaces $(BRIDGE) | \
 237          sed -n 's/^L/LINKS += /p' > $@ || \
 238          { rm $@; exit 1; }
 239
 240 .SECONDEXPANSION:
 241
 242 del-iface.%: cache/db.$$(call get,%)
 243         @echo "Removing interface for link $(call linkpart,$*) from $(call get,$*)"
 244         @$(SSH) $(HOST_$(call get,$*)) \
 245                 $(SUDO) sliver-ovs del-port L$(call linkpart,$*)
 246         @rm -f cache/iface.$* cache/link.$* cache/link.$(call opp,$*)
 247
 248
 249 ### '%' here is leftid-rightid@{1,2}
 250 # we retrieve % as $(*F)
 251 #linkid=$(call linkpart,%)
 252 #nodeid=$(call get,%)
 253 #bridgefile=cache/bridge.$(nodeid)
 254 cache/iface.%: cache/bridge.$$(call get,%)
 255         @echo "Creating interface for link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
 256         @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) sliver-ovs create-port $(BRIDGE) \
 257                 L$(call linkpart,$(*F)) > $@ 2> $(call log,$@) || { rm $@; exit 1; }
 258
 259
 260 # linkid=$(call linkpart,%)
 261 # nodeid=$(call get,%)
 262 # iface1=cache/iface.%
 263 # iface2=cache/iface.$(call opp,%)
 264 cache/link.%: cache/host.$$(call rget,%) cache/iface.% cache/iface.$$(call opp,%)
 265         @echo "Setting port number of link $(call linkpart,$(*F)) on $(call display,$(call get,$(*F))) - logs in $(call log,$@)"
 266         @$(SSH) $(call solve,$(call get,$(*F))) $(SUDO) sliver-ovs set-remote-endpoint L$(call linkpart,$(*F)) \
 267                         $$(cat cache/host.$(call rget,$(*F))) \
 268                         $$(cat cache/iface.$(call opp,$(*F))) 2> $(call log,$@) \
 269          && touch $@
 270
 271 ####################
 272 CLEANTARGETS=$(addprefix del-,$(notdir $(filter-out %.log,$(wildcard cache/bridge.*))))
 273 clean: $(CLEANTARGETS)
 274 distclean:
 275         rm -rf L U cache
 276 .PHONY: clean distclean
 277
 278 ####################
 279 graph.dot:
 280         ( echo "digraph $(SLICE) {"; ls L | sed 's/$(SEP)/->/;s/$$/;/'; echo "}" ) > $@
 281 graph.ps: graph.dot
 282         dot -Tps < $^ > $@
 283
 284
 285 ####################
 286 # 'virtual' targets in that there's no real file attached
 287 define node_shortcuts
 288 sshcheck.$(1): sshcheck-$(1) FORCE
 289 db.$(1): cache/db.$(1) FORCE
 290 switch.$(1): cache/switch.$(1) FORCE
 291 start.$(1): cache/start.$(1) FORCE
 292 stop.$(1): cache/stop.$(1) FORCE
 293 status.$(1): cache/status.$(1) FORCE
 294 bridge.$(1): cache/bridge.$(1) FORCE
 295 host.$(1): cache/host.$(1) FORCE
 296 # switch already depends on db, but well
 297 cache/start.$(1): cache/db.$(1) cache/switch.$(1) FORCE
 298 endef
 299
 300 $(foreach id,$(ALL_NODE_IDS), $(eval $(call node_shortcuts,$(id))))
 301
 302 define link_shortcuts
 303 iface.%: cache/iface.%
 304 link.%: cache/link.%
 305 endef
 306
 307 $(foreach id,$(ALL_LINK_IDS), $(eval $(call link_shortcuts,$(id))))
 308
 309 help:
 310         @cat Makefile.help
 311
 312 #################### convenience, for debugging only
 313 # make +foo : prints the value of $(foo)
 314 # make ++foo : idem but verbose, i.e. foo=$(foo)
 315 ++%: varname=$(subst +,,$@)
 316 ++%:
 317         @echo "$(varname)=$($(varname))"
 318 +%: varname=$(subst +,,$@)
 319 +%:
 320         @echo "$($(varname))"