互连函数

24 章 函数接口 第

作者:Linux C课堂 / 关注公众号:linux_c_classroom  发布:2019-01-11

目录
本章的预备知识
strcpy与strncpy
malloc与free
传入参数与传出参数
两层指针的参数
返回值是指针的情况
回调函数
可变参数
我们在“折半查找”一节讲过,函数的调用者和函数的实现者之间订立了一个契约,在调用函数之前,调用者要为实现者提供某些条件,在函数返回时,实现者要对调用者尽到某些义务。如何描述这个契约呢?首先靠函数接口来描述,即函数名,参数,返回值,只要函数和参数的名字起得合理,参数和返回值的类型定得准确,至于这个函数怎么用,调用者单看函数接口就能猜出八九分了。函数接口并不能表达函数的全部语义,这时文档就起了重要的补充作用,函数的文档该写什么,怎么写,Man Page为我们做了很好的榜样。
函数接口一旦和指针结合起来就变得异常灵活,有五花八门的用法,但是万变不离其宗,只要像图23.1 “指针的基本概念”那样画图分析,指针的任何用法都能分析清楚,所以,如果上一章你真正学明白了,本章不用学也能自己领悟出来,之所以写这一章是为了照顾悟性不高的读者。本章把函数接口总结成几类常见的模式,对于每种模式,一方面讲函数接口怎么写,另一方面讲函数的文档怎么写。
本章的预备知识
这一节介绍本章的范例代码要用的几个C标准库函数。我们先体会一下这几个函数的接口是怎么设计的,Man Page是怎么写的。其它常用的C标准库函数将在下一章介绍。strcpy与strncpy
从现在开始我们要用到很多库函数,在学习每个库函数时一定要看Man Page。Man Page随时都在我们手边,想查什么只要敲一个命令就行,然而很多初学者就是不喜欢看Man Page,宁可满世界去查书、查资料,也不愿意看Man Page。据我分析原因有三:
英文不好。那还是先学好了英文再学编程吧,否则即使你把这本书都学透了也一样无法胜任开发工作,因为你没有进一步学习的能力。
Man Page的语言不够友好。Man Page不像本书这样由浅入深地讲解,而是平铺直叙,不过看习惯了就好了,每个Man Page都不长,多看几遍自然可以抓住重点,理清头绪。本节分析一个例子,帮助读者把握Man Page的语言特点。
Man Page通常没有例子。描述一个函数怎么用,一靠接口,二靠文档,而不是靠例子。函数的用法无非是本章所总结的几种模式,只要把本章学透了,你就不需要每个函数都得有个例子教你怎么用了。
总之,Man Page是一定要看的,一开始看不懂硬着头皮也要看,为了鼓励读者看Man Page,本书不会像[K&R]那样把库函数总结成一个附录附在书后面。现在我们来分析strcpy(3)。
图24.1.strcpy(3)

这个Man Page描述了两个函数,strcpy和strncpy,敲命令man strcpy或者man strncpy都可以看到这个Man Page。这两个函数的作用是把一个字符串拷贝给另一个字符串。SYNOPSIS部分给出了这两个函数的原型,以及要用这些函数需要包含哪些头文件。参数dest、src和n都加了下划线,有时候并不想从头到尾阅读整个Man Page,而是想查一下某个参数的含义,通过下划线和参数名就能很快找到你关心的部分。
dest表示Destination,src表示Source,看名字就能猜到是把src所指向的字符串拷贝到dest所指向的内存空间。这一点从两个参数的类型也能看出来,dest是char *型的,而src是const char *型的,说明src所指向的内存空间在函数中只能读不能改写,而dest所指向的内存空间在函数中是要改写的,显然改写的目的是当函数返回后调用者可以读取改写的结果。因此可以猜到strcpy函数是这样用的:
char buf[10];strcpy(buf, "hello");printf(buf);
至于strncpy的参数n是干什么用的,单从函数接口猜不出来,就需要看下面的文档。
图24.2.strcpy(3)

在文档中强调了strcpy在拷贝字符串时会把结尾的'\0'也拷到dest中,因此保证了dest中是以'\0'结尾的字符串。但另外一个要注意的问题是,strcpy只知道src字符串的首地址,不知道长度,它会一直拷贝到'\0'为止,所以dest所指向的内存空间要足够大,否则有可能写越界,例如:
char buf[10];strcpy(buf, "hello world");
如果没有保证src所指向的内存空间以'\0'结尾,也有可能读越界,例如:
char buf[10] = "abcdefghij", str[4] = "hell";strcpy(buf, str);
因为strcpy函数的实现者通过函数接口无法得知src字符串的长度和dest内存空间的大小,所以“确保不会写越界”应该是调用者的责任,调用者提供的dest参数应该指向足够大的内存空间,“确保不会读越界”也是调用者的责任,调用者提供的src参数指向的内存应该确保以'\0'结尾。
此外,文档中还强调了src和dest所指向的内存空间不能有重叠。凡是有指针参数的C标准库函数基本上都有这条要求,每个指针参数所指向的内存空间互不重叠,例如这样调用是不允许的:
char buf[10] = "hello";strcpy(buf, buf+1);
strncpy的参数n指定最多从src中拷贝n个字节到dest中,换句话说,如果拷贝到'\0'就结束,如果拷贝到n个字节还没有碰到'\0',那么也结束,调用者负责提供适当的n值,以确保读写不会越界,比如让n的值等于dest所指向的内存空间的大小:
char buf[10];strncpy(buf, "hello world", sizeof(buf));
然而这意味着什么呢?文档中特别用了Warning指出,这意味着dest有可能不是以'\0'结尾的。例如上面的调用,虽然把"hello world"截断到10个字符拷贝至buf中,但buf不是以'\0'结尾的,如果再printf(buf)就会读越界。如果你需要确保dest以'\0'结束,可以这么调用:
char buf[10];strncpy(buf, "hello world", sizeof(buf));buf[sizeof(buf)-1] = '\0';
strncpy还有一个特性,如果src字符串全部拷完了不足n个字节,那么还差多少个字节就补多少个'\0',但是正如上面所述,这并不保证dest一定以'\0'结束,当src字符串的长度大于n时,不但不补多余的'\0',连字符串的结尾'\0'也不拷贝。strcpy(3)的文档已经相当友好了,为了帮助理解,还给出一个strncpy的简单实现。
图24.3.strcpy(3)

函数的Man Page都有一部分专门讲返回值的。这两个函数的返回值都是dest指针。可是为什么要返回dest指针呢?dest指针本来就是调用者传过去的,再返回一遍dest指针并没有提供任何有用的信息。之所以这么规定是为了把函数调用当作一个指针类型的表达式使用,比如printf(strcpy(buf, "hello")),一举两得,如果strcpy的返回值是void就没有这么方便了。
CONFORMING TO部分描述了这个函数是遵照哪些标准实现的。strcpy和strncpy是C标准库函数,当然遵照C99标准。以后我们还会看到libc中有些函数属于POSIX标准但并不属于C标准,例如write(2)。
NOTES部分给出一些提示信息。这里指出如何确保strncpy的dest以'\0'结尾,和我们上面给出的代码类似,但由于n是个变量,在执行buf[n - 1]= '\0';之前先检查一下n是否大于0,如果n不大于0,buf[n - 1]就访问越界了,所以要避免。
图24.4.strcpy(3)

BUGS部分说明了使用这些函数可能引起的Bug,这部分一定要仔细看。用strcpy比用strncpy更加不安全,如果在调用strcpy之前不仔细检查src字符串的长度就有可能写越界,这是一个很常见的错误,例如:
void foo(char *str){char buf[10];strcpy(buf, str);......}
str所指向的字符串有可能超过10个字符而导致写越界,在“段错误”一节我们看到过,这种写越界可能当时不出错,而在函数返回时出现段错误,原因是写越界覆盖了保存在栈帧上的返回地址,函数返回时跳转到非法地址,因而出错。像buf这种由调用者分配并传给函数读或写的一段内存通常称为缓冲区(Buffer),缓冲区写越界的错误称为缓冲区溢出(Buffer Overflow)。如果只是出现段错误那还不算严重,更严重的是缓冲区溢出Bug经常被恶意用户利用,使函数返回时跳转到一个事先设好的地址,执行事先设好的指令,如果设计得巧妙甚至可以启动一个Shell,然后随心所欲执行任何命令,可想而知,如果一个用root权限执行的程序存在这样的Bug,被攻陷了,后果将很严重。至于怎样巧妙设计和攻陷一个有缓冲区溢出Bug的程序,有兴趣的读者可以参考[SmashStack]。malloc与free
程序中需要动态分配一块内存时怎么办呢?可以像上一节那样定义一个缓冲区数组。这种方法不够灵活,C89要求定义的数组是固定长度的,而程序往往在运行时才知道要动态分配多大的内存,例如:
void foo(char *str, int n){char buf[?];strncpy(buf, str, n);......}
n是由参数传进来的,事先不知道是多少,那么buf该定义多大呢?在“数组的基本操作”一节讲过C99引入VLA特性,可以定义char buf[n+1] = {};,这样可确保buf是以'\0'结尾的。但即使用VLA仍然不够灵活,VLA是在栈上动态分配的,函数返回时就要释放,如果我们希望动态分配一块全局的内存空间,在各函数中都可以访问呢?由于全局数组无法定义成VLA,所以仍然不能满足要求。
其实在“虚拟内存管理”一节提过,进程有一个堆空间,C标准库函数malloc可以在堆空间动态分配内存,它的底层通过brk系统调用向操作系统申请内存。动态分配的内存用完之后可以用free释放,更准确地说是归还给malloc,这样下次调用malloc时这块内存可以再次被分配。本节学习这两个函数的用法和工作原理。
#include <stdlib.h>void *malloc(size_t size);void free(void *ptr);
malloc的参数size表示要分配的字节数,如果分配失败(系统内存耗尽)则返回NULL,如果分配成功则返回所分配内存空间的首地址。由于malloc函数不知道用户拿到这块内存要存放什么类型的数据,所以返回通用指针void *,用户可以转换成其它类型的指针再访问这块内存。
动态分配的内存用完之后可以用free释放掉,传给free的参数正是先前malloc返回的内存块首地址。举例如下:
#include <stdio.h>#include <stdlib.h>#include <string.h>typedef struct {int number;char *msg;} unit_t;int main(void){unit_t *p = malloc(sizeof(unit_t));if (p == NULL) {printf("out of memory\n");exit(1);}p->number = 3;p->msg = malloc(20);strcpy(p->msg, "Hello world!");printf("number: %d\nmsg: %s\n", p->number, p->msg);free(p->msg);free(p);p = NULL;return 0;}
关于这个程序要注意以下几点:
unit_t *p = malloc(sizeof(unit_t));这一句,等号右边是void *类型,等号左边是unit_t *类型,编译器会做隐式类型转换,我们讲过void *类型和任何指针类型之间可以相互隐式转换。
虽然内存耗尽是很不常见的错误,但写程序要规范,malloc之后应该判断是否成功。以后要学习的大部分系统函数都有成功的返回值和失败的返回值,每次调用系统函数都应该判断是否成功。
free(p);之后,p所指的内存空间是归还了,但是p的值并没有变,因为从free的函数接口来看根本就没法改变p的值,p现在指向的内存空间已经不属于用户,换句话说,p成了野指针,为避免出现野指针,我们应该在free(p);之后手动置p = NULL;。
应该先free(p->msg),再free(p)。如果先free(p),p成了野指针,就不能再通过p->msg访问内存了。
上面的例子只有一个简单的顺序控制流程,分配内存,赋值,打印,释放内存,退出程序。这种情况下即使不用free释放内存也可以,因为程序退出时整个进程地址空间都会释放,包括堆空间,该进程占用的所有内存都会归还给操作系统。但如果一个程序长年累月运行(例如网络服务器程序),并且在循环或递归中调用malloc分配内存,则必须有free与之配对,分配一次就要释放一次,否则每次循环都分配内存,分配完了又不释放,就会慢慢耗尽系统内存,这种错误称为内存泄漏(Memory Leak)。另外,malloc返回的指针一定要保存好,只有把它传给free才能释放这块内存,如果这个指针丢失了,就没有办法free这块内存了,也会造成内存泄漏。例如:
void foo(void){char *p = malloc(10);......}
foo函数返回时要释放局部变量p的内存空间,它所指向的内存地址就丢失了,这10个字节也就没法释放了。内存泄漏的Bug很难找到,因为它不会像访问越界一样导致程序运行错误,少量内存泄漏并不影响程序的正确运行,大量的内存泄漏会使系统内存紧缺,导致频繁换页,不仅影响当前进程,而且把整个系统都拖得很慢。
关于malloc和free还有一些特殊情况。malloc(0)这种调用也是合法的,也会返回一个非NULL的指针,这个指针也可以传给free释放,但是不能通过这个指针访问内存。free(NULL)也是合法的,不做任何事情,但是free一个野指针是不合法的,例如先调用malloc返回一个指针p,然后连着调用两次free(p);,则后一次调用会产生运行时错误。
[K&R]的8.7节给出了malloc和free的简单实现,基于环形链表。目前读者还没有学习链表,看那段代码会有点困难,我再做一些简化,图示如下,目的是让读者理解malloc和free的工作原理。libc的实现比这要复杂得多,但基本工作原理也是如此。读者只要理解了基本工作原理,就很容易分析在使用malloc和free时遇到的各种Bug了。
图24.5.简单的malloc和free实现

图中白色背景的框表示malloc管理的空闲内存块,深色背景的框不归malloc管,可能是已经分配给用户的内存块,也可能不属于当前进程,Break之上的地址不属于当前进程,需要通过brk系统调用向内核申请。每个内存块开头都有一个头节点,里面有一个指针字段和一个长度字段,指针字段把所有空闲块的头节点串在一起,组成一个环形链表,长度字段记录着头节点和后面的内存块加起来一共有多长,以8字节为单位(也就是以头节点的长度为单位)。
一开始堆空间由一个空闲块组成,长度为7×8=56字节,除头节点之外的长度为48字节。
调用malloc分配8个字节,要在这个空闲块的末尾截出16个字节,其中新的头节点占了8个字节,另外8个字节返回给用户使用,注意返回的指针p1指向头节点后面的内存块。
又调用malloc分配16个字节,又在空闲块的末尾截出24个字节,步骤和上一步类似。
调用free释放p1所指向的内存块,内存块(包括头节点在内)归还给了malloc,现在malloc管理着两块不连续的内存,用环形链表串起来。注意这时p1成了野指针,指向不属于用户的内存,p1所指向的内存地址在Break之下,是属于当前进程的,所以访问p1时不会出现段错误,但在访问p1时这段内存可能已经被malloc再次分配出去了,可能会读到意外改写数据。另外注意,此时如果通过p2向右写越界,有可能覆盖右边的头节点,从而破坏malloc管理的环形链表,malloc就无法从一个空闲块的指针字段找到下一个空闲块了,找到哪去都不一定,全乱套了。
调用malloc分配16个字节,现在虽然有两个空闲块,各有8个字节可分配,但是这两块不连续,malloc只好通过brk系统调用抬高Break,获得新的内存空间。在[K&R]的实现中,每次调用sbrk函数时申请1024×8=8192个字节,在Linux系统上sbrk函数也是通过brk实现的,这里为了画图方便,我们假设每次调用sbrk申请32个字节,建立一个新的空闲块。
新申请的空闲块和前一个空闲块连续,因此可以合并成一个。在能合并时要尽量合并,以免空闲块越割越小,无法满足大的分配请求。
在合并后的这个空闲块末尾截出24个字节,新的头节点占8个字节,另外16个字节返回给用户。
调用free(p3)释放这个内存块,由于它和前一个空闲块连续,又重新合并成一个空闲块。注意,Break只能抬高而不能降低,从内核申请到的内存以后都归malloc管了,即使调用free也不会还给内核。
传入参数与传出参数
如果函数接口有指针参数,既可以把指针所指向的数据传给函数使用(称为传入参数),也可以由函数填充指针所指的内存空间,传回给调用者使用(称为传出参数),例如strcpy的src参数是传入参数,dest参数是传出参数。有些函数的指针参数同时担当了这两种角色,如select(2)的fd_set *参数,既是传入参数又是传出参数,这称为Value-result参数。
表24.1.传入参数示例:void func(const unit_t *p);调用者实现者
分配p所指的内存空间
在p所指的内存空间中保存数据
调用函数
由于有const限定符,调用者可以确信p所指的内存空间不会被改变
规定指针参数的类型unit_t *
读取p所指的内存空间
想一想,如果有函数接口void func(const int p);这里的const有意义吗?
表24.2.传出参数示例:void func(unit_t *p);调用者实现者
分配p所指的内存空间
调用函数
读取p所指的内存空间
规定指针参数的类型unit_t *
在p所指的内存空间中保存数据
表24.3.Value-result参数示例:void func(unit_t *p);调用者实现者
分配p所指的内存空间
在p所指的内存空间保存数据
调用函数
读取p所指的内存空间
规定指针参数的类型unit_t *
读取p所指的内存空间
改写p所指的内存空间
由于传出参数和Value-result参数的函数接口完全相同,应该在文档中说明是哪种参数。
以下是一个传出参数的完整例子:
#ifndef POPULATOR_H#define POPULATOR_Htypedef struct { int number; char msg[20];} unit_t;extern void set_unit(unit_t *);#endif
#include <string.h>#include "populator.h"void set_unit(unit_t *p){ if (p == NULL) return; p->number = 3; strcpy(p->msg, "Hello World!");}
#include <stdio.h>#include "populator.h"int main(void){ unit_t u; set_unit(&u); printf("number: %d\nmsg: %s\n", u.number, u.msg); return 0;}
很多系统函数对于指针参数是NULL的情况有特殊规定:如果传入参数是NULL表示取缺省值,例如pthread_create(3)的pthread_attr_t *参数,也可能表示不做特别处理,例如free的参数;如果传出参数是NULL表示调用者不需要传出值,例如time(2)的参数。这些特殊规定应该在文档中写清楚。
两层指针的参数
两层指针也是指针,同样可以表示传入参数、传出参数或者Value-result参数,只不过该参数所指的内存空间应该解释成一个指针变量。用两层指针做传出参数的系统函数也很常见,比如pthread_join(3)的void **参数。下面看一个简单的例子。
#ifndef REDIRECT_PTR_H#define REDIRECT_PTR_Hextern void get_a_day(const char **);#endif
想一想,这里的参数指针是const char **,有const限定符,却不是传入参数而是传出参数,为什么?如果是传入参数应该怎么表示?
#include "redirect_ptr.h"static const char *msg[] = {"Sunday", "Monday", "Tuesday", "Wednesday","Thursday", "Friday", "Saturday"};void get_a_day(const char **pp){ static int i = 0; *pp = msg[i%7]; i++;}
#include <stdio.h>#include "redirect_ptr.h"int main(void){ const char *firstday = NULL; const char *secondday = NULL; get_a_day(&firstday); get_a_day(&secondday); printf("%s\t%s\n", firstday, secondday); return 0;}
两层指针作为传出参数还有一种特别的用法,可以在函数中分配内存,调用者通过传出参数取得指向该内存的指针,比如getaddrinfo(3)的struct addrinfo **参数。一般来说,实现一个分配内存的函数就要实现一个释放内存的函数,所以getaddrinfo(3)有一个对应的freeaddrinfo(3)函数。
表24.4.通过参数分配内存示例:void alloc_unit(unit_t **pp);void free_unit(unit_t *p);调用者实现者
分配pp所指的指针变量的空间
调用alloc_unit分配内存
读取pp所指的指针变量,通过后者使用alloc_unit分配的内存
调用free_unit释放内存
规定指针参数的类型unit_t **
alloc_unit分配unit_t的内存并初始化,为pp所指的指针变量赋值
free_unit释放在alloc_unit中分配的内存
#ifndef PARA_ALLOCATOR_H#define PARA_ALLOCATOR_Htypedef struct { int number; char *msg;} unit_t;extern void alloc_unit(unit_t **);extern void free_unit(unit_t *);#endif
#include <stdio.h>#include <string.h>#include <stdlib.h>#include "para_allocator.h"void alloc_unit(unit_t **pp){ unit_t *p = malloc(sizeof(unit_t)); if(p == NULL) { printf("out of memory\n"); exit(1); } p->number = 3; p->msg = malloc(20); strcpy(p->msg, "Hello World!"); *pp = p;}void free_unit(unit_t *p){ free(p->msg); free(p);}
#include <stdio.h>#include "para_allocator.h"int main(void){ unit_t *p = NULL; alloc_unit(&p); printf("number: %d\nmsg: %s\n", p->number, p->msg); free_unit(p); p = NULL; return 0;}
思考一下,为什么在main函数中不能直接调用free(p)释放内存,而要调用free_unit(p)?为什么一层指针的函数接口void alloc_unit(unit_t *p);不能分配内存,而一定要用两层指针的函数接口?
总结一下,两层指针参数如果是传出的,可以有两种情况:第一种情况,传出的指针指向静态内存(比如上面的例子),或者指向已分配的动态内存(比如指向某个链表的节点);第二种情况是在函数中动态分配内存,然后传出的指针指向这块内存空间,这种情况下调用者应该在使用内存之后调用释放内存的函数,调用者的责任是请求分配和请求释放内存,实现者的责任是完成分配内存和释放内存的操作。由于这两种情况的函数接口相同,应该在文档中说明是哪一种情况。
返回值是指针的情况
返回值显然是传出的而不是传入的,如果返回值传出的是指针,和上一节通过参数传出指针类似,也分为两种情况:第一种是传出指向静态内存或已分配的动态内存的指针,例如localtime(3)和inet_ntoa(3),第二种是在函数中动态分配内存并传出指向这块内存的指针,例如malloc(3),这种情况通常还要实现一个释放内存的函数,所以有和malloc(3)对应的free(3)。由于这两种情况的函数接口相同,应该在文档中说明是哪一种情况。
表24.5.返回指向已分配内存的指针示例:unit_t *func(void);调用者实现者
调用函数
将返回值保存下来以备后用
规定返回值指针的类型unit_t *
返回一个指针
以下是一个完整的例子。
#ifndef RET_PTR_H#define RET_PTR_Hextern char *get_a_day(int idx);#endif
#include <string.h>#include "ret_ptr.h"static const char *msg[] = {"Sunday", "Monday", "Tuesday", "Wednesday","Thursday", "Friday", "Saturday"};char *get_a_day(int idx){ static char buf[20]; strcpy(buf, msg[idx]); return buf;}
#include <stdio.h>#include "ret_ptr.h"int main(void){ printf("%s %s\n", get_a_day(0), get_a_day(1)); return 0;}
这个程序的运行结果是Sunday Monday吗?请读者自己分析一下。
表24.6.动态分配内存并返回指针示例:unit_t *alloc_unit(void);void free_unit(unit_t *p);调用者实现者
调用alloc_unit分配内存
将返回值保存下来以备后用
调用free_unit释放内存
规定返回值指针的类型unit_t *
alloc_unit分配内存并返回指向该内存的指针
free_unit释放由alloc_unit分配的内存
以下是一个完整的例子。
#ifndef RET_ALLOCATOR_H#define RET_ALLOCATOR_Htypedef struct { int number; char *msg;} unit_t;extern unit_t *alloc_unit(void);extern void free_unit(unit_t *);#endif
#include <stdio.h>#include <string.h>#include <stdlib.h>#include "ret_allocator.h"unit_t *alloc_unit(void){ unit_t *p = malloc(sizeof(unit_t)); if(p == NULL) { printf("out of memory\n"); exit(1); } p->number = 3; p->msg = malloc(20); strcpy(p->msg, "Hello world!"); return p;}void free_unit(unit_t *p){ free(p->msg); free(p);}
#include <stdio.h>#include "ret_allocator.h"int main(void){ unit_t *p = alloc_unit(); printf("number: %d\nmsg: %s\n", p->number, p->msg); free_unit(p); p = NULL; return 0;}
思考一下,通过参数分配内存需要两层的指针,而通过返回值分配内存就只需要返回一层的指针,为什么?
回调函数
如果参数是一个函数指针,调用者可以传递一个函数的地址给实现者,让实现者去调用它,这称为回调函数(Callback Function)。例如qsort(3)和bsearch(3)。
表24.7.回调函数示例:void func(void (*f)(void *), void *p);调用者实现者
提供一个回调函数,再提供一个准备传给回调函数的参数。
把回调函数传给参数f,把准备传给回调函数的参数按void *类型传给参数p
在适当的时候根据调用者传来的函数指针f调用回调函数,将调用者传来的参数p转交给回调函数,即调用f(p);
以下是一个简单的例子。实现了一个repeat_three_times函数,可以把调用者传来的任何回调函数连续执行三次。
#ifndef PARA_CALLBACK_H#define PARA_CALLBACK_Htypedef void (*callback_t)(void *);extern void repeat_three_times(callback_t, void *);#endif
#include "para_callback.h"void repeat_three_times(callback_t f, void *para){ f(para); f(para); f(para);}
#include <stdio.h>#include "para_callback.h"void say_hello(void *str){ printf("Hello %s\n", (const char *)str);}void count_numbers(void *num){ int i; for(i=1; i<=(int)num; i++) printf("%d ", i); putchar('\n');}int main(void){ repeat_three_times(say_hello, (void *)"Guys"); repeat_three_times(count_numbers, (void *)4); return 0;}
回顾一下前面几节的例子,参数类型都是由实现者规定的。而本例中回调函数的参数按什么类型解释由调用者规定,对于实现者来说就是一个void *指针,实现者只负责将这个指针转交给回调函数,而不关心它到底指向什么数据类型。调用者知道自己传的参数是char *型的,那么在自己提供的回调函数中就应该知道参数要转换成char *型来解释。
回调函数的一个典型应用就是实现类似C++的泛型算法(Generics Algorithm)。下面实现的max函数可以在任意一组对象中找出最大值,可以是一组int、一组char或者一组结构体,但是实现者并不知道怎样去比较两个对象的大小,调用者需要提供一个做比较操作的回调函数。
#ifndef GENERICS_H#define GENERICS_Htypedef int (*cmp_t)(void *, void *);extern void *max(void *data[], int num, cmp_t cmp);#endif
#include "generics.h"void *max(void *data[], int num, cmp_t cmp){ int i; void *temp = data[0]; for(i=1; i<num; i++) { if(cmp(temp, data[i])<0) temp = data[i]; } return temp;}
#include <stdio.h>#include "generics.h"typedef struct { const char *name; int score;} student_t;int cmp_student(void *a, void *b){ if(((student_t *)a)->score > ((student_t *)b)->score) return 1; else if(((student_t *)a)->score == ((student_t *)b)->score) return 0; else return -1;}int main(void){ student_t list[4] = {{"Tom", 68}, {"Jerry", 72}, {"Moby", 60}, {"Kirby", 89}}; student_t *plist[4] = {&list[0], &list[1], &list[2], &list[3]}; student_t *pmax = max((void **)plist, 4, cmp_student); printf("%s gets the highest score %d\n", pmax->name, pmax->score); return 0;}
max函数之所以能对一组任意类型的对象进行操作,关键在于传给max的是指向对象的指针所构成的数组,而不是对象本身所构成的数组,这样max不必关心对象到底是什么类型,只需转给比较函数cmp,然后根据比较结果做相应操作即可,cmp是调用者提供的回调函数,调用者当然知道对象是什么类型以及如何比较。
以上举例的回调函数是被同步调用的,调用者调用max函数,max函数则调用cmp函数,相当于调用者间接调了自己提供的回调函数。在实际系统中,异步调用也是回调函数的一种典型用法,调用者首先将回调函数传给实现者,实现者记住这个函数,这称为注册一个回调函数,然后当某个事件发生时实现者再调用先前注册的函数,比如sigaction(2)注册一个信号处理函数,当信号产生时由系统调用该函数进行处理,再比如pthread_create(3)注册一个线程函数,当发生调度时系统切换到新注册的线程函数中运行,在GUI编程中异步回调函数更是有普遍的应用,例如为某个按钮注册一个回调函数,当用户点击按钮时调用它。
以下是一个代码框架。
#ifndef REGISTRY_H#define REGISTRY_Htypedef void (*registry_t)(void);extern void register_func(registry_t);#endif
#include <unistd.h>#include "registry.h"static registry_t func;void register_func(registry_t f){ func = f;}static void on_some_event(void){ ... func(); ...}
既然参数可以是函数指针,返回值同样也可以是函数指针,因此可以有func()();这样的调用。返回函数的函数在C语言中很少见,在一些函数式编程语言例如LISP、Haskell中则很常见,基本思想是把函数也当作一种数据来操作,输入、输出和参与运算,操作函数的函数称为高阶函数(High-order Function)。
可变参数
到目前为止我们只见过一个带有可变参数的函数printf:
int printf(const char *format, ...);
以后还会见到更多这样的函数。现在我们实现一个简单的myprintf函数:
#include <stdio.h>#include <stdarg.h>void myprintf(const char *format, ...){ va_list ap; char c; va_start(ap, format); while (c = *format++) { switch(c) { case 'c': { char ch = va_arg(ap, int); putchar(ch); break; } case 's': { char *p = va_arg(ap, char *); fputs(p, stdout); break; } default: putchar(c); } } va_end(ap);}int main(void){ myprintf("c\ts\n", '1', "hello"); return 0;}
要处理可变参数,需要用C到标准库的va_list类型和va_start、va_arg、va_end宏,这些定义在stdarg.h头文件中。这些宏是如何取出可变参数的呢?我们首先对照反汇编分析在调用myprintf函数时这些参数的内存布局。
myprintf("c\ts\n", '1', "hello"); 80484c5:c7 44 24 08 b0 85 04 movl$0x80485b0,0x8(%esp) 80484cc:08 80484cd:c7 44 24 04 31 00 00 movl$0x31,0x4(%esp) 80484d4:00 80484d5:c7 04 24 b6 85 04 08 movl$0x80485b6,(%esp) 80484dc:e8 43 ff ff ff call8048424 <myprintf>
图24.6.myprintf函数的参数布局

这些参数是从右向左依次压栈的,所以第一个参数靠近栈顶,第三个参数靠近栈底。这些参数在内存中是连续存放的,每个参数都对齐到4字节边界。第一个和第三个参数都是指针类型,各占4个字节,虽然第二个参数只占一个字节,但为了使第三个参数对齐到4字节边界,所以第二个参数也占4个字节。现在给出一个stdarg.h的简单实现,这个实现出自[Standard C Library]:
#ifndef _STDARG#define _STDARGtypedef char *va_list;#define va_arg(ap, T) \(* (T *)(((ap) += _Bnd(T, 3U)) - _Bnd(T, 3U)))#define va_end(ap) (void)0#define va_start(ap, A) \(void)((ap) = (char *)&(A) + _Bnd(A, 3U))#define _Bnd(X, bnd) (sizeof (X) + (bnd) & ~(bnd))#endif
这个头文件中的内部宏定义_Bnd(X, bnd)将类型或变量X的长度对齐到bnd+1字节的整数倍,例如_Bnd(char, 3U)的值是4,_Bnd(int, 3U)也是4。
在myprintf中定义的va_list ap;其实是一个指针,va_start(ap, format)使ap指向format参数的下一个参数,也就是指向上图中esp+4的位置。然后va_arg(ap, int)把第二个参数的值按int型取出来,同时使ap指向第三个参数,也就是指向上图中esp+8的位置。然后va_arg(ap, char *)把第三个参数的值按char *型取出来,同时使ap指向更高的地址。va_end(ap)在我们的简单实现中不起任何作用,在有些实现中可能会把ap改写成无效值,C标准要求在函数返回前调用va_end。
如果把myprintf中的char ch = va_arg(ap, int);改成char ch = va_arg(ap, char);,用我们这个stdarg.h的简单实现是没有问题的。但如果改用libc提供的stdarg.h,在编译时会报错:
$ gcc main.cmain.c: In function ‘myprintf’:main.c:33: warning: ‘char’ is promoted to ‘int’ when passed through ‘...’main.c:33: note: (so you should pass ‘int’ not ‘char’ to ‘va_arg’)main.c:33: note: if this code is reached, the program will abort$ ./a.outIllegal instruction
因此要求char型的可变参数必须按int型来取,这是为了与C标准一致,我们在“Integer Promotion”一节讲过Default Argument Promotion规则,传递char型的可变参数时要提升为int型。
从myprintf的例子可以理解printf的实现原理,printf函数根据第一个参数(格式化字符串)来确定后面有几个参数,分别是什么类型。保证参数的类型、个数与格式化字符串的描述相匹配是调用者的责任,实现者只管按格式化字符串的描述从栈上取数据,如果调用者传递的参数类型或个数不正确,实现者是没有办法避免错误的。
还有一种方法可以确定可变参数的个数,就是在参数列表的末尾传一个Sentinel,例如NULL。execl(3)就采用这种方法确定参数的个数。下面实现一个printlist函数,可以打印若干个传入的字符串。
#include <stdio.h>#include <stdarg.h>void printlist(int begin, ...){ va_list ap; char *p; va_start(ap, begin); p = va_arg(ap, char *); while (p != NULL) { fputs(p, stdout); putchar('\n'); p = va_arg(ap, char*); } va_end(ap);}int main(void){ printlist(0, "hello", "world", "foo", "bar", NULL); return 0;}
printlist的第一个参数begin的值并没有用到,但是C语言规定至少要定义一个有名字的参数,因为va_start宏要用到参数列表中最后一个有名字的参数,从它的地址开始找可变参数的位置。实现者应该在文档中说明参数列表必须以NULL结尾,如果调用者不遵守这个约定,实现者是没有办法避免错误的。




本文作者 :Linux C课堂

关注Ta的微信公众号获取更多图文精彩内容...