有限状态机是逻辑单元内部的一种高效编程方法。
有的应用层协议头部包含数据包类型字段,每种类型可以映射为逻辑单元的一种执行状态,服务器可以根据它来编写相应的处理逻辑,代码如下:
STATE_MACHINE(Packahe _pack)
{
PackageType _type = _pack.GetType();
switch (_type)
{
case type_A:
process_package_A(_pack);
break;
case type_B:
process_package_B(_pack);
break;
default:
break;
}
}
这就是一个简单的有限状态机,只不过该状态机的每个状态都是相互独立的,即状态之间没有相互转移。状态之间的转移是需要状态机内部驱动的。下面是带状态转移的有限状态机:
STATE_MACHINE()
{
State cur_State = type_A;
while(cur_State != type_C)
{
Package _pack = getNewPackage();
switch (cur_State)
{
case type_A:
process_package_state_A(_pack);
cur_State = type_B;
break;
case type_A:
process_package_state_B(_pack);
cur_State = type_C;
break;
default:
break;
}
}
}
该状态机包含三种状态:type_A、type_B和type_C,其中type_A是状态机的开始状态,type_C是状态机的结束状态。状态机的当前状态记录在cur_State变量中。在一趟循环过程中,状态机先通过getNewPackage方法获得一个新的数据包,然后根据cur_State变量的值判断如何处理该数据包。数据包处理完之后,状态机通过cur_State变量传递目标状态值来实现状态转移。那么当状态机进入下一趟循环时,它将执行新的状态对应的逻辑。
下面我们考虑有限状态机应用的一个实例:HTTP请求的读取和分析。
很多网络协议,包括TCP协议和IP协议,都在其头部中提供头部长度字段。程序根据该字段的值就可以知道是否接受到一个完整的协议头部。但HTTP协议并未提供这样的头部长度字段,并且其头部长度变化也很大,可以只有十几字节,也可以有上百字节。
根据协议规定,我们判断HTTP头部结束的依据是遇到一个空行,该空行包含一对回车换行符(
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
/*读缓冲区大小*/
#define BUFFER_SIZE 4096
/*
主状态机的两种可能状态,分别表示:
当前正在分析请求行,
当前正在分析头部字段
*/
enum CHECK_STATE{
CHECK_STATE_REQUESTLINE = 0,
CHECK_STATE_HEADER
};
/*
从状态机的三种可能状态,即行的读取状态:
读取到一个完整的行,
行出错,
行数据尚且不完整,
*/
enum LINE_STATUS{
LINE_OK = 0,
LINE_BAD,
LINE_OPEN
};
/*服务器处理HTTP请求的结果*/
enum HTTP_CODE{
NO_REQUEST, //请求不完整,需要继续读取客户数据
GET_REQUEST, //获得一个完整的客户请求
BAD_REQUEST, //客户请求有语法错误
FORBIDDEN_REQUEST, //ch客户对资源没有足够的访问权限
INTERNAL_ERROR, //服务器内部错误
CLOSED_CONNECTION //客户端已经关闭连接了
};
/*为简化问题,没有给客户端发送一个完整的HTTP应答报文,
而只是根据服务器的处理结果发送如下成功或失败信息*/
static const char* szret[] = {"I get a correct result\n", "Something wrong\n"};
/*从状态机, 用于解析出一行内容*/
LINE_STATUS parse_line(char* buffer, int& checked_index, int& read_index)
{
char temp;
/*checked_index指向buffer(应用程序的读缓冲区)中当前正在分析的字节,
read_index指向buffer中客户数据的尾部的下一字节。
buffer中第0~checked_index都已经分析完毕。
第checked_index ~ (read-index-1)字节由下面的循环挨个分析*/
for(; checked_index < read_index; ++checked_index){
/*获取当前要分析的字节*/
temp = buffer[checked_index];
/*如果当前的字节是'\r',即回车符,则说明可能读取一个完整的行*/
if(temp == '\r'){
/*如果"\r"字符碰巧是目前buffer中的最后一个已经被读入的客户数据,
那么这次分析没有读取到一个完整的行,
返回LINE_OPEN以表示还需要读取客户端才能进一步分析*/
if( checked_index + 1 == read_index ){
return LINE_OPEN;
}
/*如果下一个字符是"\n",则说明我们成功读取到一个完整的行*/
else if (buffer[checked_index+1] == '\n'){
buffer[checked_index++] = '\0';
buffer[checked_index++] = '\0';
return LINE_OK;
}
/*否则的话,说明客户端发送的HTTP请求存在语法错误*/
return LINE_BAD;
}
/*如果当前字节是"\n",即换行符,则也说明可能读取到一个完整的行*/
else if(temp == '\n'){
if((checked_index > 1) && (buffer[checked_index - 1] == '\r')){
buffer[checked_index-1] = '\0';
buffer[checked_index++] = '\0';
return LINE_OK;
}
return LINE_BAD;
}
}
/*如果所有内容都分析完毕也没遇到"\r"则返回LINE_OPEN,
表示还需要继续读取客户数据才能进一步分析*/
return LINE_OPEN;
}
/*分析请求行*/
HTTP_CODE parse_requestline(char* temp, CHECK_STATE& checkstate)
{
char *url = strpbrk(temp, " \t");
/*如果请求行中没有空白字符或"\t"字符,则HTTP请求必有问题*/
if(!url){
return BAD_REQUEST;
}
*url++ = '\0';
char* method = temp;
if(strcasecmp(method, "GET") == 0){
//仅支持GET方法
printf("The request method is GET\n");
}
else{
return BAD_REQUEST;
}
url += strspn(url, " \t");
char* version = strpbrk(url, " \t");
if(!version){
return BAD_REQUEST;
}
*version++ = '\0';
version += strspn(version, " \t");
if(strcasecmp(version, "HTTP/1.1") != 0){
return BAD_REQUEST;
}
if(strncasecmp(url, "http://", 7) == 0){
url += 7;
url = strchr(url, '/');
}
if(!url || url[0] != '/n'){
return BAD_REQUEST;
}
printf("The request URL is: %s\n", url);
/*HTTP请求行处理完毕,状态转移到头部字段的分析*/
checkstate = CHECK_STATE_HEADER;
return NO_REQUEST;
}
/*分析头部字段*/
HTTP_CODE parse_headers(char *temp)
{
/*遇到一个空行,说明我们得到了一个正确的HTTP请求*/
if(temp[0] == '\0'){
return GET_REQUEST;
}
else if (strncasecmp(temp, "Host:", 5) == 0){
temp += 5;
temp += strspn(temp, " \t");
printf("the request host is: %s\n", temp);
}
else{
printf("I can not handle this header\n");
}
return NO_REQUEST;
}
/*分析HTTP请求的入口函数*/
HTTP_CODE parse_content(char* buffer, int& checked_index, CHECK_STATE& checkstate,
int& read_index, int& start_line)
{
LINE_STATUS linestatus = LINE_OK; /*记录当前行的读取状态*/
HTTP_CODE retcode = NO_REQUEST; /*记录HTTP请求的处理结果*/
/*主状态机, 用于从buffer中取出所有完整的行*/
while((linestatus = parse_line(buffer, checked_index, read_index)) == LINE_OK){
char * temp = buffer + start_line; /*start_line是行在buffer中的起始位置*/
start_line = checked_index; /*记录下一行的起始位置*/
/*checkstate记录主状态机的当前状态*/
switch (checkstate)
{
case CHECK_STATE_REQUESTLINE:
retcode = parse_requestline(temp, checkstate);
if(retcode == BAD_REQUEST){
return BAD_REQUEST;
}
break;
case CHECK_STATE_HEADER:
retcode = parse_headers(temp);
if(retcode == BAD_REQUEST){
return BAD_REQUEST;
}
else if(retcode == GET_REQUEST){
return GET_REQUEST;
}
break;
default:
return INTERNAL_ERROR;
}
}
if (linestatus == LINE_OPEN){
return NO_REQUEST;
}
else{
return BAD_REQUEST;
}
}
int main(int argc, char const *argv[])
{
if(argc < 2){
printf("usage: %s ip_address port_number\n", basename(argv[0]));
return 1;
}
const char* ip = argv[1];
int port = atoi(argv[2]);
struct sockaddr_in address;
bzero(&address, sizeof(address));
address.sin_family = AF_INET;
inet_pton(AF_INET, ip ,&address.sin_addr);
address.sin_port = htons(port);
int listenfd = socket(PF_INET, SOCK_STREAM, 0);
assert(listen >= 0);
int ret = bind(listenfd, (struct sockaddr*)&address, sizeof(address));
assert(ret != -1);
ret = listen(listenfd, 5);
assert(ret != -1);
struct sockaddr_in client_address;
socklen_t client_addrlength = sizeof(client_address);
int fd = accept(listenfd, (struct sockaddr*)&client_address, &client_addrlength);
if(fd < 0){
printf("errno is: %d\n", errno);
}
else{
char buffer[BUFFER_SIZE];
memset(buffer, '\0', BUFFER_SIZE);
int data_read = 0;
int read_index = 0;
int check_index = 0;
int start_line = 0;
CHECK_STATE checlstate = CHECK_STATE_REQUESTLINE;
while (1){
data_read = recv(fd, buffer+read_index, BUFFER_SIZE-read_index, 0);
if(data_read == -1){
printf("reading failed\n");
break;
}
else if(data_read == 0){
printf("remote client has closed the connection\n");
break;
}
read_index += data_read;
HTTP_CODE result = parse_content(buffer, check_index, checlstate,
read_index, start_line);
if(result == NO_REQUEST){
continue;
}
else if(result == GET_REQUEST){
send(fd, szret[0], strlen(szret[0]), 0);
break;
}
else{
send(fd, szret[1], strlen(szret[1]), 0);
break;
}
}
close(fd);
}
close(listenfd);
return 0;
}
我们将上述两个有限状态机分别称为主状态机和从状态机,这体现了他们之间的关系:主状态机在内部调用从状态机。
下面是从状态机,即parse_line函数的转移过程:
这个状态机的初始状态是LINE_OK,其原始驱动力来自于buffer中新道达的客户数据。在main函数中,我们循环调用recv函数往buffer中读入客户数据。每次成功读取数据后,我们就调用parse_content函数来分析新读入的数据。parse_content函数首先要做的就是调用parse_line函数来获取一个行。现在假设服务器经过一次recv调用之后,buffer的内容以及部分变量的值如下图a所示:
parse_line函数处理之后的结果如b所示,它挨个检查a所示的buffer中checked_index到read_index-1之间的字节,判断是否存在行结束符,并更新checked_index的值。当前buffer中不存在行结束符,所以parse_line返回LINE_OPEN。
接下来,程序继续调用recv以读取更多客户数据,这次读操作后buffer中的内容以及部分变量的值如c所示,然后parse_line函数就又开始处理这部分新到来的数据,如d所示。这次它读到了一个完整的行,即“HOST:localhost\r\n”。此时,parse_line函数就可以将这行内容递交给parse_content函数中的主状态机来处理了。
主状态机使用checkstate变量来记录当前的状态。
- 如果当前的状态是CHECK_STATE_REQUESTLINE,则表示parse_line函数解析的行是请求行,于是主状态机调用parse_requestline来分析请求行
- 如果当前的状态是CHECK_STATE_HEADER,则表示parse_line函数解析的出的是头部字段,于是主状态机调用parse_headers来分析头部字段。
checkstate变量的初始值是CHECK_STATE_REQUESTLINE,parse_requestline函数在成功地分析完请求行之后将其设置为CHECK_STATE_HEADER,从而实现状态转移。