File: socket_test_logger.erl

package info (click to toggle)
erlang 1%3A27.3.4.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 225,000 kB
  • sloc: erlang: 1,658,966; ansic: 405,769; cpp: 177,850; xml: 82,435; makefile: 15,031; sh: 14,401; lisp: 9,812; java: 8,603; asm: 6,541; perl: 5,836; python: 5,484; sed: 72
file content (151 lines) | stat: -rw-r--r-- 4,339 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2018-2021. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%%     http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%

-module(socket_test_logger).

-export([
         start/0, start/1,
         stop/0,
         format/2
        ]).


-define(QUIET,  true).
-define(LIB,    socket_test_lib).
-define(LOGGER, ?MODULE).


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

start() ->
    start(?QUIET).

start(Quiet) ->
    case global:whereis_name(?LOGGER) of
        Pid when is_pid(Pid) ->
            ok;
        undefined ->
            Self = self(),
            Pid = spawn(fun() -> init(Self, Quiet) end),
            %% We have seen some (strange) cases where the call to 
            %% register (global:register_name/2) takes *a long time*.
            %% This operation should not take more than a couple of
            %% seconds in our case (we have no complex test environment).
            %% So, we give it a bit more, 15 seconds.
            %% If it has not completed within that time limit, we give up!
            %% yes = global:register_name(?LOGGER, Pid),
            {Register, MRef} = spawn_monitor(fun() -> register_logger(Pid) end),
            await_register_logger(Register, MRef)
    end.

register_logger(Pid) when is_pid(Pid) ->
    print("[~s] try register logger (~p)", [?LIB:formated_timestamp(), Pid]),
    yes = global:register_name(?LOGGER, Pid),
    exit(ok).


await_register_logger(Pid, MRef) ->
    receive
        {'DOWN', MRef, process, Pid, ok} ->
            print("[~s] logger registration done", [?LIB:formated_timestamp()]),
            ok;
        {'DOWN', MRef, process, Pid, Reason} ->
            print("[~s] <ERROR> logger registration failed: "
                  "~n      ~p", [?LIB:formated_timestamp(), Reason]),
            {error, Reason}
    after 15000 ->
            print("[~s] <ERROR> logger registration failed: timeout",
                  [?LIB:formated_timestamp()]),
            erlang:demonitor(MRef, [flush]),
            exit(Pid, kill),
            {error, registration_timeout}
    end.


stop() ->
    case global:whereis_name(?LOGGER) of
        undefined ->
            ok;
        Pid when is_pid(Pid) ->
            global:unregister_name(?LOGGER),
            Pid ! {?LOGGER, '$logger', stop},
            ok
    end.


format(F, []) ->
    do_format(F);
format(F, A) ->
    do_format(?LIB:f(F, A)).

do_format(Msg) ->
    case global:whereis_name(?LOGGER) of
        undefined ->
            ok;
        Pid when is_pid(Pid) ->
            Pid ! {?MODULE, '$logger', {msg, Msg}},
            ok
    end.

init(Parent, Quiet) ->
    put(sname, "logger"),
    print("[~s][logger] starting~n", [?LIB:formated_timestamp()]),
    loop(#{parent => Parent, quiet => Quiet}).

loop(#{parent := Parent,
       quiet  := Quiet} = State) ->
    receive
        {'EXIT', Parent, _} ->
            print("[~s][logger] parent exit~n", [?LIB:formated_timestamp()]),
            exit(normal);

        {?MODULE, '$logger', stop} ->
            print("[~s][logger] stopping~n", [?LIB:formated_timestamp()]),
            exit(normal);

        {?MODULE, '$logger', {msg, Msg}} ->
            print_str(Quiet, Msg),
            loop(State)
    end.


%% print(F) ->
%%     print(F, []).

print(F, A) ->
    print_str(false, ?LIB:f(F, A)).

print_str(Quiet, Str) ->
    try
        begin
            if (Quiet =/= true) -> io:format(user, Str ++ "~n", []);
               true             -> ok
            end,
            io:format(Str, [])
        end
    catch
        _:_:_ ->
            io:format(user,
                      "~nFailed Format message:"
                      "~n~p~n", [Str]),
            io:format("~nFailed Format message:"
                      "~n~p~n", [Str])
    end.