swarm

defmodule Swarm.Cluster.Gossip do
  @moduledoc """
  This clustering strategy uses multicast UDP to gossip node names
  to other nodes on the network. These packets are listened for on
  each node as well, and a connection will be established between the
  two nodes if they are reachable on the network, and share the same
  magic cookie. In this way, a cluster of nodes may be formed dynamically.

  The gossip protocol is extremely simple, with a prelude followed by the node
  name which sent the packet. The node name is paresed from the packet, and a
  connection attempt is made. It will fail if the two nodes do not share a cookie.

  By default, the gossip occurs on port 45892, using the multicast address 230.0.0.251

  You may configure the multicast address, the interface address to bind to, the port,
  and the TTL of the packets, using the following settings:

      config :swarm,
        port: 45892,
        if_addr: "0.0.0.0",
        multicast_addr: "230.0.0.251",
        multicast_ttl: 1

  A TTL of 1 will limit packets to the local network, and is the default TTL.
  """
  use GenServer
  import Swarm.Logger

  @default_port 45892
  @default_addr {0,0,0,0}
  @default_multicast_addr {230,0,0,251}

  def start_link() do
    GenServer.start_link(__MODULE__, [], name: __MODULE__)
  end

  def init(_) do
    opts = Application.get_all_env(:swarm)
    port = Keyword.get(opts, :port, @default_port)
    ip   = Keyword.get(opts, :if_addr, @default_addr)
    ttl  = Keyword.get(opts, :multicast_ttl, 1)
    multicast_addr = case Keyword.get(opts, :multicast_addr, @default_multicast_addr) do
                       {_a,_b,_c,_d} = ip -> ip
                       ip when is_binary(ip) ->
                         {:ok, addr} = :inet.parse_ipv4_address(ip)
                         addr
                     end
    {:ok, socket} = :gen_udp.open(port, [
          :binary,
          active: true,
          ip: ip,
          reuseaddr: true,
          broadcast: true,
          multicast_ttl: ttl,
          multicast_loop: true,
          add_membership: {multicast_addr, {0,0,0,0}}
        ])
    Process.send_after(self(), :heartbeat, 0)
    {:ok, {multicast_addr, port, socket}}
  end

  # Send stuttered heartbeats
  def handle_info(:heartbeat, {multicast_addr, port, socket} = state) do
    :ok = :gen_udp.send(socket, multicast_addr, port, heartbeat(node()))
    Process.send_after(self(), :heartbeat, :rand.uniform(5_000))
    {:noreply, state}
  end

  # Handle received heartbeats
  def handle_info({:udp, _socket, _ip, _port, packet}, state) do
    handle_heartbeat(packet)
    {:noreply, state}
  end

  def terminate(_type, _reason, {_,_,socket}) do
    :gen_udp.close(socket)
    :ok
  end

  # Construct iodata representing packet to send
  defp heartbeat(node_name) do
    ["heartbeat::", :erlang.term_to_binary(%{node: node_name})]
  end

  # Upon receipt of a heartbeat, we check to see if the node
  # is connected to us, and if not, we connect to it.
  # If the connection fails, it's likely because the cookie
  # is different, and thus a node we can ignore
  @spec handle_heartbeat(binary) :: :ok
  defp handle_heartbeat(<<"heartbeat::", rest::binary>>) do
    case :erlang.binary_to_term(rest) do
      %{node: n} when is_atom(n) ->
        nodelist = [Node.self|Node.list(:connected)]
        cond do
          not n in nodelist ->
            case :net_kernel.connect_node(n) do
              true ->
                debug "connected to #{inspect n}"
                :ok
              reason ->
                debug "attempted to connect to node (#{inspect n}) from heartbeat, but failed with #{reason}."
                :ok
            end
          :else ->
            :ok
        end
      _ ->
        :ok
    end
  end
  defp handle_heartbeat(_packet) do
    :ok
  end
end