记录一次protobuf 段错误的bug

此bug不具典型性，仅为个人开发笔记。

概况

在项目中使用了protobuf作为数据序列化以及消息体传输的协议。
开发过程中发现一崩溃bug与protobuf有关。

bug表现

简洁描述如下：

1. 定义了一个protobuf的message，假设为 P.proto。

syntax = "proto3";
package cicv.routing;
message Waypoint {
   string id = 1;
   double s = 2;
}
message RoutingRequest {
  repeated Waypoint waypoint = 1;
}
}

2. 在A.cpp中使用了P.proto中的RoutingRequest。

#include "google/protobuf/util/json_util.h"
#include "RoutingRequest.pb.h"
std::string A:fun{
  ...
  cicv::routing RoutingRequest routing_request;
  auto waypoint = routing_request.add_waypoint(); 
  ....
  std::string json;
  google::protobuf::util::MessageToJsonString(routing_request, &json);
  return json;
}

bug表现为，在A::fun{}执行完毕，析构栈对象routing_request时崩溃。经过跟踪，是在析构其成员变量waypoint时错误。尝试了很多种写法，总结下来就是，只要在A::fun{}中调用了routing_request动态创建对象 的方法，在A::fun{}结束后析构routing_request就没办法析构创建的对象。

3. 遂尝试了另外一种写法：
   新增创建了B.cpp，其中定义了classB。

#include "RoutingRequest.pb.h"
string A::fun{
//改为完全在B中构建json
cicv::routing RoutingRequest routing_request;
B b;
return b.BuildJson(&routing_request); 
}

B.cpp

std::string B::BuildJson( cicv::routing RoutingRequest* request){
  std::string json;
  auto waypoint = routing_request.add_waypoint(); 
  ....
  google::protobuf::util::MessageToJsonString(routing_request, &json);
  return json;
}

也就是改成了在class B中调用add_waypoint()。神奇的是， 此时A::fun{}结束后能正常析构栈对象routing_request了。

解决

1. 初步估计是内存错误，经过跟踪，确实发现在析构routing_request时，其中记录的waypoint的地址完全错误。
2. 确认protobuf版本对应正确，排除protobuf库版本与proto c++文件不对应的可能。
3. 确认正确依赖了 pthread.so。不依赖此库protobuf同样会产生奇怪的问题。
4. 确认protobuf库与程序库采用同样的编译工具链以及编译参数。
5. 重新构建了一个简单的测试工程尝试以上写法，未发现bug，排除了protobuf使用方式的问题。
6. 重新思考bug，浏览了A.cpp 依赖的所有头文件，在其中一个头文件中发现了以下语句

#pragma pack(4)
... 

此编译语句为了告诉编译器采用4字节对齐，此语句与内存相关！

7. 搜索了pragma pack的详细用法，发现pragma pack应该成对使用，在不需要修改对齐字节后，应取消。
   隧在文件末尾添加#pragma pack()，修改回编译器默认的字节对齐！

#pragma pack(4)
...
#pragma pack()

8. Bug解决了。。。

总结：

1. 尽量不要在代码中涉及编译指令，很不方便问题定位。
2. 与内存相关的指令更应注意。