转自https://blog.csdn.net/andylauren/article/details/78821655
ftok
消息队列、信号量、共享内存常用在Linux服务端编程的进程间通信环境中。而此三类编程函数在实际项目中都是用System V IPC函数实现的。System V IPC函数名称和说明如下表15-1所示。
表15-1 System V IPC函数
消息队列 信号量 共享内存区
头文件 <sys/msg.h> <sys/sem.h> <sys/shm.h>
创建或打开IPC函数 msgget semget shmget
控制IPC操作的函数 msgctl semctl shmctl
IPC操作函数 msgsnd semop shmat
msgrcv shmdt
-
key_t键和ftok函数
函数ftok把一个已存在的路径名和一个整数标识符转换成一个key_t值,称为IPC键值(也称IPC key键值)。ftok函数原型及说明如下:ftok(把一个已存在的路径名和一个整数标识符转换成IPC键值)
所需头文件
#include <sys/types.h>
#include <sys/ipc.h>
函数说明
把从pathname导出的信息与id的低序8位组合成一个整数IPC键
函数原型
key_t ftok(const char *pathname, int proj_id)
函数传入值
pathname:指定的文件,此文件必须存在且可存取
proj_id:计划代号(project ID)
函数返回值
成功:返回key_t值(即IPC 键值)
出错:-1,错误原因存于error中
附加说明
key_t一般为32位的int型的重定义
ftok的典型实现是调用stat函数,然后组合以下三个值:
① pathname所在的文件系统的信息(stat结构的st_dev成员)。
② 该文件在本文件系统内的索引节点号(stat结构的st_ino成员)。
③ proj_id的低序8位(不能为0)。
上述三个值的组合产生一个32位键。
2. ftok函数代码举例
ftok.c源代码如下:
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/ipc.h>
#include <sys/stat.h>
#include <unistd.h>
int main(int argc, char **argv)
{
struct stat stat1 ;
if ( argc != 2 )
{
printf(“usage: ftok < pathname >” ) ;
exit(1) ;
}
stat( argv[1], &stat1 ) ;
printf(“st_dev:%lx, st_ino:%lx, key:%x\n”,
(unsigned long)stat1.st_dev, (unsigned long)stat1.st_ino , ftok(argv[1],0x579 )) ;
printf(“st_dev:%lx, st_ino:%lx, key:%x\n”,
(unsigned long)stat1.st_dev, (unsigned long)stat1.st_ino , ftok(argv[1],0x118 )) ;
printf(“st_dev:%lx, st_ino:%lx, key:%x\n”,
(unsigned long)stat1.st_dev, (unsigned long)stat1.st_ino , ftok(argv[1],0x22 )) ;
printf(“st_dev:%lx, st_ino:%lx, key:%x\n”,
(unsigned long)stat1.st_dev, (unsigned long)stat1.st_ino , ftok(argv[1],0x33 )) ;
exit(0) ;
}
编译 gcc ftok.c –o ftok
运行 ./ftok /tmp,执行结果如下:
st_dev:801, st_ino:4db21, key:7901db21
st_dev:801, st_ino:4db21, key:1801db21
st_dev:801, st_ino:4db21, key:2201db21
st_dev:801, st_ino:4db21, key:3301db21
st_dev:801, st_ino:4db21, key:4401db21
从上面程序可以看出,通过ftok返回的是根据文件(pathname)信息和计划编号(proj_id)合成的IPC key键值,从而避免用户使用key值的冲突。proj_id值的意义让一个文件也能生成多个IPC key键值。ftok利用同一文件最多可得到IPC key键值0xff(即256)个,因为ftok只取proj_id值二进制的后8位,即16进制的后两位与文件信息合成IPC key键值。
3. IPC键值与IPC标识符
(1)key值选择方式
对于key值,应用程序有如下三种选择:
① 调用ftok,给它传递pathname和proj_id,操作系统根据两者合成key值。
② 指定key为IPC_PRIVATE,内核保证创建一个新的、唯一的IPC对象,IPC标识符与内存中的标识符不会冲突。IPC_PRIVATE为宏定义,其值等于0。
③ 指定key为大于0的常数,这需要用户自行保证生成的IPC key值不与系统中存在的冲突,而前两种是操作系统保证的。
(2)IPC标识符
给semget、msgget、shmget传入key值,它们返回的都是相应的IPC对象标识符。注意IPC键值和IPC标识符是两个概念,后者是建立在前者之上。图15-1画出了从IPC键值生成IPC标识符图,其中key为IPC键值,由ftok函数生成;ipc_id为IPC标识符,由semget、msgget、shmget函数生成。ipc_id在信号量函数中称为semid,在消息队列函数中称为msgid,在共享内存函数中称为shmid,它们表示的是各自IPC对象标识符。
图15-1 从IPC键值生成IPC标识符图
4. ipc_perm结构说明
系统为每一个IPC对象保存一个ipc_perm结构体,该结构说明了IPC对象的权限和所有者,并确定了一个IPC操作是否可以访问该IPC对象。
struct ipc_perm {
key_t key ; /* 此IPC对象的key键 /
uid_t uid ; / 此IPC对象用户ID /
gid_t gid ; / 此IPC对象组ID /
uid_t cuid ; / IPC对象创建进程的有效用户ID /
gid_t cgid ; / IPC对象创建进程的有效组ID /
mode_t mode ; / 此IPC的读写权限 /
ulong_t seq ; / IPC对象的序列号 */
} ;
表15-2列出了ipc_perm中mode的含义,其含义与文件访问权限相似。当调用IPC对象创建函数(semget、msgget、shmget)时,会对ipc_perm结构变量的每一个成员赋值,其中mode的值来源于IPC对象创建函数最右边的形参flag(msgget中为msgflg、semget中为semflg、shmget中shmflg)。如需修改这几个成员变量则需调用相应的控制函数(msgctl、semctl、shmctl)。
表15-2 IPC对象存取权限表
ipc_perm中mode的含义
操作者 读 写 可读可写
用户 0400 0200 0600
组 0040 0020 0060
其他 0004 0002 0006
- IPC对象的创建权限
msgget、semget、shmget函数最右边的形参flag(msgget中为msgflg、semget中为semflg、shmget中shmflg)为IPC对象创建权限,三种xxxget函数中flag的作用基本相同。
IPC对象创建权限(即flag)格式为0xxxxx,其中0表示8位制,低三位为用户、属组、其他的读、写、执行权限(执行位不使用),其含义与ipc_perm的mode相同,具体含义见表15-2。在这里姑且把IPC对象创建权限格式的低三位称为“IPC对象存取权限”。如0600代表只有此用户下的进程才有可读可写权限。IPC对象存取权限常与下面IPC_CREAT、IPC_EXCL两种标志进行或(|)运算完成对IPC对象创建的管理,在这里姑且把IPC_CREAT、IPC_EXCL两种标志称为IPC创建模式标志。下面是两种创建模式标志在<sys/ipc.h>头文件中的宏定义。
#define IPC_CREAT 01000 /* Create key if key does not exist. /
#define IPC_EXCL 02000 / Fail if key exists. */
综上所述,flag标志由两部分组成,一为IPC对象存取权限(含义同ipc_perm中的mode),一为IPC对象创建模式标志(IPC_CREAT、IPC_EXCL),两者进行|运算合成IPC对象创建权限。
6. 创建或打开IPC对象流程图
semget、msgget、shmget函数的作用是创建一个新的IPC对象或者访问一个已存在的IPC对象。其创建或访问的规则如下:
① 指定key为IPC_PRIVATE操作系统保证创建一个唯一的IPC对象。
② 设置flag参数的IPC_CREAT位但不设置它的IPC_EXCL位时,如果所指定key键的IPC对象不存在,那就是创建一个新的对象;否则返回该对象。
③ 同时设置flag的IPC_CREAT和IPC_EXCL位时,如果所指定key键的IPC对象不存在,那就创建一个新的对象;否则返回一个EEXIST错误,因为该对象已存在。
综上所述,flag创建模式标志的作用如下表15-3所示。
表15-3 三种xxxget函数flag的创建模式标志作用表
flag创建模式标志 不存在 已存在
无特殊标志 出错,errno=ENOENT 成功,引用已存在对象
IPC_CREAT 成功,创建新对象 成功,引用已存在对象
IPC_CREAT|IPC_EXCL 成功,创建新对象 出错,errno=EEXIST
下图15-2画出了semget、msgget、shmget创建或打开一个IPC对象的逻辑流程图,它说明了内核创建和访问IPC对象的流程。
图15-2 semget、msgget、shmget创建或打开一个IPC对象的逻辑流程图
使用semget、msgget、shmget创建一个IPC对象时,需要指定flag标志,在key不等于IPC_PRIVATE情况下,flag标志决定了创建方式和创建后IPC对象的存取权限。在key等于IPC_PRIVATE情况下,flag标志决定了创建后IPC对象的存取权限。如果只是引用一个已经存在的IPC对象只需把flag标志设为0即可。
有关该函数的三个常见问题:
1.pathname是目录还是文件的具体路径,是否可以随便设置
2.pathname指定的目录或文件的权限是否有要求
3.proj_id是否可以随便设定,有什么限制条件
解答:
1、ftok根据路径名,提取文件信息,再根据这些文件信息及project ID合成key,该路径可以随便设置。
2、该路径是必须存在的,ftok只是根据文件inode在系统内的唯一性来取一个数值,和文件的权限无关。
3、proj_id是可以根据自己的约定,随意设置。这个数字,有的称之为project ID; 在UNIX系统上,它的取值是1到255;
关于ftok()函数的一个陷阱
在使用ftok()函数时,里面有两个参数,即fname和id,fname为指定的文件名,而id为子序列号,这个函数的返回值就是key,它与指定的文件的索引节点号和子序列号id有关,这样就会给我们一个误解,即只要文件的路径,名称和子序列号不变,那么得到的key值永远就不会变。
事实上,这种认识是错误的,想想一下,假如存在这样一种情况:在访问同一共享内存的多个进程先后调用ftok()时间段中,如果fname指向的文件或者目录被删除而且又重新创建,那么文件系统会赋予这个同名文件新的i节点信息,于是这些进程调用的ftok()都能正常返回,但键值key却不一定相同了。由此可能造成的后果是,原本这些进程意图访问一个相同的共享内存对象,然而由于它们各自得到的键值不同,实际上进程指向的共享内存不再一致;如果这些共享内存都得到创建,则在整个应用运行的过程中表面上不会报出任何错误,然而通过一个共享内存对象进行数据传输的目 的将无法实现。
这是一个很重要的问题,希望能谨记!!!
所以要确保key值不变,要么确保ftok()的文件不被删除,要么不用ftok(),指定一个固定的key值。
摘录自《深入浅出Linux工具与编程》