【Linux】webbench-1.5源码剖析

前言

---

想法来源于博客：http://blog.jobbole.com/79023/
里面说了值得剖析的10C语言开源项目，源码下载链接也有。注意是Linux下的C语言项目，下载完毕后使用解压命令：tar zxvf webbench-1.5.tar.gz解压，解压完毕进入目录切换到root用户安装使用。
1.make
2.make install
此时可能会出现错误提示：
install: cannot create regular file `/usr/local/man/man1’: No such file or directory
这时需要自己进入/usr/local目录下创建man文件，在进入man创建man1，再次执行make install安装完成。

webbench简介

---

Webbench是Linux下的一个网站压力测试工具，最多可以模拟3万个并发连接去测试网站的负载能力. 它是由Lionbridge公司开发。
Webbech 能测试处在相同硬件上，不同服务的性能以及不同硬件上同一个服务的运行状况。
webBech的标准测试可以向我们展示服务器的两项内容：每分钟相应请求次数（paga/min）和每秒钟传输数据量（byte/sec）。

webbench主要的工作原理：
1. 主函数解析命令行参数，进行必要的准备工作，调用build_request设置HTTP请求报文，进入bench开始测压
2. bench函数使用fork模拟出多个客户端，调用socket并发请求，每个子进程记录自己的访问数据，并写入管道
3. 父进程从管道读取子进程的输出信息
4. 使用alarm函数进行时间控制，到时间后会产生SIGALRM信号，调用信号处理函数使子进程停止
5. 最后只留下父进程将所有子进程的输出数据汇总计算，输出到屏幕上 。

基本使用

---

源代码剖析

---

其源码主要位于socket.c和webbench.c两个文件中。如果你有socket编程相关经验，这里的源码很容易看懂。

/****************************socket.c*************************/

//文件相关信息。
/* $Id: socket.c 1.1 1995/01/01 07:11:14 cthuang Exp $
 *
 * This module has been modified by Radim Kolar for OS/2 emx
 */

/***********************************************************************
  module:       socket.c
  program:      popclient
  SCCS ID:      @(#)socket.c    1.5  4/1/94
  programmer:   Virginia Tech Computing Center
  compiler:     DEC RISC C compiler (Ultrix 4.1)
  environment:  DEC Ultrix 4.3 
  description:  UNIX sockets code.
 ***********************************************************************/

#include <sys/types.h>
#include <sys/socket.h>
#include <fcntl.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <netdb.h>
#include <sys/time.h>
#include <string.h>
#include <unistd.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>

int Socket(const char *host, int clientPort)
{
    int sock;
    unsigned long inaddr;
    struct sockaddr_in ad;   //声明一个ipv4地址类型的结构体
    struct hostent *hp;

    memset(&ad, 0, sizeof(ad));
    ad.sin_family = AF_INET;    //设置为流式（TCP协议数据传输方式）

    inaddr = inet_addr(host);  //点分十进制的IP地址转换成网络中传输的二进制表示形式。
    if (inaddr != INADDR_NONE)
        memcpy(&ad.sin_addr, &inaddr, sizeof(inaddr));   //转换后的IP设置进ad结构体。
    else
    {
        hp = gethostbyname(host);
        if (hp == NULL)
            return -1;
        memcpy(&ad.sin_addr, hp->h_addr, hp->h_length);
    }
    ad.sin_port = htons(clientPort);   //设置端口号。

    sock = socket(AF_INET, SOCK_STREAM, 0);   //申请一个套接字
    if (sock < 0)
        return sock;
    if (connect(sock, (struct sockaddr *)&ad, sizeof(ad)) < 0)   //和刚才的ad建立连接。
        return -1;
    return sock;
}

/**************************webbench.c**********************/
/*
 * (C) Radim Kolar 1997-2004
 * This is free software, see GNU Public License version 2 for
 * details.
 *
 * Simple forking WWW Server benchmark:
 *
 * Usage:
 *   webbench --help
 *
 * Return codes:
 *    0 - sucess
 *    1 - benchmark failed (server is not on-line)
 *    2 - bad param
 *    3 - internal error, fork failed
 * 
 */ 
#include "socket.c"
#include <unistd.h>
#include <sys/param.h>
#include <rpc/types.h>
#include <getopt.h>
#include <strings.h>
#include <time.h>
#include <signal.h>

/* values */
volatile int timerexpired=0;    //用来检测测试时长是否达到指定时长
int speed=0;         //记录得到服务器响应的数量
int failed=0;      //记录失败的数量
int bytes=0;    //记录读取成功的字节数
/* globals */
int http10=1; /* 0 - http/0.9, 1 - http/1.0, 2 - http/1.1 */
/* Allow: GET, HEAD, OPTIONS, TRACE */
#define METHOD_GET 0
#define METHOD_HEAD 1
#define METHOD_OPTIONS 2
#define METHOD_TRACE 3
#define PROGRAM_VERSION "1.5"
int method=METHOD_GET;     //设置请求方法为GET
int clients=1;      //默认只有一个客户端访问服务器，可通过-c选项设置客户端数量
int force=0;   //是否需要等待服务器端返回数据，初始化0表示要等待
int force_reload=0;  //是否需要缓存页面，0表示缓存，1表示不缓存
int proxyport=80;  //代理服务器的端口
char *proxyhost=NULL;    //代理服务器的IP
int benchtime=30;    //默认的压力测试时长为30S
/* internal */ 
int mypipe[2];      //声明管道，父进程要从管道里读取子进程的输出信息
char host[MAXHOSTNAMELEN];   //服务器IP
#define REQUEST_SIZE 2048    
char request[REQUEST_SIZE];      //请求报文

static const struct option long_options[]=
{
 {"force",no_argument,&force,1},
 {"reload",no_argument,&force_reload,1},
 {"time",required_argument,NULL,'t'},
 {"help",no_argument,NULL,'?'},
 {"http09",no_argument,NULL,'9'},
 {"http10",no_argument,NULL,'1'},
 {"http11",no_argument,NULL,'2'},
 {"get",no_argument,&method,METHOD_GET},
 {"head",no_argument,&method,METHOD_HEAD},
 {"options",no_argument,&method,METHOD_OPTIONS},
 {"trace",no_argument,&method,METHOD_TRACE},
 {"version",no_argument,NULL,'V'},
 {"proxy",required_argument,NULL,'p'},
 {"clients",required_argument,NULL,'c'},
 {NULL,0,NULL,0}
};

/* prototypes */
static void benchcore(const char* host,const int port, const char *request);
static int bench(void);
static void build_request(const char *url);
//时钟信号的处理函数，webbench采用时钟信号的方式控制对服务端的访问时长，函数中将timerexpired设置为1，执行时检测此变量为1时停止对服务器端的访问。
static void alarm_handler(int signal)
{
   timerexpired=1;
}   
//当命令行参数传入不正确时调用usage函数提示用户怎么用。
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"
    );
};
int main(int argc, char *argv[])
{
 int opt=0;
 int options_index=0;
 char *tmp=NULL;
//使用时没有传参调用usage
 if(argc==1)
 {
      usage();
          return 2;
 } 
//getopt_long是对命令行进行解析的库函数，参数挨个解析，解析完毕会返回-1,可通过man 3 getopy_long查看用法
 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;        //传进来的时长保存给benchtime变量
   case 'p': 
         /* proxy server parsing server:port */
         tmp=strrchr(optarg,':');  //查找冒号在optarg字符串中最后一次出现的位置，实际在找端口号
         proxyhost=optarg;
         if(tmp==NULL)      
         {
             break;
         }
         if(tmp==optarg)           //没有输入IP
         {
             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;   //将端口号存在proxyport变量中
   case ':':
   case 'h':
   case '?': usage();return 2;break;
   case 'c': clients=atoi(optarg);break;   //客户端数量存在clients变量中
  }
 }
 //optind 被 getopt_long 设置为命令行参数中未读取的下一个元素下标值
 if(optind==argc) {
                      fprintf(stderr,"webbench: Missing URL!\n");
              usage();
              return 2;
                    }
//如果指定客户端数量为0，则重新设置为1。
 if(clients==0) clients=1;
//如果指定访问时长为0S，则设置为60S
 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"
     );
//构造http请求
 build_request(argv[optind]);
//以下到函数结束为输出到屏幕的提示信息
 /* print bench info */
 printf("\nBenchmarking: ");
 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函数用来开始压力测试，完成后返回结果
 return bench();
}

void build_request(const char *url)
{
  char tmp[10];
  int i;
//初始化，将指定内存的前n块清零。void bzero(void *s, int n)
  bzero(host,MAXHOSTNAMELEN);
  bzero(request,REQUEST_SIZE);
//判断应该使用的http协议版本
  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," ");
//判断URL合法性
  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);
  }
//判断是否是http协议，webbench只支持http
  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 */
//找到IP/域名开始的位置
  i=strstr(url,"://")-url+3;
  /* printf("%d\n",i); */
//域名或者IP都必须以/作为结束标志
  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 */
//主机加端口的访问方式：eg：http://127.0.0.1:8080/
//char *index(const char *s, int c);index函数返回字符C第一次出现的位置
   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   //没有端口号的访问方式：eg：http://www.baidu.com/
   {
     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);
}

/* vraci system rc error kod */
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);
  /* create pipe */
//创建管道
  if(pipe(mypipe))
  {
      perror("pipe failed.");
      return 3;
  }

  /* not needed, since we have alarm() in childrens */
  /* wait 4 next system clock tick */
  /*
  cas=time(NULL);
  while(time(NULL)==cas)
        sched_yield();
  */

  /* fork childs */
//传进来几个客户端，就fork多少子进程
  for(i=0;i<clients;i++)
  {
       pid=fork();
       if(pid <= (pid_t) 0)
       {
           /* child process or error*/
               sleep(1); /* make childs faster */
           break;  //创建完毕跳出循环，否则创建出来的子进程也会继续fork子进程
       }
  }
//fork失败打印错误消息
  if( pid< (pid_t) 0)
  {
          fprintf(stderr,"problems forking worker no. %d\n",i);
      perror("fork failed.");
      return 3;
  }
//子进程
  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;
  } 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);
  }
  return i;
}

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);   //计时，benchtime时间后产生闹钟信号

 rlen=strlen(req);   //计算请求报文的大小
 nexttry:while(1)
 {
    if(timerexpired)     //闹钟的处理函数会将timerepired变量置为1.
    {
       if(failed>0)
       {
          /* fprintf(stderr,"Correcting failed by signal\n"); */
          failed--;
       }
       return;
    }
    s=Socket(host,port);             //调用socket.c的Socket函数建立tcp连接 ,返回套接字s           
    if(s<0) { failed++;continue;} 
//向服务器端发送请求
    if(rlen!=write(s,req,rlen)) {failed++;close(s);continue;}
//对http0.9做特殊处理
    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);       //从服务器端读数据，保存到buf
              /* 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++;
 }
}

前后总共不到600行代码，却可以完美的对网站进行压力测试，简单却实用。
也许只看注释并不能搞懂整个的框架，我画一个流程图示意一下。