Mosquitto pub/sub服务实现代码浅析-主体框架

Mosquitto是一个IBM 开源pub/sub订阅发布协议MQTT的一个单机版实现（目前也只有单机版），MQTT主打轻便，比较适用于移动设备等上面，花费流量少，解析代价低。相对于XMPP等来说，简单许多。

MQTT采用二进制协议，而不是XMPP的XML协议，所以一般消息甚至只需要花费2个字节的大小就可以交换信息了，对于移动开发比较有优势。

IBM虽然开源了其MQTT消息协议，但是却没有开源其RSMB服务端程序，不过还好目前有比较稳定的实现可用，本文的Mosquitto是其中比较活跃的实现之一，具体在这里有目前的实现列表可供选择。

趁着大脑还没有进入睡眠状态记录一下刚才看代码学到的东西。我下载的版本是1.2.2版，在这里可以找到下载链接。

零、介绍

关于MQTT 3.1协议本身比较简单，42页的PDF介绍完了，相比XMPP那长长的文档，谢天谢地了。由于刚看，所以很多细节都没有深入进去，这里只是记录个大概，后续有时间慢慢补好坑吧。

总体来说，mosquitto实现有如下几个特点：

1. poll()异步模型，竟然不是epoll，也许这注定了其只能支持十几万连接同时在线的悲剧吧。
2. 内存处理方面几乎没有任何优化，但简单可依赖；
3. 多线程程序，许多地方都得加锁访问。但其实多线程的需求没那么强烈，可以考虑避免；

总之，是一个比较简单单可以适用于一般的服务中提供pub/sub功能支持，但如果放到大量并发的系统中，可以优化的地方还有很多。关于mosquitto的性能，暂时没有找到官方的评测，不过在邮件组里面找到的一些讨论似乎显示其性能上限为20W连接时在线的状态，当然具体取决于业务逻辑，交互是否很多等。不过这样的成绩还是不错的。一台机器可以起多个实例的嘛。

---

一、初始化

mosquitto.c文件main开头调用_mosquitto_net_init初始化SSL加密的库，然后调用mqtt3_config_init初始化配置的各个数据结构为默认值。配置文件的解析由mqtt3_config_parse_args牵头完成，具体配置文件解析就不多写了，fgets一行行的读取配置，然后设置到config全局变量中。其中包括对于监听地址等的读取。

然后保存pid进程号。mqtt3_db_open打开db文件

1int main(int argc, char *argv[])

2{

3 

4    memset(&int_db, 0, sizeof(struct mosquitto_db));

5 

6    _mosquitto_net_init();

7 

8    mqtt3_config_init(&config);

9    rc = mqtt3_config_parse_args(&config, argc, argv);//k: init && load config file, set struct members

配置读取完后，就可以打开监听端口了，使用mqtt3_socket_listen打开监听端口，并将SOCK套接字放在局部变量listensock里面，以便后面统一使用。

1listener_max = -1;

2listensock_index = 0;

3for(i=0; i<config.listener_count; i++){

4    if(mqtt3_socket_listen(&config.listeners[i])){

5        _mosquitto_free(int_db.contexts);

6        mqtt3_db_close(&int_db);

7        if(config.pid_file){

8            remove(config.pid_file);

9        }

10        return 1;

11    }

12    listensock_count += config.listeners[i].sock_count;

13    listensock = _mosquitto_realloc(listensock, sizeof(int)*listensock_count);

14    if(!listensock){

15        _mosquitto_free(int_db.contexts);

16        mqtt3_db_close(&int_db);

17        if(config.pid_file){

18            remove(config.pid_file);

19        }

20        return 1;

21    }

22    for(j=0; j<config.listeners[i].sock_count; j++){

23        if(config.listeners[i].socks[j] == INVALID_SOCKET){

24            _mosquitto_free(int_db.contexts);

25            mqtt3_db_close(&int_db);

26            if(config.pid_file){

27                remove(config.pid_file);

28            }

29            return 1;

30        }

31        listensock[listensock_index] = config.listeners[i].socks[j];

32        if(listensock[listensock_index] > listener_max){

33            listener_max = listensock[listensock_index];

34        }

35        listensock_index++;

36    }

37}

关于mqtt3_socket_listen函数也比较经典，socket(),bind(), listen()的流程，不同的是使用了新版的套接字信息获取函数getaddrinfo，该函数支持IPV4和IPV6，对应用层透明，不需要处理这些信息。

1int mqtt3_socket_listen(struct _mqtt3_listener *listener)

2{

3    snprintf(service, 10, "%d", listener->port);

4    memset(&hints, 0, sizeof(struct addrinfo));

5    hints.ai_family = PF_UNSPEC;

6    hints.ai_flags = AI_PASSIVE;

7    hints.ai_socktype = SOCK_STREAM;

8 

9    //导致下面返回多个链表节的的因素可能有：

10    //hostname参数关联的地址有多个，那么每个返回一个节点；比如host为域名的时候，nslookup返回几个ip就有几个

11    //service参数指定的服务会吃多个套接字接口类型，那么也返回多个

12    if(getaddrinfo(listener->host, service, &hints, &ainfo)) returnINVALID_SOCKET;

13 

14    listener->sock_count = 0;

15    listener->socks = NULL;

16 

17    for(rp = ainfo; rp; rp = rp->ai_next){

18        //····

19        sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);

20        if(sock == -1){

21            strerror_r(errno, err, 256);

22            _mosquitto_log_printf(NULL, MOSQ_LOG_WARNING, "Warning: %s", err);

23            continue;

24        }

25        listener->sock_count++;

26        listener->socks = _mosquitto_realloc(listener->socks, sizeof(int)*listener->sock_count);

27        if(!listener->socks){

28            _mosquitto_log_printf(NULL, MOSQ_LOG_ERR, "Error: Out of memory.");

29            return MOSQ_ERR_NOMEM;

30        }

31        listener->socks[listener->sock_count-1] = sock;

32        /* Set non-blocking */

33        opt = fcntl(sock, F_GETFL, 0);

34 

35        if(bind(sock, rp->ai_addr, rp->ai_addrlen) == -1){

36            strerror_r(errno, err, 256);

37            _mosquitto_log_printf(NULL, MOSQ_LOG_ERR, "Error: %s", err);

38            COMPAT_CLOSE(sock);

39            return 1;

40        }

41 

42        if(listen(sock, 100) == -1){

43            strerror_r(errno, err, 256);

44            _mosquitto_log_printf(NULL, MOSQ_LOG_ERR, "Error: %s", err);

45            COMPAT_CLOSE(sock);

46            return 1;

47        }

48    }

49    freeaddrinfo(ainfo);

50}

---

二、消息事件循环

打开监听套接字后，就可以进入消息事件循环，标准网络服务程序的必须过程。这个由main函数调用mosquitto_main_loop启动。mosquitto_main_loop函数主体也是一个大循环，在循环里面进行超时检测，事件处理，网络读写等等。由于使用poll模型，所以就需要在进行poll()等待之前准备需要监听的套接字数组列表pollfds，效率低的地方就在这里。

对于监听套接字，简单将其加入pollfds里面，注册POLLIN可读事件即可。如果对于其他跟客户端等的连接，就需要多做一步操作了。如果是桥接模式，进行相应的处理，这里暂时不介绍桥接模式，桥接模式是为了分布式部署加入的非标准协议，目前只有IBM rsmb和mosquitto实现了。

对于跟客户端的连接，mosquitto会在poll等待之前调用mqtt3_db_message_write尝试发送一次未发送的数据给对方，避免不必要的等待可能。

1int mosquitto_main_loop(struct mosquitto_db *db, int *listensock, intlistensock_count, int listener_max)

2{

3        memset(pollfds, -1, sizeof(struct pollfd)*pollfd_count);

4 

5        pollfd_index = 0;

6        for(i=0; i<listensock_count; i++){//注册监听sock的pollfd可读事件。也就是新连接事件

7            pollfds[pollfd_index].fd = listensock[i];

8            pollfds[pollfd_index].events = POLLIN;

9            pollfds[pollfd_index].revents = 0;

10            pollfd_index++;

11        }

12 

13        time_count = 0;

14        for(i=0; i<db->context_count; i++){//遍历每一个客户端连接,尝试将其加入poll数组中

15            if(db->contexts[i]){

16//····

17 

18                    /* Local bridges never time out in this fashion. */

19                    if(!(db->contexts[i]->keepalive)

20                            || db->contexts[i]->bridge

21                            || now - db->contexts[i]->last_msg_in < (time_t)(db->contexts[i]->keepalive)*3/2){

22 

23                        //在进入poll等待之前，先尝试将未发送的数据发送出去

24                        if(mqtt3_db_message_write(db->contexts[i]) == MOSQ_ERR_SUCCESS){

25                            pollfds[pollfd_index].fd = db->contexts[i]->sock;

26                            pollfds[pollfd_index].events = POLLIN | POLLRDHUP;

27                            pollfds[pollfd_index].revents = 0;

28                            if(db->contexts[i]->current_out_packet){

29                                pollfds[pollfd_index].events |= POLLOUT;

30                            }

31                            db->contexts[i]->pollfd_index = pollfd_index;

32                            pollfd_index++;

33                        }else{//尝试发送失败，连接出问题了

34                            mqtt3_context_disconnect(db, db->contexts[i]);

35                        }

36                    }else{//超过1.5倍的时间，超时关闭连接

37                        if(db->config->connection_messages == true){

38                            _mosquitto_log_printf(NULL, MOSQ_LOG_NOTICE, "Client %s has exceeded timeout, disconnecting.", db->co

39ntexts[i]->id);

40                        }

41                        /* Client has exceeded keepalive*1.5 */

42                        mqtt3_context_disconnect(db, db->contexts[i]);//关闭连接，清空数据，后续还可以用.sock=INVALID_SOCKET

43                    }

44                    }else{

45#endif

46                        if(db->contexts[i]->clean_session == true){

47                            //这个连接上次由于什么原因，挂了，设置了clean session，所以这里直接彻底清空其结构

48                            mqtt3_context_cleanup(db, db->contexts[i], true);

49                            db->contexts[i] = NULL;

50                        }else if(db->config->persistent_client_expiration > 0){

51                            //协议规定persistent_client的状态必须永久保存，这里避免连接永远无法删除，增加这个超时选项。

52                            //也就是如果一个客户端断开连接一段时间了，那么我们会主动干掉他

53                            /* This is a persistent client, check to see if the

54                             * last time it connected was longer than

55                             * persistent_client_expiration seconds ago. If so,

56                             * expire it and clean up.

57                             */

58                            if(now > db->contexts[i]->disconnect_t+db->config->persistent_client_expiration){

59                                _mosquitto_log_printf(NULL, MOSQ_LOG_NOTICE, "Expiring persistent client %s due to timeout.", db-

60>contexts[i]->id);

61#ifdef WITH_SYS_TREE

62                                g_clients_expired++;

63#endif

64                                db->contexts[i]->clean_session = true;

65                                mqtt3_context_cleanup(db, db->contexts[i], true);

66                                db->contexts[i] = NULL;

67                            }

68                        }

69#ifdef WITH_BRIDGE

70                    }

然后先使用mqtt3_db_message_timeout_check检测一下超时没有收到客户端回包确认的消息，mosquitto对于超时的消息处理，是会进行重发的。不过理论上，TCP是不需要重发的，具体见这里：MQTT消息推送协议应用数据包超时是否需要重发？ 不过，由于mosquitto对于客户端断开连接的处理比较弱，连接重新建立后，使用的相关数据结构还是相同的，因此重发其实也可以，只是这个时候的重发，实际上是在一个连接上没有收到ACK回包，然后后续建立的新连接上进行重传。不是在一个连接上重传。但是这样其实也有很多弊端，比如客户端必须支持消息的持久化记录，否则容易双方对不上话的情况。

1int mqtt3_db_message_timeout_check(struct mosquitto_db *db, unsigned int timeout)

2{//循环遍历每一个连接的每个消息msg,看起是否超时，如果超时，将消息状态改为上一个状态，从而后续触发重发

3    int i;

4    time_t threshold;

5    enum mosquitto_msg_state new_state = mosq_ms_invalid;

6    struct mosquitto *context;

7    struct mosquitto_client_msg *msg;

8 

9    threshold = mosquitto_time() - timeout;

10 

11    for(i=0; i<db->context_count; i++){//遍历每一个连接，

12        context = db->contexts[i];

13        if(!context) continue;

14 

15        msg = context->msgs;

16        while(msg){//遍历每个msg消息，看看其状态，如果超时了，那么从上一个消息开始重发.其实不需要重发http://chenzhenianqing.cn/ar

17ticles/977.html

18            //当然如果这个是复用了之前断开过的连接，那就需要重发。但是，这个时候其实可以重发整个消息的。不然容易出问题，客户端难>

19度大

20            if(msg->timestamp < threshold && msg->state != mosq_ms_queued){

21                switch(msg->state){

22                    case mosq_ms_wait_for_puback:

23                        new_state = mosq_ms_publish_qos1;

24                        break;

25                    case mosq_ms_wait_for_pubrec:

26                        new_state = mosq_ms_publish_qos2;

27                        break;

28                    case mosq_ms_wait_for_pubrel:

29                        new_state = mosq_ms_send_pubrec;

30                        break;

31                    case mosq_ms_wait_for_pubcomp:

32                        new_state = mosq_ms_resend_pubrel;

33                        break;

34                    default:

35                        break;

36                }

37                if(new_state != mosq_ms_invalid){

38                    msg->timestamp = mosquitto_time();//设置当前时间，下次依据来判断超时

超时提前检测完成后就可以进入poll等待了。等待完成后，对于有可读事件的连接，调用loop_handle_reads_writes进行事件读写处理，对于监听端口的事件，使用mqtt3_socket_accept去接受新连接。

loop_handle_reads_writes新事件处理函数比较简单，主体还是循环判断可读可写事件，进行相应的处理。具体不多介绍了，需要关注的是由于是异步读写，所以需要记录上次读写状态，以便下次进入上下午继续读取数据。可写事件由_mosquitto_packet_write完成，可读事件由_mosquitto_packet_read完成。

新客户端连接的事件则由qtt3_socket_accept完成，其会将新连接放在db->contexts[i]数组的某个空位置，每次都会遍历寻找一个空的槽位放新连接。这里有个小优化其实就是用hints的机制，记录上次的查找位置，避免多次重复的从前面找到后面。

连接读写事件处理完成后，mosquitto会检测是否需要重新reload部分配置文件。这个由SIGHUP的信号触发。

限于篇幅，具体的逻辑请求处理下次再介绍了。

三、总结

mosquitto是一个简单可依赖的开源MQTT实现，能支持10W左右的同时在线（未亲测），单机版本，但通过bridge桥接模式支持部分分布式，但有限；协议本身非常适合在移动设备上使用，耗电少，处理快，属于header上带有消息体长度的协议，这个在异步网络事件代码编写时是码农最爱的，哈哈。

对于后续的提高优化的地方，简单记录几点：

1. 发送数据用writev
2. poll -> epoll ，用以支持更高的冰法；
3. 改为单线程版本，降低锁开销，目前锁开销还是非常大的。目测可以改为单进程版本，类似redis，精心维护的话应该能达到不错的效果；
4. 网络数据读写使用一次尽量多读的方式，避免多次进入系统调用；
5. 内存操作优化。不free，留着下次用；
6. 考虑使用spwan-fcgi的形式或者内置一次启动多个实例监听同一个端口。这样能更好的发挥机器性能，达到更高的性能；

初步接触mosquitto &&　MQTT协议，弄错的地方大家指正一下。