emqx_pmon.erl

%%--------------------------------------------------------------------
%% Copyright (c) 2017-2022 EMQ Technologies Co., Ltd. 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.
%%--------------------------------------------------------------------

-module(emqx_pmon).

-compile({no_auto_import, [monitor/3]}).

-export([new/0]).

-export([ monitor/2
        , monitor/3
        , demonitor/2
        ]).

-export([ find/2
        , erase/2
        , erase_all/2
        ]).

-export([count/1]).

-export_type([pmon/0]).

-opaque(pmon() :: {?MODULE, map()}).

-define(PMON(Map), {?MODULE, Map}).

%%--------------------------------------------------------------------
%% APIs
%%--------------------------------------------------------------------

-spec(new() -> pmon()).
new() -> ?PMON(maps:new()).

-spec(monitor(pid(), pmon()) -> pmon()).
monitor(Pid, PMon) ->
    ?MODULE:monitor(Pid, undefined, PMon).

-spec(monitor(pid(), term(), pmon()) -> pmon()).
monitor(Pid, Val, ?PMON(Map)) ->
    case maps:is_key(Pid, Map) of
        true  ->
            {Ref, _Val} = maps:get(Pid, Map),
            ?PMON(maps:put(Pid, {Ref, Val}, Map));
        false ->
            Ref = erlang:monitor(process, Pid),
            ?PMON(maps:put(Pid, {Ref, Val}, Map))
    end.

-spec(demonitor(pid(), pmon()) -> pmon()).
demonitor(Pid, PMon = ?PMON(Map)) ->
    case maps:find(Pid, Map) of
        {ok, {Ref, _Val}} ->
            %% flush
            _ = erlang:demonitor(Ref, [flush]),
            ?PMON(maps:remove(Pid, Map));
        error -> PMon
    end.

-spec(find(pid(), pmon()) -> error | {ok, term()}).
find(Pid, ?PMON(Map)) ->
    case maps:find(Pid, Map) of
        {ok, {_Ref, Val}} ->
            {ok, Val};
        error -> error
    end.

-spec(erase(pid(), pmon()) -> pmon()).
erase(Pid, ?PMON(Map)) ->
    ?PMON(maps:remove(Pid, Map)).

-spec(erase_all([pid()], pmon()) -> {[{pid(), term()}], pmon()}).
erase_all(Pids, PMon0) ->
    lists:foldl(
      fun(Pid, {Acc, PMon}) ->
          case find(Pid, PMon) of
              {ok, Val} ->
                  {[{Pid, Val}|Acc], erase(Pid, PMon)};
              error -> {Acc, PMon}
          end
      end, {[], PMon0}, Pids).

-spec(count(pmon()) -> non_neg_integer()).
count(?PMON(Map)) -> maps:size(Map).