lwip

更正文档 贡献说明

概述

LwIP(Light Weight Internet Protoco1)是瑞士计算机科学院(Swedish Institute of Computer Science)AdamDunkels等人开发的一套用于嵌入式系统的开放源代码TCP/IP协议栈。LWIP的含义是Light Weight(轻型)IP协议。LWIP可以移植到操作系统上,也可以在无操作系统的情况下独立运行。LWIP TCP/IP实现的重点是在保持TCP协议主要功能的基础上减少对RAM的占用。一般它只需要几十KB的RAM和40 KB左右的ROM就可以运行,这使LWIP协议栈适合在小型嵌入式系统中使用。 官网:https://savannah.nongnu.org/projects/lwip/ 将LwIP协议栈分成四层: 1.应用层 2.传输层 3.网络层 4.网卡层 本文将2,3,4统称为协议层 应用层支持: arp, dhcpd, dns, httpd, ifconfig, iperf, lsfd, mdns, netbiosns, ping, sendfile, snmp, sntp, telnetd, tftp

协议层支持: IP (Internet Protocol, IPv4 and IPv6) including packet forwarding over multiple network interfaces ICMP (Internet Control Message Protocol) for network maintenance and debugging IGMP (Internet Group Management Protocol) for multicast traffic management MLD (Multicast listener discovery for IPv6). Aims to be compliant with RFC 2710. No support for MLDv2 ND (Neighbor discovery and stateless address autoconfiguration for IPv6). Aims to be compliant with RFC 4861 (Neighbor discovery) and RFC 4862 (Address autoconfiguration) UDP (User Datagram Protocol) including experimental UDP-lite extensions TCP (Transmission Control Protocol) with congestion control, RTT estimation and fast recovery/fast retransmit raw/native API for enhanced performance Optional Berkeley-like socket API DNS (Domain names resolver)

版权信息

说明

Apache license v2.0

目录结构

├── api
│   ├── api_lib.c  # 库
│   ├── api_msg.c  # 消息机制
│   ├── err.c      # 异常api
│   ├── netbuf.c   # 网络缓存api
│   ├── netdb.c    # dns实现
│   ├── netifapi.c # 网卡api
│   ├── sockets.c  # 套接字api
│   └── tcpip.c    # tcpip任务实现
├── apps           # LwIP 应用
│   ├── arp        # arp应用
│   ├── dhcpd      # dhcpd应用
│   ├── dns        # dns应用
│   ├── httpd      # httpd应用
│   ├── ifconfig   # ifconfig应用
│   ├── iperf      # iperf应用
│   ├── lsfd       # lsfd应用
│   ├── mdns       # mdns应用
│   ├── netbiosns  # netbiosns应用
│   ├── ping       # ping应用
│   ├── sendfile   # sendfile应用
│   ├── snmp       # snmp应用
│   ├── sntp       # sntp应用
│   ├── telnetd    # telnetd应用
│   └── tftp       # tftp应用
├── core           # LwIP协议栈核心模块,IPv4/IPv6/TCP/UDP等协议实现
├── include        # 头文件
├── netif          # 网卡锡相关
└── port           # 移植对接

依赖组件

常用配置

系统中相关配置已有默认值,如需修改配置,统一在yaml中def_config节点修改,具体如下:

说明

使能TCPIP是1,不使能TCPIP是0,默认是1,可修改yaml配置如

def_config:
  CONFIG_TCPIP: 1

说明

使用AOS的LwIP是1, 不实用AOS的LwIP是0,默认是1,可修改yaml配置如:

def_config:
  CONFIG_AOS_LWIP: 1

说明

使能LwIP数据包打印功能是1, 不使能是0,默认1,可修改yaml配置如:

def_config:
  WITH_LWIP_PKTPRINT: 1

API说明

创建socket

int socket(int domain, int type, int protocol);

args

description

domain

协议域

type

类型

protocol

传输协议

绑定地址端口

int bind(int s, const struct sockaddr *addr, socklen_t namelen)

args

description

s

要绑定的 socket描述符

addr

一个指向含有本机 IP 地址和端口号等信息的 sockaddr 结构的指针

namelen

sockaddr 结构的长度

将套接字设为监听模式,并在套接字指定的端口上开始监听,以便对到达的服务请求进行处理

int listen(int s, int backlog)

args

description

s

要绑定的 socket描述符

backlog

连接请求队列可以容纳的最大数目

从完全建立的连接的队列中接受一个连接

int accept(int s, struct sockaddr *addr, socklen_t *addrlen)

args

description

s

socket描述符

backlog

连接请求队列可以容纳的最大数目

与服务器建立一个 TCP 连接

int connect(int s, const struct sockaddr *name, socklen_t namelen)

args

description

s

socket描述符

name

指向 sockaddr 结构的指针,存放要连接的服务器的 IP 地址和端口号等信息

namelen

sockaddr 结构体的长度

面向连接的数据流 socket 模式下发送数据

int send(int s, const void *dataptr, size_t size, int flags)

args

description

s

socket描述符

dataptr

指向所要发送的数据区的指针

size

要发送的字节数

flags

控制选项,通常为 0

面向连接的数据流 socket 模式下接收数据

int recv(int s, void *mem, size_t len, int flags)

args

description

s

socket描述符

mem

指向存储数据的内存缓存区的指针

len

缓冲区的长度

flags

控制选项,通常为 0

在无连接的数据报 socket 模式下发送数据

int sendto(int s, const void *dataptr, size_t size, int flags, const struct sockaddr *to, socklen_t tolen)

args

description

s

socket描述符

size

要发送的字节数

flags

控制选项,通常为 0

to

指向 sockaddr 结构体的指针,存放目的主机的 IP 和端口号

tolen

sockaddr 结构体的长度

在无连接的数据报 socket 模式下接收数据

int recvfrom(int s, void*mem, size_t size, int flags, struct sockaddr *from, socklen_t *fromlen)

args

description

s

socket描述符

mem

指向存储数据的内存缓存区的指针

size

缓冲区的长度

flags

控制选项,通常为 0

from

指向 sockaddr 结构体的指针,存放源主机的 IP 和端口号

fromlen

指向 sockaddr 结构体的长度的指针

查询一个或者多个socket的可读性、可写性及错误状态信息

int select(int maxfdp1, fd_set *readset, fd_set *writeset, fd_set *exceptset,
                struct timeval *timeout)

args

description

maxfdp1

最大的文件描述符

readset

读文件描述符

writeset

写文件描述符

exceptset

异常的文件描述符

timeout

超时时间

传输完数据之后关闭 socket 并释放资源

int closesocket(int s)

args

description

s

socket 描述符

允许进行单向的关闭操作,或是全部禁止掉

int shutdown(int s, int how)

args

description

s

socket 描述符

how

控制选项

通过域名来获取主机的 IP 地址等信息

struct hostent* gethostbyname(const char*name)

args

description

name

主机域名

获取本地主机的信息

int getsockname(int s, struct sockaddr *name, socklen_t *namelen)

args

description

s

socket 描述符

name

sockaddr 结构体指针,用来存储得到的主机信息

namelen

指向 sockaddr 结构体的长度的指针

得到与本地主机连接的远程主机的信息

int getpeername(int s, struct sockaddr *name, socklen_t *namelen)

args

description

s

socket 描述符

name

sockaddr 结构体指针,用来存储得到的主机信息

namelen

指向 sockaddr 结构体的长度的指针

设置套接字控制模式

int ioctlsocket(int s, long cmd, void *argp)

args

description

s

socket 描述符

cmd

套接字操作命令

argp

操作命令所带参数

获取套接字控制模式

int getsockopt (int s, int level, int optname, void *optval, socklen_t *optlen)

args

description

s

socket 描述符

level

选项定义的层次;目前支持SOL_SOCKET, SOL_PACKET, IPPROTO_IP和IPPROTO_TCP

optname

需设置的选项

optval

指向option属性的指针

optlen

指向option属性长度的指针

设置套接字控制模式

int setsockopt (int s, int level, int optname, const void *optval, socklen_t optlen)

args

description

s

socket 描述符

level

选项定义的层次;目前支持SOL_SOCKET, SOL_PACKET, IPPROTO_IP和IPPROTO_TCP

optname

需设置的选项

optval

指向option属性的指针

optlen

option属性的长度

使用示例

组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具,所以首先需要参考《AliOS Things集成开发环境使用说明之搭建开发环境》,下载安装。 待开发环境搭建完成后,可以按照以下步骤进行示例的测试。

步骤1 创建或打开工程

打开已有工程

如果用于测试的案例工程已存在,可参考《AliOS Things集成开发环境使用说明之打开工程》打开已有工程。

创建新的工程

组件的示例代码可以通过编译链接到AliOS Things的任意案例(solution)来运行,这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考《AliOS Things集成开发环境使用说明之创建工程》

步骤2 添加组件

案例下载完成后,需要在helloworld_demo组件的package.yaml中添加对组件的依赖:

depends:
  - netmgr:dev_aos     # 添加netmgr依赖,使用netmgr连接wifi
  - lwip:dev_aos       # helloworld_demo中引入lwip组件

步骤3 下载组件

在已安装了 的开发环境工具栏中,选择Terminal -> New Terminal启动终端,并且默认工作路径为当前工程的workspace,此时在终端命令行中输入:


aos install lwip

上述命令执行成功后,组件源码则被下载到了./components/lwip路径中。

步骤4 添加示例

在lwip组件的package.yaml中添加example示例代码

source_file:
  - example/*.c

步骤5 编译固件

在示例代码已经添加至组件的配置文件,并且helloworld_demo已添加了对该组件的依赖后,就可以编译helloworld_demo案例来生成固件了,具体编译方法可参考《AliOS Things集成开发环境使用说明之编译固件》

步骤6 烧录固件

helloworld_demo案例的固件生成后,可参考《AliOS Things集成开发环境使用说明之烧录固件》来烧录固件。

步骤7 打开串口

固件烧录完成后,可以通过串口查看示例的运行结果,打开串口的具体方法可参考《AliOS Things集成开发环境使用说明之查看日志》

当串口终端打开成功后,可在串口中输入help来查看已添加的测试命令。

步骤8 测试示例

说明

CLI命令行输入netmgr相关命令进行联网操作:

netmgr_example                           # 启动netmgr组件
netmgr -t wifi -c wifissid wifipassword  # 输入ssid和密码

说明

CLI命令行输入udp 测试命令:

test_udp

关键日志

说明

输入联网命令后的WIFI联网成功日志:

Got IP

说明

启动test_udp之后的数据接收打印:

test_udp

(cli-uart)# hello world! count 15
recv: hello UDP
hello world! count 16
recv: hello UDP
hello world! count 17
recv: hello UDP
hello world! count 18
recv: hello UDP
hello world! count 19
recv: hello UDP

注意事项

  • 使用lwip前,请先确定已经联网

测试示例

说明

CLI命令行输入ping测试命令

ping -c count(发包的数量) -i interval(发包的时间间隔ms) -s packetsize(指定发包的字节数) -w timeout(指定超时时间ms) destination(指定目标地址)

说明

CLI命令行输入查看设备网络接口的配置信息命令

ifconfig

说明

CLI命令行输入tftp向服务器获取文件命令

tftp server <start|stop>
tftp get server_ip(服务器ip) server_port(服务器端口) server_src_path(服务器文件路径) device_dest_path(设备目标文件路径) file_type(文件类型)
示例:tftp get 192.168.0.101 69 1.txt /data/1.txt text

说明

CLI命令行输入iperf测试网络性能

Iperf TCP Server: iperf -s
Iperf UDP Server: iperf -s -u
Iperf TCP Client: iperf -c ip(服务器ip地址) -w window size(TCP窗口大小) -t duration(传输时间,默认10s) -p port(服务器端口号)
示例:iperf -c 192.168.0.101 -w 65535 -t 10 -p 5001
Iperf UDP Client: iperf -c ip(目标ip地址) -u -l datagram size(数据包大小) -t duration(传输时间,默认10s) -p port(服务器端口号)
示例:iperf -c 192.168.0.101 -u -l 1500 -t 10 -p 5001

关键日志

说明

ping成功收到数据包日志

 LwIP_recv

说明

ifconfig成功查看设备网络接口的配置信息日志

 en1 up, address:192.168.0.102 gateway:192.168.0.1 netmask:255.255.255.0
 lo0 up, address:127.0.0.1 gateway:127.0.0.1 netmask:255.0.0.0

说明

tftp成功获取文件日志

tftp received len:92 done

说明

iperf测试日志

TCP Server Bandwidth: 8 Mbits 716 Kbits 848 bits/sec
UDP Server Bandwidth: 10 Mbits 60 Kbits 344 bits/sec
TCP Client Bandwidth: 5 Mbits 1023 Kbits 928 bits/sec
UDP Client Bandwidth: 22 Mbits 907 Kbits 160 bits/sec

FAQ

NA