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