Pau Espin Pedrol | bb49f95 | 2024-02-27 21:15:01 +0100 | [diff] [blame] | 1 | % ip.access IPA multiplex protocol |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 2 | |
Harald Welte | d0f391e | 2019-08-11 20:00:17 +0200 | [diff] [blame] | 3 | % (C) 2010,2012,2019 by Harald Welte <laforge@gnumonks.org> |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 4 | % (C) 2010 by On-Waves |
| 5 | % |
| 6 | % All Rights Reserved |
| 7 | % |
| 8 | % This program is free software; you can redistribute it and/or modify |
| 9 | % it under the terms of the GNU General Public License as published by |
| 10 | % the Free Software Foundation; either version 2 of the License, or |
| 11 | % (at your option) any later version. |
| 12 | % |
| 13 | % This program is distributed in the hope that it will be useful, |
| 14 | % but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | % GNU General Public License for more details. |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 17 | |
| 18 | -module(ipa_proto). |
| 19 | -author('Harald Welte <laforge@gnumonks.org>'). |
| 20 | -compile(export_all). |
| 21 | |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 22 | -include("ipa.hrl"). |
| 23 | |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 24 | -define(TIMEOUT, 1000). |
| 25 | -define(IPA_SOCKOPTS, [binary, {packet, 0}, {reuseaddr, true}, {active, false}]). |
| 26 | |
| 27 | -define(IPAC_MSGT_PING, 0). |
| 28 | -define(IPAC_MSGT_PONG, 1). |
| 29 | -define(IPAC_MSGT_ID_GET, 4). |
| 30 | -define(IPAC_MSGT_ID_RESP, 5). |
| 31 | -define(IPAC_MSGT_ID_ACK, 6). |
| 32 | |
Harald Welte | d0f391e | 2019-08-11 20:00:17 +0200 | [diff] [blame] | 33 | -define(IPAC_PROTO_OSMO, 238). |
| 34 | -define(IPAC_PROTO_CCM, 254). |
| 35 | |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 36 | -export([register_socket/1, register_stream/3, unregister_stream/2, |
| 37 | send/3, connect/3, connect/4, listen_accept_handle/2, |
Harald Welte | 3b95a7c | 2019-08-11 20:31:41 +0200 | [diff] [blame] | 38 | start_listen/3, controlling_process/3, register_codec/3]). |
| 39 | |
| 40 | -type stream_id() :: integer() | {osmo, integer()}. |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 41 | |
| 42 | -record(ipa_socket, {socket, ipaPid, streamTbl, listenType}). |
| 43 | |
Harald Welte | 3b95a7c | 2019-08-11 20:31:41 +0200 | [diff] [blame] | 44 | -record(ipa_codec, {streamId :: stream_id(), |
| 45 | encodeFn :: fun(), |
| 46 | decodeFn :: fun() |
| 47 | }). |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 48 | |
| 49 | % register a TCP socket with this IPA protocol implementation |
| 50 | register_socket(Socket) -> |
| 51 | IpaPid = spawn(?MODULE, init_sock, [Socket, self()]), |
| 52 | % synchronously wait for init_sock to be done |
Pau Espin Pedrol | bb49f95 | 2024-02-27 21:15:01 +0100 | [diff] [blame] | 53 | receive |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 54 | {ipa_init_sock_done, Socket} -> |
| 55 | % assign ownership of the socket to the new IPA handler process |
| 56 | gen_tcp:controlling_process(Socket, IpaPid), |
| 57 | {ok, IpaPid} |
Pau Espin Pedrol | bb49f95 | 2024-02-27 21:15:01 +0100 | [diff] [blame] | 58 | after |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 59 | ?TIMEOUT -> |
| 60 | {error, timeout} |
| 61 | end. |
| 62 | |
| 63 | % call_sync() preceeded by a Socket -> Pid lookup |
| 64 | call_sync_sock(Socket, Request) -> |
| 65 | % resolve PID responsible for this socket |
| 66 | case ets:lookup(ipa_sockets, Socket) of |
| 67 | [IpaSock] -> |
| 68 | call_sync(IpaSock#ipa_socket.ipaPid, Request); |
| 69 | _ -> |
| 70 | io:format("No Process for Socket ~p~n", [Socket]), |
| 71 | {error, no_sock_for_pid} |
| 72 | end. |
| 73 | |
| 74 | % a user process wants to register itself for a given Socket/StreamID tuple |
| 75 | register_stream(Socket, StreamID, Pid) -> |
| 76 | call_sync_sock(Socket, {ipa_reg_stream, Socket, StreamID, Pid}). |
| 77 | |
| 78 | register_streams(_S, []) -> |
| 79 | ok; |
| 80 | register_streams(S, [{StreamID, Pid}|SList]) -> |
| 81 | ipa_proto:register_stream(S, StreamID, Pid), |
| 82 | register_streams(S, SList). |
| 83 | |
| 84 | % unregister for a given stream |
| 85 | unregister_stream(Socket, StreamID) -> |
| 86 | call_sync_sock(Socket, {ipa_unreg_stream, Socket, StreamID}). |
| 87 | |
| 88 | % change the controlling process for a given {Socket, StreamID} |
| 89 | controlling_process(Socket, StreamID, NewPid) -> |
| 90 | call_sync_sock(Socket, {ipa_ctrl_proc, Socket, StreamID, NewPid}). |
| 91 | |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 92 | % Set the metadata required for the ipa CCM sub-protocol. |
| 93 | set_ccm_options(Socket, CcmOptions) -> |
| 94 | call_sync_sock(Socket, {ipa_set_ccm_options, Socket, CcmOptions}). |
| 95 | |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 96 | % unblock the socket from further processing |
| 97 | unblock(Socket) -> |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 98 | call_sync_sock(Socket, {ipa_unblock, Socket}). |
| 99 | |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 100 | % server-side handler for unregister_stream() |
Matt Johnson | 4621456 | 2020-09-08 01:42:49 -0700 | [diff] [blame] | 101 | request({ipa_reg_stream, Socket, StreamID, Pid}, _) -> |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 102 | io:format("Registering handler ~p for socket ~p Stream ~p~n", [Pid, Socket, StreamID]), |
| 103 | [IpaSock] = ets:lookup(ipa_sockets, Socket), |
| 104 | ets:insert_new(IpaSock#ipa_socket.streamTbl, {{Socket, StreamID}, Pid}); |
| 105 | % server-side handler for unregister_stream() |
Matt Johnson | 4621456 | 2020-09-08 01:42:49 -0700 | [diff] [blame] | 106 | request({ipa_unreg_stream, Socket, StreamID}, _) -> |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 107 | io:format("Unregistering handler for Socket ~p Stream ~p~n", [Socket, StreamID]), |
| 108 | [IpaSock] = ets:lookup(ipa_sockets, Socket), |
| 109 | ets:delete(IpaSock#ipa_socket.streamTbl, {Socket, StreamID}); |
| 110 | % server-side handler for controlling_process() |
Matt Johnson | 4621456 | 2020-09-08 01:42:49 -0700 | [diff] [blame] | 111 | request({ipa_ctrl_proc, Socket, StreamID, NewPid}, _) -> |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 112 | io:format("Changing handler for socket ~p Stream ~p~n", [Socket, StreamID]), |
| 113 | [IpaSock] = ets:lookup(ipa_sockets, Socket), |
| 114 | ets:delete(IpaSock#ipa_socket.streamTbl, {Socket, StreamID}), |
| 115 | ets:insert_new(IpaSock#ipa_socket.streamTbl, {{Socket, StreamID}, NewPid}); |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 116 | % server-side handler for set_ccm_options() |
| 117 | % set ccm protocol metadata options reported with connection setup. |
Matt Johnson | 4621456 | 2020-09-08 01:42:49 -0700 | [diff] [blame] | 118 | request({ipa_set_ccm_options, Socket, CcmOptions}, _) -> |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 119 | io:format("Setting ccm options for socket ~p to ~p~n", [Socket, CcmOptions]), |
| 120 | {ccm_options, CcmOptions}; |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 121 | % server-side handler for unblock() |
Matt Johnson | 4621456 | 2020-09-08 01:42:49 -0700 | [diff] [blame] | 122 | request({ipa_unblock, Socket}, CcmOptions) -> |
| 123 | if |
| 124 | CcmOptions#ipa_ccm_options.initiate_ack -> send_ccm_id_ack(Socket); |
| 125 | true -> send_ccm_id_get(Socket) |
| 126 | end, |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 127 | io:format("Unblocking socket ~p~n", [Socket]), |
| 128 | %[IpaSock] = ets:lookup(ipa_sockets, Socket), |
| 129 | Ret = inet:setopts(Socket, [{active, once}]), |
| 130 | io:format("Unblocking socket ~p:~p~n", [Socket, Ret]). |
| 131 | |
Pau Espin Pedrol | 2286c1b | 2024-02-27 21:15:36 +0100 | [diff] [blame] | 132 | % split an incoming IPA message and split it into StreamID/Payload/Trailer |
| 133 | split_ipa_msg(IPALen, _StreamID, DataRemainBin) when byte_size(DataRemainBin) < IPALen -> |
| 134 | need_more_data; |
| 135 | split_ipa_msg(IPALen, StreamID, DataRemainBin) -> |
| 136 | <<Payload:IPALen/binary, Trailer/binary>> = DataRemainBin, |
| 137 | io:format("Stream ~p, ~p bytes~n", [StreamID, IPALen]), |
| 138 | {ok, StreamID, Payload, Trailer}. |
| 139 | split_ipa_msg(DataBin) when byte_size(DataBin) < 3 -> |
| 140 | need_more_data; |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 141 | split_ipa_msg(DataBin) -> |
Pau Espin Pedrol | 2286c1b | 2024-02-27 21:15:36 +0100 | [diff] [blame] | 142 | <<IPALen:16/big-unsigned-integer, StreamID:8, DataRemainBin/binary>> = DataBin, |
| 143 | split_ipa_msg(IPALen, StreamID, DataRemainBin). |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 144 | |
| 145 | % deliver an incoming message to the process that is registered for the socket/stream_id |
| 146 | deliver_rx_ipa_msg(Socket, StreamID, StreamMap, DataBin) -> |
Harald Welte | 3b95a7c | 2019-08-11 20:31:41 +0200 | [diff] [blame] | 147 | DataDec = try_decode(StreamID, DataBin), |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 148 | case ets:lookup(StreamMap, {Socket, StreamID}) of |
| 149 | [{_,{process_id, Pid}}] -> |
Harald Welte | 3b95a7c | 2019-08-11 20:31:41 +0200 | [diff] [blame] | 150 | Pid ! {ipa, Socket, StreamID, DataDec}; |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 151 | [{_,{callback_fn, Fn, Args}}] -> |
Harald Welte | 3b95a7c | 2019-08-11 20:31:41 +0200 | [diff] [blame] | 152 | Fn(Socket, StreamID, DataDec, Args); |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 153 | [] -> |
| 154 | io:format("No Pid registered for Socket ~p Stream ~p~n", [Socket, StreamID]) |
| 155 | end. |
| 156 | |
Harald Welte | 3b95a7c | 2019-08-11 20:31:41 +0200 | [diff] [blame] | 157 | % register a Codec with this IPA protocol implementation |
| 158 | -spec register_codec(stream_id(), fun(), fun()) -> boolean(). |
| 159 | register_codec(StreamID, EncodeFn, DecodeFn) -> |
| 160 | ets:insert(ipa_codecs, #ipa_codec{streamId=StreamID, encodeFn=EncodeFn, decodeFn=DecodeFn}). |
| 161 | |
| 162 | -spec try_decode(stream_id(), binary()) -> any(). |
| 163 | try_decode(StreamID, Data) -> |
| 164 | case ets:lookup(ipa_codecs, StreamID) of |
| 165 | [IpaCodec] -> |
| 166 | Fun = IpaCodec#ipa_codec.decodeFn, |
| 167 | Fun(Data); |
| 168 | [] -> |
| 169 | Data |
| 170 | end. |
| 171 | |
| 172 | -spec try_encode(stream_id(), any()) -> binary(). |
| 173 | try_encode(_StreamID, Data) when is_binary(Data) -> |
| 174 | Data; |
| 175 | try_encode(StreamID, Data) -> |
| 176 | case ets:lookup(ipa_codecs, StreamID) of |
| 177 | [IpaCodec] -> |
| 178 | Fun = IpaCodec#ipa_codec.encodeFn, |
| 179 | Fun(Data); |
| 180 | [] -> |
| 181 | Data |
| 182 | end. |
| 183 | |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 184 | % process (split + deliver) an incoming IPA message |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 185 | process_rx_ipa_msg(_S, _StreamMap, _, <<>>) -> |
Pau Espin Pedrol | 2286c1b | 2024-02-27 21:15:36 +0100 | [diff] [blame] | 186 | {ok, <<>>}; |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 187 | process_rx_ipa_msg(S, StreamMap, CcmOptions, Data) -> |
Pau Espin Pedrol | 2286c1b | 2024-02-27 21:15:36 +0100 | [diff] [blame] | 188 | case split_ipa_msg(Data) of |
| 189 | need_more_data -> {ok, Data}; |
| 190 | {ok, StreamID, PayloadBin, Trailer} -> |
| 191 | case StreamID of |
| 192 | ?IPAC_PROTO_CCM -> |
| 193 | process_rx_ccm_msg(S, StreamID, CcmOptions, PayloadBin); |
| 194 | ?IPAC_PROTO_OSMO -> |
| 195 | <<ExtStreamID:8, PayloadExt/binary>> = PayloadBin, |
| 196 | deliver_rx_ipa_msg(S, {osmo, ExtStreamID}, StreamMap, PayloadExt); |
| 197 | _ -> |
| 198 | deliver_rx_ipa_msg(S, StreamID, StreamMap, PayloadBin) |
| 199 | end, |
| 200 | process_rx_ipa_msg(S, StreamMap, CcmOptions, Trailer) |
| 201 | end. |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 202 | |
| 203 | send_close_signal([]) -> |
| 204 | ok; |
| 205 | send_close_signal([StreamSpec|Tail]) -> |
Harald Welte | f66bbfa | 2012-01-28 14:08:52 +0100 | [diff] [blame] | 206 | io:format("send_close_signal ~p ~p~n", [StreamSpec, Tail]), |
| 207 | case StreamSpec of |
| 208 | [{{Socket, StreamID}, {process_id, Pid}}] -> |
| 209 | Pid ! {ipa_closed, {Socket, StreamID}}; |
| 210 | [{{Socket, StreamID}, {callback_fn, Fn, Args}}] -> |
| 211 | Fn(Socket, StreamID, ipa_closed, Args) |
| 212 | end, |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 213 | send_close_signal(Tail). |
Harald Welte | f66bbfa | 2012-01-28 14:08:52 +0100 | [diff] [blame] | 214 | |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 215 | process_tcp_closed(S, StreamMap) -> |
| 216 | % signal the closed socket to the user |
| 217 | StreamList = ets:match(StreamMap, '$1'), |
| 218 | send_close_signal(StreamList), |
| 219 | % remove the stream map for this socket |
| 220 | ets:delete(StreamMap), |
| 221 | % remove any entry regarding 'S' from ipa_sockets |
| 222 | ets:delete(ipa_sockets, S), |
| 223 | ok. |
| 224 | |
| 225 | % send a binary message through a given Socket / StreamID |
Harald Welte | d0f391e | 2019-08-11 20:00:17 +0200 | [diff] [blame] | 226 | send(Socket, {osmo, StreamIdExt}, DataBin) -> |
Harald Welte | 3b95a7c | 2019-08-11 20:31:41 +0200 | [diff] [blame] | 227 | DataEnc = try_encode({osmo, StreamIdExt}, DataBin), |
| 228 | send(Socket, ?IPAC_PROTO_OSMO, [StreamIdExt, DataEnc]); |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 229 | send(Socket, StreamID, DataBin) -> |
Harald Welte | 3b95a7c | 2019-08-11 20:31:41 +0200 | [diff] [blame] | 230 | DataEnc = try_encode(StreamID, DataBin), |
| 231 | Size = iolist_size(DataEnc), |
| 232 | gen_tcp:send(Socket, iolist_to_binary([<<Size:2/big-unsigned-integer-unit:8>>, StreamID, DataEnc])). |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 233 | |
| 234 | |
| 235 | call_sync(Pid, Request) -> |
| 236 | Ref = make_ref(), |
| 237 | Pid ! {request, {self(), Ref}, Request}, |
| 238 | receive |
| 239 | {reply, Ref, Reply} -> Reply |
| 240 | after |
| 241 | ?TIMEOUT -> {error, timeout} |
| 242 | end. |
| 243 | |
| 244 | reply({From, Ref}, Reply) -> |
| 245 | From ! {reply, Ref, Reply}. |
| 246 | |
| 247 | |
| 248 | % global module initialization |
| 249 | init() -> |
Harald Welte | 3b95a7c | 2019-08-11 20:31:41 +0200 | [diff] [blame] | 250 | ipa_sockets = ets:new(ipa_sockets, [named_table, set, public, {keypos, #ipa_socket.socket}]), |
| 251 | ipa_codecs = ets:new(ipa_codecs, [named_table, set, public, {keypos, #ipa_codec.streamId}]). |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 252 | |
| 253 | % initialize a signle socket, create its handle process |
| 254 | init_sock(Socket, CallingPid) -> |
| 255 | StreamMap = ets:new(stream_map, [set]), |
| 256 | ets:insert(ipa_sockets, #ipa_socket{socket=Socket, ipaPid=self(), streamTbl=StreamMap}), |
| 257 | CallingPid ! {ipa_init_sock_done, Socket}, |
Pau Espin Pedrol | 2286c1b | 2024-02-27 21:15:36 +0100 | [diff] [blame] | 258 | loop(Socket, StreamMap, #ipa_ccm_options{}, <<>>). |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 259 | |
Pau Espin Pedrol | 2286c1b | 2024-02-27 21:15:36 +0100 | [diff] [blame] | 260 | loop(S, StreamMap, CcmOptions, RxPendingData) -> |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 261 | receive |
| 262 | {request, From, Request} -> |
Matt Johnson | 4621456 | 2020-09-08 01:42:49 -0700 | [diff] [blame] | 263 | case ipa_proto:request(Request, CcmOptions) of |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 264 | {ccm_options, NewCcmOptions} -> |
| 265 | NextCcmOptions = NewCcmOptions, |
| 266 | Reply = ok; |
| 267 | EmbeddedReply -> |
| 268 | NextCcmOptions = CcmOptions, |
| 269 | Reply = EmbeddedReply |
| 270 | end, |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 271 | ipa_proto:reply(From, Reply), |
Pau Espin Pedrol | 2286c1b | 2024-02-27 21:15:36 +0100 | [diff] [blame] | 272 | ipa_proto:loop(S, StreamMap, NextCcmOptions, RxPendingData); |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 273 | {ipa_send, S, StreamId, Data} -> |
| 274 | send(S, StreamId, Data), |
Pau Espin Pedrol | 2286c1b | 2024-02-27 21:15:36 +0100 | [diff] [blame] | 275 | ipa_proto:loop(S, StreamMap, CcmOptions, RxPendingData); |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 276 | {tcp, S, Data} -> |
| 277 | % process incoming IPA message and mark socket active once more |
Pau Espin Pedrol | 2286c1b | 2024-02-27 21:15:36 +0100 | [diff] [blame] | 278 | {ok, NewRxPendingData} = ipa_proto:process_rx_ipa_msg(S, StreamMap, CcmOptions, <<RxPendingData/binary, Data/binary>>), |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 279 | inet:setopts(S, [{active, once}]), |
Pau Espin Pedrol | 2286c1b | 2024-02-27 21:15:36 +0100 | [diff] [blame] | 280 | ipa_proto:loop(S, StreamMap, CcmOptions, NewRxPendingData); |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 281 | {tcp_closed, S} -> |
| 282 | io:format("Socket ~w closed [~w]~n", [S,self()]), |
| 283 | ipa_proto:process_tcp_closed(S, StreamMap), |
| 284 | % terminate the process by not looping further |
| 285 | ok |
| 286 | end. |
| 287 | |
| 288 | % Respond with PONG to PING |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 289 | process_ccm_msg(Socket, StreamID, _, ping, _) -> |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 290 | io:format("Socket ~p Stream ~p: PING -> PONG~n", [Socket, StreamID]), |
| 291 | send(Socket, StreamID, <<?IPAC_MSGT_PONG>>); |
Matt Johnson | 4621456 | 2020-09-08 01:42:49 -0700 | [diff] [blame] | 292 | % Respond to ID_ACK with ID_ACK if this instance did not initiate |
| 293 | process_ccm_msg(Socket, StreamID, CcmOptions, id_ack, _) -> |
| 294 | if |
| 295 | CcmOptions#ipa_ccm_options.initiate_ack /= true -> |
| 296 | % Only respond to an ack if this instance did |
| 297 | % not initiate to prevent an infinite ack loop. |
| 298 | io:format("Socket ~p Stream ~p: ID_ACK -> ID_ACK~n", [Socket, StreamID]), |
| 299 | send(Socket, StreamID, <<?IPAC_MSGT_ID_ACK>>); |
| 300 | true -> |
| 301 | io:format("Socket ~p Stream ~p: ID_ACK -> None~n", [Socket, StreamID]) |
| 302 | end; |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 303 | % Simply respond to ID_RESP with ID_ACK |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 304 | process_ccm_msg(Socket, StreamID, _, id_resp, _) -> |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 305 | io:format("Socket ~p Stream ~p: ID_RESP -> ID_ACK~n", [Socket, StreamID]), |
| 306 | send(Socket, StreamID, <<?IPAC_MSGT_ID_ACK>>); |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 307 | % Simply respond to ID_GET with ID_RESP |
| 308 | process_ccm_msg(Socket, StreamID, CcmOptions, id_req, _) -> |
| 309 | io:format("Socket ~p Stream ~p: ID_GET -> ID_RESP~n", [Socket, StreamID]), |
| 310 | CcmBin = ipa_proto_ccm:encode( |
| 311 | {id_resp, |
| 312 | [{string,serial_nr,CcmOptions#ipa_ccm_options.serial_number}, |
| 313 | {string,unit_id,CcmOptions#ipa_ccm_options.unit_id}, |
| 314 | {string,mac_address,CcmOptions#ipa_ccm_options.mac_address}, |
| 315 | {string,location,CcmOptions#ipa_ccm_options.location}, |
| 316 | {string,unit_type,CcmOptions#ipa_ccm_options.unit_type}, |
| 317 | {string,equip_vers,CcmOptions#ipa_ccm_options.equipment_version}, |
| 318 | {string,sw_version,CcmOptions#ipa_ccm_options.sw_version}, |
| 319 | {string,unit_name,CcmOptions#ipa_ccm_options.unit_name} |
| 320 | ]}), |
| 321 | send(Socket, StreamID, CcmBin); |
| 322 | |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 323 | % Default message handler for unknown messages |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 324 | process_ccm_msg(Socket, StreamID, _, MsgType, Opts) -> |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 325 | io:format("Socket ~p Stream ~p: Unknown CCM message type ~p Opts ~p~n", |
| 326 | [Socket, StreamID, MsgType, Opts]). |
| 327 | |
| 328 | % process an incoming CCM message (Stream ID 254) |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 329 | process_rx_ccm_msg(Socket, StreamID, CcmOptions, PayloadBin) -> |
Harald Welte | 515aa33 | 2019-08-22 17:58:21 +0200 | [diff] [blame] | 330 | {MsgType, Opts} = ipa_proto_ccm:decode(PayloadBin), |
Matt Johnson | 44a4dd6 | 2020-09-08 01:35:23 -0700 | [diff] [blame] | 331 | process_ccm_msg(Socket, StreamID, CcmOptions, MsgType, Opts). |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 332 | |
| 333 | send_ccm_id_get(Socket) -> |
Harald Welte | d0f391e | 2019-08-11 20:00:17 +0200 | [diff] [blame] | 334 | send(Socket, ?IPAC_PROTO_CCM, <<?IPAC_MSGT_ID_GET>>). |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 335 | |
Matt Johnson | 4621456 | 2020-09-08 01:42:49 -0700 | [diff] [blame] | 336 | send_ccm_id_ack(Socket) -> |
| 337 | send(Socket, ?IPAC_PROTO_CCM, <<?IPAC_MSGT_ID_ACK>>). |
| 338 | |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 339 | % convenience wrapper for interactive use / debugging from the shell |
| 340 | listen_accept_handle(LPort, Opts) -> |
| 341 | case gen_tcp:listen(LPort, ?IPA_SOCKOPTS ++ Opts) of |
| 342 | {ok, ListenSock} -> |
| 343 | {ok, Port} = inet:port(ListenSock), |
| 344 | {ok, Sock} = gen_tcp:accept(ListenSock), |
| 345 | {ok, IpaPid} = ipa_proto:register_socket(Sock), |
| 346 | ipa_proto:register_stream(Sock, 0, self()), |
| 347 | ipa_proto:register_stream(Sock, 255, self()), |
| 348 | gen_tcp:controlling_process(Sock, IpaPid), |
| 349 | {ok, Port}; |
| 350 | {error, Reason} -> |
| 351 | {error, Reason} |
| 352 | end. |
| 353 | |
| 354 | % gen_tcp:connect() convenience wrappers |
| 355 | connect(Address, Port, Options) -> |
| 356 | connect(Address, Port, Options, infinity). |
| 357 | |
| 358 | connect(Address, Port, Options, Timeout) -> |
| 359 | case gen_tcp:connect(Address, Port, ?IPA_SOCKOPTS ++ Options, Timeout) of |
| 360 | {ok, Socket} -> |
| 361 | case ipa_proto:register_socket(Socket) of |
Harald Welte | 5cde762 | 2012-01-23 23:18:28 +0100 | [diff] [blame] | 362 | {ok, IpaPid} -> |
| 363 | {ok, {Socket, IpaPid}}; |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 364 | {error, Reason} -> |
| 365 | gen_tcp:close(Socket), |
| 366 | {error, Reason} |
| 367 | end; |
| 368 | {error, Reason} -> |
| 369 | {error, Reason} |
| 370 | end. |
| 371 | |
| 372 | % Utility function to continuously server incomming IPA connections on a |
| 373 | % listening TCP socket |
| 374 | start_listen(LPort, NumServers, Opts) -> |
| 375 | case gen_tcp:listen(LPort, ?IPA_SOCKOPTS ++ Opts) of |
| 376 | {ok, ListenSock} -> |
| 377 | start_servers(NumServers, ListenSock, self()), |
| 378 | {ok, Port} = inet:port(ListenSock), |
Alexander Couzens | c26105e | 2023-07-10 19:43:15 +0200 | [diff] [blame] | 379 | {ok, ListenSock, Port}; |
Harald Welte | 176e28c | 2010-12-19 22:56:58 +0100 | [diff] [blame] | 380 | {error, Reason} -> |
| 381 | {error, Reason} |
| 382 | end. |
| 383 | |
| 384 | start_servers(0, _, _) -> |
| 385 | ok; |
| 386 | start_servers(Num, LS, CtrlPid) -> |
| 387 | spawn(?MODULE, listen_server, [LS, CtrlPid]), |
| 388 | start_servers(Num-1, LS, CtrlPid). |
| 389 | |
| 390 | listen_server(LS, CtrlPid) -> |
| 391 | case gen_tcp:accept(LS) of |
| 392 | {ok, S} -> |
| 393 | io:format("Accepted TCP connection from ~p~n", [inet:peername(S)]), |
| 394 | % assign the socket to the Controlling process |
| 395 | gen_tcp:controlling_process(S, CtrlPid), |
| 396 | CtrlPid ! {ipa_tcp_accept, S}, |
| 397 | listen_server(LS, CtrlPid); |
| 398 | Other -> |
| 399 | io:format("accept returned ~w - goodbye!~n", [Other]), |
| 400 | ok |
| 401 | end. |