File 1047-observer-Add-socket-options-to-the-socket-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1047-observer-Add-socket-options-to-the-socket-info-windo.patch of Package erlang (Revision e6fae69e60dcc1918fd2bc4ae52e9ff8)

Currently displaying revision e6fae69e60dcc1918fd2bc4ae52e9ff8 , Show latest

From 662a861ff5130f6985001e33422ba69e3fbc83cd Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Tue, 11 May 2021 17:03:59 +0200
Subject: [PATCH 07/17] [observer] Add socket options to the 'socket info'
 window

Add a 'Options' section to the 'socket info' window.

OTP-17346
---
 lib/observer/src/observer_lib.erl          | 47 +++++++++--
 lib/observer/src/observer_sock_wx.erl      | 96 ++++++++++++----------
 lib/runtime_tools/src/observer_backend.erl | 77 ++++++++++++++++-
 3 files changed, 170 insertions(+), 50 deletions(-)

diff --git a/lib/observer/src/observer_lib.erl b/lib/observer/src/observer_lib.erl
index b5ffec9a73..7b2b3cd82c 100644
--- a/lib/observer/src/observer_lib.erl
+++ b/lib/observer/src/observer_lib.erl
@@ -174,8 +174,25 @@ fill_info([{dynamic, Key}|Rest], Data, Default)
 	undefined   -> [undefined | fill_info(Rest, Data, Default)];
 	{Str,Value} -> [{Str, Value} | fill_info(Rest, Data, Default)]
     end;
+%% This crap is simply to make it unique, see above.
+fill_info([{socket, Str, {Level, Opt} = Key}|Rest], Data, Default)
+  when is_list(Str) andalso is_atom(Level) andalso is_atom(Opt) ->
+    %% d("fill_info(2) -> entry with"
+    %%   "~n   Str: ~s", [Str]),
+    Key = {Level, Opt},
+    case get_value(Key, Data, Default) of
+	undefined ->
+	    %% d("fill_info -> not found"),
+	    [undefined | fill_info(Rest, Data, Default)];
+	Value ->
+	    %% d("fill_info -> found: "
+	    %%   "~n   Value: ~p", [Value]),
+	    [{Str, Value} | fill_info(Rest, Data, Default)]
+    end;
 fill_info([{Str, Key}|Rest], Data, Default)
   when is_atom(Key); is_function(Key) ->
+    %% d("fill_info(3) -> entry with"
+    %%   "~n   Str: ~s", [Str]),
     case get_value(Key, Data, Default) of
 	undefined ->
 	    [undefined | fill_info(Rest, Data, Default)];
@@ -184,6 +201,8 @@ fill_info([{Str, Key}|Rest], Data, Default)
     end;
 fill_info([{Str, Attrib, Key}|Rest], Data, Default)
   when is_atom(Key); is_function(Key) ->
+    %% d("fill_info(4) -> entry with"
+    %%   "~n   Str: ~s", [Str]),
     case get_value(Key, Data, Default) of
 	undefined ->
 	    [undefined | fill_info(Rest, Data, Default)];
@@ -192,31 +211,45 @@ fill_info([{Str, Attrib, Key}|Rest], Data, Default)
     end;
 fill_info([{Str, {Format, Key}}|Rest], Data, Default)
   when is_atom(Key); is_function(Key) ->
+    %% d("fill_info(5) -> entry with"
+    %%   "~n   Str: ~s", [Str]),
     case get_value(Key, Data, Default) of
 	undefined -> [undefined | fill_info(Rest, Data, Default)];
 	Value -> [{Str, {Format, Value}} | fill_info(Rest, Data, Default)]
     end;
 fill_info([{Str, Attrib, {Format, Key}}|Rest], Data, Default)
   when is_atom(Key); is_function(Key) ->
+    %% d("fill_info(6) -> entry with"
+    %%   "~n   Str:    ~s"
+    %%   "~n   Attrib: ~p"
+    %%   "~n   Format: ~p"
+    %%   "~n   Key:    ~p", [Str, Attrib, Format, Key]),
     case get_value(Key, Data, Default) of
 	undefined -> [undefined | fill_info(Rest, Data, Default)];
 	Value -> [{Str, Attrib, {Format, Value}} |
 		  fill_info(Rest, Data, Default)]
     end;
-fill_info([{Str,SubStructure}|Rest], Data, Default)
+fill_info([{Str, SubStructure}|Rest], Data, Default)
   when is_list(SubStructure) ->
+    %% d("fill_info(7) -> entry with"
+    %%   "~n   Str: ~s", [Str]),
     [{Str, fill_info(SubStructure, Data, Default)}|
      fill_info(Rest, Data, Default)];
-fill_info([{Str,Attrib,SubStructure}|Rest], Data, Default) ->
+fill_info([{Str, Attrib, SubStructure}|Rest], Data, Default) ->
+    %% d("fill_info(8) -> entry with"
+    %%   "~n   Str: ~s", [Str]),
     [{Str, Attrib, fill_info(SubStructure, Data, Default)}|
      fill_info(Rest, Data, Default)];
 fill_info([{Str, Key = {K,N}}|Rest], Data, Default)
   when is_atom(K), is_integer(N) ->
+    %% d("fill_info(9) -> entry with"
+    %%   "~n   Str: ~s", [Str]),
     case get_value(Key, Data, Default) of
 	undefined -> [undefined | fill_info(Rest, Data, Default)];
 	Value -> [{Str, Value} | fill_info(Rest, Data, Default)]
     end;
-fill_info([], _, _Default) -> [].
+fill_info([], _, _Default) ->
+    [].
 
 get_value(Fun, Data, _Default) when is_function(Fun) ->
     Fun(Data);
@@ -911,12 +944,14 @@ make_obsbin(Bin,Tab) ->
 %% d(F) ->
 %%     d(F, []).
 
-%% d(F, A) ->
+%% d(Debug, F) when is_boolean(Debug) andalso is_list(F) ->
+%%     d(Debug, F, []);
+%% d(F, A) when is_list(F) andalso is_list(A) ->
 %%     d(get(debug), F, A).
 
 %% d(true, F, A) ->
-%%     io:format("[ol] " ++ F ++ "~n", A);
+%%    io:format("[ol] " ++ F ++ "~n", A);
 %% d(_, _, _) ->
-%%     ok.
+%%    ok.
 
 
diff --git a/lib/observer/src/observer_sock_wx.erl b/lib/observer/src/observer_sock_wx.erl
index 4db42ba3e4..af95640d26 100644
--- a/lib/observer/src/observer_sock_wx.erl
+++ b/lib/observer/src/observer_sock_wx.erl
@@ -18,11 +18,17 @@
 %% %CopyrightEnd%
 -module(observer_sock_wx).
 
-%% {ok, S1} = socket:open(inet, stream, tcp).
-%% {ok, S2} = socket:open(inet6, stream, tcp).
-%% {ok, S3} = gen_tcp:listen(0, [{inet_backend, socket}]).
-%% {ok, S4} = socket:open(local, stream, default).
-%% ok = socket:bind(S4, #{family => local, path => "/tmp/foobar"}).
+%% {ok, S1} = socket:open(inet,  stream,    tcp).
+%% {ok, S2} = socket:open(inet6, stream,    tcp).
+%% {ok, S3} = socket:open(inet,  dgram,     udp).
+%% {ok, S4} = socket:open(inet6, dgram,     udp).
+%% {ok, S5} = socket:open(inet,  seqpacket, sctp).
+%% {ok, S6} = socket:open(inet6, seqpacket, sctp).
+%% {ok, S7} = socket:open(local, stream,    default).
+%% {ok, S8} = socket:open(local, dgram,     default).
+%% {ok, S9} = gen_tcp:listen(0, [{inet_backend, socket}]).
+%% ok = socket:bind(S7, #{family => local, path => "/tmp/foobarA"}).
+%% ok = socket:bind(S8, #{family => local, path => "/tmp/foobarB"}).
 
 -export([start_link/3]).
 
@@ -61,7 +67,8 @@
 	 rstate,
          wstate,
 	 monitored_by,
-	 statistics}).
+	 statistics,
+	 options}).
 
 -record(opt, {sort_key  = 2,
 	      sort_incr = true,
@@ -456,21 +463,23 @@ infomap_to_rec(#{id           := Id,
 		 rstates      := RState,
 		 wstates      := WState,
 		 monitored_by := MonitoredBy,
-		 statistics   := Statistics} = Info) ->
+		 statistics   := Statistics,
+		 options      := Options} = Info) ->
       #socket{id           = Id,
-	    id_str       = IdStr,
-	    kind         = Kind,
-	    fd           = FD,
-	    owner        = Owner,
-	    domain       = Domain,
-	    type         = Type,
-	    protocol     = Protocol,
-	    raddress     = maps:get(raddress, Info, undefined),
-	    laddress     = maps:get(laddress, Info, undefined),
-	    rstate       = RState,
-	    wstate       = WState,
-	    monitored_by = MonitoredBy,
-	    statistics   = Statistics}.
+	      id_str       = IdStr,
+	      kind         = Kind,
+	      fd           = FD,
+	      owner        = Owner,
+	      domain       = Domain,
+	      type         = Type,
+	      protocol     = Protocol,
+	      raddress     = maps:get(raddress, Info, undefined),
+	      laddress     = maps:get(laddress, Info, undefined),
+	      rstate       = RState,
+	      wstate       = WState,
+	      monitored_by = MonitoredBy,
+	      statistics   = Statistics,
+	      options      = Options}.
 
 socketrec_to_list(#socket{id           = Id,
 			  id_str       = IdStr,
@@ -485,7 +494,8 @@ socketrec_to_list(#socket{id           = Id,
 			  rstate       = RState,
 			  wstate       = WState,
 			  monitored_by = MonitoredBy,
-			  statistics   = Statistics}) ->
+			  statistics   = Statistics,
+			  options      = Options}) ->
     [{id,           Id},
      {id_str,       IdStr},
      {kind,         Kind},
@@ -499,7 +509,8 @@ socketrec_to_list(#socket{id           = Id,
      {rstate,       RState},
      {wstate,       WState},
      {monitored_by, MonitoredBy},
-     {statistics,   Statistics}].
+     {statistics,   Statistics},
+     {options,      Options}].
 
 display_socket_info(Parent, #socket{id_str = IdStr} = Sock, Opened) ->
     case lists:keyfind(IdStr, 1, Opened) of
@@ -547,24 +558,25 @@ socket_info_fields(Socket0) ->
            {"Write State",      wstate}]},
 	 {scroll_boxes,
 	  [{"Monitored by",1,{click,monitored_by}}]} | Struct0],
+    %% d("socket_info_fields -> "
+    %%   "~n   Struct: ~p"
+    %%   "~n   Socket: ~p", [Struct, Socket]),
     observer_lib:fill_info(Struct, Socket).
 
 extra_fields(Socket) ->
     Statistics = proplists:get_value(statistics, Socket, []),
-    %% Struct = [{"Net",
-    %% 	       [{"Local Address",      local_address},
-    %% 		{"Local Port Number",  local_port},
-    %% 		{"Remote Address",     remote_address},
-    %% 		{"Remote Port Number", remote_port}]},
-    %% 	      {"Statistics",
-    %% 	       [stat_name_and_unit(Key) || {Key,_} <- Statistics]}],
-    Struct = [{"Net",
-	       [{"Local Address",  laddress},
-		{"Remote Address", raddress}]},
-	      {"Statistics",
-	       [stat_name_and_unit(Key) || {Key,_} <- Statistics]}],
-    Socket1 = lists:keydelete(statistics, 1, Socket),
-    {Struct, Socket1 ++ Statistics}.
+    Options    = proplists:get_value(options, Socket, []),
+    Struct     = [{"Net",
+		   [{"Local Address",  laddress},
+		    {"Remote Address", raddress}]},
+		  {"Statistics",
+		   [stat_name_and_unit(Key) || {Key,_} <- Statistics]},
+		  {"Options",
+		   [{socket, sockopt_to_list(Key), Key} ||
+		       {Key, _} <- Options]}],
+    Socket1    = lists:keydelete(statistics, 1, Socket),
+    Socket2    = lists:keydelete(options, 1, Socket1),
+    {Struct, Socket2 ++ Statistics ++ Options}.
 
 stat_name_and_unit(acc_fails = Key) ->
     {"Number of accept fails", Key};
@@ -603,11 +615,9 @@ stat_name_and_unit(write_pkg_max = Key) ->
 stat_name_and_unit(Key) ->
     {atom_to_list(Key), Key}.
 
-%% filter_monitor_info() ->
-%%     fun(Data) ->
-%% 	    Ms = proplists:get_value(monitors, Data),
-%% 	    [Pid || {process, Pid} <- Ms]
-%%     end.
+sockopt_to_list({LevelOrProto, Opt}) ->
+    f("~w:~w", [LevelOrProto, Opt]).
+
 
 update_grid(Grid, Sel, Opt, Ports) ->
     wx:batch(fun() -> update_grid2(Grid, Sel, Opt, Ports) end).
@@ -708,7 +718,9 @@ f(F, A) ->
 %% d(F) ->
 %%     d(F, []).
 
-%% d(F, A) ->
+%% d(Debug, F) when is_boolean(Debug) andalso is_list(F) ->
+%%     d(Debug, F, []);
+%% d(F, A) when is_list(F) andalso is_list(A) ->
 %%     d(get(debug), F, A).
 
 %% d(true, F, A) ->
diff --git a/lib/runtime_tools/src/observer_backend.erl b/lib/runtime_tools/src/observer_backend.erl
index c7643958be..0895ce04ce 100644
--- a/lib/runtime_tools/src/observer_backend.erl
+++ b/lib/runtime_tools/src/observer_backend.erl
@@ -257,12 +257,83 @@ get_socket_list() ->
 		 _ ->
 		     Info6
 	     end,
+	 SockOpts =
+	     [{socket, Opt} || {Opt, true} <-
+				   socket:supports(options, socket)],
+	 DomainOpts =
+	     case Info7 of
+		 #{domain := inet6} ->
+		     [{ipv6, Opt} || {Opt, true} <-
+					 socket:supports(options, ipv6)];
+		 _ ->
+		     [{ip, Opt} || {Opt, true} <-
+				       socket:supports(options, ip)]
+	     end,
+	 ProtoOpts =
+	     case Info7 of
+		 #{domain   := Domain,
+		   type     := stream,
+		   protocol := tcp} when (Domain =:= inet) orelse
+					 (Domain =:= inet6) ->
+		     [{tcp, Opt} || {Opt, true} <-
+					socket:supports(options, tcp)];
+		 #{domain   := Domain,
+		   type     := dgram,
+		   protocol := udp} when (Domain =:= inet) orelse
+					 (Domain =:= inet6) ->
+		     [{udp, Opt} || {Opt, true} <-
+					socket:supports(options, udp)];
+		 #{domain   := Domain,
+		   type     := seqpacket,
+		   protocol := sctp} when (Domain =:= inet) orelse
+					  (Domain =:= inet6) ->
+		     [{sctp, Opt} || {Opt, true} <-
+					 socket:supports(options, sctp)];
+		 _ ->
+		     []
+	     end,
+	 %% d("get_socket_list -> "
+	 %%   "~n   Socket Opts: ~p"
+	 %%   "~n   Domain Opts: ~p"
+	 %%   "~n   Proto Opts:  ~p", [SockOpts, DomainOpts, ProtoOpts]),
+	 Opts = SockOpts ++ DomainOpts ++ ProtoOpts,
+	 Options =
+	     [case socket:getopt(S, Opt) of
+		  %% Convert to string?
+		  {ok, Value} ->
+		      %% d("get_socket_list -> ok: "
+		      %% 	"~n   Option: ~p"
+		      %% 	"~n   Value:  ~p", [Opt, Value]),
+		      {Opt, if (Value =:= []) -> "-"; true -> Value end};
+		  %% We need to handle error cases and convert them
+		  %% to something useful ("Not Supported")
+		  {error, enotsup} = _ERROR ->
+		      %% d("get_socket_list -> error: enotsup"),
+		      {Opt, "Not Supported"};
+		  {error, enoprotoopt} = _ERROR ->
+		      %% d("get_socket_list -> error: enoprotoopt"),
+		      {Opt, "Not Supported"};
+		  {error, enotconn} = _ERROR ->
+		      %% d("get_socket_list -> error: enotconn"),
+		      {Opt, "Not Connected"};
+		  {error, {invalid, _}} = _ERROR ->
+		      %% d("get_socket_list -> error: invalid"),
+		      {Opt, "Not Implemented"};
+		  {error, Reason} ->
+		      %% d("get_socket_list -> error: "
+		      %% 	"~n   Option: ~p"
+		      %% 	"~n   Reason: ~p", [Opt, _Reason]),
+		      {Opt, f("error:~p", [Reason])}
+	      end || Opt <- Opts],
+	 %% d("get_socket_list -> "
+	 %%   "~n   Options:  ~p", [Options]),
 	 Info7#{id           => S,
 		id_str       => IdStr,
 		fd           => FD,
 		kind         => Kind,
 		monitored_by => socket:monitored_by(S),
-		statistics   => Counters}
+		statistics   => Counters,
+		options      => lists:sort(Options)}
      end || S <- socket:which_sockets()].
 
 sockaddr_to_list(#{family := local, path := PathBin}) when is_binary(PathBin) ->
@@ -878,7 +949,9 @@ f(F, A) ->
 %% d(F) ->
 %%     d(F, []).
 
-%% d(F, A) ->
+%% d(Debug, F) when is_boolean(Debug) andalso is_list(F) ->
+%%     d(Debug, F, []);
+%% d(F, A) when is_list(F) andalso is_list(A) ->
 %%     d(get(debug), F, A).
 
 %% d(true, F, A) ->
-- 
2.26.2

Places

File 1047-observer-Add-socket-options-to-the-socket-info-windo.patch of Package erlang (Revision e6fae69e60dcc1918fd2bc4ae52e9ff8)

Places