CSAPP:Tiny Web服务器

Web 服务器，一个多么庄严而神圣的名词！没有接触之前，它神秘而不可侵犯；学习研究之后，它又是如此地平易近人。今天，让我们一起走近web服务器。

此时，想像一下，当你自己动手实现了一个服务器时，你会是怎么的兴奋；尤其是将一个真正的浏览器指向我们自己实现的服务器时，看着它显示自己本机上的文本及图片时，那将是怎样的激动时刻呀！

下面就来看看它的实现全过程：

Tiny的准备

#ifndef __CSAPP_H__ #define __CSAPP_H__ #include <stdio.h> #include <stdlib.h> #include <unistd.h> #include <string.h> #include <ctype.h> #include <setjmp.h> #include <signal.h> #include <sys/time.h> #include <sys/types.h> #include <sys/wait.h> #include <sys/stat.h> #include <fcntl.h> #include <sys/mman.h> #include <errno.h> #include <math.h> #include <semaphore.h> #include <sys/socket.h> #include <netdb.h> #include <netinet/in.h> #include <arpa/inet.h> /* 默认的文件访问权限为 DEF_MODE & ~DEF_UMASK */ #define DEF_MODE S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH #define DEF_UMASK S_IWGRP|S_IWOTH typedef struct sockaddr SA; #define RIO_BUFSIZE 8192 typedef struct { int rio_fd; /* 内部缓存区的描述符 */ int rio_cnt; /* 内部缓存区剩下还未读的字节数 */ char *rio_bufptr; /* 指向内部缓存区中下一个未读字节 */ char rio_buf[RIO_BUFSIZE]; /* 内部缓存区 */ } rio_t; extern char **environ; #define MAXLINE 8192 /* 每行最大字符数 */ #define MAXBUF 8192 /* I/O缓存区的最大容量 */ #define LISTENQ 1024 /* 监听的第二个参数 */ /* helper functions */ ssize_t rio_writen(int fd,void *usrbuf,size_t n); void rio_readinitb(rio_t *rp,int fd); ssize_t rio_readlineb(rio_t *rp,void *usrbuf,size_t maxlen); int open_clientfd(char *hostname, int portno); int open_listenfd(int portno); #endif void doit(int fd); void read_requesthdrs(rio_t *rp); int parse_uri(char *uri,char *filename,char *cgiargs); void serve_static(int fd,char *filename,int filesize); void get_filetype(char *filename,char *filetype); void serve_dynamic(int fd,char *filename,char *cgiargs); void clienterror(int fd,char *cause,char *errum,char *shorting,char *longmsg);

Tiny的main程序

int main(int argc,char **argv) { int listenfd,connfd,port,clientlen; struct sockaddr_in clientaddr; if(argc != 2){ fprintf(stderr,"usage:%s <port>/n",argv[0]); exit(0); } port = atoi(argv[1]); listenfd = open_listenfd(port); while(1){ clientlen = sizeof(clientaddr); connfd = accept(listenfd,(SA *)&clientaddr,&clientlen); doit(connfd); close(connfd); } }

Tiny是一个迭代服务器，监听在命令行中确定的端口上的连接请求。在通过open_listenedfd函数打开一个监听套接字以后，Tiny执行典型的无限服务循环，反复地接受一个连接(accept)请求，执行事务(doit)，最后关闭连接描述符(close)。

Tiny的doit函数

void doit(int fd) { int is_static; struct stat sbuf; char buf[MAXLINE],method[MAXLINE],uri[MAXLINE],version[MAXLINE]; char filename[MAXLINE],cgiargs[MAXLINE]; rio_t rio; rio_readinitb(&rio,fd); rio_readlineb(&rio,buf,MAXLINE); sscanf(buf,"%s %s %s",method,uri,version); if(strcasecmp(method,"GET")){ clienterror(fd,method,"501","Not Implemented","Tiny does not implement this method"); return; } read_requesthdrs(&rio); is_static = parse_uri(uri,filename,cgiargs); if(stat(filename,&sbuf) < 0){ clienterror(fd,filename,"404","Not found","Tiny couldn't read the file"); return; } if(is_static){ if(!(S_ISREG(sbuf.st_mode)) || !(S_IRUSR & sbuf.st_mode)){ clienterror(fd,filename,"403","Forbidden","Tiny couldn't read the file"); return; } serve_static(fd,filename,sbuf.st_size); } else{ if(!(S_ISREG(sbuf.st_mode)) || !(S_IRUSR & sbuf.st_mode)){ clienterror(fd,filename,"403","Forbidden","Tiny couldn't read the file"); return; } serve_dynamic(fd,filename,cgiargs); } }

rio_readinitb(&rio,fd) ：将程序的内部缓存区与描述符相关联。

rio_readlineb(&rio,buf,MAXLINE) :从内部缓存区读出一个文本行至buf中，以null字符来结束这个文本行。当然，每行最大的字符数量不能超过MAXLINE。

sscanf(buf,"%s %s %s",method,uri,version) :作为例子，一般此时buf中存放的是“GET / HTTP/1.1”,所以可知method为“GET”，uri为“/”，version为“HTTP/1.1”。其中sscanf的功能：把buf中的字符串以空格为分隔符分别传送到method、uri及version中。

strcasecmp(method,"GET") :忽略大小写比较method与“GET”的大小，相等的话返回0。

read_requesthdrs(&rio) :读并忽略请求报头。

parse_uri(uri,filename,cgiargs) :解析uri，得文件名存入filename中，参数存入cgiargs中。

stat(filename,&sbuf) :将文件filename中的各个元数据填写进sbuf中，如果找不到文件返回0。

S_ISREG(sbuf,st_mode) :此文件为普通文件。

S_IRUSR & sbuf.st_mode :有读取权限。

serve_static(fd,filename,sbuf.st_size) :提供静态服务。

serve_dynamic(fd,filename,cgiargs) :提供动态服务。

从doit函数中可知，我们的Tiny Web服务器只支持“GET”方法，其他方法请求的话则会发送一条错误消息，主程序返回，并等待下一个请求。否则，我们读并忽略请求报头。（其实，我们在请求服务时，直接不用写请求报头即可，写上只是为了符合HTTP协议标准）。

然后，我们将uri解析为一个文件名和一个可能为空的CGI参数，并且设置一个标志位，表明请求的是静态内容还是动态内容。通过stat函数判断文件是否存在。

最后，如果请求的是静态内容，我们需要检验它是否是一个普通文件，并且可读。条件通过，则我们服务器向客服端发送静态内容；相似的，如果请求的是动态内容，我就核实该文件是否是可执行文件，如果是则执行该文件，并提供动态功能。

Tiny的clienterror函数

void clienterror(int fd,char *cause,char *errnum,char *shortmsg,char *longmsg) { char buf[MAXLINE],body[MAXLINE]; sprintf(body,"<html><title>Tiny Error</title>"); sprintf(body,"%s<body bgcolor=""ffffff"">/r/n",body); sprintf(body,"%s%s:%s/r/n",body,longmsg,shortmsg); sprintf(body,"%s<p>%s:%s/r/n",body,longmsg,cause); sprintf(body,"%s<hr><i>The Tiny Web server</i>/r/n",body); sprintf(buf,"HTTP/1.0 %s %s/r/n",errnum,shortmsg); rio_writen(fd,buf,strlen(buf)); sprintf(buf,"Content-type:text/html/r/n"); rio_writen(fd,buf,strlen(buf)); sprintf(buf,"Content-length:%d/r/n/r/n",strlen(body)); rio_writen(fd,buf,strlen(buf)); rio_writen(fd,body,strlen(body)); }

向客户端返回错误信息。

sprintf(buf,"------------"):将字符串“------------”输送到buf中。

rio_writen(fd,buf,strlen(buf)):将buf中的字符串写入fd描述符中。

Tiny的read_requesthdrs函数

void read_requesthdrs(rio_t *rp) { char buf[MAXLINE]; rio_readlineb(rp,buf,MAXLINE); while(strcmp(buf,"/r/n")) rio_readlineb(rp,buf,MAXLINE); return; }

Tiny不需要请求报头中的任何信息，所以我们这个函数就是来跳过这些请求报头的。具体做法就是读这些请求报头，直到空行，然后返回。OK！

Tiny的parse_uri函数

int parse_uri(char *uri,char *filename,char *cgiargs) { char *ptr; if(!strstr(uri,"cgi-bin")){ strcpy(cgiargs,""); strcpy(filename,"."); strcat(filename,uri); if(uri[strlen(uri)-1] == '/') strcat(filename,"home.html"); return 1; }else{ ptr = index(uri,'?'); if(ptr){ strcpy(cgiargs,ptr+1); *ptr = '/0'; } else strcpy(cgiargs,""); strcpy(filename,"."); strcat(filename,uri); return 0; } }

根据uri中是否含有cgi-bin来判断请求的是静态内容还是动态内容。如果没有cgi-bin，则说明请求的是静态内容。那么，我们需把cgiargs置NULL，然后获得文件名，如果我们请求的uri最后为 “/”，则自动添加上home.html。比如说，我们请求的是“/”,则返回的文件名为“./home.html”,而我们请求“/logo.gif”,则返回的文件名为“./logo.gif”。如果uri中含有cgi-bin，则说明请求的是动态内容。那么，我们需要把参数拷贝到cgiargs中，把要执行的文件路径写入filename。举例来说，uri为/cgi-bin/adder?3&5,则cigargs中   存放的是3&5，filename中存放的是“./cgi-bin/adder”,OK!

index(uri,'?') : 找出uri字符串中第一个出现参数‘？’的地址，并将此地址返回。

 

Tiny的serve_static函数void serve_static(int fd,char *filename,int filesize) { int srcfd; char *srcp,filetype[MAXLINE],buf[MAXBUF]; get_filetype(filename,filetype); sprintf(buf,"HTTP/1.0 200 OK/r/n"); sprintf(buf,"%sServer:Tiny Web Server/r/n",buf); sprintf(buf,"%sContent-length:%d/r/n",buf,filesize); sprintf(buf,"%sContent-type:%s/r/n/r/n",buf,filetype); rio_writen(fd,buf,strlen(buf)); srcfd = open(filename,O_RDONLY,0); srcp = mmap(0,filesize,PROT_READ,MAP_PRIVATE,srcfd,0); close(srcfd); rio_writen(fd,srcp,filesize); munmap(srcp,filesize); } void get_filetype(char *filename,char *filetype) { if(strstr(filename,".html")) strcpy(filetype,"text/html"); else if(strstr(filename,".gif")) strcpy(filetype,"image/gif"); else if(strstr(filename,",jpeg")) strcpy(filetype,"image.jpeg"); else strcpy(filetype,"text/plain"); }

打开文件名为filename的文件，把它映射到一个虚拟存储器空间，将文件的前filesize字节映射到从地址srcp开始的虚拟存储区域。关闭文件描述符srcfd，把虚拟存储区的数据写入fd描述符，最后释放虚拟存储器区域。

Tiny的serve_dynamic函数void serve_dynamic(int fd,char *filename,char *cgiargs) { char buf[MAXLINE],*emptylist[] = { NULL }; sprintf(buf,"HTTP/1.0 200 OK/r/n"); rio_writen(fd,buf,strlen(buf)); sprintf(buf,"Server:Tiny Web Server/r/n"); rio_writen(fd,buf,strlen(buf)); if(fork() == 0){ setenv("QUERY_STRING",cgiargs,1); dup2(fd,STDOUT_FILENO); execve(filename,emptylist,environ); } wait(NULL); }

Tiny通过派生一个子进程并在子进程的上下文中运行一个cgi程序（可执行文件），来提供各种类型的动态内容。

setenv("QUERY_STRING",cgiargs,1) :设置QUERY_STRING环境变量。

dup2 （fd，STDOUT_FILENO) ：重定向它的标准输出到已连接描述符。此时，任何写到标准输出的东西都直接写到客户端。

execve(filename,emptylist,environ) :加载运行cgi程序。

====================from csapp.c========================ssize_t rio_writen(int fd, void *usrbuf, size_t n) { size_t nleft = n; ssize_t nwritten; char *bufp = usrbuf; while (nleft > 0) { if ((nwritten = write(fd, bufp, nleft)) <= 0) { if (errno == EINTR) nwritten = 0; else return -1; } nleft -= nwritten; bufp += nwritten; } return n; } static ssize_t rio_read(rio_t *rp, char *usrbuf, size_t n) { int cnt; while (rp->rio_cnt <= 0) { /* 如果缓存区空，则重新填充 */ rp->rio_cnt = read(rp->rio_fd, rp->rio_buf, sizeof(rp->rio_buf)); if (rp->rio_cnt < 0) { if (errno != EINTR) return -1; } else if (rp->rio_cnt == 0) /* EOF */ return 0; else rp->rio_bufptr = rp->rio_buf; /* 重新设置缓存区指针 */ } /* 从内部缓存区拷贝 min(n, rp->rio_cnt) 个字节到usrbuf*/ cnt = n; if (rp->rio_cnt < n) cnt = rp->rio_cnt; memcpy(usrbuf, rp->rio_bufptr, cnt); rp->rio_bufptr += cnt; rp->rio_cnt -= cnt; return cnt; } void rio_readinitb(rio_t *rp, int fd) { rp->rio_fd = fd; rp->rio_cnt = 0; rp->rio_bufptr = rp->rio_buf; } ssize_t rio_readlineb(rio_t *rp, void *usrbuf, size_t maxlen) { int n, rc; char c, *bufp = usrbuf; for (n = 1; n < maxlen; n++) { if ((rc = rio_read(rp, &c, 1)) == 1) { *bufp++ = c; if (c == '/n') break; }else if (rc == 0) { if (n == 1) return 0; /* EOF, no data read */ else break; /* EOF, some data was read */ } else return -1; /* error */ } *bufp = 0; return n; } int open_clientfd(char *hostname, int port) { int clientfd; struct hostent *hp; struct sockaddr_in serveraddr; if ((clientfd = socket(AF_INET, SOCK_STREAM, 0)) < 0) return -1; if ((hp = gethostbyname(hostname)) == NULL) return -2; bzero((char *) &serveraddr, sizeof(serveraddr)); serveraddr.sin_family = AF_INET; bcopy((char *)hp->h_addr_list[0], (char *)&serveraddr.sin_addr.s_addr, hp->h_length); serveraddr.sin_port = htons(port); if (connect(clientfd, (SA *) &serveraddr, sizeof(serveraddr)) < 0) return -1; return clientfd; } int open_listenfd(int port) { int listenfd, optval=1; struct sockaddr_in serveraddr; /* 创建一个套接字描述符 */ if ((listenfd = socket(AF_INET, SOCK_STREAM, 0)) < 0) return -1; /* Eliminates "Address already in use" error from bind. */ if (setsockopt(listenfd, SOL_SOCKET, SO_REUSEADDR, (const void *)&optval , sizeof(int)) < 0) return -1; /* Listenfd will be an endpoint for all requests to port on any IP address for this host */ bzero((char *) &serveraddr, sizeof(serveraddr)); serveraddr.sin_family = AF_INET; serveraddr.sin_addr.s_addr = htonl(INADDR_ANY); serveraddr.sin_port = htons((unsigned short)port); if (bind(listenfd, (SA *)&serveraddr, sizeof(serveraddr)) < 0) return -1; /* Make it a listening socket ready to accept connection requests */ if (listen(listenfd, LISTENQ) < 0) return -1; return listenfd; }