From 638a610d0b7ada7b2099b6127410aafb9fae3313 Mon Sep 17 00:00:00 2001
From: Ahmed Omar <spawn.think@gmail.com>
Date: Wed, 15 Dec 2010 11:26:18 +0100
Subject: Fixes a race condition found in percept_db start/1 function.

When function start/1 finds an instance of percept_db running, it will send a message to stop it and spawn a process to start a new one, which leads to a race condition.
The function will return {restarted, pid()} but the pid() will die once it tries to create the ets table.
---
 lib/percept/src/percept_db.erl        | 49 +++++++++++++++++-----
 lib/percept/test/percept_db_SUITE.erl | 76 +++++++++++++++++++++++++++++++++++
 2 files changed, 116 insertions(+), 9 deletions(-)
 create mode 100644 lib/percept/test/percept_db_SUITE.erl

(limited to 'lib/percept')

diff --git a/lib/percept/src/percept_db.erl b/lib/percept/src/percept_db.erl
index edb0d79a29..52e9afb78f 100644
--- a/lib/percept/src/percept_db.erl
+++ b/lib/percept/src/percept_db.erl
@@ -33,7 +33,7 @@
 	]).
 
 -include("percept.hrl").
-
+-define(STOP_TIMEOUT, 1000).
 %%==========================================================================
 %%
 %% 		Type definitions 
@@ -77,17 +77,32 @@
 start() ->
     case erlang:whereis(percept_db) of
     	undefined ->
-	    Pid = spawn( fun() -> init_percept_db() end),
-	    erlang:register(percept_db, Pid),
-	    {started, Pid};
+	    {started, do_start()};
 	PerceptDB ->
-	    erlang:unregister(percept_db),
-	    PerceptDB ! {action, stop},
-	    Pid = spawn( fun() -> init_percept_db() end),
-	    erlang:register(percept_db, Pid),
-	    {restarted, Pid}
+	    {restarted, restart(PerceptDB)}
     end.
 
+%% @spec restart(pid()) -> pid()
+%% @private
+%% @doc restarts the percept database.
+
+-spec restart(pid())-> pid().
+
+restart(PerceptDB)->
+        stop_sync(PerceptDB),
+        do_start().
+
+%% @spec do_start(pid()) -> pid()
+%% @private
+%% @doc starts the percept database.
+
+-spec do_start()-> pid().
+
+do_start()->
+    Pid = spawn( fun() -> init_percept_db() end),
+    erlang:register(percept_db, Pid),
+    Pid.
+
 %% @spec stop() -> not_started | {stopped, Pid}
 %%	Pid = pid()
 %% @doc Stops the percept database.
@@ -103,6 +118,22 @@ stop() ->
 	    {stopped, Pid}
     end.
 
+%% @spec stop_sync(pid()) -> true
+%% @private
+%% @doc Stops the percept database, with a synchronous call.
+
+-spec stop_sync(pid())-> true.
+
+stop_sync(Pid)->
+    MonitorRef = erlang:monitor(process, Pid),
+    stop(),
+    receive
+        {'DOWN', MonitorRef, _Type, Pid, _Info}->
+            true
+    after ?STOP_TIMEOUT->
+            exit(Pid, kill)
+    end.
+
 %% @spec insert(tuple()) -> ok
 %% @doc Inserts a trace or profile message to the database.  
 
diff --git a/lib/percept/test/percept_db_SUITE.erl b/lib/percept/test/percept_db_SUITE.erl
new file mode 100644
index 0000000000..79be9714ba
--- /dev/null
+++ b/lib/percept/test/percept_db_SUITE.erl
@@ -0,0 +1,76 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2007-2010. All Rights Reserved.
+%%
+%% The contents of this file are subject to the Erlang Public License,
+%% Version 1.1, (the "License"); you may not use this file except in
+%% compliance with the License. You should have received a copy of the
+%% Erlang Public License along with this software. If not, it can be
+%% retrieved online at http://www.erlang.org/.
+%%
+%% Software distributed under the License is distributed on an "AS IS"
+%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+%% the License for the specific language governing rights and limitations
+%% under the License.
+%%
+%% %CopyrightEnd%
+%%
+
+-module(percept_db_SUITE).
+-include("test_server.hrl").
+
+%% Test server specific exports
+-export([all/1]).
+-export([init_per_suite/1, end_per_suite/1]).
+-export([init_per_testcase/2, end_per_testcase/2]).
+
+%% Test cases
+-export([
+	start/1
+	]).
+
+%% Default timetrap timeout (set in init_per_testcase)
+-define(default_timeout, ?t:minutes(2)).
+-define(restarts, 10).
+-define(alive_timeout, 500).
+
+init_per_suite(Config) when is_list(Config) ->
+    Config.
+
+end_per_suite(Config) when is_list(Config) ->
+    Config.
+
+init_per_testcase(_Case, Config) ->
+    Dog = ?t:timetrap(?default_timeout),
+    [{max_size, 300}, {watchdog,Dog} | Config].
+
+end_per_testcase(_Case, Config) ->
+    Dog = ?config(watchdog, Config),
+    ?t:timetrap_cancel(Dog),
+    ok.
+
+all(suite) ->
+    % Test cases
+    [start].
+
+%%----------------------------------------------------------------------
+%% Tests
+%%----------------------------------------------------------------------
+
+start(suite) ->
+    [];
+start(doc) ->
+    ["Percept_db start and restart test."];
+start(Config) when is_list(Config) ->
+    ok = restart(?restarts),
+    {stopped, _DB} = percept_db:stop(),
+    ok.
+
+restart(0)->
+    ok;
+restart(N)->
+    {_, DB} = percept_db:start(),
+    timer:sleep(?alive_timeout),
+    true = erlang:is_process_alive(DB),
+    restart(N-1).
-- 
cgit v1.2.3