源码初识——对webbench网站压力测试源码的初步分析

源码初识——对webbench网站压力测试源码的初步分析

本人技术一直处于飘忽不定的状态，虽然一直断断续续在学习提高，但是水平成长很慢，后来觉得应该看看别人的源码，来理解别人的工程方式，于是看了一些源码，结果发现工程太难，完全不知道它们在说什么，差点因此放弃了技术的道路。直到后来在工作中用到网站压力测试的工具，当我下下来这个源码的时候，发现源文件特别小，于是又勾起了看看它源码的兴趣，于是用了半天多一点的时间，拜读了一下整个源码。整个分析过程如下：

• 从main函数内部结构开始
• 阅读方法
• 总结

---

从main函数开始

  先来看看整个函数组成部份

从上图可以看出，前面的部分全部是为了后面bench函数服务。而本之前的这种命令选项处理机制是十分经典的，以及之后建立请求信息的过程也是让人们使用其命令的时候倍感舒服轻松的原因。

一. 打印帮助信息
对于这个工具而言，如果输入的命令格式有误，则无法正确工作，所以在用户输入错误选项参数或者缺少输入时，便要给用户提供最基本的帮助信息。于是在最开始，所有命令源代码都是提供一个帮助源码。本源码的帮助源码如下：

static void usage(void){
         fprintf(stderr,
    "webbench [option]... URL\n"
    "  -f|--force               Don't wait for reply from server.\n"
    "  -r|--reload              Send reload request - Pragma: no-cache.\n"
    "  -t|--time <sec>          Run benchmark for <sec> seconds. Default 30.\n"
    "  -p|--proxy <server:port> Use proxy server for request.\n"
    "  -c|--clients <n>         Run <n> HTTP clients at once. Default one.\n"
    "  -9|--http09              Use HTTP/0.9 style requests.\n"
    "  -1|--http10              Use HTTP/1.0 protocol.\n"
    "  -2|--http11              Use HTTP/1.1 protocol.\n"
    "  --get                    Use GET request method.\n"
    "  --head                   Use HEAD request method.\n"
    "  --options                Use OPTIONS request method.\n"
    "  --trace                  Use TRACE request method.\n"
    "  -?|-h|--help             This information.\n"
    "  -V|--version             Display program version.\n"
    );
};

---

二. 对长参数进行处理
从上文源码可以看出本工具除了对简单的短选项进行操作，还对长选项进行处理，在这里就运用了一种很是常用的长选项处理函数，废话少说，直接粘代码

while((opt=getopt_long(argc,argv,"912Vfrt:p:c:?h",long_options,&options_index))!=EOF )
 {
  switch(opt)
  {
   case  0 : break;
   case 'f': force=1;break;
   case 'r': force_reload=1;break; 
   case '9': http10=0;break;
   case '1': http10=1;break;
   case '2': http10=2;break;
   case 'V': printf(PROGRAM_VERSION"\n");exit(0);
   case 't': benchtime=atoi(optarg);break;       
   case 'p': 
         /* proxy server parsing server:port */
         tmp=strrchr(optarg,':');
         proxyhost=optarg;
         if(tmp==NULL)
         {
             break;
         }
         if(tmp==optarg)
         {
             fprintf(stderr,"Error in option --proxy %s: Missing hostname.\n",optarg);
             return 2;
         }
         if(tmp==optarg+strlen(optarg)-1)
         {
             fprintf(stderr,"Error in option --proxy %s Port number is missing.\n",optarg);
             return 2;
         }
         *tmp='\0';
         proxyport=atoi(tmp+1);break;
   case ':':
   case 'h':
   case '?': usage();return 2;break;
   case 'c': clients=atoi(optarg);break;
  }
 }

---

在这里得先说一下函数getlong_opt的参数

1. argc,argv直接就是main函数调用的参数
2. const char *optstring,是选项参数组成的字符串，如果某个字符后有冒号“:”则认为选项后还要求参数
3. const struct option *longopts，指向option结构的数组指针，传入的参数

4. longindex参数一般赋为NULL即可；如果没有设置为NULL，那么它就指向一个变量，这个变量，会被赋值为寻找到的长选项在longopts中的索引值，这可以用于错误诊断

   其中option结构体如下

struct option {
        char *name;
        int has_arg;
        int *flag;
        int val;
        }

• name指针，长选项选项名
• int has_arg,是否有参数，0没有，1需要，2可选
• int *flag，flag为空返回val字段值，flag不空，指向字段填入val，返回0
• int val,flag为空，如果长短选项一致，应该是optstring中的值

---

这个函数的使用方法：

1. 使用前准备两个数据结构，opt string，option结构数组
2. 准备好，调用即可，定义一个index差错也可
3. 正常时，每次调用，便会分析一个选项，返回其短选项值
4. 选项调用完毕，返回－1
5. 若分析时，遇到没有定义的选项，则返回“？”，可供程序员打印参数信息
6. 当处理一个带参数的选项的时候，全局变量optarg会指向参数
   -当分析完所有参数的时，全局变量optind会指向第一个“非选项”位置（对于argv来说）
   根据之前的代码可以看出，通过这个过程，选项参数便会转换成各种变量，便于之后的程序处理，如“－c“ 参数，确定客户端数目，这个在之后fork()复制子进程的过程中，便是子进程的产生个数。

三、是否输入URL判断

 if(optind==argc) {
                      fprintf(stderr,"webbench: Missing URL!\n");
              usage();
              return 2;
                    } 

通过上述代码来判断，这也是利用了上面那个函数变动的那个全局变量。其实这个很容易理解。首先optind这个变量表示的是第一个“非选项“的位置，而argc表示的输入命令时参数个数（包括命令），那么选项的个数便是argc－1，那么当optind指向argc时，便指向的是空位置，便可以认为缺少URL，并打印帮助信息帮助用户来正确的操作。

四、帮助用户补充参数及请求连接消息的建立

其实很多时候，人们不会那么有耐心，看完帮助信息，来正确使用命令。所以还需要帮助用户补充一些必须的参数，或者使用默认参数。而对于用户输入的URL可能有好几种，程序也要能够识别各式各样的结构，这样才能提高兼容性。这段的代码为

if(clients==0) clients=1;
 if(benchtime==0) benchtime=60;
 /* Copyright */
 fprintf(stderr,"Webbench - Simple Web Benchmark "PROGRAM_VERSION"\n"
     "Copyright (c) Radim Kolar 1997-2004, GPL Open Source Software.\n"
     );
 build_request(argv[optind]);

首先便是对客户端数目与socket链接超时时间来帮助用户完成初始化。之后的build_request函数的代码如下：

void build_request(const char *url)
{
  char tmp[10];
  int i;

  bzero(host,MAXHOSTNAMELEN);
  bzero(request,REQUEST_SIZE);

  if(force_reload && proxyhost!=NULL && http10<1) http10=1;
  if(method==METHOD_HEAD && http10<1) http10=1;
  if(method==METHOD_OPTIONS && http10<2) http10=2;
  if(method==METHOD_TRACE && http10<2) http10=2;

  switch(method)
  {
      default:
      case METHOD_GET: strcpy(request,"GET");break;
      case METHOD_HEAD: strcpy(request,"HEAD");break;
      case METHOD_OPTIONS: strcpy(request,"OPTIONS");break;
      case METHOD_TRACE: strcpy(request,"TRACE");break;
  }

  strcat(request," ");

  if(NULL==strstr(url,"://"))
  {
      fprintf(stderr, "\n%s: is not a valid URL.\n",url);
      exit(2);
  }
  if(strlen(url)>1500)
  {
         fprintf(stderr,"URL is too long.\n");
     exit(2);
  }
  if(proxyhost==NULL)
       if (0!=strncasecmp("http://",url,7)) 
       { fprintf(stderr,"\nOnly HTTP protocol is directly supported, set --proxy for others.\n");
             exit(2);
           }
  /* protocol/host delimiter */
  i=strstr(url,"://")-url+3;
  /* printf("%d\n",i); */

  if(strchr(url+i,'/')==NULL) {
                                fprintf(stderr,"\nInvalid URL syntax - hostname don't ends with '/'.\n");
                                exit(2);
                              }
  if(proxyhost==NULL)
  {
   /* get port from hostname */
   if(index(url+i,':')!=NULL &&
      index(url+i,':')<index(url+i,'/'))
   {
       strncpy(host,url+i,strchr(url+i,':')-url-i);
       bzero(tmp,10);
       strncpy(tmp,index(url+i,':')+1,strchr(url+i,'/')-index(url+i,':')-1);
       /* printf("tmp=%s\n",tmp); */
       proxyport=atoi(tmp);
       if(proxyport==0) proxyport=80;
   } else
   {
     strncpy(host,url+i,strcspn(url+i,"/"));
   }
   // printf("Host=%s\n",host);
   strcat(request+strlen(request),url+i+strcspn(url+i,"/"));
  } else
  {
   // printf("ProxyHost=%s\nProxyPort=%d\n",proxyhost,proxyport);
   strcat(request,url);
  }
  if(http10==1)
      strcat(request," HTTP/1.0");
  else if (http10==2)
      strcat(request," HTTP/1.1");
  strcat(request,"\r\n");
  if(http10>0)
      strcat(request,"User-Agent: WebBench "PROGRAM_VERSION"\r\n");
  if(proxyhost==NULL && http10>0)
  {
      strcat(request,"Host: ");
      strcat(request,host);
      strcat(request,"\r\n");
  }
  if(force_reload && proxyhost!=NULL)
  {
      strcat(request,"Pragma: no-cache\r\n");
  }
  if(http10>1)
      strcat(request,"Connection: close\r\n");
  /* add empty line at end */
  if(http10>0) strcat(request,"\r\n"); 
  // printf("Req=%s\n",request);
}

具体流程如下

• http版本确立，通过参数选择什么方法，或者选择版本
• 将方法写入request中，request在http版本确立之前就进行了初始化
  
  • 使用strcpy
    
    • 第一个参数为目的字符串地址，第二个为源字符串地址
• strcat拼接一个空格字符
• 对输入的url进行判断
  
  • 是否为正规的url，strstr（url,”://”）
  • url是否大于1500
• 如果没有提供proxyhost，匹配是否为http，如果不匹配则退出 • 寻找主机、协议分割符
• 判断主机名中止是否为‘／’，若是，则退出
• 定位port，在request后拼接url
• string库的熟练使用
• 拼接版本

五、打印本地信息

 switch(method)
 {
     case METHOD_GET:
     default:
         printf("GET");break;
     case METHOD_OPTIONS:
         printf("OPTIONS");break;
     case METHOD_HEAD:
         printf("HEAD");break;
     case METHOD_TRACE:
         printf("TRACE");break;
 }
 printf(" %s",argv[optind]);
 switch(http10)
 {
     case 0: printf(" (using HTTP/0.9)");break;
     case 2: printf(" (using HTTP/1.1)");break;
 }
 printf("\n");
 if(clients==1) printf("1 client");
 else
   printf("%d clients",clients);

 printf(", running %d sec", benchtime);
 if(force) printf(", early socket close");
 if(proxyhost!=NULL) printf(", via proxy server %s:%d",proxyhost,proxyport);
 if(force_reload) printf(", forcing reload");
 printf(".\n");

六、核心函数bench
准备工作完成，之后就开始主要工作，那就是压力测试。当然，bench最开始还是进行了准备。有的人会问，为什么这个准备不在准备工作的时候就做好呢。实际上，我们之前的准备就是大局上准备好，现在准备就是对某次战斗的准备。人生就是战场，我们随时要准备好进行一次大战，但是我们不可能把任何细节都准备好再迎接一次小的战斗，但我们可以在小的战斗来临的时候再次准备。不要对自己的人生说，我没有准备好，现在开始，直面这操蛋的人生，时刻准备和命运干一架，面对生活中的种种困难，你总会挺过去的。
扯远了，回到主题，我们在这里进行的准备就是先测试一下网站是否可以连接。如果可以连接则创建父子进程之间通信的管道，然后就创建子进程，然后在子进程中连接网站，发送消息；在父进程中读管道数据。具体代码如下：

• 首先，检测是否可连接

static int bench(void)
{
  int i,j,k;    
  pid_t pid=0;
  FILE *f;

  /* check avaibility of target server */
  i=Socket(proxyhost==NULL?host:proxyhost,proxyport);
  if(i<0) { 
       fprintf(stderr,"\nConnect to server failed. Aborting benchmark.\n");
           return 1;
         }
  close(i);

在这里用到了Socket函数，其实就是socket建立连接，这里不详细介绍了。

• 然后是管道建立

  /* create pipe */
  if(pipe(mypipe))
  {
      perror("pipe failed.");
      return 3;
  }

至于为什么用管道，而不用socket或者统一缓存，这个会在之后的文章里提到，现在在这里只要知道管道是用来父子进程通信使用的。

• 然后是创建子进程

/* fork childs */
  for(i=0;i<clients;i++)
  {
       pid=fork();
       if(pid <= (pid_t) 0)
       {
           /* child process or error*/
               sleep(1); /* make childs faster */
           break;
       }
  }

其实对于子进程通过fork创建，网上已经有很多博客都提到了，在这里假设会创建了很多子进程。之后就分为三部分，第一部分就是创建进程失败

if( pid< (pid_t) 0)
  {
          fprintf(stderr,"problems forking worker no. %d\n",i);
      perror("fork failed.");
      return 3;
  }

进程创建失败的原因，一般为系统有太多进程，或者有其它进程不断kill。
第二部分便是子进程部分

if(pid== (pid_t) 0)
  {
    /* I am a child */
    if(proxyhost==NULL)
      benchcore(host,proxyport,request);
         else
      benchcore(proxyhost,proxyport,request);

         /* write results to pipe */
     f=fdopen(mypipe[1],"w");
     if(f==NULL)
     {
         perror("open pipe for writing failed.");
         return 3;
     }
     /* fprintf(stderr,"Child - %d %d\n",speed,failed); */
     fprintf(f,"%d %d %d\n",speed,failed,bytes);
     fclose(f);
     return 0;
  } 

子进程中调用了关键的函数benchcore，这个函数的作用就是连接网站，发送请求，当有多个子进程对同时进行访问的时候，便可以进行了压力测试了。而只要统计发送了多少连接，有多少失败了，有多少成功了便可以简单的进行测试。
而其中的benchcore的源码如下

void benchcore(const char *host,const int port,const char *req)
{
 int rlen;
 char buf[1500];
 int s,i;
 struct sigaction sa;

 /* setup alarm signal handler */
 sa.sa_handler=alarm_handler;
 sa.sa_flags=0;
 if(sigaction(SIGALRM,&sa,NULL))
    exit(3);
 alarm(benchtime);

 rlen=strlen(req);
 nexttry:while(1)
 {
    if(timerexpired)
    {
       if(failed>0)
       {
          /* fprintf(stderr,"Correcting failed by signal\n"); */
          failed--;
       }
       return;
    }
    s=Socket(host,port);                          
    if(s<0) { failed++;continue;} 
    if(rlen!=write(s,req,rlen)) {failed++;close(s);continue;}
    if(http10==0) 
    if(shutdown(s,1)) { failed++;close(s);continue;}
    if(force==0) 
    {
            /* read all available data from socket */
    while(1)
    {
              if(timerexpired) break; 
      i=read(s,buf,1500);
              /* fprintf(stderr,"%d\n",i); */
      if(i<0) 
              { 
                 failed++;
                 close(s);
                 goto nexttry;
              }
       else
       if(i==0) break;
       else
       bytes+=i;
    }
    }
    if(close(s)) {failed++;continue;}
    speed++;
 }
}

第三部分便是父进程

else
  {
      f=fdopen(mypipe[0],"r");
      if(f==NULL) 
      {
          perror("open pipe for reading failed.");
          return 3;
      }
      setvbuf(f,NULL,_IONBF,0);
      speed=0;
          failed=0;
          bytes=0;

      while(1)
      {
          pid=fscanf(f,"%d %d %d",&i,&j,&k);
          if(pid<2)
                  {
                       fprintf(stderr,"Some of our childrens died.\n");
                       break;
                  }
          speed+=i;
          failed+=j;
          bytes+=k;
          /* fprintf(stderr,"*Knock* %d %d read=%d\n",speed,failed,pid); */
          if(--clients==0) break;
      }
      fclose(f);

父进程则进行统计，对于连接数，发送字节，失败数进行统计
最后便是检测结果的打印

 printf("\nSpeed=%d pages/min, %d bytes/sec.\nRequests: %d susceed, %d failed.\n",
          (int)((speed+failed)/(benchtime/60.0f)),
          (int)(bytes/(float)benchtime),
          speed,
          failed);

阅读方法

该源码工程量不大，500多行代码，无论你是从头读到底，还是从main函数一步一步读下去都可以读完，但是我还是觉得从main函数开始，先寻找能贯穿代码前后的线，然后对于遇到不懂的结构体（比较关键的，如option）再查阅，重点理解。对于关键函数，可以详细的读代码，对于不关键的函数，只要了解它是干什么的就可以了。

总结

这是我本人第一次完成源码的阅读，虽然理解的还是很浅显，但是还是作为该博客的处女文发出去吧。平时看别人的博客，感觉写博客也没什么，后来发现，还是挺烦的，不能把自己想说什么就说什么，还是要针对主题。希望我以后能把更多的学习笔记分享出来，大家共同讨论