Merge pull request #266 from stritzinger/otp-21-stacktrace-compatibility

Add compatibility for OTP 21+ stack traces

Author: ThomasArts

eqc/bitcask_qc_expiry.erl

@@ -26,6 +26,7 @@
 -include_lib("eqc/include/eqc.hrl").
 -include_lib("eunit/include/eunit.hrl").
 -include("include/bitcask.hrl").
+-include("stacktrace.hrl").
 
 -compile([export_all, nowarn_export_all]).
 
@@ -144,9 +145,9 @@ prop_expiry() ->
                                                  true
                                          end
                                      catch
-                                         X:Y ->
+                                         ?_exception_(X, Y, StackToken) ->
                                              io:format(user, "exception: ~p ~p @ ~p\n",
-                                                       [X,Y, erlang:get_stacktrace()]),
+                                                       [X,Y, ?_get_stacktrace_(StackToken)]),
                                              test_exception
                                      after
                                          bitcask:close(Bref)

src/bitcask.erl

@@ -46,6 +46,7 @@
 
 -include_lib("kernel/include/file.hrl").
 -include("bitcask.hrl").
+-include("stacktrace.hrl").
 
 
 -ifdef(PULSE).
@@ -471,8 +472,8 @@ open_fold_files(Dirname, Keydir, Count) ->
                 maybe_log_missing_file(Dirname, Keydir, ErrFile, Err),
                 open_fold_files(Dirname, Keydir, Count-1)
         end
-    catch X:Y ->
-            {error, {X,Y, erlang:get_stacktrace()}}
+    catch ?_exception_(X, Y, StackToken) ->
+            {error, {X,Y, ?_get_stacktrace_(StackToken)}}
     end.
 
 maybe_log_missing_file(Dirname, Keydir, ErrFile, enoent) ->
@@ -590,8 +591,8 @@ merge(Dirname, Opts, {FilesToMerge0, ExpiredFiles0}) ->
     catch
         throw:Reason ->
             Reason;
-        X:Y ->
-            {error, {generic_failure, X, Y, erlang:get_stacktrace()}}
+        ?_exception_(X, Y, StackToken) ->
+            {error, {generic_failure, X, Y, ?_get_stacktrace_(StackToken)}}
     end.
 
 %% Inner merge function, assumes that bitcask is running and all files exist.
@@ -1324,9 +1325,9 @@ init_keydir_scan_key_files(Dirname, KeyDir, KT, Count) ->
                                           F <- SetuidFiles]),
                 bitcask_nifs:increment_file_id(KeyDir, MaxSetuid)
         end
-    catch _X:_Y ->
+    catch ?_exception_(_X, _Y, StackToken) ->
             error_msg_perhaps("scan_key_files: ~p ~p @ ~p\n",
-                              [_X, _Y, erlang:get_stacktrace()]),
+                              [_X, _Y, ?_get_stacktrace_(StackToken)]),
             init_keydir_scan_key_files(Dirname, KeyDir, KT, Count - 1)
     end.
 
@@ -1930,10 +1931,10 @@ purge_setuid_files(Dirname) ->
                                               [length(StaleFs), Dirname])
                 end
             catch
-                X:Y ->
+                ?_exception_(X, Y, StackToken) ->
                     error_msg_perhaps("While deleting stale merge input "
                                       "files from ~p: ~p @ ~p\n",
-                                      [X, Y, erlang:get_stacktrace()])
+                                      [X, Y, ?_get_stacktrace_(StackToken)])
             after
                 bitcask_lockops:release(WriteLock)
             end;

src/stacktrace.hrl

@@ -0,0 +1,33 @@
+%% Originating from Quviq AB
+%% Fix to make Erlang programs compile on both OTP20 and OTP21.
+%%
+%% Get the stack trace in a way that is backwards compatible. Luckily
+%% OTP_RELEASE was introduced in the same version as the new preferred way of
+%% getting the stack trace. A _catch_/2 macro is provided for consistency in
+%% cases where the stack trace is not needed.
+%%
+%% Example use:
+%%    try f(...)
+%%    catch
+%%         ?_exception_(_, Reason, StackToken) ->
+%%             case Reason of
+%%                 {fail, Error} -> ok;
+%%                 _             -> {'EXIT', Reason, ?_get_stacktrace_(StackToken)}
+%%             end
+%%     end,
+
+-ifdef(OTP_RELEASE). %% This implies 21 or higher
+-define(_exception_(Class, Reason, StackToken), Class:Reason:StackToken).
+-define(_get_stacktrace_(StackToken), StackToken).
+-define(_current_stacktrace_(),
+        try
+            exit('$get_stacktrace')
+        catch
+            exit:'$get_stacktrace':__GetCurrentStackTrace ->
+                __GetCurrentStackTrace
+        end).
+-else.
+-define(_exception_(Class, Reason, _), Class:Reason).
+-define(_get_stacktrace_(_), erlang:get_stacktrace()).
+-define(_current_stacktrace_(), erlang:get_stacktrace()).
+-endif.