TinyHttpd开源项目的阅读笔记

于 2020-10-06 13:44:34 发布
阅读量218 收藏
点赞数 1
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Mirxat08/article/details/108929422
版权
本文详细解读了TinyHttpd开源项目的代码，从main函数开始，逐步剖析了startup、accept_request和execute_cgi等关键函数的实现，讲解了如何启动HTTP服务、接收请求、处理CGI程序的过程，适合初学者了解HTTP服务器的工作原理。
摘要由CSDN通过智能技术生成

TinyHttpd开源项目的阅读笔记

这是本人刚开始精读开源项目，若有理解错误的或者说的不对的还望大家指点，一起进步，谢谢大家的支持。

TinyHttpd源码地址

下载好源码后就开始阅读了。

什么是TinyHttpd？

tinyhttpd 是一个超轻量型 Http Server，使用C语言开发，全部代码只有500多行(包括注释)，附带一个简单的Client，可以通过阅读这段代码理解一个 Http Server 的本质。

建议源码阅读顺序： main -> startup -> accept_request -> execute_cgi，通晓主要工作流程后再仔细把每个函数的源码看一看。

程序流程

从main()函数开始

int main(void) {
    int server_sock = -1;
    u_short port = 4000;
    int client_sock = -1;
    struct sockaddr_in client_name;
    socklen_t  client_name_len = sizeof(client_name);
    pthread_t newthread;

    server_sock = startup(&port);
    printf("httpd running on port %d\n", port);

    while (1) {
        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, (void *)accept_request, (void *)(intptr_t)client_sock) != 0) {
            perror("pthread_create");
        }
    }

    close(server_sock);

    return(0);
}

startup()

  1. 程序进入startup()函数，该函数作用为初始化httpd服务，包括建立套接字、绑定端口、进行监听等。
    源码如下：
int startup(u_short *port) {
    int httpd = 0;
    int on = 1;
    struct sockaddr_in name;

    httpd = socket(PF_INET, SOCK_STREAM, 0);
    if (httpd == -1) {
        error_die("socket");
    }
    memset(&name, 0, sizeof(name));
    name.sin_family = AF_INET;
    name.sin_port = htons(*port);
    name.sin_addr.s_addr = htonl(INADDR_ANY);
    if ((setsockopt(httpd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on))) < 0)  {  
        error_die("setsockopt failed");
    }
    if (bind(httpd, (struct sockaddr *)&name, sizeof(name)) < 0) {
        error_die("bind");
    }
    if (*port == 0) {  /* if dynamically allocating a port */
        socklen_t namelen = sizeof(name);
        if (getsockname(httpd, (struct sockaddr *)&name, &namelen) == -1) {
            error_die("getsockname");
        }
        *port = ntohs(name.sin_port);
    }
    if (listen(httpd, 5) < 0) {
        error_die("listen");
    }
    return(httpd);
}

accept_request

  1. 处理从套接字上监听到的一个 HTTP 请求，取出 HTTP 请求中的 method (GET 或 POST) 和 url。
  2. 格式化 url 到 path 数组，表示浏览器请求的服务器文件路径，在 tinyhttpd 中服务器文件是在 htdocs 文件夹下。当 url 以 / 结尾，或 url 是个目录，则默认在 path 中加上 index.html，表示访问主页。
  3. 如果文件路径合法，对于无参数的 GET 请求，直接输出服务器文件到浏览器，即用 HTTP 格式写到套接字上。其他情况（带参数 GET，POST 方式，url 为可执行文件），则调用 excute_cgi 函数执行 cgi 脚本。
void accept_request(void *arg)
{
    int client = (intptr_t)arg;
    char buf[1024];
    size_t 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;

    numchars = get_line(client, buf, sizeof(buf));
    i = 0; j = 0;
    while (!ISspace(buf[i]) && (i < sizeof(method) - 1))
    {
        method[i] = buf[i];
        i++;
    }
    j=i;
    method[i] = '\0';

    if (strcasecmp(method, "GET") && strcasecmp(method, "POST"))
    {
        unimplemented(client);
        return;
    }

    if (strcasecmp(method, "POST") == 0)
        cgi = 1;

    i = 0;
    while (ISspace(buf[j]) && (j < numchars))
        j++;
    while (!ISspace(buf[j]) && (i < sizeof(url) - 1) && (j < numchars))
    {
        url[i] = buf[j];
        i++; j++;
    }
    url[i] = '\0';

    if (strcasecmp(method, "GET") == 0)
    {
        query_string = url;
        while ((*query_string != '?') && (*query_string != '\0'))
            query_string++;
        if (*query_string == '?')
        {
            cgi = 1;
            *query_string = '\0';
            query_string++;
        }
    }

    sprintf(path, "htdocs%s", url);
    if (path[strlen(path) - 1] == '/')
        strcat(path, "index.html");
    if (stat(path, &st) == -1) {
        while ((numchars > 0) && strcmp("\n", buf))  /* read & discard headers */
            numchars = get_line(client, buf, sizeof(buf));
        not_found(client);
    }
    else
    {
        if ((st.st_mode & S_IFMT) == S_IFDIR)
            strcat(path, "/index.html");
        if ((st.st_mode & S_IXUSR) ||
                (st.st_mode & S_IXGRP) ||
                (st.st_mode & S_IXOTH)    )
            cgi = 1;
        if (!cgi)
            serve_file(client, path);
        else
            execute_cgi(client, path, method, query_string);
    }

    close(client);
}

execute_cgi

  1. 运行 cgi 程序的处理，读取整个 HTTP 请求并丢弃，如果是 POST 则找出 Content-Length. 把 HTTP 200 状态码写到套接字。
  2. 建立两个管道，cgi_input 和 cgi_output, 并 fork 一个进程。
  3. 在子进程中，把 STDOUT 重定向到 cgi_output 的写入端，把 STDIN 重定向到 cgi_input 的读取端，关闭 cgi_input 的写入端 和 cgi_output 的读取端，设置 request_method 的环境变量，GET 的话设置 query_string 的环境变量，POST 的话设置 content_length 的环境变量，这些环境变量都是为了给 cgi 脚本调用。接着用 execl运行 cgi 程序。
  4. 在父进程中，关闭 cgi_input 的读取端 和 cgi_output 的写入端，如果 POST 的话，把 POST 数据写入 cgi_input，已被重定向到 STDIN，读取 cgi_output 的管道输出到客户端，该管道输入是 STDOUT。接着关闭所有管道，等待子进程结束。
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[0] = 'A'; buf[1] = '\0';
    if (strcasecmp(method, "GET") == 0)
        while ((numchars > 0) && strcmp("\n", buf))  /* read & discard headers */
            numchars = get_line(client, buf, sizeof(buf));
    else if (strcasecmp(method, "POST") == 0) /*POST*/
    {
        numchars = get_line(client, buf, sizeof(buf));
        while ((numchars > 0) && strcmp("\n", buf))
        {
            buf[15] = '\0';
            if (strcasecmp(buf, "Content-Length:") == 0)
                content_length = atoi(&(buf[16]));
            numchars = get_line(client, buf, sizeof(buf));
        }
        if (content_length == -1) {
            bad_request(client);
            return;
        }
    }
    else/*HEAD or other*/
    {
    }


    if (pipe(cgi_output) < 0) {
        cannot_execute(client);
        return;
    }
    if (pipe(cgi_input) < 0) {
        cannot_execute(client);
        return;
    }

    if ( (pid = fork()) < 0 ) {
        cannot_execute(client);
        return;
    }
    sprintf(buf, "HTTP/1.0 200 OK\r\n");
    send(client, buf, strlen(buf), 0);
    if (pid == 0)  /* child: CGI script */
    {
        char meth_env[255];
        char query_env[255];
        char length_env[255];

        dup2(cgi_output[1], STDOUT);
        dup2(cgi_input[0], STDIN);
        close(cgi_output[0]);
        close(cgi_input[1]);
        sprintf(meth_env, "REQUEST_METHOD=%s", method);
        putenv(meth_env);
        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(path, NULL);
        exit(0);
    } else {    /* parent */
        close(cgi_output[1]);
        close(cgi_input[0]);
        if (strcasecmp(method, "POST") == 0)
            for (i = 0; i < content_length; i++) {
                recv(client, &c, 1, 0);
                write(cgi_input[1], &c, 1);
            }
        while (read(cgi_output[0], &c, 1) > 0)
            send(client, &c, 1, 0);

        close(cgi_output[0]);
        close(cgi_input[1]);
        waitpid(pid, &status, 0);
    }
}

运行

终端进入Tinyhttpd目录下会有Makefile
在这里插入图片描述
输入命令make会进行编译
在这里插入图片描述
编译完后输入**./httpd**即可运行
在这里插入图片描述

大佬学习叫上我
关注
基于Java的开源项目与笔记设计源码分享
10-11
本项目汇集了基于Java的开源项目和笔记设计源码，包含376个文件，其中包含270个PNG图片、74个Markdown文档、25个Java源代码文件，以及少量Git忽略、YAML和XML文件。资源丰富，适用于学习和交流Java编程与开源项目...
tinyhttpd——C语言实现最简单的HTTP服务器
测试
06-28 1072
目录 tinyhttpd —— C 语言实现最简单的 HTTP 服务器1. 主要函数2. 工作流程3. 注释版源码4. 编译运行 tinyhttpd —— C 语言实现最简单的 HTTP 服务器 参考转载至： https://github.com/AngryHa...
Tinyhttpd精读解析
We_are_family678的博客
03-19 691
    首先，本人刚刚开始开源代码精读，写的不对的地方，大家轻拍，一起进步。本文是对Tinyhttpd的一次精读，大家每天都在用着http服务，很多人也一直活跃在上层，使用IIS、Apache等，大家是否想看看http服务器大概是怎么运作的，通过一个500多行的源码加上完整的注释，和大家逛一逛http服务器。Tinyhttpd真的非常适合阅读尤其是刚入门的，清晰的代码，简单的makefile......
五大开源Web服务器
热门推荐
yi412的专栏
05-19 1万+
开源产品的出现不仅获得了个人用户的喜爱，众多知名企业也青睐于它。虽然开源产品数不胜数，但并不是每一个开源产品都能被广泛应用并得到大众的好评。在众多成功的开源产品中，只有少数领头羊，而其它产品只能望其项背。本文汇总了五款开源Web服务器，来看看有没有你需要的吧! 　　Apache 　　 　　 　　Apache是一个免费的网络服务器系统，基于“开源”许可发布。阿帕奇版本2.0在大部分基于U
Tinyhttpd的实现和一些基本问题的解决
大洋深处
05-07 1681
TInyhttpd是一个简单的http服务器的实现，代码总共有500多行，但是读下来对http的具体实现过程和linux网络编程的学习都很有好处。我重写了代码，然后进行了详细的注释。注释见详细代码。 具体的可以用图表示： 代码： /*#!/usr/bin/env * ****************************************************** * Last...
tinyhttpd初学分析
zhuang20170703的博客
04-18 573
刚开始学习服务端相关的知识，对服务器程序没有了解，学习tinyhttpd是一个超轻量型的http server，可以用来了解服务器程序的本质和流程。Tinyhttpd的代码只有500行左右，比较易于阅读。代码下载：https://sourceforge.net/projects/tinyhttpd/在linux虚拟机上运行程序可以参照：https://blog.csdn.net/zhuang201...
zentaopms-开源项目
09-14
—— 开源项目 开源项目 开源项目 开源项目 开源项目
开源网络云笔记系统 Paperwork.zip
07-19
Paperwork 是一个开源网络云笔记系统，是 Evernote、Microsoft OneNote 和 Google Keep 的开源替代品。Paperwork 采用 PHP 开发，使用 Laravel 4 框架，提供一个很流行的 Web UI，基于 AngularJS 和 Bootstrap 3 ...
Java最著名的开源项目
04-05
在Java的生态系统中，存在诸多著名的开源项目，这些项目各有特色，为Java开发人员提供了丰富的开发工具和应用架构。以下是对一些Java著名开源项目的详细介绍，它们分别在不同的开发领域中扮演着重要角色。 首先，...
FPGA优质开源项目获取方式
08-02
内容包括各种FPGA优质开源项目的获取方式：1.FPGA优质开源模块 - SRIO、2.FPGA优质开源项目 - UDP RGMII千兆以太网、3.FPGA优质开源项目 - PCIE通信、4.FPGA优质开源项目 - DDR3读写、5.FPGA优质开源项目 - UDP万兆...
Tinyhttp源码分析
没有最好，只有更好！
05-29 1万+
Tinyhttp源码分析 简介Tinyhttp是一个轻量型Http Server，使用C语言开发，全部代码只500多行，还包括一个简单Client。 源码剖析Tinyhttp程序的逻辑为：一个无线循环，一个请求，创建一个线程，之后线程函数处理每个请求，然后解析HTTP请求，做一些判断，之后判断文件是否可执行，不可执行，打开文件，输出给客户端（浏览器），可执行就创建管道，父子进程进行通信。其整体处理流
电子商务之价格优化算法：梯度下降：机器学习在价格优化中的角色.docx
11-05
电子商务之价格优化算法：梯度下降：机器学习在价格优化中的角色.docx
ToadforOracle与Oracle数据库版本兼容性教程.docx
11-05
ToadforOracle与Oracle数据库版本兼容性教程.docx
browser360-cn-stable-13.3.1016.4-1-amd64.deb
11-05
360浏览器银河麒麟版 for X86 适配兆芯 / 海光 / intel / AMD CPU
基于React.js和Material-UI个人作品集网站模板（附源码+说明文档）.zip
11-05
使用React.js构建,提供多种主题可供选择,并且易于定制。该项目旨在帮助开发者和自由职业者创建自己的个性化投资组合。 主要功能点 多种主题可供选择,包括绿色、黑白、蓝色、红色、橙色、紫色、粉色和黄色 易于定制,可以在src/data文件夹中更新个人信息 包含主页、关于、简历、教育、技能、经验、项目、成就、服务、推荐信、博客和联系等多个部分 支持通过Google表单收集联系信息 提供SEO优化建议 支持多种部署方式,如Netlify、Firebase、Heroku和GitHub Pages 技术栈主要 React.js Material-UI Axios React-fast-marquee React-helmet React-icons React-reveal React-router-dom React-router-hash-link React-slick Slick-carousel Validator
中小型企业财务管理系统 SSM毕业设计 附带论文.zip
最新发布
11-05
中小型企业财务管理系统 SSM毕业设计 附带论文 启动教程:https://www.bilibili.com/video/BV1GK1iYyE2B
apsw-3.38.5.post1-cp39-cp39-win_amd64.whl.rar
11-05
python whl离线安装包 pip安装失败可以尝试使用whl离线安装包安装 第一步 下载whl文件，注意需要与python版本配套 python版本号、32位64位、arm或amd64均有区别 第二步 使用pip install XXXXX.whl 命令安装，如果whl路径不在cmd窗口当前目录下，需要带上路径 WHL文件是以Wheel格式保存的Python安装包， Wheel是Python发行版的标准内置包格式。 在本质上是一个压缩包，WHL文件中包含了Python安装的py文件和元数据，以及经过编译的pyd文件， 这样就使得它可以在不具备编译环境的条件下，安装适合自己python版本的库文件。 如果要查看WHL文件的内容，可以把.whl后缀名改成.zip，使用解压软件（如WinRAR、WinZIP）解压打开即可查看。 为什么会用到whl文件来安装python库文件呢？ 在python的使用过程中，我们免不了要经常通过pip来安装自己所需要的包， 大部分的包基本都能正常安装，但是总会遇到有那么一些包因为各种各样的问题导致安装不了的。 这时我们就可以通过尝试去Python安装包大全中（whl包下载）下载whl包来安装解决问题。
电子商务之价格优化算法：线性回归：价格优化策略实施.docx
11-05
电子商务之价格优化算法：线性回归：价格优化策略实施.docx
工业数字化转型的关键技术及其应用场景解析
11-05
内容概要：报告详细介绍了企业数字化转型的驱动因素、数字化转型方案分类及其应用场景，重点关注了云计算、超连接、数字孪生、人工智能、分布式账本、增材制造、人机接口、数据共享、工业物联网等关键技术。这些技术不仅支持了企业的运营效率提升和业务模式创新，也为实现更快、更开放、更高效的数字化转型提供了支撑。报告最后提出了企业实施数字化转型的六个步骤。 适合人群：企业高级管理人员、技术人员、咨询顾问，以及对工业数字化转型感兴趣的读者。 使用场景及目标：帮助企业制定和实施数字化转型策略，优化运营模式，提升业务效率，增强市场竞争力。同时，也可作为政府部门、研究机构和行业协会的参考文献。 其他说明：报告中提到的关键技术及其应用场景对企业数字化转型具有重要的指导意义，特别是对于那些希望通过数字化转型实现业务创新和升级的企业。
GitHub热门：57大深度学习开源项目一览
"GitHub上最受欢迎的57个深度学习开源项目" 深度学习是现代人工智能领域的一个重要组成部分，它已经在图像识别、自然语言处理、语音识别等多个领域取得了显著成果。随着技术的发展，许多顶级科技公司和研究机构纷纷...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值