Change naming in rabbit_guid, explicit guid passing in string/0 and binary/0.

Specifically:
fast_guid()            -> gen()
guid()                 -> secure_gen()
string_guid(Prefix)    -> string(Guid, Prefix)
binstring_guid(Prefix) -> binary(Guid, Prefix)

6 files changed, 46 insertions, 45 deletions

diff --git a/src/rabbit_basic.erl b/src/rabbit_basic.erl
index 0af35134..85a18c71 100644
--- a/src/rabbit_basic.erl
+++ b/src/rabbit_basic.erl
@@ -139,7 +139,7 @@ message(XName, RoutingKey, #content{properties = Props} = DecodedContent) ->
         {ok, #basic_message{
            exchange_name = XName,
            content       = strip_header(DecodedContent, ?DELETED_HEADER),
-           id            = rabbit_guid:fast_guid(),
+           id            = rabbit_guid:gen(),
            is_persistent = is_message_persistent(DecodedContent),
            routing_keys  = [RoutingKey |
                             header_routes(Props#'P_basic'.headers)]}}
diff --git a/src/rabbit_channel.erl b/src/rabbit_channel.erl
index f14b2973..e650d37b 100644
--- a/src/rabbit_channel.erl
+++ b/src/rabbit_channel.erl
@@ -730,7 +730,8 @@ handle_method(#'basic.consume'{queue        = QueueNameBin,
             check_read_permitted(QueueName, State),
             ActualConsumerTag =
                 case ConsumerTag of
-                    <<>>  -> rabbit_guid:binstring_guid("amq.ctag");
+                    <<>>  -> rabbit_guid:binary(rabbit_guid:gen_secure(),
+                                                "amq.ctag");
                     Other -> Other
                 end,
 
@@ -960,7 +961,8 @@ handle_method(#'queue.declare'{queue       = QueueNameBin,
                 false -> none
             end,
     ActualNameBin = case QueueNameBin of
-                        <<>>  -> rabbit_guid:binstring_guid("amq.gen");
+                        <<>>  -> rabbit_guid:binary(rabbit_guid:gen_secure(),
+                                                    "amq.gen");
                         Other -> check_name('queue', Other)
                     end,
     QueueName = rabbit_misc:r(VHostPath, queue, ActualNameBin),
diff --git a/src/rabbit_exchange_type_topic.erl b/src/rabbit_exchange_type_topic.erl
index 348655b1..d77ffc27 100644
--- a/src/rabbit_exchange_type_topic.erl
+++ b/src/rabbit_exchange_type_topic.erl
@@ -262,7 +262,7 @@ remove_all(Table, Pattern) ->
                   mnesia:match_object(Table, Pattern, write)).
 
 new_node_id() ->
-    rabbit_guid:guid().
+    rabbit_guid:gen_secure().
 
 split_topic_key(Key) ->
     split_topic_key(Key, [], []).
@@ -275,4 +275,3 @@ split_topic_key(<<$., Rest/binary>>, RevWordAcc, RevResAcc) ->
     split_topic_key(Rest, [], [lists:reverse(RevWordAcc) | RevResAcc]);
 split_topic_key(<<C:8, Rest/binary>>, RevWordAcc, RevResAcc) ->
     split_topic_key(Rest, [C | RevWordAcc], RevResAcc).
-
diff --git a/src/rabbit_guid.erl b/src/rabbit_guid.erl
index 9a464139..5068ad1f 100644
--- a/src/rabbit_guid.erl
+++ b/src/rabbit_guid.erl
@@ -19,7 +19,7 @@
 -behaviour(gen_server).
 
 -export([start_link/0]).
--export([guid/0, fast_guid/0, string_guid/1, binstring_guid/1]).
+-export([gen/0, gen_secure/0, string/2, binary/2]).
 
 -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2,
          code_change/3]).
@@ -38,10 +38,10 @@
 -type(guid() :: binary()).
 
 -spec(start_link/0 :: () -> rabbit_types:ok_pid_or_error()).
--spec(guid/0 :: () -> guid()).
--spec(fast_guid/0 :: () -> guid()).
--spec(string_guid/1 :: (any()) -> string()).
--spec(binstring_guid/1 :: (any()) -> binary()).
+-spec(gen/0 :: () -> guid()).
+-spec(gen_secure/0 :: () -> guid()).
+-spec(string/2 :: (guid(), any()) -> string()).
+-spec(binary/2 :: (guid(), any()) -> binary()).
 
 -endif.
 
@@ -66,9 +66,8 @@ update_disk_serial() ->
     end,
     Serial.
 
-%% Generate an un-hashed guid. To be used when one is hashed in the process
-%% dictionary.
-fresh_guid() ->
+%% Generate an un-hashed guid.
+fresh() ->
     %% We don't use erlang:now() here because a) it may return
     %% duplicates when the system clock has been rewound prior to a
     %% restart, or ids were generated at a high rate (which causes
@@ -81,50 +80,50 @@ fresh_guid() ->
     Serial = gen_server:call(?SERVER, serial, infinity),
     {Serial, node(), make_ref()}.
 
+%% generate a GUID. This function should be used when performance is a
+%% priority and predictability is not an issue. Otherwise, use gen_secure/0.
+gen() ->
+    %% We hash a fresh GUID and then XOR it with a process-local counter
+    %% to get a new GUID each time.
+    {S, I} =
+        case get(guid) of
+            undefined -> G = fresh(),
+                         <<S0:128/integer>> = erlang:md5(term_to_binary(G)),
+                         {S0, 0};
+            {S0, I0}  -> {S0, I0+1}
+        end,
+    put(guid, {S, I}),
+    <<(S bxor I):128>>.
+
 %% generate a non-predictable GUID.
 %%
 %% The id is only unique within a single cluster and as long as the
 %% serial store hasn't been deleted.
 %%
-%% If you are not concerned with predictability, fast_guid/0 is faster.
-guid() ->
+%% If you are not concerned with predictability, gen/0 is faster.
+gen_secure() ->
     %% Here instead of hashing once we hash the GUID and the counter each time,
     %% so that the GUID is not predictable.
     G = case get(fast_guid) of
-            undefined -> {fresh_guid(), 0};
+            undefined -> {fresh(), 0};
             {S, I}    -> {S, I+1}
         end,
     put(fast_guid, G),
     erlang:md5(term_to_binary(G)).
 
-%% generate a GUID. This function should be used when performance is a
-%% priority and predictability is not an issue.
-fast_guid() ->
-    %% We hash a fresh GUID and then XOR it with a process-local counter
-    %% to get a new GUID each time.
-    {S, I} =
-        case get(guid) of
-            undefined -> G = fresh_guid(),
-                         <<S0:128/integer>> = erlang:md5(term_to_binary(G)),
-                         {S0, 0};
-            {S0, I0}  -> {S0, I0+1}
-        end,
-    put(guid, {S, I}),
-    <<(S bxor I):128>>.
-
 %% generate a readable string representation of a GUID.
 %%
 %% employs base64url encoding, which is safer in more contexts than
 %% plain base64.
-string_guid(Prefix) ->
+string(G, Prefix) ->
     Prefix ++ "-" ++ lists:foldl(fun ($\+, Acc) -> [$\- | Acc];
                                      ($\/, Acc) -> [$\_ | Acc];
                                      ($\=, Acc) -> Acc;
                                      (Chr, Acc) -> [Chr | Acc]
-                                 end, [], base64:encode_to_string(guid())).
+                                 end, [], base64:encode_to_string(G)).
 
-binstring_guid(Prefix) ->
-    list_to_binary(string_guid(Prefix)).
+binary(G, Prefix) ->
+    list_to_binary(string(G, Prefix)).
 
 %%----------------------------------------------------------------------------
 
diff --git a/src/rabbit_tests.erl b/src/rabbit_tests.erl
index 9afb95b9..95ff81ed 100644
--- a/src/rabbit_tests.erl
+++ b/src/rabbit_tests.erl
@@ -1779,10 +1779,10 @@ test_msg_store() ->
     restart_msg_store_empty(),
     MsgIds = [msg_id_bin(M) || M <- lists:seq(1,100)],
     {MsgIds1stHalf, MsgIds2ndHalf} = lists:split(length(MsgIds) div 2, MsgIds),
-    Ref = rabbit_guid:guid(),
+    Ref = rabbit_guid:gen_secure(),
     {Cap, MSCState} = msg_store_client_init_capture(
                         ?PERSISTENT_MSG_STORE, Ref),
-    Ref2 = rabbit_guid:guid(),
+    Ref2 = rabbit_guid:gen_secure(),
     {Cap2, MSC2State} = msg_store_client_init_capture(
                           ?PERSISTENT_MSG_STORE, Ref2),
     %% check we don't contain any of the msgs we're about to publish
@@ -1934,7 +1934,7 @@ test_msg_store_confirms(MsgIds, Cap, MSCState) ->
     passed.
 
 test_msg_store_confirm_timer() ->
-    Ref = rabbit_guid:guid(),
+    Ref = rabbit_guid:gen_secure(),
     MsgId  = msg_id_bin(1),
     Self = self(),
     MSCState = rabbit_msg_store:client_init(
@@ -1963,7 +1963,7 @@ msg_store_keep_busy_until_confirm(MsgIds, MSCState) ->
 test_msg_store_client_delete_and_terminate() ->
     restart_msg_store_empty(),
     MsgIds = [msg_id_bin(M) || M <- lists:seq(1, 10)],
-    Ref = rabbit_guid:guid(),
+    Ref = rabbit_guid:gen_secure(),
     MSCState = msg_store_client_init(?PERSISTENT_MSG_STORE, Ref),
     ok = msg_store_write(MsgIds, MSCState),
     %% test the 'dying client' fast path for writes
@@ -1979,7 +1979,7 @@ test_queue() ->
 init_test_queue() ->
     TestQueue = test_queue(),
     Terms = rabbit_queue_index:shutdown_terms(TestQueue),
-    PRef = proplists:get_value(persistent_ref, Terms, rabbit_guid:guid()),
+    PRef = proplists:get_value(persistent_ref, Terms, rabbit_guid:gen_secure()),
     PersistentClient = msg_store_client_init(?PERSISTENT_MSG_STORE, PRef),
     Res = rabbit_queue_index:recover(
             TestQueue, Terms, false,
@@ -2013,7 +2013,7 @@ restart_app() ->
     rabbit:start().
 
 queue_index_publish(SeqIds, Persistent, Qi) ->
-    Ref = rabbit_guid:guid(),
+    Ref = rabbit_guid:gen_secure(),
     MsgStore = case Persistent of
                    true  -> ?PERSISTENT_MSG_STORE;
                    false -> ?TRANSIENT_MSG_STORE
@@ -2022,7 +2022,7 @@ queue_index_publish(SeqIds, Persistent, Qi) ->
     {A, B = [{_SeqId, LastMsgIdWritten} | _]} =
         lists:foldl(
           fun (SeqId, {QiN, SeqIdsMsgIdsAcc}) ->
-                  MsgId = rabbit_guid:guid(),
+                  MsgId = rabbit_guid:gen_secure(),
                   QiM = rabbit_queue_index:publish(
                           MsgId, SeqId, #message_properties{}, Persistent, QiN),
                   ok = rabbit_msg_store:write(MsgId, MsgId, MSCState),
@@ -2045,7 +2045,7 @@ verify_read_with_published(_Delivered, _Persistent, _Read, _Published) ->
 test_queue_index_props() ->
     with_empty_test_queue(
       fun(Qi0) ->
-              MsgId = rabbit_guid:guid(),
+              MsgId = rabbit_guid:gen_secure(),
               Props = #message_properties{expiry=12345},
               Qi1 = rabbit_queue_index:publish(MsgId, 1, Props, true, Qi0),
               {[{MsgId, 1, Props, _, _}], Qi2} =
diff --git a/src/rabbit_variable_queue.erl b/src/rabbit_variable_queue.erl
index 63a0927f..2db5b576 100644
--- a/src/rabbit_variable_queue.erl
+++ b/src/rabbit_variable_queue.erl
@@ -434,7 +434,7 @@ init(#amqqueue { name = QueueName, durable = true }, true,
     Terms = rabbit_queue_index:shutdown_terms(QueueName),
     {PRef, Terms1} =
         case proplists:get_value(persistent_ref, Terms) of
-            undefined -> {rabbit_guid:guid(), []};
+            undefined -> {rabbit_guid:gen_secure(), []};
             PRef1     -> {PRef1, Terms}
         end,
     PersistentClient = msg_store_client_init(?PERSISTENT_MSG_STORE, PRef,
@@ -860,7 +860,8 @@ with_immutable_msg_store_state(MSCState, IsPersistent, Fun) ->
     Res.
 
 msg_store_client_init(MsgStore, MsgOnDiskFun, Callback) ->
-    msg_store_client_init(MsgStore, rabbit_guid:guid(), MsgOnDiskFun, Callback).
+    msg_store_client_init(MsgStore, rabbit_guid:gen_secure(), MsgOnDiskFun,
+                          Callback).
 
 msg_store_client_init(MsgStore, Ref, MsgOnDiskFun, Callback) ->
     CloseFDsFun = msg_store_close_fds_fun(MsgStore =:= ?PERSISTENT_MSG_STORE),