File 1221-ssh-Add-tcp-to-ssh_dbg.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1221-ssh-Add-tcp-to-ssh_dbg.patch of Package erlang (Revision 265b547b5a7ae5e597aaf8c66f401306)

Currently displaying revision 265b547b5a7ae5e597aaf8c66f401306 , Show latest

From 8ec77e327c86873acd688b08c35f9c2602632be1 Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Thu, 19 Aug 2021 15:50:53 +0200
Subject: [PATCH] ssh: Add 'tcp' to ssh_dbg

---
 lib/ssh/src/ssh.erl                    | 72 ++++++++++++++++++++--
 lib/ssh/src/ssh_acceptor.erl           | 82 +++++++++++++++++++++-----
 lib/ssh/src/ssh_connection_handler.erl | 52 +++++++++++++++-
 3 files changed, 186 insertions(+), 20 deletions(-)

diff --git a/lib/ssh/src/ssh.erl b/lib/ssh/src/ssh.erl
index b24df1ecf7..bf354c7ef6 100644
--- a/lib/ssh/src/ssh.erl
+++ b/lib/ssh/src/ssh.erl
@@ -53,6 +53,9 @@
 %%% Internal export
 -export([is_host/2]).
 
+-behaviour(ssh_dbg).
+-export([ssh_dbg_trace_points/0, ssh_dbg_flags/1, ssh_dbg_on/1, ssh_dbg_off/1, ssh_dbg_format/2, ssh_dbg_format/3]).
+
 %%% "Deprecated" types export:
 -export_type([ssh_daemon_ref/0, ssh_connection_ref/0, ssh_channel_id/0]).
 -opaque ssh_daemon_ref()     :: daemon_ref().
@@ -173,8 +176,7 @@ connect(Host0, Port, UserOptions, NegotiationTimeout) when is_integer(Port),
             SocketOpts = [{active,false} | ?GET_OPT(socket_options,Options)],
             Host = mangle_connect_address(Host0, Options),
             try 
-                {_, Callback, _} = ?GET_OPT(transport, Options),
-                Callback:connect(Host, Port, SocketOpts, ?GET_OPT(connect_timeout,Options))
+                transport_connect(Host, Port, SocketOpts, Options)
             of
                 {ok, Socket} ->
                     continue_connect(Socket, Options, NegotiationTimeout);
@@ -351,8 +353,7 @@ daemon(Host0, Port0, UserOptions0) when 0 =< Port0, Port0 =< 65535,
                 {ok,DaemonRef} ->
                     receive
                         {request_control, ListenSocket, ReqPid} ->
-                            {_, Callback, _} = ?GET_OPT(transport, Options1),
-                            ok = Callback:controlling_process(ListenSocket, ReqPid),
+                            ok = controlling_process(ListenSocket, ReqPid, Options1),
                             ReqPid ! {its_yours,ListenSocket}
                     end,
                     {ok,DaemonRef};
@@ -864,6 +865,14 @@ close_listen_socket(ListenSocket, Options) ->
         _C:_E -> ok
     end.
 
+controlling_process(ListenSocket, ReqPid, Options) ->
+    {_, Callback, _} = ?GET_OPT(transport, Options),
+    Callback:controlling_process(ListenSocket, ReqPid).
+
+transport_connect(Host, Port, SocketOpts, Options) ->
+    {_, Callback, _} = ?GET_OPT(transport, Options),
+    Callback:connect(Host, Port, SocketOpts, ?GET_OPT(connect_timeout,Options)).
+    
 %%%----------------------------------------------------------------
 is_host(X, Opts) ->
     try is_host1(mangle_connect_address(X, Opts))
@@ -912,3 +921,58 @@ mangle_tunnel_address(X) when is_list(X) -> case catch inet:parse_address(X) of
                                      {ok, {0,0,0,0,0,0,0,0}} -> <<"">>;
                                      _ -> list_to_binary(X)
                                  end.
+
+
+%%%################################################################
+%%%#
+%%%# Tracing
+%%%#
+
+ssh_dbg_trace_points() -> [tcp].
+
+ssh_dbg_flags(tcp) -> [c].
+
+ssh_dbg_on(tcp) -> dbg:tpl(?MODULE, controlling_process, 3, x),
+                   dbg:tpl(?MODULE, transport_connect, 4, x),
+                   dbg:tpl(?MODULE, close_listen_socket, 2, x).
+                   
+ssh_dbg_off(tcp) ->dbg:ctpl(?MODULE, controlling_process, 3),
+                   dbg:ctpl(?MODULE, transport_connect, 4),
+                   dbg:ctpl(?MODULE, close_listen_socket, 2).
+
+ssh_dbg_format(tcp, {call, {?MODULE,controlling_process, [ListenSocket, ReqPid, _Opts]}}) ->
+    ["TCP socket transferred to\n",
+     io_lib:format("Sock: ~p~n"
+                   "ToPid: ~p~n", [ListenSocket, ReqPid])
+    ];
+ssh_dbg_format(tcp, {return_from, {?MODULE,controlling_process,3}, _Result}) ->
+    skip;
+
+ssh_dbg_format(tcp, {call, {?MODULE,close_listen_socket, [ListenSocket, _Opts]}}) ->
+    ["TCP socket listening closed\n",
+     io_lib:format("Sock: ~p~n", [ListenSocket])
+    ];
+ssh_dbg_format(tcp, {return_from, {?MODULE,close_listen_socket,2}, _Result}) ->
+    skip.
+
+
+ssh_dbg_format(tcp, {call, {?MODULE,transport_connect, [Host,Port,SockOpts,_Opts]}}, Stack) ->
+    {skip, [{transport_connect,Host,Port,SockOpts}|Stack]};
+ssh_dbg_format(tcp, {return_from, {?MODULE,transport_connect,4}, {ok,Sock}},
+               [{transport_connect,Host,Port,SockOpts}|Stack]) ->
+    {["TCP connected to\n",
+      io_lib:format("Host: ~p~n"
+                    "Port: ~p~n"
+                    "SockOpts: ~p~n"
+                    "Socket: ~p~n", [Host,Port,SockOpts,Sock])
+     ],
+     Stack};
+ssh_dbg_format(tcp, {return_from, {?MODULE,transport_connect,4}, Result},
+               [{transport_connect,Host,Port,SockOpts}|Stack]) ->
+    {["TCP connected FAILED to\n",
+      io_lib:format("Host: ~p~n"
+                    "Port: ~p~n"
+                    "SockOpts: ~p~n"
+                    "Result: ~p~n", [Host,Port,SockOpts,Result])
+     ],
+     Stack}.
diff --git a/lib/ssh/src/ssh_acceptor.erl b/lib/ssh/src/ssh_acceptor.erl
index 3ea066f98d..70ebffbea3 100644
--- a/lib/ssh/src/ssh_acceptor.erl
+++ b/lib/ssh/src/ssh_acceptor.erl
@@ -30,10 +30,10 @@
 	 listen/2]).
 
 %% spawn export  
--export([acceptor_init/4, acceptor_loop/7]).
+-export([acceptor_init/4, acceptor_loop/6]).
 
 -behaviour(ssh_dbg).
--export([ssh_dbg_trace_points/0, ssh_dbg_flags/1, ssh_dbg_on/1, ssh_dbg_off/1, ssh_dbg_format/2]).
+-export([ssh_dbg_trace_points/0, ssh_dbg_flags/1, ssh_dbg_on/1, ssh_dbg_off/1, ssh_dbg_format/2, ssh_dbg_format/3]).
 
 -define(SLEEP_TIME, 200).
 
@@ -59,6 +59,14 @@ listen(Port, Options) ->
 	    Other
     end.
 
+accept(ListenSocket, AcceptTimeout, Options) ->
+    {_, Callback, _} = ?GET_OPT(transport, Options),
+    Callback:accept(ListenSocket, AcceptTimeout).
+
+close(Socket, Options) ->
+    {_, Callback, _} = ?GET_OPT(transport, Options),
+    Callback:close(Socket).
+    
 %%--------------------------------------------------------------------
 %%% Internal functions
 %%--------------------------------------------------------------------
@@ -66,7 +74,6 @@ acceptor_init(Parent, SystemSup,
               #address{address=Address, port=Port, profile=_Profile},
               Opts) ->
     AcceptTimeout = ?GET_INTERNAL_OPT(timeout, Opts, ?DEFAULT_TIMEOUT),
-    {_, Callback, _} =  ?GET_OPT(transport, Opts),
     case ?GET_INTERNAL_OPT(lsocket, Opts, undefined) of
         {LSock, SockOwner} ->
             %% A listening socket (or fd option) was provided in the ssh:daemon call
@@ -75,7 +82,7 @@ acceptor_init(Parent, SystemSup,
                     %% A usable, open LSock
                     proc_lib:init_ack(Parent, {ok, self()}),
                     request_ownership(LSock, SockOwner),
-                    acceptor_loop(Callback, Port, Address, Opts, LSock, AcceptTimeout, SystemSup);
+                    acceptor_loop(Port, Address, Opts, LSock, AcceptTimeout, SystemSup);
 
                 {error,_Error} ->
                     %% Not open, a restart
@@ -84,7 +91,7 @@ acceptor_init(Parent, SystemSup,
                         {ok,NewLSock} ->
                             proc_lib:init_ack(Parent, {ok, self()}),
                             Opts1 = ?DELETE_INTERNAL_OPT(lsocket, Opts),
-                            acceptor_loop(Callback, Port, Address, Opts1, NewLSock, AcceptTimeout, SystemSup);
+                            acceptor_loop(Port, Address, Opts1, NewLSock, AcceptTimeout, SystemSup);
                         {error,Error} ->
                             proc_lib:init_ack(Parent, {error,Error})
                     end
@@ -95,7 +102,7 @@ acceptor_init(Parent, SystemSup,
             case listen(Port, Opts) of
                 {ok,LSock} ->
                     proc_lib:init_ack(Parent, {ok, self()}),
-                    acceptor_loop(Callback, Port, Address, Opts, LSock, AcceptTimeout, SystemSup);
+                    acceptor_loop(Port, Address, Opts, LSock, AcceptTimeout, SystemSup);
                 {error,Error} ->
                     proc_lib:init_ack(Parent, {error,Error})
             end
@@ -122,13 +129,13 @@ request_ownership(LSock, SockOwner) ->
     end.
     
 %%%----------------------------------------------------------------    
-acceptor_loop(Callback, Port, Address, Opts, ListenSocket, AcceptTimeout, SystemSup) ->
-    case Callback:accept(ListenSocket, AcceptTimeout) of
+acceptor_loop(Port, Address, Opts, ListenSocket, AcceptTimeout, SystemSup) ->
+    case accept(ListenSocket, AcceptTimeout, Opts) of
         {ok,Socket} ->
             {ok, {FromIP,FromPort}} = inet:peername(Socket), % Just in case of error in next line:
             case handle_connection(SystemSup, Address, Port, Opts, Socket) of
                 {error,Error} ->
-                    catch Callback:close(Socket),
+                    catch close(Socket, Opts),
                     handle_error(Error, Address, Port, FromIP, FromPort);
                 _ ->
                     ok
@@ -136,7 +143,7 @@ acceptor_loop(Callback, Port, Address, Opts, ListenSocket, AcceptTimeout, System
         {error,Error} ->
             handle_error(Error, Address, Port)
     end,
-    ?MODULE:acceptor_loop(Callback, Port, Address, Opts, ListenSocket, AcceptTimeout, SystemSup).
+    ?MODULE:acceptor_loop(Port, Address, Opts, ListenSocket, AcceptTimeout, SystemSup).
 
 %%%----------------------------------------------------------------
 handle_connection(SystemSup, Address, Port, Options0, Socket) ->
@@ -210,15 +217,60 @@ number_of_connections(SysSupPid) ->
 %%%# Tracing
 %%%#
 
-ssh_dbg_trace_points() -> [connections].
+ssh_dbg_trace_points() -> [connections, tcp].
 
+ssh_dbg_flags(tcp) -> [c];
 ssh_dbg_flags(connections) -> [c].
 
+ssh_dbg_on(tcp) -> dbg:tp(?MODULE, listen, 2, x),
+                   dbg:tpl(?MODULE, accept, 3, x),
+                   dbg:tpl(?MODULE, close, 2, x);
+                   
 ssh_dbg_on(connections) -> dbg:tp(?MODULE,  acceptor_init, 4, x),
-                           dbg:tpl(?MODULE, handle_connection, 4, x).
+                           dbg:tpl(?MODULE, handle_connection, 5, x).
+
+ssh_dbg_off(tcp) -> dbg:ctpg(?MODULE, listen, 2),
+                    dbg:ctpl(?MODULE, accept, 3),
+                    dbg:ctpl(?MODULE, close, 2);
 
 ssh_dbg_off(connections) -> dbg:ctp(?MODULE, acceptor_init, 4),
-                            dbg:ctp(?MODULE, handle_connection, 4).
+                            dbg:ctp(?MODULE, handle_connection, 5).
+
+ssh_dbg_format(tcp, {call, {?MODULE,listen, [Port,_Opts]}}, Stack) ->
+    {skip, [{port,Port}|Stack]};
+ssh_dbg_format(tcp, {return_from, {?MODULE,listen,2}, {ok,Sock}}, [{port,Port}|Stack]) ->
+    {["TCP listener started\n",
+      io_lib:format("Port: ~p~n"
+                    "ListeningSocket: ~p~n", [Port,Sock])
+     ],
+     Stack};
+ssh_dbg_format(tcp, {return_from, {?MODULE,listen,2}, Result}, [{port,Port}|Stack]) ->
+    {["TCP listener start ERROR\n",
+      io_lib:format("Port: ~p~n"
+                    "Return: ~p~n", [Port,Result])
+     ],
+     Stack};
+
+ssh_dbg_format(tcp, {call, {?MODULE,accept, [ListenSocket, _AcceptTimeout, _Options]}}, Stack) ->
+    {skip, [{lsock,ListenSocket}|Stack]};
+ssh_dbg_format(tcp, {return_from, {?MODULE,accept,3}, {ok,Sock}}, [{lsock,ListenSocket}|Stack]) ->
+    {["TCP accept\n",
+      io_lib:format("ListenSock: ~p~n"
+                    "New Socket: ~p~n", [ListenSocket,Sock])
+     ], Stack};
+ssh_dbg_format(tcp, {return_from, {?MODULE,accept,3}, {error,timeout}}, [{lsock,_ListenSocket}|Stack]) ->
+    {skip, Stack};
+ssh_dbg_format(tcp, {return_from, {?MODULE,accept,3}, Return}, [{lsock,ListenSocket}|Stack]) ->
+    {["TCP accept returned\n",
+      io_lib:format("ListenSock: ~p~n"
+                    "Return: ~p~n", [ListenSocket,Return])
+     ], Stack}.
+
+ssh_dbg_format(tcp, {call, {?MODULE,close, [Socket, _Options]}}) ->
+    ["TCP close listen socket\n",
+     io_lib:format("Socket: ~p~n", [Socket])];
+ssh_dbg_format(tcp, {return_from, {?MODULE,close,2}, _Return}) ->
+    skip;
 
 ssh_dbg_format(connections, {call, {?MODULE,acceptor_init, [_Parent, _SysSup, Address, _Opts]}}) ->
     [io_lib:format("Starting LISTENER on ~s\n", [ssh_lib:format_address(Address)])
@@ -226,9 +278,9 @@ ssh_dbg_format(connections, {call, {?MODULE,acceptor_init, [_Parent, _SysSup, Ad
 ssh_dbg_format(connections, {return_from, {?MODULE,acceptor_init,4}, _Ret}) ->
     skip;
 
-ssh_dbg_format(connections, {call, {?MODULE,handle_connection,[_,_,_,_]}}) ->
+ssh_dbg_format(connections, {call, {?MODULE,handle_connection,[_SystemSup,_Address,_Port,_Options,_Sock]}}) ->
     skip;
-ssh_dbg_format(connections, {return_from, {?MODULE,handle_connection,4}, {error,Error}}) ->
+ssh_dbg_format(connections, {return_from, {?MODULE,handle_connection,5}, {error,Error}}) ->
     ["Starting connection to server failed:\n",
      io_lib:format("Error = ~p", [Error])
     ].
diff --git a/lib/ssh/src/ssh_connection_handler.erl b/lib/ssh/src/ssh_connection_handler.erl
index 14738cbd03..0adc055ee5 100644
--- a/lib/ssh/src/ssh_connection_handler.erl
+++ b/lib/ssh/src/ssh_connection_handler.erl
@@ -2008,12 +2008,14 @@ update_inet_buffers(Socket) ->
 %%%# Tracing
 %%%#
 
-ssh_dbg_trace_points() -> [terminate, disconnect, connections, connection_events, renegotiation].
+ssh_dbg_trace_points() -> [terminate, disconnect, connections, connection_events, renegotiation,
+                           tcp].
 
 ssh_dbg_flags(connections) -> [c | ssh_dbg_flags(terminate)];
 ssh_dbg_flags(renegotiation) -> [c];
 ssh_dbg_flags(connection_events) -> [c];
 ssh_dbg_flags(terminate) -> [c];
+ssh_dbg_flags(tcp) -> [c];
 ssh_dbg_flags(disconnect) -> [c].
 
 ssh_dbg_on(connections) -> dbg:tp(?MODULE,  init, 1, x),
@@ -2025,11 +2027,22 @@ ssh_dbg_on(renegotiation) -> dbg:tpl(?MODULE,   init_renegotiate_timers, 3, x),
                              dbg:tpl(?MODULE,   start_rekeying, 2, x),
                              dbg:tp(?MODULE,   renegotiate, 1, x);
 ssh_dbg_on(terminate) -> dbg:tp(?MODULE,  terminate, 3, x);
+ssh_dbg_on(tcp) -> dbg:tp(?MODULE, handle_event, 4,
+                          [{[info, {tcp,'_','_'},       '_', '_'], [], []},
+                           {[info, {tcp_error,'_','_'}, '_', '_'], [], []},
+                           {[info, {tcp_closed,'_'},    '_', '_'], [], []}
+                          ]),
+                   dbg:tp(?MODULE, send_bytes, 2, x),
+                   dbg:tpl(?MODULE, close_transport, 1, x);
+                          
 ssh_dbg_on(disconnect) -> dbg:tpl(?MODULE,  send_disconnect, 7, x).
 
 
 ssh_dbg_off(disconnect) -> dbg:ctpl(?MODULE, send_disconnect, 7);
 ssh_dbg_off(terminate) -> dbg:ctpg(?MODULE, terminate, 3);
+ssh_dbg_off(tcp) -> dbg:ctpg(?MODULE, handle_event, 4), % How to avoid cancelling 'connection_events' ?
+                    dbg:ctpl(?MODULE, send_bytes, 2),
+                    dbg:ctpg(?MODULE, close_transport, 1);
 ssh_dbg_off(renegotiation) -> dbg:ctpl(?MODULE,   init_renegotiate_timers, 3),
                               dbg:ctpl(?MODULE,   pause_renegotiate_timers, 3),
                               dbg:ctpl(?MODULE,   check_data_rekeying_dbg, 2),
@@ -2075,6 +2088,43 @@ ssh_dbg_format(connection_events, {return_from, {?MODULE,handle_event,4}, Ret})
      io_lib:format("~p~n", [ssh_dbg:reduce_state(Ret, #data{})])
     ];
 
+ssh_dbg_format(tcp, {call, {?MODULE,handle_event, [info, {tcp,Sock,TcpData}, State, _Data]}}) ->
+    ["TCP stream data arrived\n",
+     io_lib:format("State: ~p~n"
+                   "Socket: ~p~n"
+                   "TcpData:~n~s", [State, Sock, ssh_dbg:hex_dump(TcpData, [{max_bytes,48}])])
+    ];
+ssh_dbg_format(tcp, {call, {?MODULE,handle_event, [info, {tcp_error,Sock,Msg}, State, _Data]}}) ->
+    ["TCP stream data ERROR arrived\n",
+     io_lib:format("State: ~p~n"
+                   "Socket: ~p~n"
+                   "ErrorMsg:~p~n", [State, Sock, Msg])
+    ];
+ssh_dbg_format(tcp, {call, {?MODULE,handle_event, [info, {tcp_closed,Sock}, State, _Data]}}) ->
+    ["TCP stream closed\n",
+     io_lib:format("State: ~p~n"
+                   "Socket: ~p~n", [State, Sock])
+    ];
+ssh_dbg_format(tcp, {return_from, {?MODULE,handle_event,4}, _Ret}) ->
+    skip;
+
+ssh_dbg_format(tcp, {call, {?MODULE, send_bytes, ["",_D]}}) ->
+    skip;
+ssh_dbg_format(tcp, {call, {?MODULE, send_bytes, [TcpData, #data{socket=Sock}]}}) ->
+    ["TCP send stream data\n",
+     io_lib:format("Socket: ~p~n"
+                   "TcpData:~n~s", [Sock, ssh_dbg:hex_dump(TcpData, [{max_bytes,48}])])
+    ];
+ssh_dbg_format(tcp, {return_from, {?MODULE,send_bytes,2}, _R}) ->
+    skip;
+
+ssh_dbg_format(tcp, {call, {?MODULE, close_transport, [#data{socket=Sock}]}}) ->
+    ["TCP close stream\n",
+     io_lib:format("Socket: ~p~n", [Sock])
+    ];
+ssh_dbg_format(tcp, {return_from, {?MODULE,close_transport,1}, _R}) ->
+    skip;
+
 ssh_dbg_format(renegotiation, {call, {?MODULE,init_renegotiate_timers,[OldState,NewState,D]}}) ->
     ["Renegotiation: start timer (init_renegotiate_timers)\n",
      io_lib:format("State: ~p  -->  ~p~n"
-- 
2.31.1

Places

File 1221-ssh-Add-tcp-to-ssh_dbg.patch of Package erlang (Revision 265b547b5a7ae5e597aaf8c66f401306)

Places