点击链接看github repo。
Forked from cbsheng/tinyhttpd
tinyhttpd是一个500行的极简HTTP服务器，持CGI。代码量少，非常容易阅读，十分适合网络编程初学者学习的项目。麻雀虽小，五脏俱全。在tinyhttpd中可以学到 linux 上进程的创建，管道的使用。linux 下 socket 编程基本方法和http 协议的最基本结构。
在cbsheng的基础上，添加了一些注释，帮助阅读源码，针对The Linux Programming Interface，使用了章节索引替代了原来的页码索引。
代码非常简单，和你一样我也是初学者可以多关注一下以下两个方面：
- Unix Socket Stream Server的通常流程
- 使用pipe做父子进程通信
tinyhttpd流程
tinyhttpd frame
流程图包含了一个典型的Unix socket stream server的流程，可详见：TLPI 56.5.
使用pipe做相关进程通信
Pipe是Unix like系统上最古老的IPC方法。它为一个常见需求提供了一个优雅的解决方案：给定两个运行不同程序的进程，如何让一个进程的输出作为另一个进程的输入？管道可以用于在相关进程之间传递数据。
tinyhttpd中创建子进程来执行cgi脚本的函数可以很好地用来学习pipe。
先来看代码。
/**********************************************************************/
/* Execute a CGI script. Will need to set environment variables as
* appropriate.
* Parameters: client socket descriptor
* path to the CGI script */
/**********************************************************************/
void execute_cgi(int client, const char *path, const char *method, const char *query_string)
{
char buf[1024];
int cgi_output[2];
int cgi_input[2];
pid_t pid;
int status;
int i;
char c;
int numchars = 1;
int content_length = -1;
//省略若干行不相关代码
//下面这里创建两个管道，用于两个进程间通信，参考《TLPI》44.2
/*
#include <unistd.h>
int pipe(int fields); //return 0 on succ, -1 on err.
成功的pipe()调用会在fields中返回两个打开的文件描述符：一个表示管道的读取端（fields[0]），另一个表示写入端（fields[1]）。
父子进程都通过一个pipe读写信息是可以的，但是很不常见,创建pipe，fork()创建子进程之前：
[ parent process ]
- [fields[1] fields[0]]<-
| |
-> [-------pipe------>]-
| |
- [fields[1] fields[0]]<-
[ sub process ]
通常fork()后，其中一个进程需要立即关闭管道写入端描述符，另一个关闭读取描述符。关闭未使用描述符之后：
[ parent process ]
- [fields[1] ]
|
-> [-------pipe------>]-
|
[ fields[0]]<-
[ sub process ]
*/
if (pipe(cgi_output) < 0) {
cannot_execute(client);
return;
}
if (pipe(cgi_input) < 0) {
cannot_execute(client);
return;
}
/*
cgi_output是子进程（执行cgi的进程）的输出管道，子进程写，父进程读；
cgi_input是子进程（执行cgi的进程）的输入管道，父进程写，子进程读。
*/
//创建一个子进程 参考《TLPI》 24.2
/*
#include <unistd.h>
pid_t fork(void); //in parent, return processID of child on success or -1 on error; in successfully created child: always return 0
*/
if ( (pid = fork()) < 0 ) {
cannot_execute(client);
return;
}
//子进程用来执行 cgi 脚本
if (pid == 0) /* child: CGI script */
{
char meth_env[255];
char query_env[255];
char length_env[255];
//dup2()包含<unistd.h>中，参读《TLPI》5.5
//将子进程的输出由标准输出重定向到 cgi_ouput 的管道写端上
/*
#include <unistd.h>
int dup2(int oldfd, int newfd); //return (new) file descritor on succ, -1 on err
为oldfd指定文件描述符创建副本，其编号由newfd指定。
*/
dup2(cgi_output[1], 1);
//将子进程的输出由标准输入重定向到 cgi_ouput 的管道读端上
dup2(cgi_input[0], 0);
//关闭 cgi_ouput 管道的读端与cgi_input 管道的写端
close(cgi_output[0]);
close(cgi_input[1]);
//构造一个环境变量
sprintf(meth_env, "REQUEST_METHOD=%s", method);
//putenv()包含于<stdlib.h>中，参读《TLPI》6.7
//将这个环境变量加进子进程的运行环境中
/*
#include <stdlib.h>
int putenv(char *string); //return 0 on succ, nonzero on err.
*/
putenv(meth_env);
//根据http 请求的不同方法，构造并存储不同的环境变量
if (strcasecmp(method, "GET") == 0) {
sprintf(query_env, "QUERY_STRING=%s", query_string);
putenv(query_env);
}
else { /* POST */
sprintf(length_env, "CONTENT_LENGTH=%d", content_length);
putenv(length_env);
}
//execl()包含于<unistd.h>中，参读《TLPI》P567
//最后将子进程替换成另一个进程并执行 cgi 脚本
/*
#include <unistd.h>
int execl(const char* pathname, const char *arg, ...); //not return on succ;return -1 on error.
*/
execl(path, path, NULL);
exit(0);
} else { /* parent */
//父进程则关闭了 cgi_output管道的写端和 cgi_input 管道的读端
close(cgi_output[1]);
close(cgi_input[0]);
//如果是 POST 方法的话就继续读 body 的内容，并写到 cgi_input 管道里让子进程去读
if (strcasecmp(method, "POST") == 0)
for (i = 0; i < content_length; i++) {
recv(client, &c, 1, 0);
write(cgi_input[1], &c, 1);
}
//然后从 cgi_output 管道中读子进程的输出，并发送到客户端去
while (read(cgi_output[0], &c, 1) > 0)
send(client, &c, 1, 0);
//关闭管道
close(cgi_output[0]);
close(cgi_input[1]);
//等待子进程的退出 《TLPI》26.1.2
/*
#include <sys/wait.h>
pid_t waitpid(pid_t pid, int *status, int options); //return process ID of child, 0, or -1 on err.
*/
waitpid(pid, &status, 0);
}
}
这段代码很简单，创建了一个子进程用于执行CGI脚本。子进程将标准输入重定向到管道cgi_input的输入，接受来自父进程的写入；将标准输出重定向到cgi_output的输入，将信息发给父进程。子进程通过execl执行cgi脚本替换当前子进程。如下图：
tinyhttpd_pipe
注意代码中，一个管道在两个通信进程会将一个管道不需要的一端关闭掉。子进程关闭了cgi_input1和cgi_output0,父进程关闭了cgi_output1和cgi_input[0]（读端）。
通常都会使用一个管道的一个管道，创建了管道并fork进程后，管道读写都是双向开放的，但通常会去关闭不使用的文件描述符，如下图，父进程给子进程发送信息，就对应两个进程对管道做了相应关闭处理。
pipe_fork
附录
附上tinyhttpd注释版代码：
/* J. David's webserver */
/* This is a simple webserver.
* Created November 1999 by J. David Blackstone.
* CSE 4344 (Network concepts), Prof. Zeigler
* University of Texas at Arlington
*/
/* This program compiles for Sparc Solaris 2.6.
* To compile for Linux:
* 1) Comment out the #include <pthread.h> line.
* 2) Comment out the line that defines the variable newthread.
* 3) Comment out the two lines that run pthread_create().
* 4) Uncomment the line that runs accept_request().
* 5) Remove -lsocket from the Makefile.
*/
/*
代码中除了用到 C 语言标准库的一些函数，也用到了一些与环境有关的函数(例如POSIX标准)
具体可以参读《The Linux Programming Interface》，以下简称《TLPI》，页码指示均为英文版
注释者： github: cbsheng & github: conndots
*/
#include <stdio.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <unistd.h>
#include <ctype.h>
#include <strings.h>
#include <string.h>
#include <sys/stat.h>
//#include <pthread.h>
#include <sys/wait.h>
#include <stdlib.h>
#define ISspace(x) isspace((int)(x))
#define SERVER_STRING "Server: jdbhttpd/0.1.0\r\n"
void accept_request(int);
void bad_request(int);
void cat(int, FILE *);
void cannot_execute(int);
void error_die(const char *);
void execute_cgi(int, const char *, const char *, const char *);
int get_line(int, char *, int);
void headers(int, const char *);
void not_found(int);
void serve_file(int, const char *);
int startup(u_short *);
void unimplemented(int);
/**********************************************************************/
/* A request has caused a call to accept() on the server port to
* return. Process the request appropriately.
* Parameters: the socket connected to the client */
/**********************************************************************/
void accept_request(int client)
{
char buf[1024];
int numchars;
char method[255];
char url[255];
char path[512];
size_t i, j;
struct stat st;
int cgi = 0; /* becomes true if server decides this is a CGI
* program */
char *query_string = NULL;
//读http 请求的第一行数据（request line），把请求方法存进 method 中
numchars = get_line(client, buf, sizeof(buf));
i = 0; j = 0;
while (!ISspace(buf[j]) && (i < sizeof(method) - 1))
{
method[i] = buf[j];
i++; j++;
}
method[i] = '\0';
//如果请求的方法不是 GET 或 POST 任意一个的话就直接发送 response 告诉客户端没实现该方法
if (strcasecmp(method, "GET") && strcasecmp(method, "POST"))
{
unimplemented(client);
return;
}
//如果是 POST 方法就将 cgi 标志变量置一(true)
if (strcasecmp(method, "POST") == 0)
cgi = 1;
i = 0;
//跳过所有的空白字符(空格)
while (ISspace(buf[j]) && (j < sizeof(buf)))
j++;
//然后把 URL 读出来放到 url 数组中
while (!ISspace(buf[j]) && (i < sizeof(url) - 1) && (j < sizeof(buf)))
{
url[i] = buf[j];
i++; j++;
}
url[i] = '\0';
//如果这个请求是一个 GET 方法的话
if (strcasecmp(method, "GET") == 0)
{
//用一个指针指向 url
query_string = url;
//去遍历这个 url，跳过字符 ？前面的所有字符，如果遍历完毕也没找到字符 ？则退出循环
while ((*query_string != '?') && (*query_string != '\0'))
query_string++;
//退出循环后检查当前的字符是 ？还是字符串(url)的结尾
if (*query_string == '?')
{
//如果是 ？ 的话，证明这个请求需要调用 cgi，将 cgi 标志变量置一(true)
cgi = 1;
//从字符 ？ 处把字符串 url 给分隔会两份
*query_string = '\0';
//使指针指向字符 ？后面的那个字符
query_string++;
}
}
//将前面分隔两份的前面那份字符串，拼接在字符串htdocs的后面之后就输出存储到数组 path 中。相当于现在 path 中存储着一个字符串
sprintf(path, "htdocs%s", url);
//如果 path 数组中的这个字符串的最后一个字符是以字符 / 结尾的话，就拼接上一个"index.html"的字符串。首页的意思
if (path[strlen(path) - 1] == '/')
strcat(path, "index.html");
//在系统上去查询该文件是否存在, 《TLPI》15.1
/*
#include <sys/stat.h>
int stat(const char *pathname, struct stat *statbuf); //return 0 on succ, or -1 on err.
*/
if (stat(path, &st) == -1) {
//如果不存在，那把这次 http 的请求后续的内容(head 和 body)全部读完并忽略
while ((numchars > 0) && strcmp("\n", buf)) /* read & discard headers */
numchars = get_line(client, buf, sizeof(buf));
//然后返回一个找不到文件的 response 给客户端
not_found(client);
}
else
{
//文件存在，那去跟常量S_IFMT相与，相与之后的值可以用来判断该文件是什么类型的
//st_mode: file type & file permission
//S_IFMT参读《TLPI》15.1，与下面的三个常量一样是包含在<sys/stat.h>
//stat。st_mode与S_IFMT�相与可从该字段析取文件类型
/*
| _ _ _ _ | U G T | R W X | R W X | R W X |
| | |<- user ->|<-group->|<-others->|
|<-filetype->|<- permission ->|
*/
if ((st.st_mode & S_IFMT) == S_IFDIR)
//如果这个文件是个目录，那就需要再在 path 后面拼接一个"/index.html"的字符串
strcat(path, "/index.html");
//S_IXUSR, S_IXGRP, S_IXOTH三者可以参读《TLPI》
if ((st.st_mode & S_IXUSR) ||
(st.st_mode & S_IXGRP) ||
(st.st_mode & S_IXOTH) )
//如果这个文件是一个可执行文件，不论是属于用户/组/其他这三者类型的，就将 cgi 标志变量置一
cgi = 1;
if (!cgi)
//如果不需要 cgi 机制的话，
serve_file(client, path);
else
//如果需要则调用
execute_cgi(client, path, method, query_string);
}
close(client);
}
/**********************************************************************/
/* Inform the client that a request it has made has a problem.
* Parameters: client socket */
/**********************************************************************/
void bad_request(int client)
{
char buf[1024];
sprintf(buf, "HTTP/1.0 400 BAD REQUEST\r\n");
send(client, buf, sizeof(buf), 0);
sprintf(buf, "Content-type: text/html\r\n");
send(client, buf, sizeof(buf), 0);
sprintf(buf, "\r\n");
send(client, buf, sizeof(buf), 0);
sprintf(buf, "<P>Your browser sent a bad request, ");
send(client, buf, sizeof(buf), 0);
sprintf(buf, "such as a POST without a Content-Length.\r\n");
send(client, buf, sizeof(buf), 0);
}
/**********************************************************************/
/* Put the entire contents of a file out on a socket. This function
* is named after the UNIX "cat" command, because it might have been
* easier just to do something like pipe, fork, and exec("cat").
* Parameters: the client socket descriptor
* FILE pointer for the file to cat */
/**********************************************************************/
void cat(int client, FILE *resource)
{
char buf[1024];
//从文件文件描述符中读取指定内容
fgets(buf, sizeof(buf), resource);
while (!feof(resource))
{
send(client, buf, strlen(buf), 0);
fgets(buf, sizeof(buf), resource);
}
}
/**********************************************************************/
/* Inform the client that a CGI script could not be executed.
* Parameter: the client socket descriptor. */
/**********************************************************************/
void cannot_execute(int client)
{
char buf[1024];
sprintf(buf, "HTTP/1.0 500 Internal Server Error\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "Content-type: text/html\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "<P>Error prohibited CGI execution.\r\n");
send(client, buf, strlen(buf), 0);
}
/**********************************************************************/
/* Print out an error message with perror() (for system errors; based
* on value of errno, which indicates system call errors) and exit the
* program indicating an error. */
/**********************************************************************/
void error_die(const char *sc)
{
//包含于<stdio.h>,基于当前的 errno 值，在标准错误上产生一条错误消息。参考《TLPI》P49
perror(sc);
exit(1);
}
/**********************************************************************/
/* Execute a CGI script. Will need to set environment variables as
* appropriate.
* Parameters: client socket descriptor
* path to the CGI script */
/**********************************************************************/
void execute_cgi(int client, const char *path,
const char *method, const char *query_string)
{
char buf[1024];
int cgi_output[2];
int cgi_input[2];
pid_t pid;
int status;
int i;
char c;
int numchars = 1;
int content_length = -1;
//往 buf 中填东西以保证能进入下面的 while
buf[0] = 'A'; buf[1] = '\0';
//如果是 http 请求是 GET 方法的话读取并忽略请求剩下的内容
if (strcasecmp(method, "GET") == 0)
while ((numchars > 0) && strcmp("\n", buf)) /* read & discard headers */
numchars = get_line(client, buf, sizeof(buf));
else /* POST */
{
//只有 POST 方法才继续读内容
numchars = get_line(client, buf, sizeof(buf));
//这个循环的目的是读出指示 body 长度大小的参数，并记录 body 的长度大小。其余的 header 里面的参数一律忽略
//注意这里只读完 header 的内容，body 的内容没有读
while ((numchars > 0) && strcmp("\n", buf))
{
buf[15] = '\0';
if (strcasecmp(buf, "Content-Length:") == 0)
content_length = atoi(&(buf[16])); //记录 body 的长度大小
numchars = get_line(client, buf, sizeof(buf));
}
//如果 http 请求的 header 没有指示 body 长度大小的参数，则报错返回
if (content_length == -1) {
bad_request(client);
return;
}
}
sprintf(buf, "HTTP/1.0 200 OK\r\n");
send(client, buf, strlen(buf), 0);
//下面这里创建两个管道，用于两个进程间通信，参考《TLPI》44.2
/*
#include <unistd.h>
int pipe(int fields); //return 0 on succ, -1 on err.
成功的pipe()调用会在fields中返回两个打开的文件描述符：一个表示管道的读取端（fields[0]），另一个表示写入端（fields[1]）。
父子进程都通过一个pipe读写信息是可以的，但是很不常见,创建pipe，fork()创建子进程之前：
[ parent process ]
- [fields[1] fields[0]]<-
| |
-> [-------pipe------>]-
| |
- [fields[1] fields[0]]<-
[ sub process ]
通常fork()后，其中一个进程需要立即关闭管道写入端描述符，另一个关闭读取描述符。关闭未使用描述符之后：
[ parent process ]
- [fields[1] ]
|
-> [-------pipe------>]-
|
[ fields[0]]<-
[ sub process ]
*/
if (pipe(cgi_output) < 0) {
cannot_execute(client);
return;
}
if (pipe(cgi_input) < 0) {
cannot_execute(client);
return;
}
/*
cgi_output是子进程（执行cgi的进程）的输出管道，子进程写，父进程读；
cgi_input是子进程（执行cgi的进程）的输入管道，父进程写，子进程读。
*/
//创建一个子进程 参考《TLPI》 24.2
/*
#include <unistd.h>
pid_t fork(void); //in parent, return processID of child on success or -1 on error; in successfully created child: always return 0
*/
if ( (pid = fork()) < 0 ) {
cannot_execute(client);
return;
}
//子进程用来执行 cgi 脚本
if (pid == 0) /* child: CGI script */
{
char meth_env[255];
char query_env[255];
char length_env[255];
//dup2()包含<unistd.h>中，参读《TLPI》5.5
//将子进程的输出由标准输出重定向到 cgi_ouput 的管道写端上
/*
#include <unistd.h>
int dup2(int oldfd, int newfd); //return (new) file descritor on succ, -1 on err
为oldfd指定文件描述符创建副本，其编号由newfd指定。
*/
dup2(cgi_output[1], 1);
//将子进程的输出由标准输入重定向到 cgi_ouput 的管道读端上
dup2(cgi_input[0], 0);
//关闭 cgi_ouput 管道的读端与cgi_input 管道的写端
close(cgi_output[0]);
close(cgi_input[1]);
//构造一个环境变量
sprintf(meth_env, "REQUEST_METHOD=%s", method);
//putenv()包含于<stdlib.h>中，参读《TLPI》6.7
//将这个环境变量加进子进程的运行环境中
/*
#include <stdlib.h>
int putenv(char *string); //return 0 on succ, nonzero on err.
*/
putenv(meth_env);
//根据http 请求的不同方法，构造并存储不同的环境变量
if (strcasecmp(method, "GET") == 0) {
sprintf(query_env, "QUERY_STRING=%s", query_string);
putenv(query_env);
}
else { /* POST */
sprintf(length_env, "CONTENT_LENGTH=%d", content_length);
putenv(length_env);
}
//execl()包含于<unistd.h>中，参读《TLPI》P567
//最后将子进程替换成另一个进程并执行 cgi 脚本
/*
#include <unistd.h>
int execl(const char* pathname, const char *arg, ...); //not return on succ;return -1 on error.
*/
execl(path, path, NULL);
exit(0);
} else { /* parent */
//父进程则关闭了 cgi_output管道的写端和 cgi_input 管道的读端
close(cgi_output[1]);
close(cgi_input[0]);
//如果是 POST 方法的话就继续读 body 的内容，并写到 cgi_input 管道里让子进程去读
if (strcasecmp(method, "POST") == 0)
for (i = 0; i < content_length; i++) {
recv(client, &c, 1, 0);
write(cgi_input[1], &c, 1);
}
//然后从 cgi_output 管道中读子进程的输出，并发送到客户端去
while (read(cgi_output[0], &c, 1) > 0)
send(client, &c, 1, 0);
//关闭管道
close(cgi_output[0]);
close(cgi_input[1]);
//等待子进程的退出 《TLPI》26.1.2
/*
#include <sys/wait.h>
pid_t waitpid(pid_t pid, int *status, int options); //return process ID of child, 0, or -1 on err.
*/
waitpid(pid, &status, 0);
}
}
/**********************************************************************/
/* Get a line from a socket, whether the line ends in a newline,
* carriage return, or a CRLF combination. Terminates the string read
* with a null character. If no newline indicator is found before the
* end of the buffer, the string is terminated with a null. If any of
* the above three line terminators is read, the last character of the
* string will be a linefeed and the string will be terminated with a
* null character.
* Parameters: the socket descriptor
* the buffer to save the data in
* the size of the buffer
* Returns: the number of bytes stored (excluding null) */
/**********************************************************************/
int get_line(int sock, char *buf, int size)
{
int i = 0;
char c = '\0';
int n;
while ((i < size - 1) && (c != '\n'))
{
//recv()包含于<sys/socket.h>,参读《TLPI》61.3,
//读一个字节的数据存放在 c 中
/*
#include<sys/socket.h>
ssize_t recv(int sockfd, void *buffer, size_t length, int flags); //return num of bytes received, 0 on EOF, -1 on err.
*/
n = recv(sock, &c, 1, 0);
/* DEBUG printf("%02X\n", c); */
if (n > 0)
{
if (c == '\r')
{
//MSG_PEEK, 从套接字缓冲区获取一份请求字节副本，但不会将请求的字节从缓冲区中实际移除。
n = recv(sock, &c, 1, MSG_PEEK);
/* DEBUG printf("%02X\n", c); */
if ((n > 0) && (c == '\n'))
recv(sock, &c, 1, 0);
else
c = '\n';
}
buf[i] = c;
i++;
}
else
c = '\n';
}
buf[i] = '\0';
return(i);
}
/**********************************************************************/
/* Return the informational HTTP headers about a file. */
/* Parameters: the socket to print the headers on
* the name of the file */
/**********************************************************************/
void headers(int client, const char *filename)
{
char buf[1024];
(void)filename; /* could use filename to determine file type */
strcpy(buf, "HTTP/1.0 200 OK\r\n");
send(client, buf, strlen(buf), 0);
strcpy(buf, SERVER_STRING);
send(client, buf, strlen(buf), 0);
sprintf(buf, "Content-Type: text/html\r\n");
send(client, buf, strlen(buf), 0);
strcpy(buf, "\r\n");
send(client, buf, strlen(buf), 0);
}
/**********************************************************************/
/* Give a client a 404 not found status message. */
/**********************************************************************/
void not_found(int client)
{
char buf[1024];
sprintf(buf, "HTTP/1.0 404 NOT FOUND\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, SERVER_STRING);
send(client, buf, strlen(buf), 0);
sprintf(buf, "Content-Type: text/html\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "<HTML><TITLE>Not Found</TITLE>\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "<BODY><P>The server could not fulfill\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "your request because the resource specified\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "is unavailable or nonexistent.\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "</BODY></HTML>\r\n");
send(client, buf, strlen(buf), 0);
}
/**********************************************************************/
/* Send a regular file to the client. Use headers, and report
* errors to client if they occur.
* Parameters: a pointer to a file structure produced from the socket
* file descriptor
* the name of the file to serve */
/**********************************************************************/
void serve_file(int client, const char *filename)
{
FILE *resource = NULL;
int numchars = 1;
char buf[1024];
//确保 buf 里面有东西，能进入下面的 while 循环
buf[0] = 'A'; buf[1] = '\0';
//循环作用是读取并忽略掉这个 http 请求后面的所有内容
while ((numchars > 0) && strcmp("\n", buf)) /* read & discard headers */
numchars = get_line(client, buf, sizeof(buf));
//打开这个传进来的这个路径所指的文件
resource = fopen(filename, "r");
if (resource == NULL)
not_found(client);
else
{
//打开成功后，将这个文件的基本信息封装成 response 的头部(header)并返回
headers(client, filename);
//接着把这个文件的内容读出来作为 response 的 body 发送到客户端
cat(client, resource);
}
fclose(resource);
}
/**********************************************************************/
/* This function starts the process of listening for web connections
* on a specified port. If the port is 0, then dynamically allocate a
* port and modify the original port variable to reflect the actual
* port.
* Parameters: pointer to variable containing the port to connect on
* Returns: the socket */
/**********************************************************************/
int startup(u_short *port)
{
int httpd = 0;
//sockaddr_in 是 IPV4的套接字地址结构。定义在<netinet/in.h>,参读《TLPI》P59.4
struct sockaddr_in name;
//socket()用于创建一个用于 socket 的描述符，函数包含于<sys/socket.h>。参读《TLPI》56.2
//这里的PF_INET其实是与 AF_INET同义，具体可以参读《TLPI》P946
/*
int socket(int domain, int type, int protocol); //return file descriptor on success,-1 on error
type = SOCK_STREAM -> 流socket 一般使用TCP协议传输
type = SOCK_DGRAM -> 数据报socket 使用UDP协议传输
*/
httpd = socket(PF_INET, SOCK_STREAM, 0);
if (httpd == -1)
error_die("socket");
memset(&name, 0, sizeof(name));
name.sin_family = AF_INET;
//htons()，ntohs() 和 htonl()包含于<arpa/inet.h>, 参读《TLPI》P59.2
//将*port 转换成以网络字节序表示的16位整数
name.sin_port = htons(*port);
//INADDR_ANY是一个 IPV4通配地址的常量，包含于<netinet/in.h>
//大多实现都将其定义成了0.0.0.0 参读《TLPI》P1187
name.sin_addr.s_addr = htonl(INADDR_ANY);
//bind()用于绑定地址与 socket。参读《TLPI》56.3
//如果传进去的sockaddr结构中的 sin_port 指定为0，这时系统会选择一个临时的端口号
/*
int bind(int sockfd, const struct sockaddr *addr, socklen_t addrlen); //return 0 on succ, -1 on err.
sockfd: sock函数返回的文件描述符
�
struct sockaddr {
sa_family_t sa_family; //address family(AF_* constant)
char sa_data[14]; //socket address(size varies according to socket domain)
}
struct sockaddr_in {
so_family_t sin_family; //address family(AF_INET)
in_port_t sin_port; //port 16 bytes
struct in_addr sin_addr; //IVv4 address 32 bytes
unsigned char __pad[X]; //pad to size of 'sockaddr' structure(16 bytes)
}
sin_port + sin_addr -> sa_data[14]
每种socket domain都使用了不同的地址格式。Unix domain socket使用路径名；Internet domain socket使用ip地址和端口号。bind适用于所有的socket domain，必须能够接受任意类型地址结构。sockaddr是通用的地址结构。需要将特定domain socket转换为sockaddr。
*/
if (bind(httpd, (struct sockaddr *)&name, sizeof(name)) < 0)
error_die("bind");
//如果调用 bind 后端口号仍然是0，则手动调用getsockname()获取端口号
if (*port == 0) /* if dynamically allocating a port */
{
int namelen = sizeof(name);
//getsockname()包含于<sys/socker.h>中，参读《TLPI》61.5
//调用getsockname()获取系统给 httpd 这个 socket 随机分配的端口号
/*
int getsockname(int sockfd, struct sockaddr *addr, socklen_t *addrlen); //return 0 on succ, -1 on err.
*/
if (getsockname(httpd, (struct sockaddr *)&name, &namelen) == -1)
error_die("getsockname");
*port = ntohs(name.sin_port);
}
//最初的 BSD socket 实现中，backlog 的上限是5.参读《TLPI》56.5.1
/*
#include<sys/socket.h>
int listen(int sockfd, int backlog); //return 0 on success, -1 on err.
将文件描述符sockfd引用的流socket标记为被动，这个socket后面会被用来接受来自其它（主动的）socket连接。
如何理解backlog参数？
未决连接请求：
被动socket连接：
socket() -> bind() -> listen() -> accept() -><-
主动socket连接：
socket() -> connect() //可能阻塞，取决于后台登录的连接请求数量
联系：
C: connect() --> S: accept()
当服务器忙于处理其他客户端时，会先client调用connect(),然后server再accept。内核需要记录这些未决连接请求的相关信息，这样后续accept()才能处理这些请求。backlog为允许这种未决连接的数量。这个限制以内的请求会立即成功。之外的连接请求会阻塞到一个未决的连接被接受（通过accept())。linux中被定义成了128，可以通过/proc/sys/net/core/somaxconn配置。
*/
if (listen(httpd, 5) < 0)
error_die("listen");
return(httpd);
}
/**********************************************************************/
/* Inform the client that the requested web method has not been
* implemented.
* Parameter: the client socket */
/**********************************************************************/
void unimplemented(int client)
{
char buf[1024];
sprintf(buf, "HTTP/1.0 501 Method Not Implemented\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, SERVER_STRING);
send(client, buf, strlen(buf), 0);
sprintf(buf, "Content-Type: text/html\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "<HTML><HEAD><TITLE>Method Not Implemented\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "</TITLE></HEAD>\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "<BODY><P>HTTP request method not supported.\r\n");
send(client, buf, strlen(buf), 0);
sprintf(buf, "</BODY></HTML>\r\n");
send(client, buf, strlen(buf), 0);
}
/**********************************************************************/
int main(void)
{
int server_sock = -1;
u_short port = 0;
int client_sock = -1;
//sockaddr_in 是 IPV4的套接字地址结构。定义在<netinet/in.h>,《TLPI》59.4
/*
struct in_addr {
in_addr_t s_addr; //unsigned 32-bit int
}
struct sockaddr_in {
so_family_t sin_family; //address family(AF_INET)
in_port_t sin_port; //port 16 bytes
struct in_addr sin_addr; //IVv4 address 32 bytes
unsigned char __pad[X]; //pad to size of 'sockaddr' structure(16 bytes)
}
*/
struct sockaddr_in client_name;
int client_name_len = sizeof(client_name);
//pthread_t newthread;
server_sock = startup(&port);
printf("httpd running on port %d\n", port);
while (1)
{
//阻塞等待客户端的连接，如果没有未决连接的话，参读《TLPI》56.5.2
/*
#include<sys/socket.h>
int accept(int sockfd, struct sockaddr *addr, socklen_t addrlen); //return file descriptor on succ, -1 on err.
它会创建一个新的socket，正是这个socket与执行connect()的对等socket进行连接。
socket(sockfd)会保持打开状态，并可用于接受后续的连接。
accept4(): 新添参数flags, SOCK_CLOSEEXEC-内核在调用返回的新文件描述符上启用close-on-exec标记 SOCK_NONBLOCK-内核在底层打开着的文件描述上启用O_NONBLOCK标记，后续I/O操作变成非阻塞,无需调用fcntl()获得同样效果。
*/
client_sock = accept(server_sock,
(struct sockaddr *)&client_name,
&client_name_len);
if (client_sock == -1)
error_die("accept");
accept_request(client_sock);
/*if (pthread_create(&newthread , NULL, accept_request, client_sock) != 0)
perror("pthread_create");*/
}
/*
如果多个文件描述符引用了一个socket，那么当所有文件描述符被关闭后连接就会被终止。
*/
close(server_sock);
return(0);
}
simple client:
#include <stdio.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <unistd.h>
int main(int argc, char *argv[])
{
int sockfd;
int len;
struct sockaddr_in address;
int result;
char ch = 'A';
//申请一个流 socket
sockfd = socket(AF_INET, SOCK_STREAM, 0);
//填充地址结构，指定服务器的 IP 和 端口
address.sin_family = AF_INET;
//inet_addr 可以参考 man inet_addr
//可以用现代的inet_pton()替代inet_addr(), example 中有参考例子
address.sin_addr.s_addr = inet_addr("127.0.0.1");
address.sin_port = htons(9734);
len = sizeof(address);
//下面的语句可以输出连接的 IP 地址
//但是inet_ntoa()是过时的方法，应该改用 inet_ntop(可参考 example)。但很多代码仍然遗留着inet_ntoa.
//printf("%s\n", inet_ntoa( address.sin_addr));
result = connect(sockfd, (struct sockaddr *)&address, len);
if (result == -1)
{
perror("oops: client1");
exit(1);
}
//往服务端写一个字节
write(sockfd, &ch, 1);
//从服务端读一个字符
read(sockfd, &ch, 1);
printf("char from server = %c\n", ch);
close(sockfd);
exit(0);
}
网友评论