From a59d5bb459b03be2050e7ed1240fa5ab11213900 Mon Sep 17 00:00:00 2001 From: Feng Date: Wed, 15 Feb 2017 22:05:28 +0800 Subject: [PATCH 01/34] Rename the emqttd_time APIs --- src/emqttd_alarm.erl | 4 ++-- src/emqttd_cli.erl | 4 ++-- src/emqttd_message.erl | 6 +++--- test/emqttd_lib_SUITE.erl | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/emqttd_alarm.erl b/src/emqttd_alarm.erl index 1ff4a5ae9..9e7404100 100644 --- a/src/emqttd_alarm.erl +++ b/src/emqttd_alarm.erl @@ -90,12 +90,12 @@ handle_event({set_alarm, Alarm = #mqtt_alarm{id = AlarmId, {severity, Severity}, {title, iolist_to_binary(Title)}, {summary, iolist_to_binary(Summary)}, - {ts, emqttd_time:now_to_secs(Timestamp)}]), + {ts, emqttd_time:now_secs(Timestamp)}]), emqttd:publish(alarm_msg(alert, AlarmId, Json)), {ok, [Alarm#mqtt_alarm{timestamp = Timestamp} | Alarms]}; handle_event({clear_alarm, AlarmId}, Alarms) -> - Json = mochijson2:encode([{id, AlarmId}, {ts, emqttd_time:now_to_secs()}]), + Json = mochijson2:encode([{id, AlarmId}, {ts, emqttd_time:now_secs()}]), emqttd:publish(alarm_msg(clear, AlarmId, Json)), {ok, lists:keydelete(AlarmId, 2, Alarms), hibernate}; diff --git a/src/emqttd_cli.erl b/src/emqttd_cli.erl index 085032b24..5e49d61c6 100644 --- a/src/emqttd_cli.erl +++ b/src/emqttd_cli.erl @@ -503,7 +503,7 @@ print(#mqtt_client{client_id = ClientId, clean_sess = CleanSess, username = User peername = Peername, connected_at = ConnectedAt}) -> ?PRINT("Client(~s, clean_sess=~s, username=~s, peername=~s, connected_at=~p)~n", [ClientId, CleanSess, Username, emqttd_net:format(Peername), - emqttd_time:now_to_secs(ConnectedAt)]); + emqttd_time:now_secs(ConnectedAt)]); %% print(#mqtt_topic{topic = Topic, flags = Flags}) -> %% ?PRINT("~s: ~s~n", [Topic, string:join([atom_to_list(F) || F <- Flags], ",")]); @@ -542,7 +542,7 @@ print(subscription, {Sub, Topic}) -> ?PRINT("~s -> ~s~n", [Sub, Topic]). format(created_at, Val) -> - emqttd_time:now_to_secs(Val); + emqttd_time:now_secs(Val); format(_, Val) -> Val. diff --git a/src/emqttd_message.erl b/src/emqttd_message.erl index ec4a02479..0fa3237c6 100644 --- a/src/emqttd_message.erl +++ b/src/emqttd_message.erl @@ -42,7 +42,7 @@ make(From, Qos, Topic, Payload) -> qos = ?QOS_I(Qos), topic = Topic, payload = Payload, - timestamp = emqttd_time:now_to_secs()}. + timestamp = emqttd_time:now_secs()}. %% @doc Message from Packet -spec(from_packet(mqtt_packet()) -> mqtt_message()). @@ -60,7 +60,7 @@ from_packet(#mqtt_packet{header = #mqtt_packet_header{type = ?PUBLISH, dup = Dup, topic = Topic, payload = Payload, - timestamp = emqttd_time:now_to_secs()}; + timestamp = emqttd_time:now_secs()}; from_packet(#mqtt_packet_connect{will_flag = false}) -> undefined; @@ -78,7 +78,7 @@ from_packet(#mqtt_packet_connect{client_id = ClientId, qos = Qos, dup = false, payload = Msg, - timestamp = emqttd_time:now_to_secs()}. + timestamp = emqttd_time:now_secs()}. from_packet(ClientId, Packet) -> Msg = from_packet(Packet), diff --git a/test/emqttd_lib_SUITE.erl b/test/emqttd_lib_SUITE.erl index e51e778f0..d4d44cb82 100644 --- a/test/emqttd_lib_SUITE.erl +++ b/test/emqttd_lib_SUITE.erl @@ -141,8 +141,8 @@ priority_queue_out2(_) -> time_now_to_(_) -> emqttd_time:seed(), - emqttd_time:now_to_secs(), - emqttd_time:now_to_ms(). + emqttd_time:now_secs(), + emqttd_time:now_ms(). %%-------------------------------------------------------------------- %% emqttd_node From 61a54b4b331bfe1d2ec15c3f7c22d37ae5daf1c7 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 10:27:27 +0800 Subject: [PATCH 02/34] Bump version to 2.1 --- Makefile | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index a4e02ce45..4355cc413 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ PROJECT = emqttd PROJECT_DESCRIPTION = Erlang MQTT Broker -PROJECT_VERSION = 2.0.7 +PROJECT_VERSION = 2.1 DEPS = gproc lager esockd mochiweb @@ -24,9 +24,9 @@ TEST_ERLC_OPTS += +'{parse_transform, lager_transform}' EUNIT_OPTS = verbose # EUNIT_ERL_OPTS = -CT_SUITES = emqttd emqttd_access emqttd_lib emqttd_mod emqttd_net \ - emqttd_mqueue emqttd_protocol emqttd_topic emqttd_trie \ - emqttd_vm +CT_SUITES = emqttd emqttd_access emqttd_lib emqttd_inflight emqttd_mod \ + emqttd_net emqttd_mqueue emqttd_protocol emqttd_topic \ + emqttd_trie emqttd_vm CT_OPTS = -cover test/ct.cover.spec -erl_args -name emqttd_ct@127.0.0.1 From 08100525a5a3d31fd36f7905859d721bc3dbc0a9 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 10:44:00 +0800 Subject: [PATCH 03/34] Add inflight module and test suite --- src/{emqttd_hook.erl => emqttd_hooks.erl} | 0 src/emqttd_inflight.erl | 94 +++++++++++++++++++++++ src/emqttd_opts.erl | 35 --------- test/emqttd_inflight_SUITE.erl | 50 ++++++++++++ 4 files changed, 144 insertions(+), 35 deletions(-) rename src/{emqttd_hook.erl => emqttd_hooks.erl} (100%) create mode 100644 src/emqttd_inflight.erl delete mode 100644 src/emqttd_opts.erl create mode 100644 test/emqttd_inflight_SUITE.erl diff --git a/src/emqttd_hook.erl b/src/emqttd_hooks.erl similarity index 100% rename from src/emqttd_hook.erl rename to src/emqttd_hooks.erl diff --git a/src/emqttd_inflight.erl b/src/emqttd_inflight.erl new file mode 100644 index 000000000..bb9af390b --- /dev/null +++ b/src/emqttd_inflight.erl @@ -0,0 +1,94 @@ +%%-------------------------------------------------------------------- +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) +%% +%% 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. +%%-------------------------------------------------------------------- + +%% @doc Inflight Window that wraps the gb_trees. + +-module(emqttd_inflight). + +-author("Feng Lee "). + +-export([new/1, contain/2, lookup/2, insert/3, update/3, delete/2, values/1, + to_list/1, size/1, max_size/1, is_full/1, is_empty/1, window/1]). + +-type(inflight() :: {?MODULE, list()}). + +-export_type([inflight/0]). + +-spec(new(non_neg_integer()) -> inflight()). +new(MaxSize) when MaxSize >= 0 -> + {?MODULE, [MaxSize, gb_trees:empty()]}. + +-spec(contain(Key :: any(), inflight()) -> boolean()). +contain(Key, {?MODULE, [_MaxSize, Tree]}) -> + gb_trees:is_defined(Key, Tree). + +-spec(lookup(Key :: any(), inflight()) -> any()). +lookup(Key, {?MODULE, [_MaxSize, Tree]}) -> + gb_trees:get(Key, Tree). + +-spec(insert(Key :: any(), Value :: any(), inflight()) -> inflight()). +insert(Key, Value, {?MODULE, [MaxSize, Tree]}) -> + {?MODULE, [MaxSize, gb_trees:insert(Key, Value, Tree)]}. + +-spec(delete(Key :: any(), inflight()) -> inflight()). +delete(Key, {?MODULE, [MaxSize, Tree]}) -> + {?MODULE, [MaxSize, gb_trees:delete(Key, Tree)]}. + +-spec(update(Key :: any(), Val :: any(), inflight()) -> inflight()). +update(Key, Val, {?MODULE, [MaxSize, Tree]}) -> + {?MODULE, [MaxSize, gb_trees:update(Key, Val, Tree)]}. + +-spec(is_full(inflight()) -> boolean()). +is_full({?MODULE, [0, _Tree]}) -> + false; +is_full({?MODULE, [MaxSize, Tree]}) -> + MaxSize =< gb_trees:size(Tree). + +-spec(is_empty(inflight()) -> boolean()). +is_empty({?MODULE, [_MaxSize, Tree]}) -> + gb_trees:is_empty(Tree). + +-spec(smallest(inflight()) -> {K :: any(), V :: any()}). +smallest({?MODULE, [_MaxSize, Tree]}) -> + gb_trees:smallest(Tree). + +-spec(largest(inflight()) -> {K :: any(), V :: any()}). +largest({?MODULE, [_MaxSize, Tree]}) -> + gb_trees:largest(Tree). + +-spec(values(inflight()) -> list()). +values({?MODULE, [_MaxSize, Tree]}) -> + gb_trees:values(Tree). + +-spec(to_list(inflight()) -> list({K :: any(), V :: any()})). +to_list({?MODULE, [_MaxSize, Tree]}) -> + gb_trees:to_list(Tree). + +-spec(window(inflight()) -> list()). +window(Inflight = {?MODULE, [_MaxSize, Tree]}) -> + case gb_trees:is_empty(Tree) of + true -> []; + false -> [Key || {Key, _Val} <- [smallest(Inflight), largest(Inflight)]] + end. + +-spec(size(inflight()) -> non_neg_integer()). +size({?MODULE, [_MaxSize, Tree]}) -> + gb_trees:size(Tree). + +-spec(max_size(inflight()) -> non_neg_integer()). +max_size({?MODULE, [MaxSize, _Tree]}) -> + MaxSize. + diff --git a/src/emqttd_opts.erl b/src/emqttd_opts.erl deleted file mode 100644 index 8f5f3fea5..000000000 --- a/src/emqttd_opts.erl +++ /dev/null @@ -1,35 +0,0 @@ -%%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . -%% -%% 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(emqttd_opts). - --export([merge/2]). - -%% @doc Merge Options -merge(Defaults, Options) -> - lists:foldl( - fun({Opt, Val}, Acc) -> - case lists:keymember(Opt, 1, Acc) of - true -> lists:keyreplace(Opt, 1, Acc, {Opt, Val}); - false -> [{Opt, Val}|Acc] - end; - (Opt, Acc) -> - case lists:member(Opt, Acc) of - true -> Acc; - false -> [Opt | Acc] - end - end, Defaults, Options). - diff --git a/test/emqttd_inflight_SUITE.erl b/test/emqttd_inflight_SUITE.erl new file mode 100644 index 000000000..5a87d056d --- /dev/null +++ b/test/emqttd_inflight_SUITE.erl @@ -0,0 +1,50 @@ +%% +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) +%% + +-module(emqttd_inflight_SUITE). + +-author("Feng Lee "). + +-include_lib("eunit/include/eunit.hrl"). + +%% CT +-compile(export_all). + +all() -> [t_contain, t_lookup, t_insert, t_update, t_delete, t_window, + t_is_full, t_is_empty]. + +t_contain(_) -> + Inflight = emqttd_inflight:new(0), + ?assertNot(Inflight:contain(k)), + Inflight1 = Inflight:insert(k, v), + ?assert(Inflight1:contain(k)). + +t_lookup(_) -> + Inflight = (emqttd_inflight:new(0)):insert(k, v), + ?assertEqual(v, Inflight:lookup(k)). + +t_insert(_) -> + Inflight = ((emqttd_inflight:new(0)):insert(k1, v1)):insert(k2, v2), + ?assertEqual(v2, Inflight:lookup(k2)). + +t_update(_) -> + Inflight = ((emqttd_inflight:new(0)):insert(k, v1)):update(k, v2), + ?assertEqual(v2, Inflight:lookup(k)). + +t_delete(_) -> + Inflight = ((emqttd_inflight:new(0)):insert(k, v1)):delete(k), + ?assert(Inflight:is_empty()). + +t_window(_) -> + ?assertEqual([], (emqttd_inflight:new(10)):window()), + Inflight = ((emqttd_inflight:new(0)):insert(1, 1)):insert(2, 2), + ?assertEqual([1, 2], Inflight:window()). + +t_is_full(_) -> + Inflight = ((emqttd_inflight:new(1)):insert(k, v1)), + ?assert(Inflight:is_full()). + +t_is_empty(_) -> + Inflight = ((emqttd_inflight:new(1)):insert(k, v1)), + ?assertNot(Inflight:is_empty()). From 0bc071d792caaefce2aa2621d039736d4da0addc Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 10:48:31 +0800 Subject: [PATCH 04/34] Add emqttd_misc module --- src/emqttd_misc.erl | 63 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 src/emqttd_misc.erl diff --git a/src/emqttd_misc.erl b/src/emqttd_misc.erl new file mode 100644 index 000000000..8111264cc --- /dev/null +++ b/src/emqttd_misc.erl @@ -0,0 +1,63 @@ +%%-------------------------------------------------------------------- +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) +%% +%% 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(emqttd_misc). + +-author("Feng Lee "). + +-export([merge_opts/2, start_timer/2, start_timer/3, cancel_timer/1, + proc_stats/0, proc_stats/1]). + +%% @doc Merge Options +merge_opts(Defaults, Options) -> + lists:foldl( + fun({Opt, Val}, Acc) -> + case lists:keymember(Opt, 1, Acc) of + true -> lists:keyreplace(Opt, 1, Acc, {Opt, Val}); + false -> [{Opt, Val}|Acc] + end; + (Opt, Acc) -> + case lists:member(Opt, Acc) of + true -> Acc; + false -> [Opt | Acc] + end + end, Defaults, Options). + +-spec(start_timer(integer(), term()) -> reference()). +start_timer(Interval, Msg) -> + start_timer(Interval, self(), Msg). + +-spec(start_timer(integer(), pid() | atom(), term()) -> reference()). +start_timer(Interval, Dest, Msg) -> + erlang:start_timer(Interval, Dest, Msg). + +-spec(cancel_timer(undefined | reference()) -> ok). +cancel_timer(undefined) -> + ok; +cancel_timer(Timer) -> + case catch erlang:cancel_timer(Timer) of + false -> receive {timeout, Timer, _} -> ok after 0 -> ok end; + _ -> ok + end. + +proc_stats() -> + proc_stats(self()). + +proc_stats(Pid) -> + Stats = process_info(Pid, [message_queue_len, heap_size, reductions]), + {value, {_, V}, Stats1} = lists:keytake(message_queue_len, 1, Stats), + [{mailbox_len, V} | Stats1]. + From a52754df5629e6a5b8a5a6e3824275193d945d60 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 10:51:03 +0800 Subject: [PATCH 05/34] Add 'syslog' config and update client, session config --- etc/emq.conf | 79 +++++++++++++++------- priv/emq.schema | 174 +++++++++++++++++++++++++++++++++--------------- 2 files changed, 176 insertions(+), 77 deletions(-) diff --git a/etc/emq.conf b/etc/emq.conf index 7238f3395..e30ddfa26 100644 --- a/etc/emq.conf +++ b/etc/emq.conf @@ -1,3 +1,8 @@ + +##=================================================================== +## EMQ Configuration R2.1 +##=================================================================== + ##-------------------------------------------------------------------- ## Node Args ##-------------------------------------------------------------------- @@ -45,16 +50,25 @@ node.crash_dump = {{ platform_log_dir }}/crash.dump node.dist_net_ticktime = 60 ## Distributed node port range -## node.dist_listen_min = 6000 -## node.dist_listen_max = 6999 +## node.dist_listen_min = 6369 +## node.dist_listen_max = 6369 ##-------------------------------------------------------------------- ## Log ##-------------------------------------------------------------------- +## Set the log dir +log.dir = {{ platform_log_dir }} + ## Console log. Enum: off, file, console, both log.console = console +## Syslog. Enum: on, off +log.syslog = on + +## syslog level. Enum: debug, info, notice, warning, error, critical, alert, emergency +log.syslog.level = error + ## Console log level. Enum: debug, info, notice, warning, error, critical, alert, emergency log.console.level = error @@ -70,18 +84,9 @@ log.crash = on log.crash.file = {{ platform_log_dir }}/crash.log ##-------------------------------------------------------------------- -## MQTT Protocol +## Allow Anonymous and Default ACL ##-------------------------------------------------------------------- -## Max ClientId Length Allowed. -mqtt.max_clientid_len = 1024 - -## Max Packet Size Allowed, 64K by default. -mqtt.max_packet_size = 64KB - -## Client Idle Timeout (Second) -mqtt.client_idle_timeout = 30 - ## Allow Anonymous authentication mqtt.allow_anonymous = true @@ -91,25 +96,48 @@ mqtt.acl_file = {{ platform_etc_dir }}/acl.conf ## Cache ACL for PUBLISH mqtt.cache_acl = true +##-------------------------------------------------------------------- +## MQTT Protocol +##-------------------------------------------------------------------- + +## Max ClientId Length Allowed. +mqtt.max_clientid_len = 1024 + +## Max Packet Size Allowed, 64K by default. +mqtt.max_packet_size = 64KB + +##-------------------------------------------------------------------- +## MQTT Client +##-------------------------------------------------------------------- + +## Client Idle Timeout (Second) +mqtt.client.idle_timeout = 30s + +## Enable client Stats: seconds or off +mqtt.client.enable_stats = off + ##-------------------------------------------------------------------- ## MQTT Session ##-------------------------------------------------------------------- +## Upgrade QoS? +mqtt.session.upgrade_qos = off + ## Max number of QoS 1 and 2 messages that can be “inflight” at one time. ## 0 means no limit -mqtt.session.max_inflight = 100 +mqtt.session.max_inflight = 32 -## Retry interval for redelivering QoS1/2 messages. -mqtt.session.retry_interval = 60 - -## Awaiting PUBREL Timeout -mqtt.session.await_rel_timeout = 20 +## Retry Interval for redelivering QoS1/2 messages. +mqtt.session.retry_interval = 20s ## Max Packets that Awaiting PUBREL, 0 means no limit -mqtt.session.max_awaiting_rel = 0 +mqtt.session.max_awaiting_rel = 100 -## Statistics Collection Interval(seconds) -mqtt.session.collect_interval = 0 +## Awaiting PUBREL Timeout +mqtt.session.await_rel_timeout = 20s + +## Enable Statistics at the Interval(seconds) +mqtt.session.enable_stats = off ## Expired after 1 day: ## w - week @@ -117,7 +145,7 @@ mqtt.session.collect_interval = 0 ## h - hour ## m - minute ## s - second -mqtt.session.expired_after = 1d +mqtt.session.expiry_interval = 2h ##-------------------------------------------------------------------- ## MQTT Queue @@ -212,9 +240,10 @@ mqtt.listener.ssl.max_clients = 512 ## Rate Limit. Format is 'burst,rate', Unit is KB/Sec ## mqtt.listener.ssl.rate_limit = 100,10 -## Configuring SSL Options -## See http://erlang.org/doc/man/ssl.html -mqtt.listener.ssl.handshake_timeout = 15 +## Configuring SSL Options. See http://erlang.org/doc/man/ssl.html +### TLS only for POODLE attack +mqtt.listener.ssl.tls_versions = tlsv1.2,tlsv1.1,tlsv1 +mqtt.listener.ssl.handshake_timeout = 15s mqtt.listener.ssl.keyfile = {{ platform_etc_dir }}/certs/key.pem mqtt.listener.ssl.certfile = {{ platform_etc_dir }}/certs/cert.pem ## mqtt.listener.ssl.cacertfile = {{ platform_etc_dir }}/certs/cacert.pem diff --git a/priv/emq.schema b/priv/emq.schema index 1722522c4..156bc4874 100644 --- a/priv/emq.schema +++ b/priv/emq.schema @@ -148,8 +148,13 @@ end}. %% Log %%-------------------------------------------------------------------- +{mapping, "log.dir", "lager.log_dir", [ + {default, "log"}, + {datatype, string} +]}. + {mapping, "log.console", "lager.handlers", [ - {default, file }, + {default, file}, {datatype, {enum, [off, file, console, both]}} ]}. @@ -168,6 +173,26 @@ end}. {datatype, file} ]}. +{mapping, "log.syslog", "lager.handlers", [ + {default, off}, + {datatype, flag} +]}. + +{mapping, "log.syslog.identity", "lager.handlers", [ + {default, "emq"}, + {datatype, string} +]}. + +{mapping, "log.syslog.facility", "lager.handlers", [ + {default, local0}, + {datatype, {enum, [daemon, local0, local1, local2, local3, local4, local5, local6, local7]}} +]}. + +{mapping, "log.syslog.level", "lager.handlers", [ + {default, err}, + {datatype, {enum, [debug, info, notice, warning, error, critical, alert, emergency]}} +]}. + {mapping, "log.error.redirect", "lager.error_logger_redirect", [ {default, on}, {datatype, flag}, @@ -209,7 +234,16 @@ end}. both -> [ConsoleHandler, ConsoleFileHandler]; _ -> [] end, - ConsoleHandlers ++ ErrorHandler + + SyslogHandler = case cuttlefish:conf_get("log.syslog", Conf) of + false -> []; + true -> [{lager_syslog_backend, + [cuttlefish:conf_get("log.syslog.identity", Conf), + cuttlefish:conf_get("log.syslog.facility", Conf), + cuttlefish:conf_get("log.syslog.level", Conf)]}] + end, + + ConsoleHandlers ++ ErrorHandler ++ SyslogHandler end }. @@ -240,33 +274,9 @@ end}. ]}. %%-------------------------------------------------------------------- -%% MQTT Protocol +%% Allow Anonymous and Default ACL %%-------------------------------------------------------------------- -%% @doc Set the Max ClientId Length Allowed. -{mapping, "mqtt.max_clientid_len", "emqttd.protocol", [ - {default, 1024}, - {datatype, integer} -]}. - -%% @doc Max Packet Size Allowed, 64K by default. -{mapping, "mqtt.max_packet_size", "emqttd.protocol", [ - {default, "64KB"}, - {datatype, bytesize} -]}. - -%% @doc Client Idle Timeout. -{mapping, "mqtt.client_idle_timeout", "emqttd.protocol", [ - {default, 30}, - {datatype, integer} -]}. - -{translation, "emqttd.protocol", fun(Conf) -> - [{max_clientid_len, cuttlefish:conf_get("mqtt.max_clientid_len", Conf)}, - {max_packet_size, cuttlefish:conf_get("mqtt.max_packet_size", Conf)}, - {client_idle_timeout, cuttlefish:conf_get("mqtt.client_idle_timeout", Conf)}] -end}. - %% @doc Allow Anonymous {mapping, "mqtt.allow_anonymous", "emqttd.allow_anonymous", [ {default, false}, @@ -285,10 +295,58 @@ end}. {datatype, {enum, [true, false]}} ]}. +%%-------------------------------------------------------------------- +%% MQTT Protocol +%%-------------------------------------------------------------------- + +%% @doc Set the Max ClientId Length Allowed. +{mapping, "mqtt.max_clientid_len", "emqttd.protocol", [ + {default, 1024}, + {datatype, integer} +]}. + +%% @doc Max Packet Size Allowed, 64K by default. +{mapping, "mqtt.max_packet_size", "emqttd.protocol", [ + {default, "64KB"}, + {datatype, bytesize} +]}. + +{translation, "emqttd.protocol", fun(Conf) -> + [{max_clientid_len, cuttlefish:conf_get("mqtt.max_clientid_len", Conf)}, + {max_packet_size, cuttlefish:conf_get("mqtt.max_packet_size", Conf)}] +end}. + +%%-------------------------------------------------------------------- +%% MQTT Client +%%-------------------------------------------------------------------- + +%% @doc Client Idle Timeout. +{mapping, "mqtt.client.idle_timeout", "emqttd.client", [ + {default, "30s"}, + {datatype, {duration, ms}} +]}. + +%% @doc Enable Stats of Client. +{mapping, "mqtt.client.enable_stats", "emqttd.client", [ + {default, off}, + {datatype, [{duration, ms}, flag]} +]}. + +%% @doc Client +{translation, "emqttd.client", fun(Conf) -> + [{client_idle_timeout, cuttlefish:conf_get("mqtt.client.idle_timeout", Conf)}, + {client_enable_stats, cuttlefish:conf_get("mqtt.client.enable_stats", Conf)}] +end}. + %%-------------------------------------------------------------------- %% MQTT Session %%-------------------------------------------------------------------- +%% @doc Upgrade QoS? +{mapping, "mqtt.session.upgrade_qos", "emqttd.session", [ + {default, off}, + {datatype, flag} +]}. %% @doc Max number of QoS 1 and 2 messages that can be “inflight” at one time. %% 0 means no limit {mapping, "mqtt.session.max_inflight", "emqttd.session", [ @@ -296,17 +354,10 @@ end}. {datatype, integer} ]}. - %% @doc Retry interval for redelivering QoS1/2 messages. {mapping, "mqtt.session.retry_interval", "emqttd.session", [ - {default, 60}, - {datatype, integer} -]}. - -%% @doc Awaiting PUBREL Timeout -{mapping, "mqtt.session.await_rel_timeout", "emqttd.session", [ - {default, 30}, - {datatype, integer} + {default, "20s"}, + {datatype, {duration, ms}} ]}. %% @doc Max Packets that Awaiting PUBREL, 0 means no limit @@ -315,25 +366,32 @@ end}. {datatype, integer} ]}. -%% @doc Statistics Collection Interval(seconds) -{mapping, "mqtt.session.collect_interval", "emqttd.session", [ - {default, 0}, - {datatype, integer} +%% @doc Awaiting PUBREL Timeout +{mapping, "mqtt.session.await_rel_timeout", "emqttd.session", [ + {default, "20s"}, + {datatype, {duration, ms}} ]}. -%% @doc Session expired after... -{mapping, "mqtt.session.expired_after", "emqttd.session", [ - {default, "2d"}, - {datatype, {duration, s}} +%% @doc Enable Stats +{mapping, "mqtt.session.enable_stats", "emqttd.session", [ + {default, off}, + {datatype, [{duration, ms}, flag]} +]}. + +%% @doc Session Expiry Interval +{mapping, "mqtt.session.expiry_interval", "emqttd.session", [ + {default, "2h"}, + {datatype, {duration, ms}} ]}. {translation, "emqttd.session", fun(Conf) -> - [{max_inflight, cuttlefish:conf_get("mqtt.session.max_inflight", Conf)}, - {retry_interval, cuttlefish:conf_get("mqtt.session.retry_interval", Conf)}, + [{upgrade_qos, cuttlefish:conf_get("mqtt.session.upgrade_qos", Conf)}, + {max_inflight, cuttlefish:conf_get("mqtt.session.max_inflight", Conf)}, + {retry_interval, cuttlefish:conf_get("mqtt.session.retry_interval", Conf)}, + {max_awaiting_rel, cuttlefish:conf_get("mqtt.session.max_awaiting_rel", Conf)}, {await_rel_timeout, cuttlefish:conf_get("mqtt.session.await_rel_timeout", Conf)}, - {max_awaiting_rel, cuttlefish:conf_get("mqtt.session.max_awaiting_rel", Conf)}, - {collect_interval, cuttlefish:conf_get("mqtt.session.collect_interval", Conf)}, - {expired_after, cuttlefish:conf_get("mqtt.session.expired_after", Conf)}] + {enable_stats, cuttlefish:conf_get("mqtt.session.enable_stats", Conf)}, + {expiry_interval, cuttlefish:conf_get("mqtt.session.expiry_interval", Conf)}] end}. %%-------------------------------------------------------------------- @@ -528,9 +586,13 @@ end}. {datatype, string} ]}. +{mapping, "mqtt.listener.ssl.tls_versions", "emqttd.listeners", [ + {datatype, string} +]}. + {mapping, "mqtt.listener.ssl.handshake_timeout", "emqttd.listeners", [ - {default, 15}, - {datatype, integer} + {default, "15s"}, + {datatype, {duration, ms}} ]}. {mapping, "mqtt.listener.ssl.keyfile", "emqttd.listeners", [ @@ -622,8 +684,16 @@ end}. {buffer, cuttlefish:conf_get(Prefix ++ ".buffer", Conf, undefined)}, {nodelay, cuttlefish:conf_get(Prefix ++ ".nodelay", Conf, true)}]) end, + + SplitFun = fun(undefined) -> undefined; (S) -> string:tokens(S, ",") end, + SslOpts = fun(Prefix) -> - Filter([{handshake_timeout, cuttlefish:conf_get(Prefix ++ ".handshake_timeout", Conf) * 1000}, + Versions = case SplitFun(cuttlefish:conf_get(Prefix ++ ".tls_versions", Conf, undefined)) of + undefined -> undefined; + L -> [list_to_atom(V) || V <- L] + end, + Filter([{versions, Versions}, + {handshake_timeout, cuttlefish:conf_get(Prefix ++ ".handshake_timeout", Conf), undefined}, {keyfile, cuttlefish:conf_get(Prefix ++ ".keyfile", Conf, undefined)}, {certfile, cuttlefish:conf_get(Prefix ++ ".certfile", Conf, undefined)}, {cacertfile, cuttlefish:conf_get(Prefix ++ ".cacertfile", Conf, undefined)}, From 4df2a71c27cbf8881d8759d980ca002a3678aa7e Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 10:53:51 +0800 Subject: [PATCH 06/34] Update copyright, format record, add 'AUTH' packet type for MQTT 5.0 --- include/emqttd.hrl | 148 +++++++++++++++-------------- include/emqttd_cli.hrl | 2 +- include/emqttd_internal.hrl | 2 +- include/emqttd_protocol.hrl | 183 ++++++++++++++++++++---------------- include/emqttd_trie.hrl | 30 +++--- 5 files changed, 198 insertions(+), 167 deletions(-) diff --git a/include/emqttd.hrl b/include/emqttd.hrl index 53350ed6d..0d7d4c134 100644 --- a/include/emqttd.hrl +++ b/include/emqttd.hrl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -18,7 +18,7 @@ %% Banner %%-------------------------------------------------------------------- --define(COPYRIGHT, "Copyright (C) 2012-2017, Feng Lee "). +-define(COPYRIGHT, "Copyright (c) 2013-2017 EMQ Enterprise, Inc."). -define(LICENSE_MESSAGE, "Licensed under the Apache License, Version 2.0"). @@ -48,21 +48,21 @@ %% MQTT Topic %%-------------------------------------------------------------------- --record(mqtt_topic, { - topic :: binary(), - flags = [] :: [retained | static] -}). +-record(mqtt_topic, + { topic :: binary(), + flags = [] :: [retained | static] + }). -type(mqtt_topic() :: #mqtt_topic{}). %%-------------------------------------------------------------------- %% MQTT Subscription %%-------------------------------------------------------------------- --record(mqtt_subscription, { - subid :: binary() | atom(), - topic :: binary(), - qos :: 0 | 1 | 2 -}). +-record(mqtt_subscription, + { subid :: binary() | atom(), + topic :: binary(), + qos :: 0 | 1 | 2 + }). -type(mqtt_subscription() :: #mqtt_subscription{}). @@ -73,18 +73,18 @@ -type(ws_header_key() :: atom() | binary() | string()). -type(ws_header_val() :: atom() | binary() | string() | integer()). --record(mqtt_client, { - client_id :: binary() | undefined, - client_pid :: pid(), - username :: binary() | undefined, - peername :: {inet:ip_address(), integer()}, - clean_sess :: boolean(), - proto_ver :: 3 | 4, - keepalive = 0, - will_topic :: undefined | binary(), - ws_initial_headers :: list({ws_header_key(), ws_header_val()}), - connected_at :: erlang:timestamp() -}). +-record(mqtt_client, + { client_id :: binary() | undefined, + client_pid :: pid(), + username :: binary() | undefined, + peername :: {inet:ip_address(), inet:port_number()}, + clean_sess :: boolean(), + proto_ver :: 3 | 4, + keepalive = 0, + will_topic :: undefined | binary(), + ws_initial_headers :: list({ws_header_key(), ws_header_val()}), + connected_at :: erlang:timestamp() + }). -type(mqtt_client() :: #mqtt_client{}). @@ -92,33 +92,46 @@ %% MQTT Session %%-------------------------------------------------------------------- --record(mqtt_session, { - client_id :: binary(), - sess_pid :: pid(), - persistent :: boolean() -}). +-record(mqtt_session, + { client_id :: binary(), + sess_pid :: pid(), + clean_sess :: boolean() + }). -type(mqtt_session() :: #mqtt_session{}). %%-------------------------------------------------------------------- %% MQTT Message %%-------------------------------------------------------------------- + -type(mqtt_msgid() :: binary() | undefined). + -type(mqtt_pktid() :: 1..16#ffff | undefined). --record(mqtt_message, { - id :: mqtt_msgid(), %% Global unique message ID - pktid :: mqtt_pktid(), %% PacketId - from :: {binary(), undefined | binary()}, %% ClientId and Username - topic :: binary(), %% Topic that the message is published to - qos = 0 :: 0 | 1 | 2, %% Message QoS - flags = [] :: [retain | dup | sys], %% Message Flags - retain = false :: boolean(), %% Retain flag - dup = false :: boolean(), %% Dup flag - sys = false :: boolean(), %% $SYS flag - headers = [] :: list(), - payload :: binary(), %% Payload - timestamp :: pos_integer() %% os:timestamp to seconds +-record(mqtt_message, + { %% Global unique message ID + id :: mqtt_msgid(), + %% PacketId + pktid :: mqtt_pktid(), + %% ClientId and Username + from :: {binary(), undefined | binary()}, + %% Topic that the message is published to + topic :: binary(), + %% Message QoS + qos = 0 :: 0 | 1 | 2, + %% Message Flags + flags = [] :: [retain | dup | sys], + %% Retain flag + retain = false :: boolean(), + %% Dup flag + dup = false :: boolean(), + %% $SYS flag + sys = false :: boolean(), + headers = [] :: list(), + %% Payload + payload :: binary(), + %% Timestamp + timestamp :: erlang:timestamp() }). -type(mqtt_message() :: #mqtt_message{}). @@ -126,46 +139,45 @@ %%-------------------------------------------------------------------- %% MQTT Delivery %%-------------------------------------------------------------------- --record(mqtt_delivery, { - sender :: pid(), %% Pid of the sender/publisher - message :: mqtt_message(), %% Message - flows :: list() -}). + +-record(mqtt_delivery, + { sender :: pid(), %% Pid of the sender/publisher + message :: mqtt_message(), %% Message + flows :: list() + }). -type(mqtt_delivery() :: #mqtt_delivery{}). %%-------------------------------------------------------------------- %% MQTT Route %%-------------------------------------------------------------------- --record(mqtt_route, { - topic :: binary(), - node :: node() -}). + +-record(mqtt_route, + { topic :: binary(), + node :: node() + }). -type(mqtt_route() :: #mqtt_route{}). %%-------------------------------------------------------------------- %% MQTT Alarm %%-------------------------------------------------------------------- --record(mqtt_alarm, { - id :: binary(), - severity :: warning | error | critical, - title :: iolist() | binary(), - summary :: iolist() | binary(), - timestamp :: erlang:timestamp() %% Timestamp -}). + +-record(mqtt_alarm, + { id :: binary(), + severity :: warning | error | critical, + title :: iolist() | binary(), + summary :: iolist() | binary(), + timestamp :: erlang:timestamp() %% Timestamp + }). -type(mqtt_alarm() :: #mqtt_alarm{}). %%-------------------------------------------------------------------- %% MQTT Plugin %%-------------------------------------------------------------------- --record(mqtt_plugin, { - name, - version, - descr, - active = false -}). + +-record(mqtt_plugin, { name, version, descr, active = false }). -type(mqtt_plugin() :: #mqtt_plugin{}). @@ -173,14 +185,8 @@ %% MQTT CLI Command %% For example: 'broker metrics' %%-------------------------------------------------------------------- --record(mqtt_cli, { - name, - action, - args = [], - opts = [], - usage, - descr -}). + +-record(mqtt_cli, { name, action, args = [], opts = [], usage, descr }). -type(mqtt_cli() :: #mqtt_cli{}). diff --git a/include/emqttd_cli.hrl b/include/emqttd_cli.hrl index 461306747..bda88d801 100644 --- a/include/emqttd_cli.hrl +++ b/include/emqttd_cli.hrl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. diff --git a/include/emqttd_internal.hrl b/include/emqttd_internal.hrl index 06102e26a..ec5fb3e73 100644 --- a/include/emqttd_internal.hrl +++ b/include/emqttd_internal.hrl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. diff --git a/include/emqttd_protocol.hrl b/include/emqttd_protocol.hrl index 9ed3a993b..ab0650ead 100644 --- a/include/emqttd_protocol.hrl +++ b/include/emqttd_protocol.hrl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,23 +14,32 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% MQTT Protocol Header +%%-------------------------------------------------------------------- +%% MQTT SockOpts +%%-------------------------------------------------------------------- + +-define(MQTT_SOCKOPTS, [binary, {packet, raw}, {reuseaddr, true}, + {backlog, 512}, {nodelay, true}]). %%-------------------------------------------------------------------- %% MQTT Protocol Version and Levels %%-------------------------------------------------------------------- --define(MQTT_PROTO_V31, 3). --define(MQTT_PROTO_V311, 4). + +-define(MQTT_PROTO_V3, 3). +-define(MQTT_PROTO_V4, 4). +-define(MQTT_PROTO_V5, 5). -define(PROTOCOL_NAMES, [ - {?MQTT_PROTO_V31, <<"MQIsdp">>}, - {?MQTT_PROTO_V311, <<"MQTT">>}]). + {?MQTT_PROTO_V3, <<"MQIsdp">>}, + {?MQTT_PROTO_V4, <<"MQTT">>}, + {?MQTT_PROTO_V5, <<"MQTT">>}]). --type(mqtt_vsn() :: ?MQTT_PROTO_V31 | ?MQTT_PROTO_V311). +-type(mqtt_vsn() :: ?MQTT_PROTO_V3 | ?MQTT_PROTO_V4 | ?MQTT_PROTO_V5). %%-------------------------------------------------------------------- -%% MQTT QoS +%% MQTT QoS Level %%-------------------------------------------------------------------- + -define(QOS_0, 0). %% At most once -define(QOS_1, 1). %% At least once -define(QOS_2, 2). %% Exactly once @@ -63,28 +72,30 @@ end). %%-------------------------------------------------------------------- -%% Max ClientId Length. Why 1024? NiDongDe... +%% Max ClientId Length. Why 1024? %%-------------------------------------------------------------------- + -define(MAX_CLIENTID_LEN, 1024). %%-------------------------------------------------------------------- %% MQTT Control Packet Types %%-------------------------------------------------------------------- --define(RESERVED, 0). %% Reserved --define(CONNECT, 1). %% Client request to connect to Server --define(CONNACK, 2). %% Server to Client: Connect acknowledgment --define(PUBLISH, 3). %% Publish message --define(PUBACK, 4). %% Publish acknowledgment --define(PUBREC, 5). %% Publish received (assured delivery part 1) --define(PUBREL, 6). %% Publish release (assured delivery part 2) --define(PUBCOMP, 7). %% Publish complete (assured delivery part 3) --define(SUBSCRIBE, 8). %% Client subscribe request --define(SUBACK, 9). %% Server Subscribe acknowledgment --define(UNSUBSCRIBE, 10). %% Unsubscribe request --define(UNSUBACK, 11). %% Unsubscribe acknowledgment --define(PINGREQ, 12). %% PING request --define(PINGRESP, 13). %% PING response --define(DISCONNECT, 14). %% Client is disconnecting +-define(RESERVED, 0). %% Reserved +-define(CONNECT, 1). %% Client request to connect to Server +-define(CONNACK, 2). %% Server to Client: Connect acknowledgment +-define(PUBLISH, 3). %% Publish message +-define(PUBACK, 4). %% Publish acknowledgment +-define(PUBREC, 5). %% Publish received (assured delivery part 1) +-define(PUBREL, 6). %% Publish release (assured delivery part 2) +-define(PUBCOMP, 7). %% Publish complete (assured delivery part 3) +-define(SUBSCRIBE, 8). %% Client subscribe request +-define(SUBACK, 9). %% Server Subscribe acknowledgment +-define(UNSUBSCRIBE, 10). %% Unsubscribe request +-define(UNSUBACK, 11). %% Unsubscribe acknowledgment +-define(PINGREQ, 12). %% PING request +-define(PINGRESP, 13). %% PING response +-define(DISCONNECT, 14). %% Client is disconnecting +-define(AUTH, 15). %% Authentication exchange -define(TYPE_NAMES, [ 'CONNECT', @@ -100,25 +111,28 @@ 'UNSUBACK', 'PINGREQ', 'PINGRESP', - 'DISCONNECT']). + 'DISCONNECT', + 'AUTH']). -type(mqtt_packet_type() :: ?RESERVED..?DISCONNECT). %%-------------------------------------------------------------------- %% MQTT Connect Return Codes %%-------------------------------------------------------------------- --define(CONNACK_ACCEPT, 0). %% Connection accepted --define(CONNACK_PROTO_VER, 1). %% Unacceptable protocol version --define(CONNACK_INVALID_ID, 2). %% Client Identifier is correct UTF-8 but not allowed by the Server --define(CONNACK_SERVER, 3). %% Server unavailable --define(CONNACK_CREDENTIALS, 4). %% Username or password is malformed --define(CONNACK_AUTH, 5). %% Client is not authorized to connect + +-define(CONNACK_ACCEPT, 0). %% Connection accepted +-define(CONNACK_PROTO_VER, 1). %% Unacceptable protocol version +-define(CONNACK_INVALID_ID, 2). %% Client Identifier is correct UTF-8 but not allowed by the Server +-define(CONNACK_SERVER, 3). %% Server unavailable +-define(CONNACK_CREDENTIALS, 4). %% Username or password is malformed +-define(CONNACK_AUTH, 5). %% Client is not authorized to connect -type(mqtt_connack() :: ?CONNACK_ACCEPT..?CONNACK_AUTH). %%-------------------------------------------------------------------- %% MQTT Parser and Serializer %%-------------------------------------------------------------------- + -define(MAX_LEN, 16#fffffff). -define(HIGHBIT, 2#10000000). -define(LOWBITS, 2#01111111). @@ -126,76 +140,87 @@ %%-------------------------------------------------------------------- %% MQTT Packet Fixed Header %%-------------------------------------------------------------------- + -record(mqtt_packet_header, { - type = ?RESERVED :: mqtt_packet_type(), - dup = false :: boolean(), - qos = ?QOS_0 :: mqtt_qos(), - retain = false :: boolean()}). + type = ?RESERVED :: mqtt_packet_type(), + dup = false :: boolean(), + qos = ?QOS_0 :: mqtt_qos(), + retain = false :: boolean()}). %%-------------------------------------------------------------------- %% MQTT Packets %%-------------------------------------------------------------------- --type(mqtt_client_id() :: binary()). --type(mqtt_username() :: binary() | undefined). --type(mqtt_packet_id() :: 1..16#ffff | undefined). --record(mqtt_packet_connect, { - client_id = <<>> :: mqtt_client_id(), - proto_ver = ?MQTT_PROTO_V311 :: mqtt_vsn(), - proto_name = <<"MQTT">> :: binary(), - will_retain = false :: boolean(), - will_qos = ?QOS_0 :: mqtt_qos(), - will_flag = false :: boolean(), - clean_sess = false :: boolean(), - keep_alive = 60 :: non_neg_integer(), - will_topic = undefined :: undefined | binary(), - will_msg = undefined :: undefined | binary(), - username = undefined :: undefined | binary(), - password = undefined :: undefined | binary()}). +-type(mqtt_client_id() :: binary()). +-type(mqtt_username() :: binary() | undefined). +-type(mqtt_packet_id() :: 1..16#ffff | undefined). --record(mqtt_packet_connack, { - ack_flags = ?RESERVED :: 0 | 1, - return_code :: mqtt_connack() }). +-record(mqtt_packet_connect, + { client_id = <<>> :: mqtt_client_id(), + proto_ver = ?MQTT_PROTO_V4 :: mqtt_vsn(), + proto_name = <<"MQTT">> :: binary(), + will_retain = false :: boolean(), + will_qos = ?QOS_0 :: mqtt_qos(), + will_flag = false :: boolean(), + clean_sess = false :: boolean(), + keep_alive = 60 :: non_neg_integer(), + will_topic = undefined :: undefined | binary(), + will_msg = undefined :: undefined | binary(), + username = undefined :: undefined | binary(), + password = undefined :: undefined | binary() + }). --record(mqtt_packet_publish, { - topic_name :: binary(), - packet_id :: mqtt_packet_id() }). +-record(mqtt_packet_connack, + { ack_flags = ?RESERVED :: 0 | 1, + return_code :: mqtt_connack() + }). --record(mqtt_packet_puback, { - packet_id :: mqtt_packet_id() }). +-record(mqtt_packet_publish, + { topic_name :: binary(), + packet_id :: mqtt_packet_id() + }). --record(mqtt_packet_subscribe, { - packet_id :: mqtt_packet_id(), - topic_table :: list({binary(), mqtt_qos()}) }). +-record(mqtt_packet_puback, + { packet_id :: mqtt_packet_id() }). --record(mqtt_packet_unsubscribe, { - packet_id :: mqtt_packet_id(), - topics :: list(binary()) }). +-record(mqtt_packet_subscribe, + { packet_id :: mqtt_packet_id(), + topic_table :: list({binary(), mqtt_qos()}) + }). --record(mqtt_packet_suback, { - packet_id :: mqtt_packet_id(), - qos_table :: list(mqtt_qos() | 128) }). +-record(mqtt_packet_unsubscribe, + { packet_id :: mqtt_packet_id(), + topics :: list(binary()) + }). --record(mqtt_packet_unsuback, { - packet_id :: mqtt_packet_id() }). +-record(mqtt_packet_suback, + { packet_id :: mqtt_packet_id(), + qos_table :: list(mqtt_qos() | 128) + }). + +-record(mqtt_packet_unsuback, + { packet_id :: mqtt_packet_id() }). %%-------------------------------------------------------------------- %% MQTT Control Packet %%-------------------------------------------------------------------- --record(mqtt_packet, { - header :: #mqtt_packet_header{}, - variable :: #mqtt_packet_connect{} | #mqtt_packet_connack{} - | #mqtt_packet_publish{} | #mqtt_packet_puback{} - | #mqtt_packet_subscribe{} | #mqtt_packet_suback{} - | #mqtt_packet_unsubscribe{} | #mqtt_packet_unsuback{} - | mqtt_packet_id() | undefined, - payload :: binary() | undefined }). --type mqtt_packet() :: #mqtt_packet{}. +-record(mqtt_packet, + { header :: #mqtt_packet_header{}, + variable :: #mqtt_packet_connect{} | #mqtt_packet_connack{} + | #mqtt_packet_publish{} | #mqtt_packet_puback{} + | #mqtt_packet_subscribe{} | #mqtt_packet_suback{} + | #mqtt_packet_unsubscribe{} | #mqtt_packet_unsuback{} + | mqtt_packet_id() | undefined, + payload :: binary() | undefined + }). + +-type(mqtt_packet() :: #mqtt_packet{}). %%-------------------------------------------------------------------- %% MQTT Packet Match %%-------------------------------------------------------------------- + -define(CONNECT_PACKET(Var), #mqtt_packet{header = #mqtt_packet_header{type = ?CONNECT}, variable = Var}). diff --git a/include/emqttd_trie.hrl b/include/emqttd_trie.hrl index bd4184ad8..eb4e1390d 100644 --- a/include/emqttd_trie.hrl +++ b/include/emqttd_trie.hrl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2016-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,20 +16,20 @@ -type(trie_node_id() :: binary() | atom()). --record(trie_node, { - node_id :: trie_node_id(), - edge_count = 0 :: non_neg_integer(), - topic :: binary() | undefined, - flags :: [retained | static] -}). +-record(trie_node, + { node_id :: trie_node_id(), + edge_count = 0 :: non_neg_integer(), + topic :: binary() | undefined, + flags :: [retained | static] + }). --record(trie_edge, { - node_id :: trie_node_id(), - word :: binary() | atom() -}). +-record(trie_edge, + { node_id :: trie_node_id(), + word :: binary() | atom() + }). --record(trie, { - edge :: #trie_edge{}, - node_id :: trie_node_id() -}). +-record(trie, + { edge :: #trie_edge{}, + node_id :: trie_node_id() + }). From cae247be97acda2466ca89b404350bcdbe30cf88 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 10:56:53 +0800 Subject: [PATCH 07/34] Rename 'emqttd_hook' module to 'emqttd_hooks' --- src/emqttd.erl | 16 +++++++++------- src/emqttd_hooks.erl | 12 ++++-------- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/src/emqttd.erl b/src/emqttd.erl index 23db807cc..63b53d4e1 100644 --- a/src/emqttd.erl +++ b/src/emqttd.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,10 +14,12 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% Facade Module for The EMQ Broker +%% @doc EMQ Main Module. -module(emqttd). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). @@ -138,23 +140,23 @@ subscriber_down(Subscriber) -> -spec(hook(atom(), function(), list(any())) -> ok | {error, any()}). hook(Hook, Function, InitArgs) -> - emqttd_hook:add(Hook, Function, InitArgs). + emqttd_hooks:add(Hook, Function, InitArgs). -spec(hook(atom(), function(), list(any()), integer()) -> ok | {error, any()}). hook(Hook, Function, InitArgs, Priority) -> - emqttd_hook:add(Hook, Function, InitArgs, Priority). + emqttd_hooks:add(Hook, Function, InitArgs, Priority). -spec(unhook(atom(), function()) -> ok | {error, any()}). unhook(Hook, Function) -> - emqttd_hook:delete(Hook, Function). + emqttd_hooks:delete(Hook, Function). -spec(run_hooks(atom(), list(any())) -> ok | stop). run_hooks(Hook, Args) -> - emqttd_hook:run(Hook, Args). + emqttd_hooks:run(Hook, Args). -spec(run_hooks(atom(), list(any()), any()) -> {ok | stop, any()}). run_hooks(Hook, Args, Acc) -> - emqttd_hook:run(Hook, Args, Acc). + emqttd_hooks:run(Hook, Args, Acc). %%-------------------------------------------------------------------- %% Debug diff --git a/src/emqttd_hooks.erl b/src/emqttd_hooks.erl index 675698688..ce2691894 100644 --- a/src/emqttd_hooks.erl +++ b/src/emqttd_hooks.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2016 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,12 +14,12 @@ %% limitations under the License. %%-------------------------------------------------------------------- --module(emqttd_hook). - --author("Feng Lee "). +-module(emqttd_hooks). -behaviour(gen_server). +-author("Feng Lee "). + %% Start -export([start_link/0]). @@ -40,10 +40,6 @@ -define(HOOK_TAB, mqtt_hook). -%%-------------------------------------------------------------------- -%% Start API -%%-------------------------------------------------------------------- - start_link() -> gen_server:start_link({local, ?MODULE}, ?MODULE, [], []). From 9e0b2ed57b7de50f5a967918eaffb959e3059731 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:07:47 +0800 Subject: [PATCH 08/34] Update copyright and change the format of -type, -callback --- src/emqttd_access_control.erl | 22 +++++++++------------- src/emqttd_access_rule.erl | 17 ++++++++++------- src/emqttd_acl_internal.erl | 4 +++- src/emqttd_acl_mod.erl | 11 ++++++----- src/emqttd_alarm.erl | 4 +++- src/emqttd_auth_mod.erl | 12 +++++++----- src/emqttd_base62.erl | 4 +++- src/emqttd_boot.erl | 4 +++- src/emqttd_bridge.erl | 8 +++++--- src/emqttd_bridge_sup.erl | 2 +- src/emqttd_bridge_sup_sup.erl | 6 ++++-- src/emqttd_broker.erl | 24 +++++++++++++----------- src/emqttd_cluster.erl | 4 +++- src/emqttd_ctl.erl | 7 ++++++- src/emqttd_gen_mod.erl | 10 ++++++---- src/emqttd_guid.erl | 5 +++-- src/emqttd_http.erl | 7 +++++-- src/emqttd_keepalive.erl | 13 ++++++++----- src/emqttd_mnesia.erl | 4 +++- src/emqttd_mod_sup.erl | 8 ++------ src/emqttd_net.erl | 3 +-- src/emqttd_node.erl | 4 +++- src/emqttd_pool_sup.erl | 4 +++- src/emqttd_pooler.erl | 3 ++- src/emqttd_pubsub.erl | 9 +++++---- src/emqttd_pubsub_sup.erl | 4 +++- src/emqttd_sysmon.erl | 4 +++- src/emqttd_sysmon_sup.erl | 2 +- src/emqttd_trace.erl | 10 +++++----- src/emqttd_trace_sup.erl | 8 +++++--- src/emqttd_trie.erl | 5 ++++- src/emqttd_vm.erl | 2 +- src/lager_emqtt_backend.erl | 4 +++- 33 files changed, 142 insertions(+), 96 deletions(-) diff --git a/src/emqttd_access_control.erl b/src/emqttd_access_control.erl index 7aea58e79..cc60a57f2 100644 --- a/src/emqttd_access_control.erl +++ b/src/emqttd_access_control.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,29 +16,25 @@ -module(emqttd_access_control). --include("emqttd.hrl"). - -behaviour(gen_server). --define(SERVER, ?MODULE). +-author("Feng Lee "). + +-include("emqttd.hrl"). %% API Function Exports --export([start_link/0, - auth/2, % authentication - check_acl/3, % acl check - reload_acl/0, % reload acl - lookup_mods/1, - register_mod/3, register_mod/4, - unregister_mod/2, - stop/0]). +-export([start_link/0, auth/2, check_acl/3, reload_acl/0, lookup_mods/1, + register_mod/3, register_mod/4, unregister_mod/2, stop/0]). %% gen_server callbacks -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). +-define(SERVER, ?MODULE). + -define(ACCESS_CONTROL_TAB, mqtt_access_control). --type password() :: undefined | binary(). +-type(password() :: undefined | binary()). -record(state, {}). diff --git a/src/emqttd_access_rule.erl b/src/emqttd_access_rule.erl index 1590d2efe..73718fd3a 100644 --- a/src/emqttd_access_rule.erl +++ b/src/emqttd_access_rule.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,21 +16,24 @@ -module(emqttd_access_rule). +-author("Feng Lee "). + -include("emqttd.hrl"). --type who() :: all | binary() | + +-type(who() :: all | binary() | {ipaddr, esockd_cidr:cidr_string()} | {client, binary()} | - {user, binary()}. + {user, binary()}). --type access() :: subscribe | publish | pubsub. +-type(access() :: subscribe | publish | pubsub). --type topic() :: binary(). +-type(topic() :: binary()). --type rule() :: {allow, all} | +-type(rule() :: {allow, all} | {allow, who(), access(), list(topic())} | {deny, all} | - {deny, who(), access(), list(topic())}. + {deny, who(), access(), list(topic())}). -export_type([rule/0]). diff --git a/src/emqttd_acl_internal.erl b/src/emqttd_acl_internal.erl index 74ab8519a..f1c8b801b 100644 --- a/src/emqttd_acl_internal.erl +++ b/src/emqttd_acl_internal.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -18,6 +18,8 @@ -behaviour(emqttd_acl_mod). +-author("Feng Lee "). + -include("emqttd.hrl"). -export([all_rules/0]). diff --git a/src/emqttd_acl_mod.erl b/src/emqttd_acl_mod.erl index 44c775460..12e949afe 100644 --- a/src/emqttd_acl_mod.erl +++ b/src/emqttd_acl_mod.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_acl_mod). +-author("Feng Lee "). + -include("emqttd.hrl"). %%-------------------------------------------------------------------- @@ -26,10 +28,9 @@ -callback(init(AclOpts :: list()) -> {ok, State :: any()}). --callback(check_acl({Client, PubSub, Topic}, State :: any()) -> allow | deny | ignore when - Client :: mqtt_client(), - PubSub :: pubsub(), - Topic :: binary()). +-callback(check_acl({Client :: mqtt_client(), + PubSub :: pubsub(), + Topic :: binary()}, State :: any()) -> allow | deny | ignore). -callback(reload_acl(State :: any()) -> ok | {error, any()}). diff --git a/src/emqttd_alarm.erl b/src/emqttd_alarm.erl index 1ff4a5ae9..b214ab8fc 100644 --- a/src/emqttd_alarm.erl +++ b/src/emqttd_alarm.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_alarm). +-author("Feng Lee "). + -behaviour(gen_event). -include("emqttd.hrl"). diff --git a/src/emqttd_auth_mod.erl b/src/emqttd_auth_mod.erl index d6d4a55b0..c27f49d36 100644 --- a/src/emqttd_auth_mod.erl +++ b/src/emqttd_auth_mod.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_auth_mod). +-author("Feng Lee "). + -include("emqttd.hrl"). -export([passwd_hash/2]). @@ -30,10 +32,10 @@ -callback(init(AuthOpts :: list()) -> {ok, State :: any()}). --callback(check(Client, Password, State) -> ok | | {ok, boolean()} | ignore | {error, string()} when - Client :: mqtt_client(), - Password :: binary(), - State :: any()). +-callback(check(Client :: mqtt_client(), + Password :: binary(), + State :: any()) + -> ok | | {ok, boolean()} | ignore | {error, string()}). -callback(description() -> string()). diff --git a/src/emqttd_base62.erl b/src/emqttd_base62.erl index 5895fa245..481488fb9 100644 --- a/src/emqttd_base62.erl +++ b/src/emqttd_base62.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2016-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_base62). +-author("Feng Lee "). + -export([encode/1, decode/1]). %% @doc Encode an integer to base62 string diff --git a/src/emqttd_boot.erl b/src/emqttd_boot.erl index dd1b8a65b..d7a6d311e 100644 --- a/src/emqttd_boot.erl +++ b/src/emqttd_boot.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_boot). +-author("Feng Lee "). + -export([apply_module_attributes/1, all_module_attributes/1]). %% only {F, Args}... diff --git a/src/emqttd_bridge.erl b/src/emqttd_bridge.erl index 3dca7bf0f..7e36ad256 100644 --- a/src/emqttd_bridge.erl +++ b/src/emqttd_bridge.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -18,6 +18,8 @@ -behaviour(gen_server2). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). @@ -43,11 +45,11 @@ ping_down_interval = ?PING_DOWN_INTERVAL, status = up}). --type option() :: {qos, mqtt_qos()} | +-type(option() :: {qos, mqtt_qos()} | {topic_suffix, binary()} | {topic_prefix, binary()} | {max_queue_len, pos_integer()} | - {ping_down_interval, pos_integer()}. + {ping_down_interval, pos_integer()}). -export_type([option/0]). diff --git a/src/emqttd_bridge_sup.erl b/src/emqttd_bridge_sup.erl index dd418b2f6..d28b2274c 100644 --- a/src/emqttd_bridge_sup.erl +++ b/src/emqttd_bridge_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. diff --git a/src/emqttd_bridge_sup_sup.erl b/src/emqttd_bridge_sup_sup.erl index 47e246273..1d47bd003 100644 --- a/src/emqttd_bridge_sup_sup.erl +++ b/src/emqttd_bridge_sup_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -18,6 +18,8 @@ -behavior(supervisor). +-author("Feng Lee "). + -export([start_link/0, bridges/0, start_bridge/2, start_bridge/3, stop_bridge/2]). -export([init/1]). @@ -47,7 +49,7 @@ start_bridge(Node, _Topic, _Options) when Node =:= node() -> {error, bridge_to_self}; start_bridge(Node, Topic, Options) when is_atom(Node) andalso is_binary(Topic) -> {ok, BridgeEnv} = emqttd:env(bridge), - Options1 = emqttd_opts:merge(BridgeEnv, Options), + Options1 = emqttd_misc:merge_opts(BridgeEnv, Options), supervisor:start_child(?MODULE, bridge_spec(Node, Topic, Options1)). %% @doc Stop a bridge diff --git a/src/emqttd_broker.erl b/src/emqttd_broker.erl index 96dd7d553..ce2e4210c 100644 --- a/src/emqttd_broker.erl +++ b/src/emqttd_broker.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -18,6 +18,8 @@ -behaviour(gen_server). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_internal.hrl"). @@ -40,16 +42,18 @@ -record(state, {started_at, sys_interval, heartbeat, tick_tref, version, sysdescr}). +-define(APP, emqttd). + -define(SERVER, ?MODULE). -define(BROKER_TAB, mqtt_broker). %% $SYS Topics of Broker -define(SYSTOP_BROKERS, [ - version, % Broker version - uptime, % Broker uptime - datetime, % Broker local datetime - sysdescr % Broker description + version, % Broker version + uptime, % Broker uptime + datetime, % Broker local datetime + sysdescr % Broker description ]). %%-------------------------------------------------------------------- @@ -74,12 +78,12 @@ notify(EventType, Event) -> %% @doc Get broker version -spec(version() -> string()). version() -> - {ok, Version} = application:get_key(emqttd, vsn), Version. + {ok, Version} = application:get_key(?APP, vsn), Version. %% @doc Get broker description -spec(sysdescr() -> string()). sysdescr() -> - {ok, Descr} = application:get_key(emqttd, description), Descr. + {ok, Descr} = application:get_key(?APP, description), Descr. %% @doc Get broker uptime -spec(uptime() -> string()). @@ -161,13 +165,11 @@ retain(brokers) -> Payload = list_to_binary(string:join([atom_to_list(N) || N <- emqttd_mnesia:running_nodes()], ",")), Msg = emqttd_message:make(broker, <<"$SYS/brokers">>, Payload), - Msg1 = emqttd_message:set_flag(sys, emqttd_message:set_flag(retain, Msg)), - emqttd:publish(Msg1). + emqttd:publish(emqttd_message:set_flag(sys, emqttd_message:set_flag(retain, Msg))). retain(Topic, Payload) when is_binary(Payload) -> Msg = emqttd_message:make(broker, emqttd_topic:systop(Topic), Payload), - Msg1 = emqttd_message:set_flag(sys, emqttd_message:set_flag(retain, Msg)), - emqttd:publish(Msg1). + emqttd:publish(emqttd_message:set_flag(sys, emqttd_message:set_flag(retain, Msg))). publish(Topic, Payload) when is_binary(Payload) -> Msg = emqttd_message:make(broker, emqttd_topic:systop(Topic), Payload), diff --git a/src/emqttd_cluster.erl b/src/emqttd_cluster.erl index 7c83c079c..7990a5d51 100644 --- a/src/emqttd_cluster.erl +++ b/src/emqttd_cluster.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_cluster). +-author("Feng Lee "). + -include("emqttd.hrl"). %% Cluster API diff --git a/src/emqttd_ctl.erl b/src/emqttd_ctl.erl index c0b7dcf70..0aa8ce353 100644 --- a/src/emqttd_ctl.erl +++ b/src/emqttd_ctl.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -18,6 +18,8 @@ -behaviour(gen_server). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_cli.hrl"). @@ -134,7 +136,9 @@ next_seq(State = #state{seq = Seq}) -> State#state{seq = Seq + 1}. -ifdef(TEST). + -include_lib("eunit/include/eunit.hrl"). + register_cmd_test_() -> {setup, fun() -> @@ -149,4 +153,5 @@ register_cmd_test_() -> [?_assertMatch([{{0,test0},{?MODULE, test0}, []}], ets:lookup(?CMD_TAB, {Seq,test0}))] end }. + -endif. diff --git a/src/emqttd_gen_mod.erl b/src/emqttd_gen_mod.erl index b201f7bdd..824b65f4c 100644 --- a/src/emqttd_gen_mod.erl +++ b/src/emqttd_gen_mod.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -15,15 +15,18 @@ %%-------------------------------------------------------------------- %% @doc emqttd gen_mod behaviour + -module(emqttd_gen_mod). +-author("Feng Lee "). + -include("emqttd.hrl"). -ifdef(use_specs). --callback load(Opts :: any()) -> ok | {error, any()}. +-callback(load(Opts :: any()) -> ok | {error, any()}). --callback unload(State :: any()) -> any(). +-callback(unload(State :: any()) -> any()). -else. @@ -35,4 +38,3 @@ behaviour_info(_Other) -> undefined. -endif. - diff --git a/src/emqttd_guid.erl b/src/emqttd_guid.erl index a4c2d1ea4..24199fa01 100644 --- a/src/emqttd_guid.erl +++ b/src/emqttd_guid.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -27,13 +27,14 @@ %% 4. Sequence: 2 bytes sequence in one process %% %% @end + -module(emqttd_guid). -export([gen/0, new/0, timestamp/1, to_hexstr/1, from_hexstr/1, to_base62/1, from_base62/1]). -define(MAX_SEQ, 16#FFFF). --type guid() :: <<_:128>>. +-type(guid() :: <<_:128>>). %% @doc Generate a global unique id. -spec(gen() -> guid()). diff --git a/src/emqttd_http.erl b/src/emqttd_http.erl index 8ad37dd10..692477447 100644 --- a/src/emqttd_http.erl +++ b/src/emqttd_http.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,9 +14,12 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% @doc emqttd http publish API and websocket client. +%% @doc HTTP publish API and websocket client. + -module(emqttd_http). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). diff --git a/src/emqttd_keepalive.erl b/src/emqttd_keepalive.erl index 54a4d20e5..51d45c89c 100644 --- a/src/emqttd_keepalive.erl +++ b/src/emqttd_keepalive.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -15,15 +15,18 @@ %%-------------------------------------------------------------------- %% @doc Client Keepalive + -module(emqttd_keepalive). +-author("Feng Lee "). + -export([start/3, check/1, cancel/1]). --record(keepalive, {statfun, statval, - tsec, tmsg, tref, - repeat = 0}). +-record(keepalive, {statfun, statval, tsec, tmsg, tref, repeat = 0}). --type keepalive() :: #keepalive{}. +-type(keepalive() :: #keepalive{}). + +-export_type([keepalive/0]). %% @doc Start a keepalive -spec(start(fun(), integer(), any()) -> undefined | keepalive()). diff --git a/src/emqttd_mnesia.erl b/src/emqttd_mnesia.erl index 52dca1d1b..31fa88d3a 100644 --- a/src/emqttd_mnesia.erl +++ b/src/emqttd_mnesia.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_mnesia). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_internal.hrl"). diff --git a/src/emqttd_mod_sup.erl b/src/emqttd_mod_sup.erl index 57b13bc37..586d5af1a 100644 --- a/src/emqttd_mod_sup.erl +++ b/src/emqttd_mod_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -39,11 +39,7 @@ start_link() -> start_child(ChildSpec) when is_tuple(ChildSpec) -> supervisor:start_child(?MODULE, ChildSpec). -%% -%% start_child(Mod::atom(), Type::type()) -> {ok, pid()} -%% @type type() = worker | supervisor -%% -start_child(Mod, Type) when is_atom(Mod) and is_atom(Type) -> +start_child(Mod, Type) when is_atom(Mod) andalso is_atom(Type) -> supervisor:start_child(?MODULE, ?CHILD(Mod, Type)). -spec(stop_child(any()) -> ok | {error, any()}). diff --git a/src/emqttd_net.erl b/src/emqttd_net.erl index 8278e1f74..1f246a315 100644 --- a/src/emqttd_net.erl +++ b/src/emqttd_net.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,7 +14,6 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% @doc emqttd net utilities. -module(emqttd_net). -include_lib("kernel/include/inet.hrl"). diff --git a/src/emqttd_node.erl b/src/emqttd_node.erl index e48f71fae..ecf44503f 100644 --- a/src/emqttd_node.erl +++ b/src/emqttd_node.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_node). +-author("Feng Lee "). + -import(lists, [concat/1]). -export([is_aliving/1, parse_name/1]). diff --git a/src/emqttd_pool_sup.erl b/src/emqttd_pool_sup.erl index e06d09e8f..bc8f59562 100644 --- a/src/emqttd_pool_sup.erl +++ b/src/emqttd_pool_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -17,6 +17,8 @@ %% @doc Common Pool Supervisor -module(emqttd_pool_sup). +-author("Feng Lee "). + -behaviour(supervisor). %% API diff --git a/src/emqttd_pooler.erl b/src/emqttd_pooler.erl index 2701c470e..1b73d138c 100644 --- a/src/emqttd_pooler.erl +++ b/src/emqttd_pooler.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -39,6 +39,7 @@ start_link() -> %%-------------------------------------------------------------------- %% API %%-------------------------------------------------------------------- + -spec(start_link(atom(), pos_integer()) -> {ok, pid()} | ignore | {error, any()}). start_link(Pool, Id) -> gen_server:start_link({local, ?PROC_NAME(?MODULE, Id)}, ?MODULE, [Pool, Id], []). diff --git a/src/emqttd_pubsub.erl b/src/emqttd_pubsub.erl index 83a080ff6..c99aca513 100644 --- a/src/emqttd_pubsub.erl +++ b/src/emqttd_pubsub.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -18,11 +18,12 @@ -behaviour(gen_server2). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_internal.hrl"). -%% Start API. -export([start_link/3]). %% PubSub API. @@ -31,7 +32,7 @@ -export([dispatch/2]). -%% gen_server. +%% gen_server Callbacks -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). @@ -45,7 +46,6 @@ %% Start PubSub %%-------------------------------------------------------------------- -%% @doc Start one Pubsub -spec(start_link(atom(), pos_integer(), list()) -> {ok, pid()} | ignore | {error, any()}). start_link(Pool, Id, Env) -> gen_server2:start_link({local, ?PROC_NAME(?MODULE, Id)}, ?MODULE, [Pool, Id, Env], []). @@ -115,6 +115,7 @@ dispatch({_Share, [Sub]}, Topic, Msg) -> dispatch(Sub, Topic, Msg); dispatch({_Share, []}, _Topic, _Msg) -> ok; +%%TODO: round-robbin dispatch({_Share, Subs}, Topic, Msg) -> dispatch(lists:nth(rand:uniform(length(Subs)), Subs), Topic, Msg). diff --git a/src/emqttd_pubsub_sup.erl b/src/emqttd_pubsub_sup.erl index 882fce57c..09d08d110 100644 --- a/src/emqttd_pubsub_sup.erl +++ b/src/emqttd_pubsub_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -17,6 +17,8 @@ %% @doc PubSub Supervisor. -module(emqttd_pubsub_sup). +-author("Feng Lee "). + -behaviour(supervisor). %% API diff --git a/src/emqttd_sysmon.erl b/src/emqttd_sysmon.erl index 7c338a842..c94c1df54 100644 --- a/src/emqttd_sysmon.erl +++ b/src/emqttd_sysmon.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -17,6 +17,8 @@ %% @doc VM System Monitor -module(emqttd_sysmon). +-author("Feng Lee "). + -behavior(gen_server). -include("emqttd_internal.hrl"). diff --git a/src/emqttd_sysmon_sup.erl b/src/emqttd_sysmon_sup.erl index 0131c42db..99e7a628d 100644 --- a/src/emqttd_sysmon_sup.erl +++ b/src/emqttd_sysmon_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. diff --git a/src/emqttd_trace.erl b/src/emqttd_trace.erl index 069f44937..4d46d9165 100644 --- a/src/emqttd_trace.erl +++ b/src/emqttd_trace.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,13 +14,13 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% @doc -%% Trace MQTT packets/messages by ClientID or Topic. -%% @end +%% @docTrace MQTT packets/messages by ClientID or Topic. -module(emqttd_trace). -behaviour(gen_server). +-author("Feng Lee "). + -include("emqttd_internal.hrl"). %% API Function Exports @@ -34,7 +34,7 @@ -record(state, {level, traces}). --type trace_who() :: {client | topic, binary()}. +-type(trace_who() :: {client | topic, binary()}). -define(TRACE_OPTIONS, [{formatter_config, [time, " [",severity,"] ", message, "\n"]}]). diff --git a/src/emqttd_trace_sup.erl b/src/emqttd_trace_sup.erl index 22736b1a2..728e6818e 100644 --- a/src/emqttd_trace_sup.erl +++ b/src/emqttd_trace_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_trace_sup). +-author("Feng Lee "). + -behaviour(supervisor). %% API @@ -29,6 +31,6 @@ start_link() -> init([]) -> Trace = {trace, {emqttd_trace, start_link, []}, - permanent, 5000, worker, [emqttd_trace]}, - {ok, {{one_for_one, 10, 100}, [Trace]}}. + permanent, 5000, worker, [emqttd_trace]}, + {ok, {{one_for_one, 10, 3600}, [Trace]}}. diff --git a/src/emqttd_trie.erl b/src/emqttd_trie.erl index 23bb40bcf..70b1c003f 100644 --- a/src/emqttd_trie.erl +++ b/src/emqttd_trie.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -17,8 +17,11 @@ %% @doc MQTT Topic Trie: %% [Trie](http://en.wikipedia.org/wiki/Trie) %% @end + -module(emqttd_trie). +-author("Feng Lee "). + -include("emqttd_trie.hrl"). %% Mnesia Callbacks diff --git a/src/emqttd_vm.erl b/src/emqttd_vm.erl index abf4d3b78..16fae60ae 100644 --- a/src/emqttd_vm.erl +++ b/src/emqttd_vm.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. diff --git a/src/lager_emqtt_backend.erl b/src/lager_emqtt_backend.erl index 214182b8d..69c1aece4 100644 --- a/src/lager_emqtt_backend.erl +++ b/src/lager_emqtt_backend.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(lager_emqtt_backend). +-author("Feng Lee "). + -behaviour(gen_event). -include_lib("lager/include/lager.hrl"). From 0019fb2b49788720c00a0e38d9e326325542d2e3 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:10:47 +0800 Subject: [PATCH 09/34] Change the message timestamp to 'os:timestamp()' --- src/emqttd_message.erl | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/emqttd_message.erl b/src/emqttd_message.erl index ec4a02479..4c3bea0d8 100644 --- a/src/emqttd_message.erl +++ b/src/emqttd_message.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -15,8 +15,11 @@ %%-------------------------------------------------------------------- %% @doc MQTT Message Functions + -module(emqttd_message). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). @@ -42,7 +45,7 @@ make(From, Qos, Topic, Payload) -> qos = ?QOS_I(Qos), topic = Topic, payload = Payload, - timestamp = emqttd_time:now_to_secs()}. + timestamp = os:timestamp()}. %% @doc Message from Packet -spec(from_packet(mqtt_packet()) -> mqtt_message()). @@ -60,7 +63,7 @@ from_packet(#mqtt_packet{header = #mqtt_packet_header{type = ?PUBLISH, dup = Dup, topic = Topic, payload = Payload, - timestamp = emqttd_time:now_to_secs()}; + timestamp = os:timestamp()}; from_packet(#mqtt_packet_connect{will_flag = false}) -> undefined; @@ -78,7 +81,7 @@ from_packet(#mqtt_packet_connect{client_id = ClientId, qos = Qos, dup = false, payload = Msg, - timestamp = emqttd_time:now_to_secs()}. + timestamp = os:timestamp()}. from_packet(ClientId, Packet) -> Msg = from_packet(Packet), From 796d5df1c0ea1fded71549f6874be075bd55c9b6 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:17:57 +0800 Subject: [PATCH 10/34] Upgrade parse/2 function --- src/emqttd_topic.erl | 57 ++++++++++++++++++++++++-------------------- 1 file changed, 31 insertions(+), 26 deletions(-) diff --git a/src/emqttd_topic.erl b/src/emqttd_topic.erl index 0afeacae8..458a41f7d 100644 --- a/src/emqttd_topic.erl +++ b/src/emqttd_topic.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,8 +16,12 @@ -module(emqttd_topic). +-author("Feng Lee "). + -include("emqttd_protocol.hrl"). +-include("emqttd_internal.hrl"). + -import(lists, [reverse/1]). -export([match/2, validate/1, triples/1, words/1, wildcard/1]). @@ -55,8 +59,8 @@ wildcard([_H|T]) -> %% @doc Match Topic name with filter -spec(match(Name, Filter) -> boolean() when - Name :: topic() | words(), - Filter :: topic() | words()). + Name :: topic() | words(), + Filter :: topic() | words()). match(Name, Filter) when is_binary(Name) and is_binary(Filter) -> match(words(Name), words(Filter)); match([], []) -> @@ -94,17 +98,14 @@ validate2([]) -> true; validate2(['#']) -> % end with '#' true; -validate2(['#'|Words]) when length(Words) > 0 -> - false; +validate2(['#'|Words]) when length(Words) > 0 -> + false; validate2([''|Words]) -> validate2(Words); validate2(['+'|Words]) -> validate2(Words); validate2([W|Words]) -> - case validate3(W) of - true -> validate2(Words); - false -> false - end. + case validate3(W) of true -> validate2(Words); false -> false end. validate3(<<>>) -> true; @@ -180,24 +181,28 @@ join(Words) -> parse(Topic) when is_binary(Topic) -> parse(Topic, []). -parse(Topic = <<"$local/", Topic1/binary>>, Options) -> - case lists:member(local, Options) of - true -> error({invalid_topic, Topic}); - false -> parse(Topic1, [local | Options]) - end; +parse(<<"$local/", Topic1/binary>>, Options) -> + if_not_contain(local, Options, fun() -> + parse(Topic1, [local | Options]) + end); -parse(Topic = <<"$queue/", Topic1/binary>>, Options) -> - case lists:keyfind(share, 1, Options) of - {share, _} -> error({invalid_topic, Topic}); - false -> parse(Topic1, [{share, '$queue'} | Options]) - end; +parse(<<"$queue/", Topic1/binary>>, Options) -> + if_not_contain(share, Options,fun() -> + parse(Topic1, [{share, '$queue'} | Options]) + end); -parse(Topic = <<"$share/", Topic1/binary>>, Options) -> - case lists:keyfind(share, 1, Options) of - {share, _} -> error({invalid_topic, Topic}); - false -> [Share, Topic2] = binary:split(Topic1, <<"/">>), - {Topic2, [{share, Share} | Options]} - end; +parse(<<"$share/", Topic1/binary>>, Options) -> + if_not_contain(share, Options, fun() -> + [Share, Topic2] = binary:split(Topic1, <<"/">>), + {Topic2, [{share, Share} | Options]} + end); -parse(Topic, Options) -> {Topic, Options}. +parse(Topic, Options) -> + {Topic, Options}. + +if_not_contain(local, Options, Fun) -> + ?IF(lists:member(local, Options), error(invalid_topic), Fun()); + +if_not_contain(share, Options, Fun) -> + ?IF(lists:keyfind(share, 1, Options), error(invalid_topic), Fun()). From 640c9287c2093dab7fce98adf244e17d10aaa569 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:18:37 +0800 Subject: [PATCH 11/34] Rename now_to_secs, now_to_ms functions --- src/emqttd_time.erl | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/src/emqttd_time.erl b/src/emqttd_time.erl index 49cf4965c..f9ada795d 100644 --- a/src/emqttd_time.erl +++ b/src/emqttd_time.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,21 +16,27 @@ -module(emqttd_time). --export([seed/0, now_to_secs/0, now_to_secs/1, now_to_ms/0, now_to_ms/1]). +-author("Feng Lee "). + +-export([seed/0, now_secs/0, now_secs/1, now_ms/0, now_ms/1, ts_from_ms/1]). seed() -> case erlang:function_exported(erlang, timestamp, 0) of - true -> random:seed(erlang:timestamp()); %% R18 + true -> rand:seed(exsplus, erlang:timestamp()); %% R18 false -> random:seed(os:timestamp()) %% Compress now() deprecated warning... end. -now_to_secs() -> now_to_secs(os:timestamp()). +now_ms() -> + now_ms(os:timestamp()). -now_to_secs({MegaSecs, Secs, _MicroSecs}) -> - MegaSecs * 1000000 + Secs. - -now_to_ms() -> now_to_ms(os:timestamp()). - -now_to_ms({MegaSecs, Secs, MicroSecs}) -> +now_ms({MegaSecs, Secs, MicroSecs}) -> (MegaSecs * 1000000 + Secs) * 1000 + round(MicroSecs/1000). +now_secs() -> + now_secs(os:timestamp()). + +now_secs({MegaSecs, Secs, _MicroSecs}) -> + MegaSecs * 1000000 + Secs. + +ts_from_ms(Ms) -> + {Ms div 1000000, Ms rem 1000000, 0}. From d93caa7c9ecadd51f31bf5946ae4d6a00c37a8ea Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:19:02 +0800 Subject: [PATCH 12/34] Update copyright and format code --- src/emqttd_cli.erl | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/src/emqttd_cli.erl b/src/emqttd_cli.erl index 085032b24..06faf6879 100644 --- a/src/emqttd_cli.erl +++ b/src/emqttd_cli.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_cli). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_cli.hrl"). @@ -57,6 +59,7 @@ is_cmd(Fun) -> %%-------------------------------------------------------------------- %% @doc Node status + status([]) -> {InternalStatus, _ProvidedStatus} = init:get_status(), ?PRINT("Node ~p is ~p~n", [node(), InternalStatus]), @@ -71,6 +74,7 @@ status(_) -> %%-------------------------------------------------------------------- %% @doc Query broker + broker([]) -> Funs = [sysdescr, version, uptime, datetime], foreach(fun(Fun) -> @@ -105,6 +109,7 @@ broker(_) -> %%-------------------------------------------------------------------- %% @doc Cluster with other nodes + cluster(["join", SNode]) -> case emqttd_cluster:join(emqttd_node:parse_name(SNode)) of ok -> @@ -143,10 +148,12 @@ cluster(_) -> %%-------------------------------------------------------------------- %% @doc Users usage + users(Args) -> emq_auth_username:cli(Args). %%-------------------------------------------------------------------- %% @doc Query clients + clients(["list"]) -> dump(mqtt_client); @@ -169,14 +176,17 @@ if_client(ClientId, Fun) -> %%-------------------------------------------------------------------- %% @doc Sessions Command + sessions(["list"]) -> dump(mqtt_local_session); %% performance issue? + sessions(["list", "persistent"]) -> lists:foreach(fun print/1, ets:match_object(mqtt_local_session, {'_', '_', false, '_'})); %% performance issue? + sessions(["list", "transient"]) -> lists:foreach(fun print/1, ets:match_object(mqtt_local_session, {'_', '_', true, '_'})); @@ -194,6 +204,7 @@ sessions(_) -> %%-------------------------------------------------------------------- %% @doc Routes Command + routes(["list"]) -> Routes = emqttd_router:dump(), foreach(fun print/1, Routes); @@ -207,6 +218,7 @@ routes(_) -> %%-------------------------------------------------------------------- %% @doc Topics Command + topics(["list"]) -> lists:foreach(fun(Topic) -> ?PRINT("~s~n", [Topic]) end, emqttd:topics()); @@ -260,14 +272,14 @@ subscriptions(_) -> {"subscriptions del ", "Delete static subscriptions manually"}, {"subscriptions del ", "Delete a static subscription manually"}]). -if_could_print(Tab, Fun) -> - case mnesia:table_info(Tab, size) of - Size when Size >= ?MAX_LIMIT -> - ?PRINT("Could not list, too many ~ss: ~p~n", [Tab, Size]); - _Size -> - Keys = mnesia:dirty_all_keys(Tab), - foreach(fun(Key) -> Fun(ets:lookup(Tab, Key)) end, Keys) - end. +% if_could_print(Tab, Fun) -> +% case mnesia:table_info(Tab, size) of +% Size when Size >= ?MAX_LIMIT -> +% ?PRINT("Could not list, too many ~ss: ~p~n", [Tab, Size]); +% _Size -> +% Keys = mnesia:dirty_all_keys(Tab), +% foreach(fun(Key) -> Fun(ets:lookup(Tab, Key)) end, Keys) +% end. if_valid_qos(QoS, Fun) -> try list_to_integer(QoS) of @@ -303,6 +315,7 @@ plugins(_) -> %%-------------------------------------------------------------------- %% @doc Bridges command + bridges(["list"]) -> foreach(fun({Node, Topic, _Pid}) -> ?PRINT("bridge: ~s--~s-->~s~n", [node(), Topic, Node]) @@ -360,6 +373,7 @@ parse_opt(_Cmd, Opt, _Val) -> %%-------------------------------------------------------------------- %% @doc vm command + vm([]) -> vm(["all"]); @@ -398,6 +412,7 @@ vm(_) -> %%-------------------------------------------------------------------- %% @doc mnesia Command + mnesia([]) -> mnesia:system_info(); @@ -406,6 +421,7 @@ mnesia(_) -> %%-------------------------------------------------------------------- %% @doc Trace Command + trace(["list"]) -> foreach(fun({{Who, Name}, LogFile}) -> ?PRINT("trace ~s ~s -> ~s~n", [Who, Name, LogFile]) @@ -448,6 +464,7 @@ trace_off(Who, Name) -> %%-------------------------------------------------------------------- %% @doc Listeners Command + listeners([]) -> foreach(fun({{Protocol, ListenOn}, Pid}) -> Info = [{acceptors, esockd:get_acceptors(Pid)}, From dbcd79fb749d549e6ee3c510fe144e738806dcfe Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:22:48 +0800 Subject: [PATCH 13/34] Move the 'MQTT_SOCKOPTS' macro to include/emqttd_protocol.hrl --- src/emqttd_app.erl | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/src/emqttd_app.erl b/src/emqttd_app.erl index bdbfc4a54..6f758b870 100644 --- a/src/emqttd_app.erl +++ b/src/emqttd_app.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -18,29 +18,26 @@ -behaviour(application). +-author("Feng Lee "). + -include("emqttd_cli.hrl"). +-include("emqttd_protocol.hrl"). + %% Application callbacks -export([start/2, stop/1]). -export([start_listener/1, stop_listener/1]). -%% MQTT SockOpts --define(MQTT_SOCKOPTS, [binary, {packet, raw}, {reuseaddr, true}, - {backlog, 512}, {nodelay, true}]). +-type(listener() :: {atom(), esockd:listen_on(), [esockd:option()]}). --type listener() :: {atom(), esockd:listen_on(), [esockd:option()]}. +-define(APP, emqttd). %%-------------------------------------------------------------------- %% Application callbacks %%-------------------------------------------------------------------- --spec(start(StartType, StartArgs) -> {ok, pid()} | {ok, pid(), State} | {error, Reason} when - StartType :: normal | {takeover, node()} | {failover, node()}, - StartArgs :: term(), - State :: term(), - Reason :: term()). -start(_StartType, _StartArgs) -> +start(_Type, _Args) -> print_banner(), emqttd_mnesia:start(), {ok, Sup} = emqttd_sup:start_link(), @@ -63,12 +60,11 @@ stop(_State) -> %%-------------------------------------------------------------------- print_banner() -> - ?PRINT("starting emqttd on node '~s'~n", [node()]). + ?PRINT("starting ~s on node '~s'~n", [?APP, node()]). print_vsn() -> {ok, Vsn} = application:get_key(vsn), - {ok, Desc} = application:get_key(description), - ?PRINT("~s ~s is running now~n", [Desc, Vsn]). + ?PRINT("~s ~s is running now~n", [?APP, Vsn]). %%-------------------------------------------------------------------- %% Start Servers @@ -176,14 +172,14 @@ start_listener({Proto, ListenOn, Opts}) when Proto == https; Proto == wss -> mochiweb:start_http('mqtt:wss', ListenOn, Opts, {emqttd_http, handle_request, []}). start_listener(Proto, ListenOn, Opts) -> - {ok, Env} = emqttd:env(protocol), + Env = lists:append(emqttd:env(client, []), emqttd:env(protocol, [])), MFArgs = {emqttd_client, start_link, [Env]}, {ok, _} = esockd:open(Proto, ListenOn, merge_sockopts(Opts), MFArgs). merge_sockopts(Options) -> - SockOpts = emqttd_opts:merge(?MQTT_SOCKOPTS, - proplists:get_value(sockopts, Options, [])), - emqttd_opts:merge(Options, [{sockopts, SockOpts}]). + SockOpts = emqttd_misc:merge_opts( + ?MQTT_SOCKOPTS, proplists:get_value(sockopts, Options, [])), + emqttd_misc:merge_opts(Options, [{sockopts, SockOpts}]). %%-------------------------------------------------------------------- %% Stop Listeners @@ -211,3 +207,4 @@ merge_sockopts_test_() -> ?_assert(merge_sockopts(Opts) == [{sockopts, ?MQTT_SOCKOPTS} | Opts]). -endif. + From 23e49c317dcb8f7581ebd98ea4f3db3e986e3577 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:24:46 +0800 Subject: [PATCH 14/34] Improve the module and support statistics --- src/emqttd_client.erl | 210 ++++++++++++++++++++++++++---------------- 1 file changed, 131 insertions(+), 79 deletions(-) diff --git a/src/emqttd_client.erl b/src/emqttd_client.erl index 6f15bdf8c..1e4b3db4a 100644 --- a/src/emqttd_client.erl +++ b/src/emqttd_client.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,24 +14,36 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% @doc MQTT Client Connection +%% @doc MQTT/TCP Connection + -module(emqttd_client). -behaviour(gen_server). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). -include("emqttd_internal.hrl"). +-import(proplists, [get_value/2, get_value/3]). + %% API Function Exports --export([start_link/2, session/1, info/1, kick/1, - set_rate_limit/2, get_rate_limit/1]). +-export([start_link/2]). + +%% Management and Monitor API +-export([info/1, stats/1, kick/1]). + +-export([set_rate_limit/2, get_rate_limit/1]). %% SUB/UNSUB Asynchronously. Called by plugins. -export([subscribe/2, unsubscribe/2]). +%% Get the session proc? +-export([session/1]). + %% gen_server Function Exports -export([init/1, handle_call/3, handle_cast/2, handle_info/2, code_change/3, terminate/2]). @@ -39,24 +51,25 @@ %% Client State -record(client_state, {connection, connname, peername, peerhost, peerport, await_recv, conn_state, rate_limit, parser_fun, - proto_state, packet_opts, keepalive, mountpoint}). + proto_state, packet_opts, keepalive, enable_stats, + stats_timer}). --define(INFO_KEYS, [peername, peerhost, peerport, await_recv, conn_state]). +-define(INFO_KEYS, [connname, peername, peerhost, peerport, await_recv, conn_state]). --define(SOCK_STATS, [recv_oct, recv_cnt, send_oct, send_cnt]). +-define(SOCK_STATS, [recv_oct, recv_cnt, send_oct, send_cnt, send_pend]). -define(LOG(Level, Format, Args, State), lager:Level("Client(~s): " ++ Format, [State#client_state.connname | Args])). -start_link(Connection, MqttEnv) -> - {ok, proc_lib:spawn_link(?MODULE, init, [[Connection, MqttEnv]])}. - -session(CPid) -> - gen_server:call(CPid, session, infinity). +start_link(Conn, Env) -> + {ok, proc_lib:spawn_link(?MODULE, init, [[Conn, Env]])}. info(CPid) -> gen_server:call(CPid, info, infinity). +stats(CPid) -> + gen_server:call(CPid, stats). + kick(CPid) -> gen_server:call(CPid, kick). @@ -67,42 +80,49 @@ get_rate_limit(Cpid) -> gen_server:call(Cpid, get_rate_limit). subscribe(CPid, TopicTable) -> - gen_server:cast(CPid, {subscribe, TopicTable}). + CPid ! {subscribe, TopicTable}. unsubscribe(CPid, Topics) -> - gen_server:cast(CPid, {unsubscribe, Topics}). + CPid ! {unsubscribe, Topics}. -init([OriginConn, MqttEnv]) -> - {ok, Connection} = OriginConn:wait(), +session(CPid) -> + gen_server2:call(CPid, session, infinity). + +%%-------------------------------------------------------------------- +%% gen_server Callbacks +%%-------------------------------------------------------------------- + +init([Conn0, Env]) -> + {ok, Conn} = Conn0:wait(), {PeerHost, PeerPort, PeerName} = - case Connection:peername() of + case Conn:peername() of {ok, Peer = {Host, Port}} -> {Host, Port, Peer}; {error, enotconn} -> - Connection:fast_close(), + Conn:fast_close(), exit(normal); {error, Reason} -> - Connection:fast_close(), + Conn:fast_close(), exit({shutdown, Reason}) end, ConnName = esockd_net:format(PeerName), Self = self(), - %% Send Packet... SendFun = fun(Packet) -> Data = emqttd_serializer:serialize(Packet), ?LOG(debug, "SEND ~p", [Data], #client_state{connname = ConnName}), emqttd_metrics:inc('bytes/sent', iolist_size(Data)), - try Connection:async_send(Data) of + try Conn:async_send(Data) of true -> ok catch error:Error -> Self ! {shutdown, Error} end end, - ParserFun = emqttd_parser:new(MqttEnv), - ProtoState = emqttd_protocol:init(PeerName, SendFun, MqttEnv), - RateLimit = proplists:get_value(rate_limit, Connection:opts()), - State = run_socket(#client_state{connection = Connection, + ParserFun = emqttd_parser:new(Env), + ProtoState = emqttd_protocol:init(PeerName, SendFun, Env), + RateLimit = get_value(rate_limit, Conn:opts()), + EnableStats = get_value(client_enable_stats, Env, false), + State = run_socket(#client_state{connection = Conn, connname = ConnName, peername = PeerName, peerhost = PeerHost, @@ -112,20 +132,21 @@ init([OriginConn, MqttEnv]) -> rate_limit = RateLimit, parser_fun = ParserFun, proto_state = ProtoState, - packet_opts = MqttEnv}), - IdleTimout = proplists:get_value(client_idle_timeout, MqttEnv, 30), - gen_server:enter_loop(?MODULE, [], State, timer:seconds(IdleTimout)). + packet_opts = Env, + enable_stats = EnableStats}), + IdleTimout = get_value(client_idle_timeout, Env, 30000), + gen_server:enter_loop(?MODULE, [], maybe_enable_stats(State), IdleTimout). -handle_call(session, _From, State = #client_state{proto_state = ProtoState}) -> - {reply, emqttd_protocol:session(ProtoState), State}; - -handle_call(info, _From, State = #client_state{connection = Connection, - proto_state = ProtoState}) -> - ClientInfo = ?record_to_proplist(client_state, State, ?INFO_KEYS), +handle_call(info, From, State = #client_state{proto_state = ProtoState}) -> ProtoInfo = emqttd_protocol:info(ProtoState), - {ok, SockStats} = Connection:getstat(?SOCK_STATS), - {reply, lists:append([ClientInfo, [{proto_info, ProtoInfo}, - {sock_stats, SockStats}]]), State}; + ClientInfo = ?record_to_proplist(client_state, State, ?INFO_KEYS), + {reply, Stats, _} = handle_call(stats, From, State), + {reply, lists:append([ClientInfo, ProtoInfo, Stats]), State}; + +handle_call(stats, _From, State = #client_state{proto_state = ProtoState}) -> + {reply, lists:append([emqttd_misc:proc_stats(), + emqttd_protocol:stats(ProtoState), + sock_stats(State)]), State}; handle_call(kick, _From, State) -> {stop, {shutdown, kick}, ok, State}; @@ -136,45 +157,56 @@ handle_call({set_rate_limit, Rl}, _From, State) -> handle_call(get_rate_limit, _From, State = #client_state{rate_limit = Rl}) -> {reply, Rl, State}; +handle_call(session, _From, State = #client_state{proto_state = ProtoState}) -> + {reply, emqttd_protocol:session(ProtoState), State}; + handle_call(Req, _From, State) -> ?UNEXPECTED_REQ(Req, State). -handle_cast({subscribe, TopicTable}, State) -> - with_proto_state(fun(ProtoState) -> - emqttd_protocol:handle({subscribe, TopicTable}, ProtoState) - end, State); - -handle_cast({unsubscribe, Topics}, State) -> - with_proto_state(fun(ProtoState) -> - emqttd_protocol:handle({unsubscribe, Topics}, ProtoState) - end, State); - handle_cast(Msg, State) -> ?UNEXPECTED_MSG(Msg, State). -handle_info(timeout, State) -> - shutdown(idle_timeout, State); +handle_info({subscribe, TopicTable}, State) -> + with_proto( + fun(ProtoState) -> + emqttd_protocol:subscribe(TopicTable, ProtoState) + end, State); -%% fix issue #535 -handle_info({shutdown, Error}, State) -> - shutdown(Error, State); +handle_info({unsubscribe, Topics}, State) -> + with_proto( + fun(ProtoState) -> + emqttd_protocol:unsubscribe(Topics, ProtoState) + end, State); %% Asynchronous SUBACK handle_info({suback, PacketId, GrantedQos}, State) -> - with_proto_state(fun(ProtoState) -> - Packet = ?SUBACK_PACKET(PacketId, GrantedQos), - emqttd_protocol:send(Packet, ProtoState) - end, State); + with_proto( + fun(ProtoState) -> + Packet = ?SUBACK_PACKET(PacketId, GrantedQos), + emqttd_protocol:send(Packet, ProtoState) + end, State); handle_info({deliver, Message}, State) -> - with_proto_state(fun(ProtoState) -> - emqttd_protocol:send(Message, ProtoState) - end, State); + with_proto( + fun(ProtoState) -> + emqttd_protocol:send(Message, ProtoState) + end, State); handle_info({redeliver, {?PUBREL, PacketId}}, State) -> - with_proto_state(fun(ProtoState) -> - emqttd_protocol:redeliver({?PUBREL, PacketId}, ProtoState) - end, State); + with_proto( + fun(ProtoState) -> + emqttd_protocol:pubrel(PacketId, ProtoState) + end, State); + +handle_info(timeout, State) -> + shutdown(idle_timeout, State); + +handle_info({timeout, _Timer, emit_stats}, State) -> + hibernate(maybe_enable_stats(emit_stats(State))); + +%% Fix issue #535 +handle_info({shutdown, Error}, State) -> + shutdown(Error, State); handle_info({shutdown, conflict, {ClientId, NewPid}}, State) -> ?LOG(warning, "clientid '~s' conflict with ~p", [ClientId, NewPid], State), @@ -193,26 +225,26 @@ handle_info({inet_async, _Sock, _Ref, {error, Reason}}, State) -> shutdown(Reason, State); handle_info({inet_reply, _Sock, ok}, State) -> - hibernate(State); + {noreply, State}; handle_info({inet_reply, _Sock, {error, Reason}}, State) -> shutdown(Reason, State); -handle_info({keepalive, start, Interval}, State = #client_state{connection = Connection}) -> +handle_info({keepalive, start, Interval}, State = #client_state{connection = Conn}) -> ?LOG(debug, "Keepalive at the interval of ~p", [Interval], State), StatFun = fun() -> - case Connection:getstat([recv_oct]) of + case Conn:getstat([recv_oct]) of {ok, [{recv_oct, RecvOct}]} -> {ok, RecvOct}; {error, Error} -> {error, Error} end end, KeepAlive = emqttd_keepalive:start(StatFun, Interval, {keepalive, check}), - hibernate(State#client_state{keepalive = KeepAlive}); + {noreply, stats_by_keepalive(State#client_state{keepalive = KeepAlive})}; handle_info({keepalive, check}, State = #client_state{keepalive = KeepAlive}) -> case emqttd_keepalive:check(KeepAlive) of {ok, KeepAlive1} -> - hibernate(State#client_state{keepalive = KeepAlive1}); + hibernate(emit_stats(State#client_state{keepalive = KeepAlive1})); {error, timeout} -> ?LOG(debug, "Keepalive timeout", [], State), shutdown(keepalive_timeout, State); @@ -224,10 +256,10 @@ handle_info({keepalive, check}, State = #client_state{keepalive = KeepAlive}) -> handle_info(Info, State) -> ?UNEXPECTED_INFO(Info, State). -terminate(Reason, #client_state{connection = Connection, +terminate(Reason, #client_state{connection = Conn, keepalive = KeepAlive, proto_state = ProtoState}) -> - Connection:fast_close(), + Conn:fast_close(), emqttd_keepalive:cancel(KeepAlive), case {ProtoState, Reason} of {undefined, _} -> @@ -245,10 +277,6 @@ code_change(_OldVsn, State, _Extra) -> %% Internal functions %%-------------------------------------------------------------------- -with_proto_state(Fun, State = #client_state{proto_state = ProtoState}) -> - {ok, ProtoState1} = Fun(ProtoState), - hibernate(State#client_state{proto_state = ProtoState1}). - %% Receive and parse tcp data received(<<>>, State) -> hibernate(State); @@ -258,7 +286,7 @@ received(Bytes, State = #client_state{parser_fun = ParserFun, proto_state = ProtoState}) -> case catch ParserFun(Bytes) of {more, NewParser} -> - noreply(run_socket(State#client_state{parser_fun = NewParser})); + {noreply, run_socket(State#client_state{parser_fun = NewParser})}; {ok, Packet, Rest} -> emqttd_metrics:received(Packet), case emqttd_protocol:received(Packet, ProtoState) of @@ -289,7 +317,7 @@ rate_limit(Size, State = #client_state{rate_limit = Rl}) -> {0, Rl1} -> run_socket(State#client_state{conn_state = running, rate_limit = Rl1}); {Pause, Rl1} -> - ?LOG(error, "Rate limiter pause for ~p", [Pause], State), + ?LOG(warning, "Rate limiter pause for ~p", [Pause], State), erlang:send_after(Pause, self(), activate_sock), State#client_state{conn_state = blocked, rate_limit = Rl1} end. @@ -298,12 +326,36 @@ run_socket(State = #client_state{conn_state = blocked}) -> State; run_socket(State = #client_state{await_recv = true}) -> State; -run_socket(State = #client_state{connection = Connection}) -> - Connection:async_recv(0, infinity), +run_socket(State = #client_state{connection = Conn}) -> + Conn:async_recv(0, infinity), State#client_state{await_recv = true}. -noreply(State) -> - {noreply, State}. +with_proto(Fun, State = #client_state{proto_state = ProtoState}) -> + {ok, ProtoState1} = Fun(ProtoState), + {noreply, State#client_state{proto_state = ProtoState1}}. + +maybe_enable_stats(State = #client_state{enable_stats = false}) -> + State; +maybe_enable_stats(State = #client_state{enable_stats = keepalive}) -> + State; +maybe_enable_stats(State = #client_state{enable_stats = Interval}) -> + State#client_state{stats_timer = emqttd_misc:start_timer(Interval, self(), emit_stats)}. + +stats_by_keepalive(State) -> + State#client_state{enable_stats = keepalive}. + +emit_stats(State = #client_state{enable_stats = false}) -> + State; +emit_stats(State = #client_state{proto_state = ProtoState}) -> + {reply, Stats, _} = handle_call(stats, undefined, State), + emqttd_stats:set_client_stats(emqttd_protocol:clientid(ProtoState), Stats), + State. + +sock_stats(#client_state{connection = Conn}) -> + case Conn:getstat(?SOCK_STATS) of + {ok, Ss} -> Ss; + {error, _} -> [] + end. hibernate(State) -> {noreply, State, hibernate}. From 90ff296ebeac2d20400cae05da17317b36e128e5 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:25:10 +0800 Subject: [PATCH 15/34] Improve the module and support statistics --- src/emqttd_ws_client.erl | 176 +++++++++++++++++++++++++-------------- 1 file changed, 112 insertions(+), 64 deletions(-) diff --git a/src/emqttd_ws_client.erl b/src/emqttd_ws_client.erl index bd416fa27..3641a98a8 100644 --- a/src/emqttd_ws_client.erl +++ b/src/emqttd_ws_client.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -18,50 +18,64 @@ -behaviour(gen_server). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). %% API Exports --export([start_link/4, session/1, info/1, kick/1]). +-export([start_link/4]). + +%% Management and Monitor API +-export([info/1, stats/1, kick/1]). %% SUB/UNSUB Asynchronously -export([subscribe/2, unsubscribe/2]). +%% Get the session proc? +-export([session/1]). + %% gen_server Function Exports -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). %% WebSocket Client State --record(wsclient_state, {ws_pid, peer, connection, proto_state, keepalive}). +-record(wsclient_state, {ws_pid, peer, connection, proto_state, keepalive, + enable_stats, stats_timer}). + +-define(SOCK_STATS, [recv_oct, recv_cnt, send_oct, send_cnt, send_pend]). -define(WSLOG(Level, Peer, Format, Args), lager:Level("WsClient(~s): " ++ Format, [Peer | Args])). %% @doc Start WebSocket Client. -start_link(MqttEnv, WsPid, Req, ReplyChannel) -> - gen_server:start_link(?MODULE, [MqttEnv, WsPid, Req, ReplyChannel], []). - -session(CPid) -> - gen_server:call(CPid, session, infinity). +start_link(Env, WsPid, Req, ReplyChannel) -> + gen_server:start_link(?MODULE, [Env, WsPid, Req, ReplyChannel], []). info(CPid) -> - gen_server:call(CPid, info, infinity). + gen_server:call(CPid, info). + +stats(CPid) -> + gen_server:call(CPid, stats). kick(CPid) -> gen_server:call(CPid, kick). subscribe(CPid, TopicTable) -> - gen_server:cast(CPid, {subscribe, TopicTable}). + CPid ! {subscribe, TopicTable}. unsubscribe(CPid, Topics) -> - gen_server:cast(CPid, {unsubscribe, Topics}). + CPid ! {unsubscribe, Topics}. + +session(CPid) -> + gen_server:call(CPid, session). %%-------------------------------------------------------------------- %% gen_server Callbacks %%-------------------------------------------------------------------- -init([MqttEnv, WsPid, Req, ReplyChannel]) -> +init([Env, WsPid, Req, ReplyChannel]) -> process_flag(trap_exit, true), true = link(WsPid), {ok, Peername} = Req:get(peername), @@ -73,45 +87,41 @@ init([MqttEnv, WsPid, Req, ReplyChannel]) -> emqttd_metrics:inc('bytes/sent', iolist_size(Data)), ReplyChannel({binary, Data}) end, + EnableStats = proplists:get_value(client_enable_stats, Env, false), ProtoState = emqttd_protocol:init(Peername, SendFun, - [{ws_initial_headers, Headers} | MqttEnv]), - {ok, #wsclient_state{ws_pid = WsPid, peer = Req:get(peer), - connection = Req:get(connection), - proto_state = ProtoState}, idle_timeout(MqttEnv)}. + [{ws_initial_headers, Headers} | Env]), + {ok, maybe_enable_stats(#wsclient_state{ws_pid = WsPid, + peer = Req:get(peer), + connection = Req:get(connection), + proto_state = ProtoState, + enable_stats = EnableStats}), + proplists:get_value(client_idle_timeout, Env, 30000)}. -idle_timeout(MqttEnv) -> - timer:seconds(proplists:get_value(client_idle_timeout, MqttEnv, 10)). +handle_call(info, From, State = #wsclient_state{peer = Peer, proto_state = ProtoState}) -> + Info = [{websocket, true}, {peer, Peer} | emqttd_protocol:info(ProtoState)], + {reply, Stats, _} = handle_call(stats, From, State), + {reply, lists:append(Info, Stats), State}; -handle_call(session, _From, State = #wsclient_state{proto_state = ProtoState}) -> - {reply, emqttd_protocol:session(ProtoState), State}; - -handle_call(info, _From, State = #wsclient_state{peer = Peer, - proto_state = ProtoState}) -> - ProtoInfo = emqttd_protocol:info(ProtoState), - {reply, [{websocket, true}, {peer, Peer}| ProtoInfo], State}; +handle_call(stats, _From, State = #wsclient_state{proto_state = ProtoState}) -> + {reply, lists:append([emqttd_misc:proc_stats(), + wsock_stats(State), + emqttd_protocol:stats(ProtoState)]), State}; handle_call(kick, _From, State) -> {stop, {shutdown, kick}, ok, State}; +handle_call(session, _From, State = #wsclient_state{proto_state = ProtoState}) -> + {reply, emqttd_protocol:session(ProtoState), State}; + handle_call(Req, _From, State = #wsclient_state{peer = Peer}) -> - ?WSLOG(critical, Peer, "Unexpected request: ~p", [Req]), + ?WSLOG(error, Peer, "Unexpected request: ~p", [Req]), {reply, {error, unsupported_request}, State}. -handle_cast({subscribe, TopicTable}, State) -> - with_proto_state(fun(ProtoState) -> - emqttd_protocol:handle({subscribe, TopicTable}, ProtoState) - end, State); - -handle_cast({unsubscribe, Topics}, State) -> - with_proto_state(fun(ProtoState) -> - emqttd_protocol:handle({unsubscribe, Topics}, ProtoState) - end, State); - handle_cast({received, Packet}, State = #wsclient_state{peer = Peer, proto_state = ProtoState}) -> emqttd_metrics:received(Packet), case emqttd_protocol:received(Packet, ProtoState) of {ok, ProtoState1} -> - noreply(State#wsclient_state{proto_state = ProtoState1}); + {noreply, State#wsclient_state{proto_state = ProtoState1}, hibernate}; {error, Error} -> ?WSLOG(error, Peer, "Protocol error - ~p", [Error]), shutdown(Error, State); @@ -122,28 +132,46 @@ handle_cast({received, Packet}, State = #wsclient_state{peer = Peer, proto_state end; handle_cast(Msg, State = #wsclient_state{peer = Peer}) -> - ?WSLOG(critical, Peer, "Unexpected msg: ~p", [Msg]), - noreply(State). + ?WSLOG(error, Peer, "Unexpected msg: ~p", [Msg]), + {noreply, State}. + +handle_info({subscribe, TopicTable}, State) -> + with_proto( + fun(ProtoState) -> + emqttd_protocol:subscribe(TopicTable, ProtoState) + end, State); + +handle_info({unsubscribe, Topics}, State) -> + with_proto( + fun(ProtoState) -> + emqttd_protocol:unsubscribe(Topics, ProtoState) + end, State); + +handle_info({suback, PacketId, GrantedQos}, State) -> + with_proto( + fun(ProtoState) -> + Packet = ?SUBACK_PACKET(PacketId, GrantedQos), + emqttd_protocol:send(Packet, ProtoState) + end, State); + +handle_info({deliver, Message}, State) -> + with_proto( + fun(ProtoState) -> + emqttd_protocol:send(Message, ProtoState) + end, State); + +handle_info({redeliver, {?PUBREL, PacketId}}, State) -> + with_proto( + fun(ProtoState) -> + emqttd_protocol:pubrel(PacketId, ProtoState) + end, State); + +handle_info({timeout, _Timer, emit_stats}, State) -> + {noreply, maybe_enable_stats(emit_stats(State)), hibernate}; handle_info(timeout, State) -> shutdown(idle_timeout, State); -handle_info({suback, PacketId, GrantedQos}, State) -> - with_proto_state(fun(ProtoState) -> - Packet = ?SUBACK_PACKET(PacketId, GrantedQos), - emqttd_protocol:send(Packet, ProtoState) - end, State); - -handle_info({deliver, Message}, State) -> - with_proto_state(fun(ProtoState) -> - emqttd_protocol:send(Message, ProtoState) - end, State); - -handle_info({redeliver, {?PUBREL, PacketId}}, State) -> - with_proto_state(fun(ProtoState) -> - emqttd_protocol:redeliver({?PUBREL, PacketId}, ProtoState) - end, State); - handle_info({shutdown, conflict, {ClientId, NewPid}}, State = #wsclient_state{peer = Peer}) -> ?WSLOG(warning, Peer, "clientid '~s' conflict with ~p", [ClientId, NewPid]), shutdown(conflict, State); @@ -157,13 +185,13 @@ handle_info({keepalive, start, Interval}, State = #wsclient_state{peer = Peer, c end end, KeepAlive = emqttd_keepalive:start(StatFun, Interval, {keepalive, check}), - noreply(State#wsclient_state{keepalive = KeepAlive}); + {noreply, stats_by_keepalive(State#wsclient_state{keepalive = KeepAlive})}; handle_info({keepalive, check}, State = #wsclient_state{peer = Peer, keepalive = KeepAlive}) -> case emqttd_keepalive:check(KeepAlive) of {ok, KeepAlive1} -> - noreply(State#wsclient_state{keepalive = KeepAlive1}); + {noreply, emit_stats(State#wsclient_state{keepalive = KeepAlive1}), hibernate}; {error, timeout} -> ?WSLOG(debug, Peer, "Keepalive Timeout!", []), shutdown(keepalive_timeout, State); @@ -180,8 +208,8 @@ handle_info({'EXIT', WsPid, Reason}, State = #wsclient_state{peer = Peer, ws_pid shutdown(Reason, State); handle_info(Info, State = #wsclient_state{peer = Peer}) -> - ?WSLOG(critical, Peer, "Unexpected Info: ~p", [Info]), - noreply(State). + ?WSLOG(error, Peer, "Unexpected Info: ~p", [Info]), + {noreply, State}. terminate(Reason, #wsclient_state{proto_state = ProtoState, keepalive = KeepAlive}) -> emqttd_keepalive:cancel(KeepAlive), @@ -199,12 +227,32 @@ code_change(_OldVsn, State, _Extra) -> %% Internal functions %%-------------------------------------------------------------------- -with_proto_state(Fun, State = #wsclient_state{proto_state = ProtoState}) -> - {ok, ProtoState1} = Fun(ProtoState), - noreply(State#wsclient_state{proto_state = ProtoState1}). +maybe_enable_stats(State = #wsclient_state{enable_stats = false}) -> + State; +maybe_enable_stats(State = #wsclient_state{enable_stats = keepalive}) -> + State; +maybe_enable_stats(State = #wsclient_state{enable_stats = Interval}) -> + State#wsclient_state{stats_timer = emqttd_misc:start_timer(Interval, self(), emit_stats)}. -noreply(State) -> - {noreply, State, hibernate}. +stats_by_keepalive(State) -> + State#wsclient_state{enable_stats = keepalive}. + +emit_stats(State = #wsclient_state{enable_stats = false}) -> + State; +emit_stats(State = #wsclient_state{proto_state = ProtoState}) -> + {reply, Stats, _} = handle_call(stats, undefined, State), + emqttd_stats:set_client_stats(emqttd_protocol:clientid(ProtoState), Stats), + State. + +wsock_stats(#wsclient_state{connection = Conn}) -> + case Conn:getstat(?SOCK_STATS) of + {ok, Ss} -> Ss; + {error, _} -> [] + end. + +with_proto(Fun, State = #wsclient_state{proto_state = ProtoState}) -> + {ok, ProtoState1} = Fun(ProtoState), + {noreply, State#wsclient_state{proto_state = ProtoState1}}. shutdown(Reason, State) -> stop({shutdown, Reason}, State). From a54076cf0aa9cca094d27e3505d29bdc73011165 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:25:44 +0800 Subject: [PATCH 16/34] Change the 'Env' --- src/emqttd_ws_client_sup.erl | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/emqttd_ws_client_sup.erl b/src/emqttd_ws_client_sup.erl index d01055115..60e1461b7 100644 --- a/src/emqttd_ws_client_sup.erl +++ b/src/emqttd_ws_client_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -37,8 +37,9 @@ start_client(WsPid, Req, ReplyChannel) -> %%-------------------------------------------------------------------- %% Supervisor callbacks %%-------------------------------------------------------------------- + init([]) -> - {ok, Env} = emqttd:env(protocol), + Env = lists:append(emqttd:env(client), emqttd:env(protocol)), {ok, {{simple_one_for_one, 0, 1}, [{ws_client, {emqttd_ws_client, start_link, [Env]}, temporary, 5000, worker, [emqttd_ws_client]}]}}. From 5a49196a07941f99cffc645ae05036fe94c6babd Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:28:35 +0800 Subject: [PATCH 17/34] Update copyright info and format code --- src/emqttd_cm_sup.erl | 5 ++++- src/emqttd_parser.erl | 12 +++++++----- src/emqttd_plugins.erl | 4 +++- src/emqttd_pmon.erl | 11 +++++++---- src/emqttd_sm_sup.erl | 5 ++++- src/emqttd_ws.erl | 4 +++- 6 files changed, 28 insertions(+), 13 deletions(-) diff --git a/src/emqttd_cm_sup.erl b/src/emqttd_cm_sup.erl index dfa623cc3..fc01ea649 100644 --- a/src/emqttd_cm_sup.erl +++ b/src/emqttd_cm_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -15,10 +15,13 @@ %%-------------------------------------------------------------------- %% @doc Client Manager Supervisor. + -module(emqttd_cm_sup). -behaviour(supervisor). +-author("Feng Lee "). + -include("emqttd.hrl"). %% API diff --git a/src/emqttd_parser.erl b/src/emqttd_parser.erl index d6c09c42e..669f4aab2 100644 --- a/src/emqttd_parser.erl +++ b/src/emqttd_parser.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -17,6 +17,8 @@ %% @doc MQTT Packet Parser -module(emqttd_parser). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). @@ -26,9 +28,9 @@ -record(mqtt_packet_limit, {max_packet_size}). --type option() :: {atom(), any()}. +-type(option() :: {atom(), any()}). --type parser() :: fun( (binary()) -> any() ). +-type(parser() :: fun( (binary()) -> any() )). %% @doc Initialize a parser -spec(new(Opts :: [option()]) -> parser()). @@ -86,7 +88,7 @@ parse_frame(Bin, #mqtt_packet_header{type = Type, qos = Qos} = Header, Length) WillRetain : 1, WillQos : 2, WillFlag : 1, - CleanSession : 1, + CleanSess : 1, _Reserved : 1, KeepAlive : 16/big, Rest3/binary>> = Rest2, @@ -104,7 +106,7 @@ parse_frame(Bin, #mqtt_packet_header{type = Type, qos = Qos} = Header, Length) will_retain = bool(WillRetain), will_qos = WillQos, will_flag = bool(WillFlag), - clean_sess = bool(CleanSession), + clean_sess = bool(CleanSess), keep_alive = KeepAlive, client_id = ClientId, will_topic = WillTopic, diff --git a/src/emqttd_plugins.erl b/src/emqttd_plugins.erl index 78b543440..f126f631c 100644 --- a/src/emqttd_plugins.erl +++ b/src/emqttd_plugins.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_plugins). +-author("Feng Lee "). + -include("emqttd.hrl"). -export([init/0]). diff --git a/src/emqttd_pmon.erl b/src/emqttd_pmon.erl index e5f286eea..ebe691ad4 100644 --- a/src/emqttd_pmon.erl +++ b/src/emqttd_pmon.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2016-2017 Feng Lee . All Rights Reserved. +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -18,11 +18,14 @@ -author("Feng Lee "). --type(pmon() :: {?MODULE, map()}). - -export([new/0, monitor/2, demonitor/2, erase/2]). -new() -> {?MODULE, [maps:new()]}. +-type(pmon() :: {?MODULE, map()}). + +-export_type([pmon/0]). + +new() -> + {?MODULE, [maps:new()]}. -spec(monitor(pid(), pmon()) -> pmon()). monitor(Pid, PM = {?MODULE, [M]}) -> diff --git a/src/emqttd_sm_sup.erl b/src/emqttd_sm_sup.erl index c43f89f80..efabadb96 100644 --- a/src/emqttd_sm_sup.erl +++ b/src/emqttd_sm_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -15,10 +15,13 @@ %%-------------------------------------------------------------------- %% @doc Session Manager Supervisor. + -module(emqttd_sm_sup). -behaviour(supervisor). +-author("Feng Lee "). + -include("emqttd.hrl"). -define(SM, emqttd_sm). diff --git a/src/emqttd_ws.erl b/src/emqttd_ws.erl index a5b3b344f..8c483344e 100644 --- a/src/emqttd_ws.erl +++ b/src/emqttd_ws.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_ws). +-author("Feng Lee "). + -export([handle_request/1, ws_loop/3]). %% WebSocket Loop State From 20216670216399accd330e9296176ff16d2304ad Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:29:55 +0800 Subject: [PATCH 18/34] Add 'local_session/0 function, change reg_session/3 unreg_session/1 functions --- src/emqttd_sm.erl | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/src/emqttd_sm.erl b/src/emqttd_sm.erl index 704242b2d..02dfdb879 100644 --- a/src/emqttd_sm.erl +++ b/src/emqttd_sm.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,9 +14,10 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% @doc Session Manager -module(emqttd_sm). +-author("Feng Lee "). + -behaviour(gen_server2). -include("emqttd.hrl"). @@ -32,10 +33,12 @@ %% API Function Exports -export([start_link/2]). --export([start_session/2, lookup_session/1, reg_session/3, unreg_session/1]). +-export([start_session/2, lookup_session/1, register_session/3, unregister_session/1]). -export([dispatch/3]). +-export([local_sessions/0]). + %% gen_server Function Exports -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). @@ -91,13 +94,13 @@ lookup_session(ClientId) -> end. %% @doc Register a session with info. --spec(reg_session(binary(), boolean(), [tuple()]) -> true). -reg_session(ClientId, CleanSess, Properties) -> +-spec(register_session(binary(), boolean(), [tuple()]) -> true). +register_session(ClientId, CleanSess, Properties) -> ets:insert(mqtt_local_session, {ClientId, self(), CleanSess, Properties}). %% @doc Unregister a session. --spec(unreg_session(binary()) -> true). -unreg_session(ClientId) -> +-spec(unregister_session(binary()) -> true). +unregister_session(ClientId) -> ets:delete(mqtt_local_session, ClientId). dispatch(ClientId, Topic, Msg) -> @@ -110,8 +113,12 @@ dispatch(ClientId, Topic, Msg) -> call(SM, Req) -> gen_server2:call(SM, Req, ?TIMEOUT). %%infinity). +%% @doc for debug. +local_sessions() -> + ets:tab2list(mqtt_local_session). + %%-------------------------------------------------------------------- -%% gen_server callbacks +%% gen_server Callbacks %%-------------------------------------------------------------------- init([Pool, Id]) -> @@ -171,6 +178,7 @@ handle_info({'DOWN', MRef, process, DownPid, _Reason}, State) -> [] -> ok; [Sess = #mqtt_session{sess_pid = DownPid}] -> + emqttd_stats:del_session_stats(ClientId), mnesia:delete_object(mqtt_session, Sess, write); [_Sess] -> ok @@ -208,7 +216,7 @@ create_session({CleanSess, {ClientId, Username}, ClientPid}, State) -> create_session(CleanSess, {ClientId, Username}, ClientPid) -> case emqttd_session_sup:start_session(CleanSess, {ClientId, Username}, ClientPid) of {ok, SessPid} -> - Session = #mqtt_session{client_id = ClientId, sess_pid = SessPid, persistent = not CleanSess}, + Session = #mqtt_session{client_id = ClientId, sess_pid = SessPid, clean_sess = CleanSess}, case insert_session(Session) of {aborted, {conflict, ConflictPid}} -> %% Conflict with othe node? From 6b22fb0a0c71ae0386e964715e8f606c2d2baa4c Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:30:43 +0800 Subject: [PATCH 19/34] Remove the 'DOWN' client from emqttd_stats --- src/emqttd_cm.erl | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/emqttd_cm.erl b/src/emqttd_cm.erl index 6b40a480f..2e57ebe5b 100644 --- a/src/emqttd_cm.erl +++ b/src/emqttd_cm.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -15,10 +15,13 @@ %%-------------------------------------------------------------------- %% @doc MQTT Client Manager + -module(emqttd_cm). -behaviour(gen_server2). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_internal.hrl"). @@ -120,6 +123,7 @@ handle_info({'DOWN', MRef, process, DownPid, _Reason}, State) -> {ok, {ClientId, DownPid}} -> case lookup_proc(ClientId) of DownPid -> + emqttd_stats:del_client_stats(ClientId), ets:delete(mqtt_client, ClientId); _ -> ignore From a5ac32b49b1b60a76425b708d51104362587567f Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:31:46 +0800 Subject: [PATCH 20/34] add 'packets/puback/missed', 'packets/pubrec/missed', 'packets/pubrel/missed', 'packets/pubcomp/missed' metrics --- src/emqttd_metrics.erl | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/src/emqttd_metrics.erl b/src/emqttd_metrics.erl index 6f7a53f5a..2c0e42ea0 100644 --- a/src/emqttd_metrics.erl +++ b/src/emqttd_metrics.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,11 +14,12 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% @doc emqttd metrics. responsible for collecting broker metrics. -module(emqttd_metrics). -behaviour(gen_server). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). @@ -37,7 +38,7 @@ -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). --record(state, {tick_tref}). +-record(state, {tick}). -define(METRIC_TAB, mqtt_metric). @@ -57,12 +58,16 @@ {counter, 'packets/publish/sent'}, % PUBLISH packets sent {counter, 'packets/puback/received'}, % PUBACK packets received {counter, 'packets/puback/sent'}, % PUBACK packets sent + {counter, 'packets/puback/missed'}, % PUBACK packets missed {counter, 'packets/pubrec/received'}, % PUBREC packets received {counter, 'packets/pubrec/sent'}, % PUBREC packets sent + {counter, 'packets/pubrec/missed'}, % PUBREC packets missed {counter, 'packets/pubrel/received'}, % PUBREL packets received {counter, 'packets/pubrel/sent'}, % PUBREL packets sent + {counter, 'packets/pubrel/missed'}, % PUBREL packets missed {counter, 'packets/pubcomp/received'}, % PUBCOMP packets received {counter, 'packets/pubcomp/sent'}, % PUBCOMP packets sent + {counter, 'packets/pubcomp/missed'}, % PUBCOMP packets missed {counter, 'packets/subscribe'}, % SUBSCRIBE Packets received {counter, 'packets/suback'}, % SUBACK packets sent {counter, 'packets/unsubscribe'}, % UNSUBSCRIBE Packets received @@ -74,14 +79,15 @@ %% Messages sent and received of broker -define(SYSTOP_MESSAGES, [ - {counter, 'messages/received'}, % Messages received - {counter, 'messages/sent'}, % Messages sent - {counter, 'messages/qos0/received'}, % Messages received - {counter, 'messages/qos0/sent'}, % Messages sent - {counter, 'messages/qos1/received'}, % Messages received - {counter, 'messages/qos1/sent'}, % Messages sent - {counter, 'messages/qos2/received'}, % Messages received - {counter, 'messages/qos2/sent'}, % Messages sent + {counter, 'messages/received'}, % All Messages received + {counter, 'messages/sent'}, % All Messages sent + {counter, 'messages/qos0/received'}, % QoS0 Messages received + {counter, 'messages/qos0/sent'}, % QoS0 Messages sent + {counter, 'messages/qos1/received'}, % QoS1 Messages received + {counter, 'messages/qos1/sent'}, % QoS1 Messages sent + {counter, 'messages/qos2/received'}, % QoS2 Messages received + {counter, 'messages/qos2/sent'}, % QoS2 Messages sent + {counter, 'messages/qos2/dropped'}, % QoS2 Messages dropped {gauge, 'messages/retained'}, % Messagea retained {counter, 'messages/dropped'} % Messages dropped ]). @@ -138,7 +144,7 @@ qos_received(?QOS_2) -> sent(?PUBLISH_PACKET(_Qos, <<"$SYS/", _/binary>>, _, _)) -> ignore; sent(Packet) -> - emqttd_metrics:inc('packets/sent'), + inc('packets/sent'), sent1(Packet). sent1(?PUBLISH_PACKET(Qos, _PktId)) -> inc('packets/publish/sent'), @@ -245,7 +251,7 @@ init([]) -> % $SYS Topics for metrics % [ok = emqttd:create(topic, metric_topic(Topic)) || {_, Topic} <- Metrics], % Tick to publish metrics - {ok, #state{tick_tref = emqttd_broker:start_tick(tick)}, hibernate}. + {ok, #state{tick = emqttd_broker:start_tick(tick)}, hibernate}. handle_call(_Req, _From, State) -> {reply, error, State}. @@ -261,7 +267,7 @@ handle_info(tick, State) -> handle_info(_Info, State) -> {noreply, State}. -terminate(_Reason, #state{tick_tref = TRef}) -> +terminate(_Reason, #state{tick = TRef}) -> emqttd_broker:stop_tick(TRef). code_change(_OldVsn, State, _Extra) -> From 67566ca372df6a06dac09cdb673382dbe4a65ab0 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:32:24 +0800 Subject: [PATCH 21/34] Add dropped/1 function --- src/emqttd_mqueue.erl | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/src/emqttd_mqueue.erl b/src/emqttd_mqueue.erl index 53f37206f..9abcc6843 100644 --- a/src/emqttd_mqueue.erl +++ b/src/emqttd_mqueue.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -43,35 +43,33 @@ -module(emqttd_mqueue). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). -import(proplists, [get_value/3]). --export([new/3, type/1, name/1, is_empty/1, len/1, max_len/1, in/2, out/1, stats/1]). +-export([new/3, type/1, name/1, is_empty/1, len/1, max_len/1, in/2, out/1, + dropped/1, stats/1]). -define(LOW_WM, 0.2). -define(HIGH_WM, 0.6). --type priority() :: {iolist(), pos_integer()}. +-type(priority() :: {iolist(), pos_integer()}). --type option() :: {type, simple | priority} +-type(option() :: {type, simple | priority} | {max_length, pos_integer() | infinity} | {priority, list(priority())} - | {low_watermark, float()} %% Low watermark - | {high_watermark, float()} %% High watermark - | {queue_qos0, boolean()}. %% Queue Qos0? + | {low_watermark, float()} %% Low watermark + | {high_watermark, float()} %% High watermark + | {queue_qos0, boolean()}). %% Queue Qos0? --type mqueue_option() :: {max_length, pos_integer()} %% Max queue length - | {low_watermark, float()} %% Low watermark - | {high_watermark, float()} %% High watermark - | {queue_qos0, boolean()}. %% Queue Qos0 - --type stat() :: {max_len, infinity | pos_integer()} +-type(stat() :: {max_len, infinity | pos_integer()} | {len, non_neg_integer()} - | {dropped, non_neg_integer()}. + | {dropped, non_neg_integer()}). -record(mqueue, {type :: simple | priority, name, q :: queue:queue() | priority_queue:q(), @@ -83,12 +81,12 @@ qos0 = false, dropped = 0, alarm_fun}). --type mqueue() :: #mqueue{}. +-type(mqueue() :: #mqueue{}). -export_type([mqueue/0, priority/0, option/0]). %% @doc New Queue. --spec(new(iolist(), list(mqueue_option()), fun()) -> mqueue()). +-spec(new(iolist(), list(option()), fun()) -> mqueue()). new(Name, Opts, AlarmFun) -> Type = get_value(type, Opts, simple), MaxLen = get_value(max_length, Opts, infinity), @@ -141,6 +139,10 @@ len(#mqueue{type = priority, q = Q}) -> priority_queue:len(Q). max_len(#mqueue{max_len= MaxLen}) -> MaxLen. +%% @doc Dropped of the mqueue +-spec(dropped(mqueue()) -> non_neg_integer()). +dropped(#mqueue{dropped = Dropped}) -> Dropped. + %% @doc Stats of the mqueue -spec(stats(mqueue()) -> [stat()]). stats(#mqueue{type = Type, q = Q, max_len = MaxLen, len = Len, dropped = Dropped}) -> @@ -208,14 +210,12 @@ maybe_set_alarm(MQ = #mqueue{name = Name, len = Len, high_wm = HighWM, alarm_fun title = io_lib:format("Queue ~s high-water mark", [Name]), summary = io_lib:format("queue len ~p > high_watermark ~p", [Len, HighWM])}, MQ#mqueue{alarm_fun = AlarmFun(alert, Alarm)}; - maybe_set_alarm(MQ) -> MQ. maybe_clear_alarm(MQ = #mqueue{name = Name, len = Len, low_wm = LowWM, alarm_fun = AlarmFun}) when Len < LowWM -> MQ#mqueue{alarm_fun = AlarmFun(clear, list_to_binary(["queue_high_watermark.", Name]))}; - maybe_clear_alarm(MQ) -> MQ. From bbbfafb759e1bcf36e419e482ac8422e5b4ed629 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:33:27 +0800 Subject: [PATCH 22/34] Update protocol_name/1, type_name/1 functions for MQTT 5 --- src/emqttd_protocol.erl | 84 +++++++++++++++++++++++++---------------- 1 file changed, 52 insertions(+), 32 deletions(-) diff --git a/src/emqttd_protocol.erl b/src/emqttd_protocol.erl index f0b877dc5..a9cc37778 100644 --- a/src/emqttd_protocol.erl +++ b/src/emqttd_protocol.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,6 +16,8 @@ -module(emqttd_protocol). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). @@ -25,9 +27,11 @@ -import(proplists, [get_value/2, get_value/3]). %% API --export([init/3, info/1, clientid/1, client/1, session/1]). +-export([init/3, info/1, stats/1, clientid/1, client/1, session/1]). --export([received/2, handle/2, send/2, redeliver/2, shutdown/2]). +-export([subscribe/2, unsubscribe/2, pubrel/2, shutdown/2]). + +-export([received/2, send/2]). -export([process/2]). @@ -39,17 +43,20 @@ session, ws_initial_headers, %% Headers from first HTTP request for websocket client connected_at}). --type proto_state() :: #proto_state{}. +-type(proto_state() :: #proto_state{}). -define(INFO_KEYS, [client_id, username, clean_sess, proto_ver, proto_name, keepalive, will_msg, ws_initial_headers, connected_at]). +-define(STATS_KEYS, [recv_pkt, recv_msg, send_pkt, send_msg]). + -define(LOG(Level, Format, Args, State), lager:Level([{client, State#proto_state.client_id}], "Client(~s@~s): " ++ Format, [State#proto_state.client_id, esockd_net:format(State#proto_state.peername) | Args])). %% @doc Init protocol init(Peername, SendFun, Opts) -> + lists:foreach(fun(K) -> put(K, 0) end, ?STATS_KEYS), MaxLen = get_value(max_clientid_len, Opts, ?MAX_CLIENTID_LEN), WsInitialHeaders = get_value(ws_initial_headers, Opts), #proto_state{peername = Peername, @@ -61,6 +68,9 @@ init(Peername, SendFun, Opts) -> info(ProtoState) -> ?record_to_proplist(proto_state, ProtoState, ?INFO_KEYS). +stats(_ProtoState) -> + [{K, get(K)} || K <- ?STATS_KEYS]. + clientid(#proto_state{client_id = ClientId}) -> ClientId. @@ -115,22 +125,22 @@ received(Packet = ?PACKET(_Type), State) -> {error, Reason, State} end. -handle({subscribe, RawTopicTable}, ProtoState = #proto_state{client_id = ClientId, - username = Username, - session = Session}) -> +subscribe(RawTopicTable, ProtoState = #proto_state{client_id = ClientId, + username = Username, + session = Session}) -> TopicTable = parse_topic_table(RawTopicTable), - case emqttd:run_hooks('client.subscribe', [ClientId, Username], TopicTable) of + case emqttd_hooks:run('client.subscribe', [ClientId, Username], TopicTable) of {ok, TopicTable1} -> emqttd_session:subscribe(Session, TopicTable1); {stop, _} -> ok end, - {ok, ProtoState}; + {ok, ProtoState}. -handle({unsubscribe, RawTopics}, ProtoState = #proto_state{client_id = ClientId, - username = Username, - session = Session}) -> - case emqttd:run_hooks('client.unsubscribe', [ClientId, Username], parse_topics(RawTopics)) of +unsubscribe(RawTopics, ProtoState = #proto_state{client_id = ClientId, + username = Username, + session = Session}) -> + case emqttd_hooks:run('client.unsubscribe', [ClientId, Username], parse_topics(RawTopics)) of {ok, TopicTable} -> emqttd_session:unsubscribe(Session, TopicTable); {stop, _} -> @@ -138,6 +148,9 @@ handle({unsubscribe, RawTopics}, ProtoState = #proto_state{client_id = ClientId, end, {ok, ProtoState}. +%% @doc Send PUBREL +pubrel(PacketId, State) -> send(?PUBREL_PACKET(PacketId), State). + process(Packet = ?CONNECT_PACKET(Var), State0) -> #mqtt_packet_connect{proto_ver = ProtoVer, @@ -187,7 +200,7 @@ process(Packet = ?CONNECT_PACKET(Var), State0) -> {ReturnCode, false, State1} end, %% Run hooks - emqttd:run_hooks('client.connected', [ReturnCode1], client(State3)), + emqttd_hooks:run('client.connected', [ReturnCode1], client(State3)), %% Send connack send(?CONNACK_PACKET(ReturnCode1, sp(SessPresent)), State3), %% stop if authentication failure @@ -220,8 +233,11 @@ process(?SUBSCRIBE_PACKET(PacketId, []), State) -> send(?SUBACK_PACKET(PacketId, []), State); %% TODO: refactor later... -process(?SUBSCRIBE_PACKET(PacketId, RawTopicTable), State = #proto_state{session = Session, - client_id = ClientId, username = Username, is_superuser = IsSuperuser}) -> +process(?SUBSCRIBE_PACKET(PacketId, RawTopicTable), + State = #proto_state{session = Session, + client_id = ClientId, + username = Username, + is_superuser = IsSuperuser}) -> Client = client(State), TopicTable = parse_topic_table(RawTopicTable), AllowDenies = if IsSuperuser -> []; @@ -232,7 +248,7 @@ process(?SUBSCRIBE_PACKET(PacketId, RawTopicTable), State = #proto_state{session ?LOG(error, "Cannot SUBSCRIBE ~p for ACL Deny", [TopicTable], State), send(?SUBACK_PACKET(PacketId, [16#80 || _ <- TopicTable]), State); false -> - case emqttd:run_hooks('client.subscribe', [ClientId, Username], TopicTable) of + case emqttd_hooks:run('client.subscribe', [ClientId, Username], TopicTable) of {ok, TopicTable1} -> emqttd_session:subscribe(Session, PacketId, TopicTable1), {ok, State}; {stop, _} -> @@ -244,9 +260,11 @@ process(?SUBSCRIBE_PACKET(PacketId, RawTopicTable), State = #proto_state{session process(?UNSUBSCRIBE_PACKET(PacketId, []), State) -> send(?UNSUBACK_PACKET(PacketId), State); -process(?UNSUBSCRIBE_PACKET(PacketId, RawTopics), State = #proto_state{ - client_id = ClientId, username = Username, session = Session}) -> - case emqttd:run_hooks('client.unsubscribe', [ClientId, Username], parse_topics(RawTopics)) of +process(?UNSUBSCRIBE_PACKET(PacketId, RawTopics), + State = #proto_state{client_id = ClientId, + username = Username, + session = Session}) -> + case emqttd_hooks:run('client.unsubscribe', [ClientId, Username], parse_topics(RawTopics)) of {ok, TopicTable} -> emqttd_session:unsubscribe(Session, TopicTable); {stop, _} -> @@ -262,7 +280,9 @@ process(?PACKET(?DISCONNECT), State) -> {stop, normal, State#proto_state{will_msg = undefined}}. publish(Packet = ?PUBLISH_PACKET(?QOS_0, _PacketId), - #proto_state{client_id = ClientId, username = Username, session = Session}) -> + #proto_state{client_id = ClientId, + username = Username, + session = Session}) -> Msg = emqttd_message:from_packet(Username, ClientId, Packet), emqttd_session:publish(Session, Msg); @@ -287,7 +307,7 @@ with_puback(Type, Packet = ?PUBLISH_PACKET(_Qos, PacketId), -spec(send(mqtt_message() | mqtt_packet(), proto_state()) -> {ok, proto_state()}). send(Msg, State = #proto_state{client_id = ClientId, username = Username}) when is_record(Msg, mqtt_message) -> - emqttd:run_hooks('message.delivered', [ClientId, Username], Msg), + emqttd_hooks:run('message.delivered', [ClientId, Username], Msg), send(emqttd_message:to_packet(Msg), State); send(Packet, State = #proto_state{sendfun = SendFun}) @@ -297,15 +317,15 @@ send(Packet, State = #proto_state{sendfun = SendFun}) SendFun(Packet), {ok, State}. -trace(recv, Packet, ProtoState) -> +trace(recv, Packet = ?PACKET(Type), ProtoState) -> + inc(recv_pkt), ?IF(Type =:= ?PUBLISH, inc(recv_msg), ok), ?LOG(info, "RECV ~s", [emqttd_packet:format(Packet)], ProtoState); -trace(send, Packet, ProtoState) -> +trace(send, Packet = ?PACKET(Type), ProtoState) -> + inc(send_pkt), ?IF(Type =:= ?PUBLISH, inc(send_msg), ok), ?LOG(info, "SEND ~s", [emqttd_packet:format(Packet)], ProtoState). -%% @doc redeliver PUBREL PacketId -redeliver({?PUBREL, PacketId}, State) -> - send(?PUBREL_PACKET(PacketId), State). +inc(Key) -> put(Key, get(Key) + 1). stop_if_auth_failure(RC, State) when RC == ?CONNACK_CREDENTIALS; RC == ?CONNACK_AUTH -> {stop, {shutdown, auth_failure}, State}; @@ -325,7 +345,7 @@ shutdown(Error, State = #proto_state{will_msg = WillMsg}) -> ?LOG(info, "Shutdown for ~p", [Error], State), Client = client(State), send_willmsg(Client, WillMsg), - emqttd:run_hooks('client.disconnected', [Error], Client), + emqttd_hooks:run('client.disconnected', [Error], Client), %% let it down %% emqttd_cm:unreg(ClientId). ok. @@ -375,19 +395,19 @@ validate_protocol(#mqtt_packet_connect{proto_ver = Ver, proto_name = Name}) -> validate_clientid(#mqtt_packet_connect{client_id = ClientId}, #proto_state{max_clientid_len = MaxLen}) - when (size(ClientId) >= 1) andalso (size(ClientId) =< MaxLen) -> + when (byte_size(ClientId) >= 1) andalso (byte_size(ClientId) =< MaxLen) -> true; %% Issue#599: Null clientId and clean_sess = false validate_clientid(#mqtt_packet_connect{client_id = ClientId, clean_sess = CleanSess}, _ProtoState) - when size(ClientId) == 0 andalso (not CleanSess) -> + when byte_size(ClientId) == 0 andalso (not CleanSess) -> false; %% MQTT3.1.1 allow null clientId. -validate_clientid(#mqtt_packet_connect{proto_ver =?MQTT_PROTO_V311, +validate_clientid(#mqtt_packet_connect{proto_ver =?MQTT_PROTO_V4, client_id = ClientId}, _ProtoState) - when size(ClientId) =:= 0 -> + when byte_size(ClientId) =:= 0 -> true; validate_clientid(#mqtt_packet_connect{proto_ver = ProtoVer, From d5ac9f0dcbb4e7b4a5da5f6234be1901897cc244 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:33:50 +0800 Subject: [PATCH 23/34] Update protocol_name/1, type_name/1 functions for MQTT 5 --- src/emqttd_packet.erl | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/src/emqttd_packet.erl b/src/emqttd_packet.erl index 38de31fe0..6349e58b1 100644 --- a/src/emqttd_packet.erl +++ b/src/emqttd_packet.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,9 +14,10 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% @doc MQTT Packet Functions -module(emqttd_packet). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). @@ -28,12 +29,13 @@ %% @doc Protocol name of version -spec(protocol_name(mqtt_vsn()) -> binary()). -protocol_name(Ver) when Ver =:= ?MQTT_PROTO_V31; Ver =:= ?MQTT_PROTO_V311 -> - proplists:get_value(Ver, ?PROTOCOL_NAMES). +protocol_name(?MQTT_PROTO_V3) -> <<"MQIsdp">>; +protocol_name(?MQTT_PROTO_V4) -> <<"MQTT">>; +protocol_name(?MQTT_PROTO_V5) -> <<"MQTT">>. %% @doc Name of MQTT packet type -spec(type_name(mqtt_packet_type()) -> atom()). -type_name(Type) when Type > ?RESERVED andalso Type =< ?DISCONNECT -> +type_name(Type) when Type > ?RESERVED andalso Type =< ?AUTH -> lists:nth(Type, ?TYPE_NAMES). %% @doc Connack Name From d91e49a5a5dfb25e6593af6f84e788e8e3d09d99 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:35:33 +0800 Subject: [PATCH 24/34] Change the restart strategy of the top supervisor --- src/emqttd_sup.erl | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/emqttd_sup.erl b/src/emqttd_sup.erl index 59ffde2ea..e38d20d65 100644 --- a/src/emqttd_sup.erl +++ b/src/emqttd_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,11 +14,12 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% @doc emqttd top supervisor. -module(emqttd_sup). -behaviour(supervisor). +-author("Feng Lee "). + -include("emqttd.hrl"). %% API @@ -50,5 +51,5 @@ start_child(Mod, Type) when is_atom(Mod) and is_atom(Type) -> %%-------------------------------------------------------------------- init([]) -> - {ok, {{one_for_all, 10, 3600}, []}}. + {ok, {{one_for_all, 0, 1}, []}}. From fa8882b499e35d579a499f410eac2524c691dc3d Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:36:08 +0800 Subject: [PATCH 25/34] Support client, session stats --- src/emqttd_stats.erl | 74 ++++++++++++++++++++++++++++++++------------ 1 file changed, 55 insertions(+), 19 deletions(-) diff --git a/src/emqttd_stats.erl b/src/emqttd_stats.erl index cae57207f..73a1471ac 100644 --- a/src/emqttd_stats.erl +++ b/src/emqttd_stats.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,34 +14,39 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% @doc emqttd statistics -module(emqttd_stats). --include("emqttd.hrl"). - -behaviour(gen_server). --define(SERVER, ?MODULE). +-author("Feng Lee "). + +-include("emqttd.hrl"). -export([start_link/0, stop/0]). -%% statistics API. --export([statsfun/1, statsfun/2, - getstats/0, getstat/1, - setstat/2, setstats/3]). +%% Client and Session Stats +-export([set_client_stats/2, get_client_stats/1, del_client_stats/1, + set_session_stats/2, get_session_stats/1, del_session_stats/1]). + +%% Statistics API. +-export([statsfun/1, statsfun/2, getstats/0, getstat/1, setstat/2, setstats/3]). %% gen_server Function Exports -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). --record(state, {tick_tref}). +-record(state, {tick}). + +-type(stats() :: list({atom(), non_neg_integer()})). -define(STATS_TAB, mqtt_stats). +-define(CLIENT_STATS_TAB, mqtt_client_stats). +-define(SESSION_STATS_TAB, mqtt_session_stats). %% $SYS Topics for Clients -define(SYSTOP_CLIENTS, [ - 'clients/count', % clients connected current - 'clients/max' % max clients connected + 'clients/count', % clients connected current + 'clients/max' % max clients connected ]). %% $SYS Topics for Sessions @@ -75,10 +80,40 @@ %% @doc Start stats server -spec(start_link() -> {ok, pid()} | ignore | {error, term()}). start_link() -> - gen_server:start_link({local, ?SERVER}, ?MODULE, [], []). + gen_server:start_link({local, ?MODULE}, ?MODULE, [], []). stop() -> - gen_server:call(?SERVER, stop). + gen_server:call(?MODULE, stop). + +-spec(set_client_stats(binary(), stats()) -> true). +set_client_stats(ClientId, Stats) -> + ets:insert(?CLIENT_STATS_TAB, {ClientId, [{'$ts', emqttd_time:now_secs()}|Stats]}). + +-spec(get_client_stats(binary()) -> stats()). +get_client_stats(ClientId) -> + case ets:lookup(?CLIENT_STATS_TAB, ClientId) of + [{_, Stats}] -> Stats; + [] -> [] + end. + +-spec(del_client_stats(binary()) -> true). +del_client_stats(ClientId) -> + ets:delete(?CLIENT_STATS_TAB, ClientId). + +-spec(set_session_stats(binary(), stats()) -> true). +set_session_stats(ClientId, Stats) -> + ets:insert(?SESSION_STATS_TAB, {ClientId, [{'$ts', emqttd_time:now_secs()}|Stats]}). + +-spec(get_session_stats(binary()) -> stats()). +get_session_stats(ClientId) -> + case ets:lookup(?SESSION_STATS_TAB, ClientId) of + [{_, Stats}] -> Stats; + [] -> [] + end. + +-spec(del_session_stats(binary()) -> true). +del_session_stats(ClientId) -> + ets:delete(?SESSION_STATS_TAB, ClientId). %% @doc Generate stats fun -spec(statsfun(Stat :: atom()) -> fun()). @@ -118,13 +153,14 @@ setstats(Stat, MaxStat, Val) -> init([]) -> emqttd_time:seed(), - ets:new(?STATS_TAB, [set, public, named_table, {write_concurrency, true}]), + lists:foreach( + fun(Tab) -> + Tab = ets:new(Tab, [set, public, named_table, {write_concurrency, true}]) + end, [?STATS_TAB, ?CLIENT_STATS_TAB, ?SESSION_STATS_TAB]), Topics = ?SYSTOP_CLIENTS ++ ?SYSTOP_SESSIONS ++ ?SYSTOP_PUBSUB ++ ?SYSTOP_RETAINED, ets:insert(?STATS_TAB, [{Topic, 0} || Topic <- Topics]), - % Create $SYS Topics - % [ok = emqttd:create(topic, stats_topic(Topic)) || Topic <- Topics], % Tick to publish stats - {ok, #state{tick_tref = emqttd_broker:start_tick(tick)}, hibernate}. + {ok, #state{tick = emqttd_broker:start_tick(tick)}, hibernate}. handle_call(stop, _From, State) -> {stop, normal, ok, State}; @@ -154,7 +190,7 @@ handle_info(tick, State) -> handle_info(_Info, State) -> {noreply, State}. -terminate(_Reason, #state{tick_tref = TRef}) -> +terminate(_Reason, #state{tick = TRef}) -> emqttd_broker:stop_tick(TRef). code_change(_OldVsn, State, _Extra) -> From 78c8856eda11070fb5136575513cc2d8b6c7d562 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:36:24 +0800 Subject: [PATCH 26/34] Update copyright info --- src/emqttd_sm_helper.erl | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/emqttd_sm_helper.erl b/src/emqttd_sm_helper.erl index 97b356c8d..0f7cb7ef1 100644 --- a/src/emqttd_sm_helper.erl +++ b/src/emqttd_sm_helper.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -17,6 +17,8 @@ %% @doc Session Helper. -module(emqttd_sm_helper). +-author("Feng Lee "). + -behaviour(gen_server). -include("emqttd.hrl"). From d69d7697979d813594640f793e0d39a1ff5f6362 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:36:57 +0800 Subject: [PATCH 27/34] Upgrade copyright info --- src/emqttd_session_sup.erl | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/emqttd_session_sup.erl b/src/emqttd_session_sup.erl index 88766b11a..bd9b34f02 100644 --- a/src/emqttd_session_sup.erl +++ b/src/emqttd_session_sup.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,9 +14,11 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% @doc emqttd session supervisor. +%% @doc Session Supervisor. -module(emqttd_session_sup). +-author("Feng Lee "). + -behavior(supervisor). -export([start_link/0, start_session/3]). @@ -41,4 +43,3 @@ init([]) -> {ok, {{simple_one_for_one, 0, 1}, [{session, {emqttd_session, start_link, []}, temporary, 5000, worker, [emqttd_session]}]}}. - From 45a379f11299dc87246ba17261e9c21101dc7e4d Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:38:40 +0800 Subject: [PATCH 28/34] Replace 'size/1' with 'byte_size/1', serialize to output iolist --- src/emqttd_serializer.erl | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/src/emqttd_serializer.erl b/src/emqttd_serializer.erl index f08ed7eef..ed920f584 100644 --- a/src/emqttd_serializer.erl +++ b/src/emqttd_serializer.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -17,6 +17,8 @@ %% @doc MQTT Packet Serializer -module(emqttd_serializer). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). @@ -25,7 +27,7 @@ -export([serialize/1]). %% @doc Serialise MQTT Packet --spec(serialize(mqtt_packet()) -> binary()). +-spec(serialize(mqtt_packet()) -> iolist()). serialize(#mqtt_packet{header = Header = #mqtt_packet_header{type = Type}, variable = Variable, payload = Payload}) -> @@ -37,14 +39,12 @@ serialize_header(#mqtt_packet_header{type = Type, dup = Dup, qos = Qos, retain = Retain}, - {VariableBin, PayloadBin}) when ?CONNECT =< Type andalso Type =< ?DISCONNECT -> - Len = size(VariableBin) + size(PayloadBin), + {VariableBin, PayloadBin}) + when ?CONNECT =< Type andalso Type =< ?DISCONNECT -> + Len = byte_size(VariableBin) + byte_size(PayloadBin), true = (Len =< ?MAX_LEN), - LenBin = serialize_len(Len), - <>. + [<>, + serialize_len(Len), VariableBin, PayloadBin]. serialize_variable(?CONNECT, #mqtt_packet_connect{client_id = ClientId, proto_ver = ProtoVer, @@ -58,7 +58,7 @@ serialize_variable(?CONNECT, #mqtt_packet_connect{client_id = ClientId, will_msg = WillMsg, username = Username, password = Password}, undefined) -> - VariableBin = <<(size(ProtoName)):16/big-unsigned-integer, + VariableBin = <<(byte_size(ProtoName)):16/big-unsigned-integer, ProtoName/binary, ProtoVer:8, (opt(Username)):1, @@ -73,7 +73,7 @@ serialize_variable(?CONNECT, #mqtt_packet_connect{client_id = ClientId, PayloadBin1 = case WillFlag of true -> <>; false -> PayloadBin end, @@ -93,7 +93,7 @@ serialize_variable(?SUBACK, #mqtt_packet_suback{packet_id = PacketId, {<>, << <> || Q <- QosTable >>}; serialize_variable(?UNSUBSCRIBE, #mqtt_packet_unsubscribe{packet_id = PacketId, - topics = Topics }, undefined) -> + topics = Topics }, undefined) -> {<>, serialize_topics(Topics)}; serialize_variable(?UNSUBACK, #mqtt_packet_unsuback{packet_id = PacketId}, undefined) -> @@ -134,7 +134,7 @@ serialize_topics([H|_] = Topics) when is_binary(H) -> serialize_utf(String) -> StringBin = unicode:characters_to_binary(String), - Len = size(StringBin), + Len = byte_size(StringBin), true = (Len =< 16#ffff), <>. @@ -148,4 +148,3 @@ opt(false) -> 0; opt(true) -> 1; opt(X) when is_integer(X) -> X; opt(B) when is_binary(B) -> 1. - From a345b3682b645f1292f48c2ba648ce171baa16e6 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:39:48 +0800 Subject: [PATCH 29/34] Rename emqttd_hook to emqttd_hooks --- src/emqttd_server.erl | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/emqttd_server.erl b/src/emqttd_server.erl index f21bd5d4b..ec57f2802 100644 --- a/src/emqttd_server.erl +++ b/src/emqttd_server.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -16,10 +16,10 @@ -module(emqttd_server). --author("Feng Lee "). - -behaviour(gen_server2). +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). @@ -43,7 +43,7 @@ %% Debug API -export([dump/0]). -%% gen_server. +%% gen_server Callbacks -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). @@ -89,7 +89,7 @@ async_subscribe(Topic, Subscriber, Options) when is_binary(Topic) -> -spec(publish(mqtt_message()) -> {ok, mqtt_delivery()} | ignore). publish(Msg = #mqtt_message{from = From}) -> trace(publish, From, Msg), - case emqttd_hook:run('message.publish', [], Msg) of + case emqttd_hooks:run('message.publish', [], Msg) of {ok, Msg1 = #mqtt_message{topic = Topic}} -> emqttd_pubsub:publish(Topic, Msg1); {stop, Msg1} -> @@ -97,14 +97,13 @@ publish(Msg = #mqtt_message{from = From}) -> ignore end. +%% @private trace(publish, From, _Msg) when is_atom(From) -> %% Dont' trace '$SYS' publish ignore; - trace(publish, {ClientId, Username}, #mqtt_message{topic = Topic, payload = Payload}) -> lager:info([{client, ClientId}, {topic, Topic}], "~s/~s PUBLISH to ~s: ~p", [ClientId, Username, Topic, Payload]); - trace(publish, From, #mqtt_message{topic = Topic, payload = Payload}) when is_binary(From); is_list(From) -> lager:info([{client, From}, {topic, Topic}], "~s PUBLISH to ~s: ~p", [From, Topic, Payload]). @@ -142,7 +141,8 @@ subscriptions(Subscriber) -> subscription(Topic, Subscriber) -> {Topic, Subscriber, ets:lookup_element(mqtt_subproperty, {Topic, Subscriber}, 2)}. -subscribers(Topic) -> emqttd_pubsub:subscribers(Topic). +subscribers(Topic) -> + emqttd_pubsub:subscribers(Topic). -spec(is_subscribed(binary(), emqttd:subscriber()) -> boolean()). is_subscribed(Topic, Subscriber) when is_binary(Topic) -> From bad855bdd93b2e2547947bce25ef5442fb5a9e62 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:46:06 +0800 Subject: [PATCH 30/34] Improve the session design, support tune_qos, enable_stats --- src/emqttd_session.erl | 1011 ++++++++++++++++++++++------------------ 1 file changed, 561 insertions(+), 450 deletions(-) diff --git a/src/emqttd_session.erl b/src/emqttd_session.erl index a73503479..31efaab55 100644 --- a/src/emqttd_session.erl +++ b/src/emqttd_session.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. @@ -14,47 +14,60 @@ %% limitations under the License. %%-------------------------------------------------------------------- -%% @doc Session for persistent MQTT client. %% -%% Session State in the broker consists of: +%% @doc MQTT Session %% -%% 1. The Client’s subscriptions. +%% A stateful interaction between a Client and a Server. Some Sessions +%% last only as long as the Network Connection, others can span multiple +%% consecutive Network Connections between a Client and a Server. %% -%% 2. inflight qos1/2 messages sent to the client but unacked, QoS 1 and QoS 2 -%% messages which have been sent to the Client, but have not been completely -%% acknowledged. +%% The Session state in the Server consists of: %% -%% 3. inflight qos2 messages received from client and waiting for pubrel. QoS 2 -%% messages which have been received from the Client, but have not been -%% completely acknowledged. +%% The existence of a Session, even if the rest of the Session state is empty. %% -%% 4. all qos1, qos2 messages published to when client is disconnected. -%% QoS 1 and QoS 2 messages pending transmission to the Client. +%% The Client’s subscriptions. %% -%% 5. Optionally, QoS 0 messages pending transmission to the Client. +%% QoS 1 and QoS 2 messages which have been sent to the Client, but have not +%% been completely acknowledged. %% -%% State of Message: newcome, inflight, pending +%% QoS 1 and QoS 2 messages pending transmission to the Client. +%% +%% QoS 2 messages which have been received from the Client, but have not +%% been completely acknowledged. +%% +%% Optionally, QoS 0 messages pending transmission to the Client. +%% +%% If the session is currently disconnected, the time at which the Session state +%% will be deleted. %% %% @end +%% -module(emqttd_session). +-behaviour(gen_server2). + +-author("Feng Lee "). + -include("emqttd.hrl"). -include("emqttd_protocol.hrl"). -include("emqttd_internal.hrl"). --behaviour(gen_server2). +-import(emqttd_misc, [start_timer/2]). -import(proplists, [get_value/2, get_value/3]). %% Session API --export([start_link/3, resume/3, info/1, destroy/2]). +-export([start_link/3, resume/3, destroy/2]). -%% PubSub APIs --export([publish/2, puback/2, pubrec/2, pubrel/2, pubcomp/2, - subscribe/2, subscribe/3, unsubscribe/2]). +%% Management and Monitor API +-export([state/1, info/1, stats/1]). + +%% PubSub API +-export([subscribe/2, subscribe/3, publish/2, puback/2, pubrec/2, + pubrel/2, pubcomp/2, unsubscribe/2]). %% gen_server Function Exports -export([init/1, handle_call/3, handle_cast/2, handle_info/2, @@ -63,150 +76,199 @@ %% gen_server2 Message Priorities -export([prioritise_call/4, prioritise_cast/3, prioritise_info/3]). --record(session, { +-record(state, + { + %% Clean Session Flag + clean_sess = false :: boolean(), - %% Clean Session Flag - clean_sess = true, + %% Client Binding: local | remote + binding = local :: local | remote, - %% ClientId: Identifier of Session - client_id :: binary(), + %% ClientId: Identifier of Session + client_id :: binary(), - %% Client Pid bind with session - client_pid :: pid(), + %% Username + username :: binary() | undefined, - %% Old Client Pid that has been kickout - old_client_pid :: pid(), + %% Client Pid binding with session + client_pid :: pid(), - %% Username - username :: binary() | undefined, + %% Old Client Pid that has been kickout + old_client_pid :: pid(), - %% Last packet id of the session - packet_id = 1, - - %% Client’s subscriptions. - subscriptions :: map(), + %% Next message id of the session + next_msg_id = 1 :: mqtt_packet_id(), - %% Inflight qos1, qos2 messages sent to the client but unacked, - %% QoS 1 and QoS 2 messages which have been sent to the Client, - %% but have not been completely acknowledged. - %% Client <- Broker - inflight_queue :: list(), + max_subscriptions :: non_neg_integer(), - max_inflight = 0, + %% Client’s subscriptions. + subscriptions :: map(), - %% All qos1, qos2 messages published to when client is disconnected. - %% QoS 1 and QoS 2 messages pending transmission to the Client. - %% - %% Optionally, QoS 0 messages pending transmission to the Client. - message_queue :: emqttd_mqueue:mqueue(), + %% Upgrade Qos? + upgrade_qos = false :: boolean(), - %% Inflight qos2 messages received from client and waiting for pubrel. - %% QoS 2 messages which have been received from the Client, - %% but have not been completely acknowledged. - %% Client -> Broker - awaiting_rel :: map(), + %% Client <- Broker: Inflight QoS1, QoS2 messages sent to the client but unacked. + inflight :: emqttd_inflight:inflight(), - %% Awaiting PUBREL timeout - await_rel_timeout = 8, + %% Max Inflight Size + max_inflight = 32 :: non_neg_integer(), - %% Max Packets that Awaiting PUBREL - max_awaiting_rel = 100, + %% Retry interval for redelivering QoS1/2 messages + retry_interval = 20000 :: pos_integer(), - %% Awaiting timers for ack, rel. - awaiting_ack :: map(), + %% Retry Timer + retry_timer :: reference(), - %% Retry interval for redelivering QoS1/2 messages - retry_interval = 20, + %% All QoS1, QoS2 messages published to when client is disconnected. + %% QoS 1 and QoS 2 messages pending transmission to the Client. + %% + %% Optionally, QoS 0 messages pending transmission to the Client. + mqueue :: emqttd_mqueue:mqueue(), - %% Awaiting for PUBCOMP - awaiting_comp :: map(), + %% Client -> Broker: Inflight QoS2 messages received from client and waiting for pubrel. + awaiting_rel :: map(), - %% session expired after 48 hours - expired_after = 172800, + %% Awaiting PUBREL timeout + await_rel_timeout = 20000 :: pos_integer(), - expired_timer, + %% Max Packets that Awaiting PUBREL + max_awaiting_rel = 100 :: non_neg_integer(), - collect_interval, + %% Awaiting PUBREL timer + await_rel_timer :: reference(), - collect_timer, - - timestamp}). + %% Session Expiry Interval + expiry_interval = 7200000 :: pos_integer(), --define(PUBSUB_TIMEOUT, 60000). + %% Expired Timer + expiry_timer :: reference(), + + %% Enable Stats + enable_stats :: false | pos_integer(), + + %% Stats Timer + stats_timer :: reference(), + + created_at :: erlang:timestamp() + }). + +-define(TIMEOUT, 60000). + +-define(INFO_KEYS, [clean_sess, client_id, username, client_pid, binding, created_at]). + +-define(STATE_KEYS, [clean_sess, client_id, username, binding, client_pid, old_client_pid, + next_msg_id, max_subscriptions, subscriptions, upgrade_qos, inflight, + max_inflight, retry_interval, mqueue, awaiting_rel, max_awaiting_rel, + await_rel_timeout, expiry_interval, enable_stats, created_at]). -define(LOG(Level, Format, Args, State), - lager:Level([{client, State#session.client_id}], - "Session(~s): " ++ Format, [State#session.client_id | Args])). + lager:Level([{client, State#state.client_id}], + "Session(~s): " ++ Format, [State#state.client_id | Args])). -%% @doc Start a session. +%% @doc Start a Session -spec(start_link(boolean(), {mqtt_client_id(), mqtt_username()}, pid()) -> {ok, pid()} | {error, any()}). start_link(CleanSess, {ClientId, Username}, ClientPid) -> gen_server2:start_link(?MODULE, [CleanSess, {ClientId, Username}, ClientPid], []). -%% @doc Resume a session. --spec(resume(pid(), mqtt_client_id(), pid()) -> ok). -resume(SessPid, ClientId, ClientPid) -> - gen_server2:cast(SessPid, {resume, ClientId, ClientPid}). - -%% @doc Session Info. -info(SessPid) -> - gen_server2:call(SessPid, info). - -%% @doc Destroy a session. --spec(destroy(pid(), mqtt_client_id()) -> ok). -destroy(SessPid, ClientId) -> - gen_server2:cast(SessPid, {destroy, ClientId}). - %%-------------------------------------------------------------------- -%% PubSub +%% PubSub API %%-------------------------------------------------------------------- -%% @doc Subscribe Topics +%% @doc Subscribe topics -spec(subscribe(pid(), [{binary(), [emqttd_topic:option()]}]) -> ok). -subscribe(SessPid, TopicTable) -> - gen_server2:cast(SessPid, {subscribe, TopicTable, fun(_) -> ok end}). +subscribe(Session, TopicTable) ->%%TODO: the ack function??... + gen_server2:cast(Session, {subscribe, self(), TopicTable, fun(_) -> ok end}). --spec(subscribe(pid(), mqtt_pktid(), [{binary(), [emqttd_topic:option()]}]) -> ok). -subscribe(SessPid, PktId, TopicTable) -> +-spec(subscribe(pid(), mqtt_packet_id(), [{binary(), [emqttd_topic:option()]}]) -> ok). +subscribe(Session, PacketId, TopicTable) -> %%TODO: the ack function??... From = self(), - AckFun = fun(GrantedQos) -> From ! {suback, PktId, GrantedQos} end, - gen_server2:cast(SessPid, {subscribe, TopicTable, AckFun}). + AckFun = fun(GrantedQos) -> From ! {suback, PacketId, GrantedQos} end, + gen_server2:cast(Session, {subscribe, From, TopicTable, AckFun}). -%% @doc Publish message +%% @doc Publish Message -spec(publish(pid(), mqtt_message()) -> ok | {error, any()}). -publish(_SessPid, Msg = #mqtt_message{qos = ?QOS_0}) -> - %% publish qos0 directly - emqttd:publish(Msg), ok; +publish(_Session, Msg = #mqtt_message{qos = ?QOS_0}) -> + %% Publish QoS0 Directly + emqttd_server:publish(Msg), ok; -publish(_SessPid, Msg = #mqtt_message{qos = ?QOS_1}) -> - %% publish qos1 directly, and client will puback automatically - emqttd:publish(Msg), ok; +publish(_Session, Msg = #mqtt_message{qos = ?QOS_1}) -> + %% Publish QoS1 message directly for client will PubAck automatically + emqttd_server:publish(Msg), ok; -publish(SessPid, Msg = #mqtt_message{qos = ?QOS_2}) -> - %% publish qos2 by session - gen_server2:call(SessPid, {publish, Msg}, ?PUBSUB_TIMEOUT). +publish(Session, Msg = #mqtt_message{qos = ?QOS_2}) -> + %% Publish QoS2 to Session + gen_server2:call(Session, {publish, Msg}, ?TIMEOUT). -%% @doc PubAck message +%% @doc PubAck Message -spec(puback(pid(), mqtt_packet_id()) -> ok). -puback(SessPid, PktId) -> - gen_server2:cast(SessPid, {puback, PktId}). +puback(Session, PacketId) -> + gen_server2:cast(Session, {puback, PacketId}). -spec(pubrec(pid(), mqtt_packet_id()) -> ok). -pubrec(SessPid, PktId) -> - gen_server2:cast(SessPid, {pubrec, PktId}). +pubrec(Session, PacketId) -> + gen_server2:cast(Session, {pubrec, PacketId}). -spec(pubrel(pid(), mqtt_packet_id()) -> ok). -pubrel(SessPid, PktId) -> - gen_server2:cast(SessPid, {pubrel, PktId}). +pubrel(Session, PacketId) -> + gen_server2:cast(Session, {pubrel, PacketId}). -spec(pubcomp(pid(), mqtt_packet_id()) -> ok). -pubcomp(SessPid, PktId) -> - gen_server2:cast(SessPid, {pubcomp, PktId}). +pubcomp(Session, PacketId) -> + gen_server2:cast(Session, {pubcomp, PacketId}). -%% @doc Unsubscribe Topics +%% @doc Unsubscribe the topics -spec(unsubscribe(pid(), [{binary(), [emqttd_topic:option()]}]) -> ok). -unsubscribe(SessPid, TopicTable) -> - gen_server2:cast(SessPid, {unsubscribe, TopicTable}). +unsubscribe(Session, TopicTable) -> + gen_server2:cast(Session, {unsubscribe, self(), TopicTable}). + +%% @doc Resume the session +-spec(resume(pid(), mqtt_client_id(), pid()) -> ok). +resume(Session, ClientId, ClientPid) -> + gen_server2:cast(Session, {resume, ClientId, ClientPid}). + +%% @doc Get session state +state(Session) when is_pid(Session) -> + gen_server2:call(Session, state). + +%% @doc Get session info +-spec(info(pid() | #state{}) -> list(tuple())). +info(Session) when is_pid(Session) -> + gen_server2:call(Session, info); + +info(State) when is_record(State, state) -> + ?record_to_proplist(state, State, ?INFO_KEYS). + +-spec(stats(pid() | #state{}) -> list({atom(), non_neg_integer()})). +stats(Session) when is_pid(Session) -> + gen_server2:call(Session, stats); + +stats(#state{max_subscriptions = MaxSubscriptions, + subscriptions = Subscriptions, + inflight = Inflight, + max_inflight = MaxInflight, + mqueue = MQueue, + max_awaiting_rel = MaxAwaitingRel, + awaiting_rel = AwaitingRel}) -> + lists:append(emqttd_misc:proc_stats(), + [{max_subscriptions, MaxSubscriptions}, + {subscriptions, maps:size(Subscriptions)}, + {max_inflight, MaxInflight}, + {inflight_len, Inflight:size()}, + {max_mqueue, case emqttd_mqueue:max_len(MQueue) of + infinity -> 0; + Len -> Len + end}, + {mqueue_len, emqttd_mqueue:len(MQueue)}, + {mqueue_dropped, emqttd_mqueue:dropped(MQueue)}, + {max_awaiting_rel, MaxAwaitingRel}, + {awaiting_rel_len, maps:size(AwaitingRel)}, + {deliver_msg, get(deliver_msg)}, + {enqueue_msg, get(enqueue_msg)}]). + +%% @doc Destroy the session +-spec(destroy(pid(), mqtt_client_id()) -> ok). +destroy(Session, ClientId) -> + gen_server2:cast(Session, {destroy, ClientId}). %%-------------------------------------------------------------------- %% gen_server Callbacks @@ -215,36 +277,43 @@ unsubscribe(SessPid, TopicTable) -> init([CleanSess, {ClientId, Username}, ClientPid]) -> process_flag(trap_exit, true), true = link(ClientPid), + init_stats([deliver_msg, enqueue_msg]), + {ok, Env} = emqttd:env(session), {ok, QEnv} = emqttd:env(queue), - {ok, SessEnv} = emqttd:env(session), - Session = #session{ - clean_sess = CleanSess, - client_id = ClientId, - client_pid = ClientPid, - username = Username, - subscriptions = #{}, - inflight_queue = [], - max_inflight = get_value(max_inflight, SessEnv, 0), - message_queue = emqttd_mqueue:new(ClientId, QEnv, emqttd_alarm:alarm_fun()), - awaiting_rel = #{}, - awaiting_ack = #{}, - awaiting_comp = #{}, - retry_interval = get_value(retry_interval, SessEnv), - await_rel_timeout = get_value(await_rel_timeout, SessEnv), - max_awaiting_rel = get_value(max_awaiting_rel, SessEnv), - expired_after = get_value(expired_after, SessEnv), - collect_interval = get_value(collect_interval, SessEnv, 0), - timestamp = os:timestamp()}, - emqttd_sm:reg_session(ClientId, CleanSess, sess_info(Session)), - emqttd:run_hooks('session.created', [ClientId, Username]), - %% Start statistics - {ok, start_collector(Session), hibernate}. + MaxInflight = get_value(max_inflight, Env, 0), + EnableStats = get_value(enable_stats, Env, false), + MQueue = emqttd_mqueue:new(ClientId, QEnv, emqttd_alarm:alarm_fun()), + State = #state{clean_sess = CleanSess, + binding = binding(ClientPid), + client_id = ClientId, + client_pid = ClientPid, + username = Username, + subscriptions = #{}, + max_subscriptions = get_value(max_subscriptions, Env, 0), + upgrade_qos = get_value(upgrade_qos, Env, false), + max_inflight = MaxInflight, + inflight = emqttd_inflight:new(MaxInflight), + mqueue = MQueue, + retry_interval = get_value(retry_interval, Env), + awaiting_rel = #{}, + await_rel_timeout = get_value(await_rel_timeout, Env), + max_awaiting_rel = get_value(max_awaiting_rel, Env), + expiry_interval = get_value(expiry_interval, Env), + enable_stats = EnableStats, + created_at = os:timestamp()}, + emqttd_stats:set_session_stats(ClientId, stats(State)), + emqttd_sm:register_session(ClientId, CleanSess, info(State)), + emqttd_hooks:run('session.created', [ClientId, Username]), + {ok, State, hibernate, {backoff, 1000, 1000, 5000}, ?MODULE}. + +init_stats(Keys) -> + lists:foreach(fun(K) -> put(K, 0) end, Keys). + +binding(ClientPid) -> + case node(ClientPid) =:= node() of true -> local; false -> remote end. prioritise_call(Msg, _From, _Len, _State) -> - case Msg of - info -> 10; - _ -> 0 - end. + case Msg of info -> 10; stats -> 10; state -> 10; _ -> 5 end. prioritise_cast(Msg, _Len, _State) -> case Msg of @@ -262,279 +331,249 @@ prioritise_cast(Msg, _Len, _State) -> prioritise_info(Msg, _Len, _State) -> case Msg of {'EXIT', _, _} -> 10; - expired -> 10; {timeout, _, _} -> 5; - collect_info -> 2; {dispatch, _, _} -> 1; _ -> 0 end. -handle_call(info, _From, State) -> - {reply, sess_info(State), State, hibernate}; - -handle_call({publish, Msg = #mqtt_message{qos = ?QOS_2, pktid = PktId}}, - _From, Session = #session{awaiting_rel = AwaitingRel, - await_rel_timeout = Timeout}) -> - case check_awaiting_rel(Session) of - true -> - TRef = timer(Timeout, {timeout, awaiting_rel, PktId}), - AwaitingRel1 = maps:put(PktId, {Msg, TRef}, AwaitingRel), - {reply, ok, Session#session{awaiting_rel = AwaitingRel1}}; +handle_call({publish, Msg = #mqtt_message{qos = ?QOS_2, pktid = PacketId}}, + _From, State = #state{awaiting_rel = AwaitingRel, + await_rel_timer = Timer, + await_rel_timeout = Timeout}) -> + case is_awaiting_full(State) of false -> - ?LOG(critical, "Dropped Qos2 message for too many awaiting_rel: ~p", [Msg], Session), - {reply, {error, dropped}, Session, hibernate} + State1 = case Timer == undefined of + true -> State#state{await_rel_timer = start_timer(Timeout, check_awaiting_rel)}; + false -> State + end, + reply(ok, State1#state{awaiting_rel = maps:put(PacketId, Msg, AwaitingRel)}); + true -> + ?LOG(warning, "Dropped Qos2 Message for too many awaiting_rel: ~p", [Msg], State), + emqttd_metrics:inc('messages/qos2/dropped'), + reply({error, dropped}, State) end; +handle_call(info, _From, State) -> + reply(info(State), State); + +handle_call(stats, _From, State) -> + reply(stats(State), State); + +handle_call(state, _From, State) -> + reply(?record_to_proplist(state, State, ?STATE_KEYS), State); + handle_call(Req, _From, State) -> ?UNEXPECTED_REQ(Req, State). -handle_cast({subscribe, TopicTable, AckFun}, Session = #session{client_id = ClientId, - username = Username, - subscriptions = Subscriptions}) -> - ?LOG(info, "Subscribe ~p", [TopicTable], Session), +handle_cast({subscribe, _From, TopicTable, AckFun}, + State = #state{client_id = ClientId, + username = Username, + subscriptions = Subscriptions}) -> + ?LOG(info, "Subscribe ~p", [TopicTable], State), {GrantedQos, Subscriptions1} = lists:foldl(fun({Topic, Opts}, {QosAcc, SubMap}) -> NewQos = proplists:get_value(qos, Opts), SubMap1 = case maps:find(Topic, SubMap) of {ok, NewQos} -> - ?LOG(warning, "duplicated subscribe: ~s, qos = ~w", [Topic, NewQos], Session), + ?LOG(warning, "Duplicated subscribe: ~s, qos = ~w", [Topic, NewQos], State), SubMap; {ok, OldQos} -> emqttd:setqos(Topic, ClientId, NewQos), - ?LOG(warning, "duplicated subscribe ~s, old_qos=~w, new_qos=~w", - [Topic, OldQos, NewQos], Session), + ?LOG(warning, "Duplicated subscribe ~s, old_qos=~w, new_qos=~w", + [Topic, OldQos, NewQos], State), maps:put(Topic, NewQos, SubMap); error -> emqttd:subscribe(Topic, ClientId, Opts), - emqttd:run_hooks('session.subscribed', [ClientId, Username], {Topic, Opts}), + emqttd_hooks:run('session.subscribed', [ClientId, Username], {Topic, Opts}), maps:put(Topic, NewQos, SubMap) end, {[NewQos|QosAcc], SubMap1} end, {[], Subscriptions}, TopicTable), AckFun(lists:reverse(GrantedQos)), - hibernate(Session#session{subscriptions = Subscriptions1}); + noreply(emit_stats(State#state{subscriptions = Subscriptions1})); -handle_cast({unsubscribe, TopicTable}, Session = #session{client_id = ClientId, - username = Username, - subscriptions = Subscriptions}) -> - ?LOG(info, "unsubscribe ~p", [TopicTable], Session), +handle_cast({unsubscribe, _From, TopicTable}, + State = #state{client_id = ClientId, + username = Username, + subscriptions = Subscriptions}) -> + ?LOG(info, "Unsubscribe ~p", [TopicTable], State), Subscriptions1 = lists:foldl(fun({Topic, Opts}, SubMap) -> case maps:find(Topic, SubMap) of {ok, _Qos} -> emqttd:unsubscribe(Topic, ClientId), - emqttd:run_hooks('session.unsubscribed', [ClientId, Username], {Topic, Opts}), + emqttd_hooks:run('session.unsubscribed', [ClientId, Username], {Topic, Opts}), maps:remove(Topic, SubMap); error -> SubMap end end, Subscriptions, TopicTable), - hibernate(Session#session{subscriptions = Subscriptions1}); + noreply(emit_stats(State#state{subscriptions = Subscriptions1})); -handle_cast({destroy, ClientId}, Session = #session{client_id = ClientId, client_pid = undefined}) -> - ?LOG(warning, "destroyed", [], Session), - shutdown(destroy, Session); +%% PUBACK: +handle_cast({puback, PacketId}, State = #state{inflight = Inflight}) -> + case Inflight:contain(PacketId) of + true -> + noreply(dequeue(acked(puback, PacketId, State))); + false -> + ?LOG(warning, "The PUBACK ~p is not inflight: ~p", + [PacketId, Inflight:window()], State), + emqttd_metrics:inc('packets/puback/missed'), + noreply(State) + end; -handle_cast({destroy, ClientId}, Session = #session{client_id = ClientId, client_pid = OldClientPid}) -> - ?LOG(warning, "kickout ~p", [OldClientPid], Session), - shutdown(conflict, Session); +%% PUBREC: +handle_cast({pubrec, PacketId}, State = #state{inflight = Inflight}) -> + case Inflight:contain(PacketId) of + true -> + noreply(acked(pubrec, PacketId, State)); + false -> + ?LOG(warning, "The PUBREC ~p is not inflight: ~p", + [PacketId, Inflight:window()], State), + emqttd_metrics:inc('packets/pubrec/missed'), + noreply(State) + end; -handle_cast({resume, ClientId, ClientPid}, Session = #session{client_id = ClientId, - client_pid = OldClientPid, - clean_sess = CleanSess, - inflight_queue = InflightQ, - awaiting_ack = AwaitingAck, - awaiting_comp = AwaitingComp, - expired_timer = ETimer} = Session) -> +%% PUBREL: +handle_cast({pubrel, PacketId}, State = #state{awaiting_rel = AwaitingRel}) -> + case maps:take(PacketId, AwaitingRel) of + {Msg, AwaitingRel1} -> + spawn(emqttd_server, publish, [Msg]),%%:) + noreply(State#state{awaiting_rel = AwaitingRel1}); + error -> + ?LOG(warning, "Cannot find PUBREL: ~p", [PacketId], State), + emqttd_metrics:inc('packets/pubrel/missed'), + noreply(State) + end; - ?LOG(info, "resumed by ~p", [ClientPid], Session), +%% PUBCOMP: +handle_cast({pubcomp, PacketId}, State = #state{inflight = Inflight}) -> + case Inflight:contain(PacketId) of + true -> + noreply(dequeue(acked(pubcomp, PacketId, State))); + false -> + ?LOG(warning, "The PUBCOMP ~p is not inflight: ~p", + [PacketId, Inflight:window()], State), + emqttd_metrics:inc('packets/pubcomp/missed'), + noreply(State) + end; - %% Cancel expired timer - cancel_timer(ETimer), +%% RESUME: +handle_cast({resume, ClientId, ClientPid}, + State = #state{client_id = ClientId, + client_pid = OldClientPid, + clean_sess = CleanSess, + retry_timer = RetryTimer, + await_rel_timer = AwaitTimer, + stats_timer = StatsTimer, + expiry_timer = ExpireTimer}) -> + + ?LOG(info, "Resumed by ~p", [ClientPid], State), + + %% Cancel Timers + lists:foreach(fun emqttd_misc:cancel_timer/1, + [RetryTimer, AwaitTimer, StatsTimer, ExpireTimer]), case kick(ClientId, OldClientPid, ClientPid) of - ok -> ?LOG(warning, "~p kickout ~p", [ClientPid, OldClientPid], Session); + ok -> ?LOG(warning, "~p kickout ~p", [ClientPid, OldClientPid], State); ignore -> ok end, true = link(ClientPid), - %% Redeliver PUBREL - [ClientPid ! {redeliver, {?PUBREL, PktId}} || PktId <- maps:keys(AwaitingComp)], + State1 = State#state{client_pid = ClientPid, + binding = binding(ClientPid), + old_client_pid = OldClientPid, + clean_sess = false, + retry_timer = undefined, + awaiting_rel = #{}, + await_rel_timer = undefined, + expiry_timer = undefined}, - %% Clear awaiting_ack timers - [cancel_timer(TRef) || TRef <- maps:values(AwaitingAck)], - - %% Clear awaiting_comp timers - [cancel_timer(TRef) || TRef <- maps:values(AwaitingComp)], - - Session1 = Session#session{client_pid = ClientPid, - old_client_pid = OldClientPid, - clean_sess = false, - awaiting_ack = #{}, - awaiting_comp = #{}, - expired_timer = undefined}, - - %% CleanSess: true -> false? + %% Clean Session: true -> false? if - CleanSess =:= true -> - ?LOG(warning, "CleanSess changed to false.", [], Session), - emqttd_sm:reg_session(ClientId, false, sess_info(Session1)); + CleanSess =:= true -> + ?LOG(error, "CleanSess changed to false.", [], State1), + emqttd_sm:register_session(ClientId, false, info(State1)); CleanSess =:= false -> ok end, - %% Redeliver inflight messages - Session2 = - lists:foldl(fun({_Id, Msg}, Sess) -> - redeliver(Msg, Sess) - end, Session1, lists:reverse(InflightQ)), + %% Replay delivery and Dequeue pending messages + noreply(emit_stats(dequeue(retry_delivery(true, State1)))); - %% Dequeue pending messages - hibernate(dequeue(Session2)); +handle_cast({destroy, ClientId}, State = #state{client_id = ClientId, + client_pid = undefined}) -> + ?LOG(warning, "Destroyed", [], State), + shutdown(destroy, State); -%% PUBACK -handle_cast({puback, PktId}, Session = #session{awaiting_ack = AwaitingAck}) -> - case maps:find(PktId, AwaitingAck) of - {ok, TRef} -> - cancel_timer(TRef), - hibernate(dequeue(acked(PktId, Session))); - error -> - ?LOG(warning, "Cannot find PUBACK: ~p", [PktId], Session), - hibernate(Session) - end; - -%% PUBREC -handle_cast({pubrec, PktId}, Session = #session{awaiting_ack = AwaitingAck, - awaiting_comp = AwaitingComp, - await_rel_timeout = Timeout}) -> - case maps:find(PktId, AwaitingAck) of - {ok, TRef} -> - cancel_timer(TRef), - TRef1 = timer(Timeout, {timeout, awaiting_comp, PktId}), - AwaitingComp1 = maps:put(PktId, TRef1, AwaitingComp), - Session1 = acked(PktId, Session#session{awaiting_comp = AwaitingComp1}), - hibernate(dequeue(Session1)); - error -> - ?LOG(error, "Cannot find PUBREC: ~p", [PktId], Session), - hibernate(Session) - end; - -%% PUBREL -handle_cast({pubrel, PktId}, Session = #session{awaiting_rel = AwaitingRel}) -> - case maps:find(PktId, AwaitingRel) of - {ok, {Msg, TRef}} -> - cancel_timer(TRef), - emqttd:publish(Msg), - hibernate(Session#session{awaiting_rel = maps:remove(PktId, AwaitingRel)}); - error -> - ?LOG(error, "Cannot find PUBREL: ~p", [PktId], Session), - hibernate(Session) - end; - -%% PUBCOMP -handle_cast({pubcomp, PktId}, Session = #session{awaiting_comp = AwaitingComp}) -> - case maps:find(PktId, AwaitingComp) of - {ok, TRef} -> - cancel_timer(TRef), - hibernate(Session#session{awaiting_comp = maps:remove(PktId, AwaitingComp)}); - error -> - ?LOG(error, "Cannot find PUBCOMP: ~p", [PktId], Session), - hibernate(Session) - end; +handle_cast({destroy, ClientId}, State = #state{client_id = ClientId, + client_pid = OldClientPid}) -> + ?LOG(warning, "kickout ~p", [OldClientPid], State), + shutdown(conflict, State); handle_cast(Msg, State) -> ?UNEXPECTED_MSG(Msg, State). %% Dispatch Message -handle_info({dispatch, Topic, Msg}, Session = #session{subscriptions = Subscriptions}) - when is_record(Msg, mqtt_message) -> - dispatch(tune_qos(Topic, Msg, Subscriptions), Session); +handle_info({dispatch, Topic, Msg}, State) when is_record(Msg, mqtt_message) -> + noreply(dispatch(tune_qos(Topic, Msg, State), State)); -handle_info({timeout, awaiting_ack, PktId}, Session = #session{client_pid = undefined, - awaiting_ack = AwaitingAck}) -> - %% just remove awaiting - hibernate(Session#session{awaiting_ack = maps:remove(PktId, AwaitingAck)}); +%% Do nothing if the client has been disconnected. +handle_info({timeout, _Timer, retry_delivery}, State = #state{client_pid = undefined}) -> + hibernate(emit_stats(State#state{retry_timer = undefined})); -handle_info({timeout, awaiting_ack, PktId}, Session = #session{inflight_queue = InflightQ, - awaiting_ack = AwaitingAck}) -> - case maps:find(PktId, AwaitingAck) of - {ok, _TRef} -> - case lists:keyfind(PktId, 1, InflightQ) of - {_, Msg} -> - hibernate(redeliver(Msg, Session)); - false -> - ?LOG(error, "AwaitingAck timeout but Cannot find PktId: ~p", [PktId], Session), - hibernate(dequeue(Session)) - end; - error -> - ?LOG(error, "Cannot find AwaitingAck: ~p", [PktId], Session), - hibernate(Session) - end; +handle_info({timeout, _Timer, retry_delivery}, State) -> + noreply(emit_stats(retry_delivery(false, State#state{retry_timer = undefined}))); -handle_info({timeout, awaiting_rel, PktId}, Session = #session{awaiting_rel = AwaitingRel}) -> - case maps:find(PktId, AwaitingRel) of - {ok, {_Msg, _TRef}} -> - ?LOG(warning, "AwaitingRel Timout: ~p, Drop Message!", [PktId], Session), - hibernate(Session#session{awaiting_rel = maps:remove(PktId, AwaitingRel)}); - error -> - ?LOG(error, "Cannot find AwaitingRel: ~p", [PktId], Session), - hibernate(Session) - end; +handle_info({timeout, _Timer, check_awaiting_rel}, State) -> + noreply(expire_awaiting_rel(emit_stats(State#state{await_rel_timer = undefined}))); -handle_info({timeout, awaiting_comp, PktId}, Session = #session{awaiting_comp = Awaiting}) -> - case maps:find(PktId, Awaiting) of - {ok, _TRef} -> - ?LOG(warning, "Awaiting PUBCOMP Timout: ~p", [PktId], Session), - hibernate(Session#session{awaiting_comp = maps:remove(PktId, Awaiting)}); - error -> - ?LOG(error, "Cannot find Awaiting PUBCOMP: ~p", [PktId], Session), - hibernate(Session) - end; +handle_info({timeout, _Timer, emit_stats}, State) -> + hibernate(maybe_enable_stats(emit_stats(State))); -handle_info(collect_info, Session = #session{clean_sess = CleanSess, client_id = ClientId}) -> - emqttd_sm:reg_session(ClientId, CleanSess, sess_info(Session)), - hibernate(start_collector(Session)); +handle_info({timeout, _Timer, expired}, State) -> + ?LOG(info, "Expired, shutdown now.", [], State), + shutdown(expired, State); -handle_info({'EXIT', ClientPid, _Reason}, Session = #session{clean_sess = true, - client_pid = ClientPid}) -> - {stop, normal, Session}; +handle_info({'EXIT', ClientPid, _Reason}, + State = #state{clean_sess = true, client_pid = ClientPid}) -> + {stop, normal, State}; -handle_info({'EXIT', ClientPid, Reason}, Session = #session{clean_sess = false, - client_pid = ClientPid, - expired_after = Expires}) -> - ?LOG(info, "Client ~p EXIT for ~p", [ClientPid, Reason], Session), - TRef = timer(Expires, expired), - hibernate(Session#session{client_pid = undefined, expired_timer = TRef}); +handle_info({'EXIT', ClientPid, Reason}, + State = #state{clean_sess = false, + client_pid = ClientPid, + expiry_interval = Interval}) -> + ?LOG(info, "Client ~p EXIT for ~p", [ClientPid, Reason], State), + ExpireTimer = start_timer(Interval, expired), + State1 = State#state{client_pid = undefined, expiry_timer = ExpireTimer}, + hibernate(maybe_enable_stats(emit_stats(State1))); -handle_info({'EXIT', Pid, _Reason}, Session = #session{old_client_pid = Pid}) -> +handle_info({'EXIT', Pid, _Reason}, State = #state{old_client_pid = Pid}) -> %%ignore - hibernate(Session); + hibernate(State); -handle_info({'EXIT', Pid, Reason}, Session = #session{client_pid = ClientPid}) -> +handle_info({'EXIT', Pid, Reason}, State = #state{client_pid = ClientPid}) -> ?LOG(error, "Unexpected EXIT: client_pid=~p, exit_pid=~p, reason=~p", - [ClientPid, Pid, Reason], Session), - hibernate(Session); - -handle_info(expired, Session) -> - ?LOG(info, "expired, shutdown now.", [], Session), - shutdown(expired, Session); + [ClientPid, Pid, Reason], State), + hibernate(State); handle_info(Info, Session) -> ?UNEXPECTED_INFO(Info, Session). -terminate(Reason, #session{client_id = ClientId, username = Username}) -> - emqttd:run_hooks('session.terminated', [ClientId, Username, Reason]), - emqttd:subscriber_down(ClientId), - emqttd_sm:unreg_session(ClientId). +terminate(Reason, #state{client_id = ClientId, username = Username}) -> + emqttd_stats:del_session_stats(ClientId), + emqttd_hooks:run('session.terminated', [ClientId, Username, Reason]), + emqttd_server:subscriber_down(ClientId), + emqttd_sm:unregister_session(ClientId). code_change(_OldVsn, Session, _Extra) -> {ok, Session}. %%-------------------------------------------------------------------- -%% Kick old client out +%% Kick old client %%-------------------------------------------------------------------- kick(_ClientId, undefined, _Pid) -> ignore; @@ -546,130 +585,228 @@ kick(ClientId, OldPid, Pid) -> %% Clean noproc receive {'EXIT', OldPid, _} -> ok after 0 -> ok end. +%%-------------------------------------------------------------------- +%% Replay or Retry Delivery +%%-------------------------------------------------------------------- + +%% Redeliver at once if Force is true + +retry_delivery(Force, State = #state{inflight = Inflight}) -> + case Inflight:is_empty() of + true -> State; + false -> Msgs = lists:sort(sortfun(inflight), Inflight:values()), + retry_delivery(Force, Msgs, os:timestamp(), State) + end. + +retry_delivery(_Force, [], _Now, State = #state{retry_interval = Interval}) -> + State#state{retry_timer = start_timer(Interval, retry_delivery)}; + +retry_delivery(Force, [{Type, Msg, Ts} | Msgs], Now, + State = #state{inflight = Inflight, + retry_interval = Interval}) -> + Diff = timer:now_diff(Now, Ts) div 1000, %% micro -> ms + if + Force orelse (Diff >= Interval) -> + case {Type, Msg} of + {publish, Msg = #mqtt_message{pktid = PacketId}} -> + redeliver(Msg, State), + Inflight1 = Inflight:update(PacketId, {publish, Msg, Now}), + retry_delivery(Force, Msgs, Now, State#state{inflight = Inflight1}); + {pubrel, PacketId} -> %% remove 'pubrel' directly? + retry_delivery(Force, Msgs, Now, State#state{inflight = Inflight:delete(PacketId)}) + end; + true -> + State#state{retry_timer = start_timer(Interval - Diff, retry_delivery)} + end. + +%%-------------------------------------------------------------------- +%% Expire Awaiting Rel +%%-------------------------------------------------------------------- + +expire_awaiting_rel(State = #state{awaiting_rel = AwaitingRel}) -> + case maps:size(AwaitingRel) of + 0 -> State; + _ -> Msgs = lists:sort(sortfun(awaiting_rel), maps:to_list(AwaitingRel)), + expire_awaiting_rel(Msgs, os:timestamp(), State) + end. + +expire_awaiting_rel([], _Now, State) -> + State#state{await_rel_timer = undefined}; + +expire_awaiting_rel([{PacketId, #mqtt_message{timestamp = TS}} | Msgs], + Now, State = #state{awaiting_rel = AwaitingRel, + await_rel_timeout = Timeout}) -> + case (timer:now_diff(Now, TS) div 1000) of + Diff when Diff >= Timeout -> + expire_awaiting_rel(Msgs, Now, State#state{awaiting_rel = maps:remove(PacketId, AwaitingRel)}); + Diff -> + State#state{await_rel_timer = start_timer(Timeout - Diff, check_awaiting_rel)} + end. + +%%-------------------------------------------------------------------- +%% Sort Inflight, AwaitingRel +%%-------------------------------------------------------------------- + +sortfun(inflight) -> + fun({_, _, Ts1}, {_, _, Ts2}) -> Ts1 < Ts2 end; + +sortfun(awaiting_rel) -> + fun({_, #mqtt_message{timestamp = Ts1}}, + {_, #mqtt_message{timestamp = Ts2}}) -> + Ts1 < Ts2 + end. + +%%-------------------------------------------------------------------- +%% Check awaiting rel +%%-------------------------------------------------------------------- + +is_awaiting_full(#state{max_awaiting_rel = 0}) -> + false; +is_awaiting_full(#state{awaiting_rel = AwaitingRel, max_awaiting_rel = MaxLen}) -> + maps:size(AwaitingRel) >= MaxLen. + %%-------------------------------------------------------------------- %% Dispatch Messages %%-------------------------------------------------------------------- -%% Queue message if client disconnected -dispatch(Msg, Session = #session{client_pid = undefined, message_queue = Q}) -> - hibernate(Session#session{message_queue = emqttd_mqueue:in(Msg, Q)}); +%% Enqueue message if the client has been disconnected +dispatch(Msg, State = #state{client_pid = undefined}) -> + enqueue_msg(Msg, State); %% Deliver qos0 message directly to client -dispatch(Msg = #mqtt_message{qos = ?QOS0}, Session = #session{client_pid = ClientPid}) -> - ClientPid ! {deliver, Msg}, - hibernate(Session); +dispatch(Msg = #mqtt_message{qos = ?QOS0}, State) -> + deliver(Msg, State), State; -dispatch(Msg = #mqtt_message{qos = QoS}, Session = #session{message_queue = MsgQ}) +dispatch(Msg = #mqtt_message{qos = QoS}, + State = #state{next_msg_id = MsgId, inflight = Inflight}) when QoS =:= ?QOS1 orelse QoS =:= ?QOS2 -> - case check_inflight(Session) of + case Inflight:is_full() of true -> - noreply(deliver(Msg, Session)); + enqueue_msg(Msg, State); false -> - hibernate(Session#session{message_queue = emqttd_mqueue:in(Msg, MsgQ)}) + Msg1 = Msg#mqtt_message{pktid = MsgId}, + deliver(Msg1, State), + await(Msg1, next_msg_id(State)) end. -tune_qos(Topic, Msg = #mqtt_message{qos = PubQos}, SubMap) -> +enqueue_msg(Msg, State = #state{mqueue = Q}) -> + inc(enqueue_msg), State#state{mqueue = emqttd_mqueue:in(Msg, Q)}. + +%%-------------------------------------------------------------------- +%% Deliver +%%-------------------------------------------------------------------- + +redeliver(Msg = #mqtt_message{qos = QoS}, State) -> + deliver(Msg#mqtt_message{dup = if QoS =:= ?QOS2 -> false; true -> true end}, State). + +deliver(Msg, #state{client_pid = Pid}) -> + inc(deliver_msg), Pid ! {deliver, Msg}. + +%%-------------------------------------------------------------------- +%% Awaiting ACK for QoS1/QoS2 Messages +%%-------------------------------------------------------------------- + +await(Msg = #mqtt_message{pktid = PacketId}, + State = #state{inflight = Inflight, + retry_timer = RetryTimer, + retry_interval = Interval}) -> + %% Start retry timer if the Inflight is still empty + State1 = ?IF(RetryTimer == undefined, State#state{retry_timer = start_timer(Interval, retry_delivery)}, State), + State1#state{inflight = Inflight:insert(PacketId, {publish, Msg, os:timestamp()})}. + +acked(puback, PacketId, State = #state{client_id = ClientId, + username = Username, + inflight = Inflight}) -> + {publish, Msg, _Ts} = Inflight:lookup(PacketId), + emqttd_hooks:run('message.acked', [ClientId, Username], Msg), + State#state{inflight = Inflight:delete(PacketId)}; + +acked(pubrec, PacketId, State = #state{client_id = ClientId, + username = Username, + inflight = Inflight}) -> + {publish, Msg, _Ts} = Inflight:lookup(PacketId), + emqttd_hooks:run('message.acked', [ClientId, Username], Msg), + State#state{inflight = Inflight:update(PacketId, {pubrel, PacketId, os:timestamp()})}; + +acked(pubcomp, PacketId, State = #state{inflight = Inflight}) -> + State#state{inflight = Inflight:delete(PacketId)}. + +%%-------------------------------------------------------------------- +%% Dequeue +%%-------------------------------------------------------------------- + +%% Do nothing if client is disconnected +dequeue(State = #state{client_pid = undefined}) -> + State; + +dequeue(State = #state{inflight = Inflight}) -> + case Inflight:is_full() of + true -> State; + false -> dequeue2(State) + end. + +dequeue2(State = #state{mqueue = Q}) -> + case emqttd_mqueue:out(Q) of + {empty, _Q} -> + State; + {{value, Msg}, Q1} -> + %% Dequeue more + dequeue(dispatch(Msg, State#state{mqueue = Q1})) + end. + +%%-------------------------------------------------------------------- +%% Tune QoS +%%-------------------------------------------------------------------- + +tune_qos(Topic, Msg = #mqtt_message{qos = PubQoS}, + #state{subscriptions = SubMap, upgrade_qos = UpgradeQoS}) -> case maps:find(Topic, SubMap) of - {ok, SubQos} when PubQos > SubQos -> - Msg#mqtt_message{qos = SubQos}; - {ok, _SubQos} -> + {ok, SubQoS} when UpgradeQoS andalso (SubQoS > PubQoS) -> + Msg#mqtt_message{qos = SubQoS}; + {ok, SubQoS} when (not UpgradeQoS) andalso (SubQoS < PubQoS) -> + Msg#mqtt_message{qos = SubQoS}; + {ok, _} -> Msg; error -> Msg end. %%-------------------------------------------------------------------- -%% Check inflight and awaiting_rel +%% Next Msg Id %%-------------------------------------------------------------------- -check_inflight(#session{max_inflight = 0}) -> - true; -check_inflight(#session{max_inflight = Max, inflight_queue = Q}) -> - Max > length(Q). +next_msg_id(State = #state{next_msg_id = 16#FFFF}) -> + State#state{next_msg_id = 1}; -check_awaiting_rel(#session{max_awaiting_rel = 0}) -> - true; -check_awaiting_rel(#session{awaiting_rel = AwaitingRel, - max_awaiting_rel = MaxLen}) -> - maps:size(AwaitingRel) < MaxLen. +next_msg_id(State = #state{next_msg_id = Id}) -> + State#state{next_msg_id = Id + 1}. %%-------------------------------------------------------------------- -%% Dequeue and Deliver +%% Emit session stats %%-------------------------------------------------------------------- -dequeue(Session = #session{client_pid = undefined}) -> - %% do nothing if client is disconnected - Session; +maybe_enable_stats(State = #state{enable_stats = false}) -> + State; +maybe_enable_stats(State = #state{client_pid = Pid}) when is_pid(Pid) -> + State; +maybe_enable_stats(State = #state{enable_stats = Interval}) -> + StatsTimer = start_timer(Interval, emit_stats), + State#state{stats_timer = StatsTimer}. -dequeue(Session) -> - case check_inflight(Session) of - true -> dequeue2(Session); - false -> Session - end. - -dequeue2(Session = #session{message_queue = Q}) -> - case emqttd_mqueue:out(Q) of - {empty, _Q} -> - Session; - {{value, Msg}, Q1} -> - %% dequeue more - dequeue(deliver(Msg, Session#session{message_queue = Q1})) - end. - -deliver(Msg = #mqtt_message{qos = ?QOS_0}, Session = #session{client_pid = ClientPid}) -> - ClientPid ! {deliver, Msg}, Session; - -deliver(Msg = #mqtt_message{qos = QoS}, Session = #session{packet_id = PktId, - client_pid = ClientPid, - inflight_queue = InflightQ}) - when QoS =:= ?QOS_1 orelse QoS =:= ?QOS_2 -> - Msg1 = Msg#mqtt_message{pktid = PktId, dup = false}, - ClientPid ! {deliver, Msg1}, - await(Msg1, next_packet_id(Session#session{inflight_queue = [{PktId, Msg1}|InflightQ]})). - -redeliver(Msg = #mqtt_message{qos = ?QOS_0}, Session) -> - deliver(Msg, Session); - -redeliver(Msg = #mqtt_message{qos = QoS}, Session = #session{client_pid = ClientPid}) - when QoS =:= ?QOS_1 orelse QoS =:= ?QOS_2 -> - ClientPid ! {deliver, Msg#mqtt_message{dup = true}}, - await(Msg, Session). +emit_stats(State = #state{enable_stats = false}) -> + State; +emit_stats(State = #state{client_id = ClientId}) -> + emqttd_stats:set_session_stats(ClientId, stats(State)), + State. %%-------------------------------------------------------------------- -%% Awaiting ack for qos1, qos2 message -%%------------------------------------------------------------------------------ -await(#mqtt_message{pktid = PktId}, Session = #session{awaiting_ack = Awaiting, - retry_interval = Timeout}) -> - TRef = timer(Timeout, {timeout, awaiting_ack, PktId}), - Awaiting1 = maps:put(PktId, TRef, Awaiting), - Session#session{awaiting_ack = Awaiting1}. +%% Helper functions +%%-------------------------------------------------------------------- -acked(PktId, Session = #session{client_id = ClientId, - username = Username, - inflight_queue = InflightQ, - awaiting_ack = Awaiting}) -> - case lists:keyfind(PktId, 1, InflightQ) of - {_, Msg} -> - emqttd:run_hooks('message.acked', [ClientId, Username], Msg); - false -> - ?LOG(error, "Cannot find acked pktid: ~p", [PktId], Session) - end, - Session#session{awaiting_ack = maps:remove(PktId, Awaiting), - inflight_queue = lists:keydelete(PktId, 1, InflightQ)}. +inc(Key) -> put(Key, get(Key) + 1). -next_packet_id(Session = #session{packet_id = 16#ffff}) -> - Session#session{packet_id = 1}; - -next_packet_id(Session = #session{packet_id = Id}) -> - Session#session{packet_id = Id + 1}. - -timer(TimeoutSec, TimeoutMsg) -> - erlang:send_after(timer:seconds(TimeoutSec), self(), TimeoutMsg). - -cancel_timer(undefined) -> - undefined; -cancel_timer(Ref) -> - catch erlang:cancel_timer(Ref). +reply(Reply, State) -> + {reply, Reply, State}. noreply(State) -> {noreply, State}. @@ -680,29 +817,3 @@ hibernate(State) -> shutdown(Reason, State) -> {stop, {shutdown, Reason}, State}. -start_collector(Session = #session{collect_interval = 0}) -> - Session; - -start_collector(Session = #session{collect_interval = Interval}) -> - TRef = erlang:send_after(timer:seconds(Interval), self(), collect_info), - Session#session{collect_timer = TRef}. - -sess_info(#session{clean_sess = CleanSess, - inflight_queue = InflightQueue, - max_inflight = MaxInflight, - message_queue = MessageQueue, - awaiting_rel = AwaitingRel, - awaiting_ack = AwaitingAck, - awaiting_comp = AwaitingComp, - timestamp = CreatedAt}) -> - Stats = emqttd_mqueue:stats(MessageQueue), - [{clean_sess, CleanSess}, - {max_inflight, MaxInflight}, - {inflight_queue, length(InflightQueue)}, - {message_queue, get_value(len, Stats)}, - {message_dropped,get_value(dropped, Stats)}, - {awaiting_rel, maps:size(AwaitingRel)}, - {awaiting_ack, maps:size(AwaitingAck)}, - {awaiting_comp, maps:size(AwaitingComp)}, - {created_at, CreatedAt}]. - From a5ba86fd1a9b845ab87799f5032db7df94160704 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:46:21 +0800 Subject: [PATCH 31/34] Update rebar.config --- rebar.config | 5 +---- src/emqttd_router.erl | 2 +- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/rebar.config b/rebar.config index af42c962a..3ac69aea2 100644 --- a/rebar.config +++ b/rebar.config @@ -1,7 +1,4 @@ {deps, [ - {gproc,".*",{git,"https://github.com/uwiger/gproc",""}}, - {lager,".*",{git,"https://github.com/basho/lager","master"}}, - {esockd,".*",{git,"https://github.com/emqtt/esockd","master"}}, - {mochiweb,".*",{git,"https://github.com/emqtt/mochiweb",""}} +{gproc,".*",{git,"https://github.com/uwiger/gproc",""}},{lager,".*",{git,"https://github.com/basho/lager","master"}},{esockd,".*",{git,"https://github.com/emqtt/esockd","master"}},{mochiweb,".*",{git,"https://github.com/emqtt/mochiweb",""}} ]}. {erl_opts, [{parse_transform,lager_transform}]}. diff --git a/src/emqttd_router.erl b/src/emqttd_router.erl index e0e3962a2..6894ea528 100644 --- a/src/emqttd_router.erl +++ b/src/emqttd_router.erl @@ -1,5 +1,5 @@ %%-------------------------------------------------------------------- -%% Copyright (c) 2012-2017 Feng Lee . +%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io) %% %% Licensed under the Apache License, Version 2.0 (the "License"); %% you may not use this file except in compliance with the License. From fde1f92bf2031ca3d74b70cad23fcf1b31cada85 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 11:49:59 +0800 Subject: [PATCH 32/34] Fix format of CT_SUITES --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 4355cc413..3711319dd 100644 --- a/Makefile +++ b/Makefile @@ -25,8 +25,8 @@ EUNIT_OPTS = verbose # EUNIT_ERL_OPTS = CT_SUITES = emqttd emqttd_access emqttd_lib emqttd_inflight emqttd_mod \ - emqttd_net emqttd_mqueue emqttd_protocol emqttd_topic \ - emqttd_trie emqttd_vm + emqttd_net emqttd_mqueue emqttd_protocol emqttd_topic \ + emqttd_trie emqttd_vm CT_OPTS = -cover test/ct.cover.spec -erl_args -name emqttd_ct@127.0.0.1 From 5419266724a1ce28c42a75d6db76414e31df56c7 Mon Sep 17 00:00:00 2001 From: turtled Date: Thu, 16 Feb 2017 18:33:57 +0800 Subject: [PATCH 33/34] emqttd_hook -> emqttd_hooks, syslog --- Makefile | 3 ++- src/emqttd_app.erl | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 3711319dd..1447dd30c 100644 --- a/Makefile +++ b/Makefile @@ -2,13 +2,14 @@ PROJECT = emqttd PROJECT_DESCRIPTION = Erlang MQTT Broker PROJECT_VERSION = 2.1 -DEPS = gproc lager esockd mochiweb +DEPS = gproc lager esockd mochiweb lager_syslog dep_gproc = git https://github.com/uwiger/gproc dep_getopt = git https://github.com/jcomellas/getopt v0.8.2 dep_lager = git https://github.com/basho/lager master dep_esockd = git https://github.com/emqtt/esockd master dep_mochiweb = git https://github.com/emqtt/mochiweb +dep_lager_syslog = git https://github.com/basho/lager_syslog ERLC_OPTS += +'{parse_transform, lager_transform}' diff --git a/src/emqttd_app.erl b/src/emqttd_app.erl index 6f758b870..992e22da6 100644 --- a/src/emqttd_app.erl +++ b/src/emqttd_app.erl @@ -72,7 +72,7 @@ print_vsn() -> start_servers(Sup) -> Servers = [{"emqttd ctl", emqttd_ctl}, - {"emqttd hook", emqttd_hook}, + {"emqttd hook", emqttd_hooks}, {"emqttd router", emqttd_router}, {"emqttd pubsub", {supervisor, emqttd_pubsub_sup}}, {"emqttd stats", emqttd_stats}, From 726f829df5d68d4be2559085e66fb466ec28a9d0 Mon Sep 17 00:00:00 2001 From: Feng Lee Date: Thu, 16 Feb 2017 18:59:53 +0800 Subject: [PATCH 34/34] Fix the error caused by emqttd:env/1 --- src/emqttd_ws_client_sup.erl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/emqttd_ws_client_sup.erl b/src/emqttd_ws_client_sup.erl index 60e1461b7..1375ac036 100644 --- a/src/emqttd_ws_client_sup.erl +++ b/src/emqttd_ws_client_sup.erl @@ -39,7 +39,7 @@ start_client(WsPid, Req, ReplyChannel) -> %%-------------------------------------------------------------------- init([]) -> - Env = lists:append(emqttd:env(client), emqttd:env(protocol)), + Env = lists:append(emqttd:env(client, []), emqttd:env(protocol, [])), {ok, {{simple_one_for_one, 0, 1}, [{ws_client, {emqttd_ws_client, start_link, [Env]}, temporary, 5000, worker, [emqttd_ws_client]}]}}.