Tinyhttpd 源码学习

Tinyhttpd 是一个超轻量型 Http Server，使用C语言开发，附带一个简单的Client，通过学习 Tinyhttpd 可以帮助理解一个 Http Server 的本质。源码可以在这个网站获取：https://sourceforge.net/projects/tiny-httpd/

首先将源码下载到本地，我们可以看到项目代码主要有主程序 httpd.c ，一个客户端 simpleclient.c ，htdocs 下则是一个界面和一些 cgi 脚本，其它则是一些编译相关的文件，项目结构如下图：

其中，httpd 与 client 是 在项目下运行 make all 命令生成的可执行程序，运行 httpd ，在浏览器打开可以看到如下的界面：

界面

这就是一个可以提供 http 服务的 http server 啦，下面我们来看下主程序，即 httpd.c 文件。


主文件开头有两段注释，一个是程序注解，包括了程序的简单描述，作者，时间，（好家伙，1999年，远古大神），还有地址，这也是国际惯例了，大家在编码的时候也要良好的习惯哈。
另一段则说明了这个程序是在 Sparc Solaris 2.6 下编写运行的，如果要在 linux 下编译运行的话需要改变一些编码，按照说明一一修改即可。

一般情况下， 在代码层面 main 函数就是程序运行的起点，因此我们阅读源码也从 main 函数入手，我们可以在 main 函数开头看到，作者创建了一些局部变量用来保存后续创建网络连接的参数与一个客户端变量，在后续的代码中，我们可以更直观的看到这些参数的作用。

随后，调用 startup 函数，传入之前创建的 port 参数，并用 server_sock 记录返回值，这里就是 sock fd。

接下来我们进入 startup 函数看看其做了什么，首先调用 系统函数 socket 创建了一个 socket ，随后设置网络地址与端口并保存在一个 sockaddr_in 的结构中，变量名为 name，紧接着调用系统函数 setsockopt ，这个函数的作用是保证在一定时间内返回，从而避免在 tcp 连接中调用某些函数时一直阻塞，然后调用系统函数 bind 将之前创建的 socket 与 地址端口 name 进行绑定，接下来，添加了一个对 端口为零的判断，如果为零的话则对其进行动态分配，并将分配的值赋予 port 参数。最后，开启对该 socket 的监听，返回该的 socket fd 至函数的调用者 main 函数中。

startup

接着回到 main 函数，可以看到开启了一个一直运行的循环，循环体内，调用 系统函数 accept ，这是一个阻塞函数，从已经建立连接的队列中取出一个连接返回给 client_sock，并赋值 client_name 。然后判断如果这个连接的值为 -1 ，说明发生错误，就调用辅助函数 error_die 打印错误并退出程序。如果连接有效，就调用 accept_request 函数去进行处理，处理完就会重新进入循环，依旧从 accept 函数执行，如果没有出现连接错误就会一直运行下去。

我们进入 accept_request 函数看下是如何处理客户端请求的：

1. 首先声明 client buf 等需要用到的局部变量。

2. 然后调用 get_line 从客户端与服务端的连接socket 中读取数据。

3. 随后对读取到的数据进行处理：
   a. 首先从数据头部读取请求方法；
   b. 再根据请求方法去选择下面的行为，如果方法为 “get" "post" 并存，则调用 unimplemented 函数返回错误信息，并返回主函数；
   c. 如果是 post 方法，把 cgi 设置为 1；
   d. 接着 读取 url ；
   e. 对 url 进行解析，如果方法为 get 并且 url 中 包含 ’？‘ 字符，则把 cgi 设置为1；
   f. 把 url 存入 path 变量中，如果url 最后为 ‘' ，则在 path 末尾 添加 ’index.html' ；
   g. 使用 stat 从 path 中获取文件信息，并保存在 stat 中。
   h. 如果上一步出错，则把剩余数据读完，然后调用 not_found 返回错误；
   i. 接着判断是否是一个文件夹，如果是，在 path 后面添加上 ‘index.html’ ；
   j. 接着判断如果有执行权限，则设置 cgi 为 1；

   
   
   这里使用位模式判断文件类型与执行权限

4. 最后如果 cgi 为 0，则调用serve_file 函数，如果 cgi 为 1， 则调用 execute_cgi 函数，
   最后关闭 socket 并返回。

serve_file 函数 则是把客户端请求的文件以流的形式发给客户端，调用了 cat 函数。

execute_cgi 函数 顾名思义，就是执行 cgi 脚本了，具体的话：

1. 判断请求类型，如果为 get 则无需处理，如果为 post 则读取 content_lentgh 与 content；
2. 建立 cgi 输入输出管道。
3. 建立成功后发送请求成功头；
4. 使用子进程执行 cgi 请求：
   a. 重定向输入输出管道，关闭无用管道；
   b. 设置 cgi 环境；
   c. 执行 path, 退出 子进程。
5. 主进程则负责将收到的 post 写入输入管道供子进程读取，并将输出管道中子进程处理后的消息取出发送给客户端。

最后，建议阅读顺序为 main -> startup -> accept_request -> serve_file -> execute_cgi.

其它就是一些辅助工具类函数了，
bad_request 用于返回客户端错误请求信息,
cat 把文件所有信息发送给客户端,
cannot_execute 返回客户端服务器无法执行 cgi 的信息,
error_die 打印错误并跳出循环退出程序,
get_line 按行读取 socket 数据并返回数据字节数,
headers 返回 http 头信息给客户端,
not_found 返回客户端 404 错误信息,
unimplemented 返回客户端请求方法不支持信息。

这虽然是一份只有 500 行的代码，但是可以帮助了解一个简单的服务器的实现与基本功能，此外大佬的代码风格还是很值得学习的。