From ec4e8058989e1e57ce8d547de8c687567c323755 Mon Sep 17 00:00:00 2001 From: Dave Smith Date: Fri, 8 Jan 2010 12:16:57 -0700 Subject: [PATCH] Adding sketch of functionality for creating a reltool node from template --- priv/templates/simplenode.app.config | 11 ++ priv/templates/simplenode.erl.script | 34 ++++++ priv/templates/simplenode.nodetool | 80 ++++++++++++++ priv/templates/simplenode.reltool.config | 28 +++++ priv/templates/simplenode.runner | 130 +++++++++++++++++++++++ priv/templates/simplenode.template | 7 ++ priv/templates/simplenode.vm.args | 21 ++++ src/rebar_templater.erl | 6 ++ 8 files changed, 317 insertions(+) create mode 100644 priv/templates/simplenode.app.config create mode 100644 priv/templates/simplenode.erl.script create mode 100644 priv/templates/simplenode.nodetool create mode 100644 priv/templates/simplenode.reltool.config create mode 100755 priv/templates/simplenode.runner create mode 100644 priv/templates/simplenode.template create mode 100644 priv/templates/simplenode.vm.args diff --git a/priv/templates/simplenode.app.config b/priv/templates/simplenode.app.config new file mode 100644 index 0000000..bba388b --- /dev/null +++ b/priv/templates/simplenode.app.config @@ -0,0 +1,11 @@ +[ + %% SASL config + {sasl, [ + {sasl_error_logger, {file, "log/sasl-error.log"}}, + {errlog_type, error}, + {error_logger_mf_dir, "log/sasl"}, % Log directory + {error_logger_mf_maxbytes, 10485760}, % 10 MB max file size + {error_logger_mf_maxfiles, 5} % 5 files max + ]} +]. + diff --git a/priv/templates/simplenode.erl.script b/priv/templates/simplenode.erl.script new file mode 100644 index 0000000..d97c514 --- /dev/null +++ b/priv/templates/simplenode.erl.script @@ -0,0 +1,34 @@ +#!/bin/bash + +## This script replaces the default "erl" in erts-VSN/bin. This is necessary +## as escript depends on erl and in turn, erl depends on having access to a +## bootscript (start.boot). Note that this script is ONLY invoked as a side-effect +## of running escript -- the embedded node bypasses erl and uses erlexec directly +## (as it should). +## +## Note that this script makes the assumption that there is a start_clean.boot +## file available in $ROOTDIR/release/VSN. + +# Determine the abspath of where this script is executing from. +ERTS_BIN_DIR=$(cd ${0%/*} && pwd) + +# Now determine the root directory -- this script runs from erts-VSN/bin, +# so we simply need to strip off two dirs from the end of the ERTS_BIN_DIR +# path. +ROOTDIR=${ERTS_BIN_DIR%/*/*} + +# Parse out release and erts info +START_ERL=`cat $ROOTDIR/releases/start_erl.data` +ERTS_VSN=${START_ERL% *} +APP_VSN=${START_ERL#* } + +BINDIR=$ROOTDIR/erts-$ERTS_VSN/bin +EMU=beam +PROGNAME=`echo $0 | sed 's/.*\///'` +CMD="$BINDIR/erlexec" +export EMU +export ROOTDIR +export BINDIR +export PROGNAME + +exec $CMD -boot $ROOTDIR/releases/$APP_VSN/start_clean ${1+"$@"} \ No newline at end of file diff --git a/priv/templates/simplenode.nodetool b/priv/templates/simplenode.nodetool new file mode 100644 index 0000000..8afc167 --- /dev/null +++ b/priv/templates/simplenode.nodetool @@ -0,0 +1,80 @@ +%% -*- erlang -*- +%% ------------------------------------------------------------------- +%% +%% nodetool: Helper Script for interacting with live nodes +%% +%% ------------------------------------------------------------------- + +main(Args) -> + %% Extract the args + {RestArgs, TargetNode} = process_args(Args, [], undefined), + + %% See if the node is currently running -- if it's not, we'll bail + case net_adm:ping(TargetNode) of + pong -> + ok; + pang -> + io:format("Node ~p not responding to pings.\n", [TargetNode]), + halt(1) + end, + + case RestArgs of + ["ping"] -> + %% If we got this far, the node already responsed to a ping, so just dump + %% a "pong" + io:format("pong\n"); + ["stop"] -> + io:format("~p\n", [rpc:call(TargetNode, init, stop, [], 60000)]); + ["restart"] -> + io:format("~p\n", [rpc:call(TargetNode, init, restart, [], 60000)]); + ["reboot"] -> + io:format("~p\n", [rpc:call(TargetNode, init, reboot, [], 60000)]); + ["rpc", Module, Function | RpcArgs] -> + case rpc:call(TargetNode, list_to_atom(Module), list_to_atom(Function), [RpcArgs], 60000) of + ok -> + ok; + {badrpc, Reason} -> + io:format("RPC to ~p failed: ~p\n", [TargetNode, Reason]), + halt(1); + _ -> + halt(1) + end; + Other -> + io:format("Other: ~p\n", [Other]), + io:format("Usage: nodetool {ping|stop|restart|reboot}\n") + end, + net_kernel:stop(). + +process_args([], Acc, TargetNode) -> + {lists:reverse(Acc), TargetNode}; +process_args(["-setcookie", Cookie | Rest], Acc, TargetNode) -> + erlang:set_cookie(node(), list_to_atom(Cookie)), + process_args(Rest, Acc, TargetNode); +process_args(["-name", TargetName | Rest], Acc, _) -> + ThisNode = append_node_suffix(TargetName, "_maint_"), + {ok, _} = net_kernel:start([ThisNode, longnames]), + process_args(Rest, Acc, nodename(TargetName)); +process_args(["-sname", TargetName | Rest], Acc, _) -> + ThisNode = append_node_suffix(TargetName, "_maint_"), + {ok, _} = net_kernel:start([ThisNode, shortnames]), + process_args(Rest, Acc, nodename(TargetName)); +process_args([Arg | Rest], Acc, Opts) -> + process_args(Rest, [Arg | Acc], Opts). + + +nodename(Name) -> + case string:tokens(Name, "@") of + [_Node, _Host] -> + list_to_atom(Name); + [Node] -> + [_, Host] = string:tokens(atom_to_list(node()), "@"), + list_to_atom(lists:concat([Node, "@", Host])) + end. + +append_node_suffix(Name, Suffix) -> + case string:tokens(Name, "@") of + [Node, Host] -> + list_to_atom(lists:concat([Node, Suffix, os:getpid(), "@", Host])); + [Node] -> + list_to_atom(lists:concat([Node, Suffix, os:getpid()])) + end. diff --git a/priv/templates/simplenode.reltool.config b/priv/templates/simplenode.reltool.config new file mode 100644 index 0000000..c409660 --- /dev/null +++ b/priv/templates/simplenode.reltool.config @@ -0,0 +1,28 @@ +{sys, [ + {lib_dirs, []}, + {rel, "{{nodeid}}", "1", + [ + kernel, + stdlib, + sasl + ]}, + {rel, "start_clean", "", + [ + kernel, + stdlib + ]}, + {boot_rel, "{{nodeid}}"}, + {profile, embedded}, + {excl_sys_filters, ["^bin/.*", + "^erts.*/bin/(dialyzer|typer)"]}, + {app, riak, [{incl_cond, include}]}, + {app, sasl, [{incl_cond, include}]} + ]}. + +{rebar, [ + {empty_dirs, [ + "log/sasl" + ]}, + + {overlay, "overlay"} + ]}. diff --git a/priv/templates/simplenode.runner b/priv/templates/simplenode.runner new file mode 100755 index 0000000..08fa4af --- /dev/null +++ b/priv/templates/simplenode.runner @@ -0,0 +1,130 @@ +#!/bin/bash + +RUNNER_SCRIPT_DIR=$(cd ${0%/*} && pwd) + +RUNNER_BASE_DIR=${RUNNER_SCRIPT_DIR%/*} +RUNNER_ETC_DIR=$RUNNER_BASE_DIR/etc +RUNNER_LOG_DIR=$RUNNER_BASE_DIR/log +PIPE_DIR=/tmp/$RUNNER_BASE_DIR/ +RUNNER_USER= + +# Make sure this script is running as the appropriate user +if [ ! -z "$RUNNER_USER" ] && [ `whoami` != "$RUNNER_USER" ]; then + exec sudo -u $RUNNER_USER -i $0 $@ +fi + +# Make sure CWD is set to runner base dir +cd $RUNNER_BASE_DIR + +# Make sure log directory exists +mkdir -p $RUNNER_LOG_DIR + +# Extract the target node name from node.args +NAME_ARG=`grep -e '-[s]*name' $RUNNER_ETC_DIR/vm.args` +if [ -z "$NAME_ARG" ]; then + echo "vm.args needs to have either -name or -sname parameter." + exit 1 +fi + +# Extract the target cookie +COOKIE_ARG=`grep -e '-setcookie' $RUNNER_ETC_DIR/vm.args` +if [ -z "$COOKIE_ARG" ]; then + echo "vm.args needs to have a -setcookie parameter." + exit 1 +fi + +# Identify the script name +SCRIPT=`basename $0` + +# Parse out release and erts info +START_ERL=`cat $RUNNER_BASE_DIR/releases/start_erl.data` +ERTS_VSN=${START_ERL% *} +APP_VSN=${START_ERL#* } + +# Add ERTS bin dir to our path +ERTS_PATH=$RUNNER_BASE_DIR/erts-$ERTS_VSN/bin + +# Setup command to control the node +NODETOOL="$ERTS_PATH/escript $ERTS_PATH/nodetool $NAME_ARG $COOKIE_ARG" + +# Check the first argument for instructions +case "$1" in + start) + # Make sure there is not already a node running + RES=`$NODETOOL ping` + if [ "$RES" == "pong" ]; then + echo "Node is already running!" + exit 1 + fi + export HEART_COMMAND="$RUNNER_BASE_DIR/bin/$SCRIPT start" + mkdir -p $PIPE_DIR + $ERTS_PATH/run_erl -daemon $PIPE_DIR $RUNNER_LOG_DIR "exec $RUNNER_BASE_DIR/bin/$SCRIPT console" 2>&1 + ;; + + stop) + # Wait for the node to completely stop... + PID=`ps -ef|grep "$RUNNER_BASE_DIR/.*/[b]eam.smp|awk '{print $2}'"` + $NODETOOL stop + while `kill -0 $PID 2>/dev/null`; + do + sleep 1 + done + ;; + + restart) + ## Restart the VM without exiting the process + $NODETOOL restart + ;; + + reboot) + ## Restart the VM completely (uses heart to restart it) + $NODETOOL reboot + ;; + + ping) + ## See if the VM is alive + $NODETOOL ping + ;; + + attach) + # Make sure a node IS running + RES=`$NODETOOL ping` + if [ "$RES" != "pong" ]; then + echo "Node is not running!" + exit 1 + fi + + shift + $ERTS_PATH/to_erl $PIPE_DIR + ;; + + console) + # Setup beam-required vars + ROOTDIR=$RUNNER_BASE_DIR + BINDIR=$ROOTDIR/erts-$ERTS_VSN/bin + EMU=beam + PROGNAME=`echo $0 | sed 's/.*\///'` + CMD="$BINDIR/erlexec -boot $RUNNER_BASE_DIR/releases/$APP_VSN/$SCRIPT -embedded -config $RUNNER_ETC_DIR/app.config -args_file $RUNNER_ETC_DIR/vm.args -- ${1+"$@"}" + export EMU + export ROOTDIR + export BINDIR + export PROGNAME + + # Dump environment info for logging purposes + echo "Exec: $CMD" + echo "Root: $ROOTDIR" + + # Log the startup + logger -t "$SCRIPT[$$]" "Starting up" + + # Start the VM + exec $CMD + ;; + + *) + echo "Usage: $SCRIPT {start|stop|restart|reboot|ping|console|attach}" + exit 1 + ;; +esac + +exit 0 diff --git a/priv/templates/simplenode.template b/priv/templates/simplenode.template new file mode 100644 index 0000000..2615e35 --- /dev/null +++ b/priv/templates/simplenode.template @@ -0,0 +1,7 @@ +{variables, [{nodeid, "mynode"}]}. +{file, "simplenode.reltool.config", "reltool.config"}. +{file, "simplenode.erl.script", "overlay/erts-vsn/bin/erl"}. +{file, "simplenode.nodetool", "overlay/erts-vsn/bin/nodetool"}. +{file, "simplenode.runner", "overlay/bin/{{nodeid}}"}. +{file, "simplenode.app.config", "overlay/etc/app.config"}. +{file, "simplenode.vm.args", "overlay/etc/vm.args"}. diff --git a/priv/templates/simplenode.vm.args b/priv/templates/simplenode.vm.args new file mode 100644 index 0000000..89c3141 --- /dev/null +++ b/priv/templates/simplenode.vm.args @@ -0,0 +1,21 @@ + +## Name of the node +-name {{nodeid}}@127.0.0.1 + +## Cookie for distributed erlang +-setcookie {{nodeid}} + +## Heartbeat management; auto-restarts VM if it dies or becomes unresponsive +## (Disabled by default..use with caution!) +##-heart + +## Enable kernel poll and a few async threads ++K true ++A 5 + +## Increase number of concurrent ports/sockets +-env ERL_MAX_PORTS 4096 + +## Tweak GC to run more often +-env ERL_FULLSWEEP_AFTER 10 + diff --git a/src/rebar_templater.erl b/src/rebar_templater.erl index 329df7c..675f4bf 100644 --- a/src/rebar_templater.erl +++ b/src/rebar_templater.erl @@ -27,6 +27,7 @@ -module(rebar_templater). -export(['create-app'/2, + 'create-node'/2, create/2]). -include("rebar.hrl"). @@ -42,6 +43,11 @@ rebar_config:set_global(template, "simpleapp"), create(Config, File). +'create-node'(Config, File) -> + %% Alias for create w/ template=simplenode + rebar_config:set_global(template, "simplenode"), + create(Config, File). + create(_Config, _) -> %% Load a list of all the files in the escript -- cache it in the pdict %% since we'll potentially need to walk it several times over the course