Bootstrap

C/C++ boost 库实现共享内存（share memory）的读写操作【代码实例】

文档声明：
以下资料均属于本人在学习过程中产出的学习笔记，如果错误或者遗漏之处，请多多指正。并且该文档在后期会随着学习的深入不断补充完善。感谢各位的参考查看。

笔记资料仅供学习交流使用，转载请标明出处，谢谢配合。
如果存在相关知识点的遗漏，可以在评论区留言，看到后将在第一时间更新。
作者：Aliven888

1、 概念

  共享内存（Shared Memory）就是允许多个进程访问同一个内存空间，是在多个进程之间共享和传递数据最高效的方式。操作系统将不同进程之间共享内存安排为同一段物理内存，进程可以将共享内存连接到它们自己的地址空间中，如果某个进程修改了共享内存中的数据，其它的进程读到的数据也将会改变。

2、简单读写操作

2.1、Linux 库实现

头文件： 

#include <sys/ipc.h>
#include <sys/shm.h>

函数介绍：

1、shmget函数

/***********************************************************************************
功能： shmget函数用来获取或创建共享内存

参数
	key : 是共享内存的键值，是一个整数，typedef unsigned int key_t，
      	  是共享内存在系统中的编号，不同共享内存的编号不能相同，这一点由程序员保证。
          key用十六进制表示比较好。
	size : 待创建的共享内存的大小，以字节为单位。
	shmflg : 共享内存的访问权限，与文件的权限一样，0666|IPC_CREAT表示全部用户对它可读写，如果共享内存不存在，就创建一个共享内存。

返回值：
	成功返回共享存储的id，失败返回-1
***********************************************************************************/
int shmget(key_t key, size_t size, int shmflg);

2、shmat函数

/***********************************************************************************
功能： 把共享内存连接到当前进程的地址空间

参数
	hm_id : 是由shmget函数返回的共享内存标识
	shm_addr : 指定共享内存连接到当前进程中的地址位置，通常为空，表示让系统来选择共享内存的地址。
	shm_flg : 是一组标志位，通常为0。

返回值：
	调用成功时返回一个指向共享内存第一个字节的指针，如果调用失败返回-1.
***********************************************************************************/
void *shmat(int shm_id, const void *shm_addr, int shmflg);

3、shmdt函数

/***********************************************************************************
功能： 该函数用于将共享内存从当前进程中分离，相当于shmat函数的反操作

参数
	shmaddr是shmat函数返回的地址

返回值：
	调用成功时返回0，失败时返回-1
***********************************************************************************/
int shmdt(const void *shmaddr);

4、shmctl函数

/***********************************************************************************
功能： 删除共享内存

参数
	shm_id : shmget函数返回的共享内存标识符
	command : 默认填IPC_RMID
	buf : 默认填0

说明 ： 
	1、解释一下，shmctl是控制共享内存的函数，其功能不只是删除共享内容，但其它的功能没什么用，所以不介绍了
	2、注意，用root创建的共享内存，不管创建的权限是什么，普通用户无法删除

返回值：
	成功返回 0， 失败返回 -1
***********************************************************************************/
int shmctl(int shm_id, int command, struct shmid_ds *buf);

Demo 实现： 

#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <sys/ipc.h>
#include <sys/shm.h>

int main(int argc, char *argv[])
{
	int shmid = shmget((key_t)0x5005, 1024, 0640|IPC_CREAT); // 共享内存标识符

	// 创建共享内存，键值为0x5005，共1024字节。
  	if (-1 == shmid)
  	{ 
		printf("shmat(0x5005) failed\n"); 
		return -1; 
	}
   
    char *ptext=0;   // 用于指向共享内存的指针
 
  	// 将共享内存连接到当前进程的地址空间，由ptext指针指向它
  	ptext = (char *)shmat(shmid, 0, 0);
 
  	// 操作本程序的ptext指针，就是操作共享内存
  	printf("写入前：%s\n",ptext);
  	sprintf(ptext,"本程序的进程号是：%d",getpid());
  	printf("写入后：%s\n",ptext);
 
  	// 把共享内存从当前进程中分离
  	shmdt(ptext);
   
  	// 删除共享内存 - 暂时屏蔽，方便看效果
  	// if (-1 == shmctl(shmid, IPC_RMID, 0))
  	// {
	// 	  printf("shmctl(0x5005) failed\n");
	// 	  return -1;
	// }
	
	return 0;
}

结果输出：

  第一次执行程序，写入前 的内容为空；因为删除语句注释掉了，所有在第二次以及之后 写入前 的才存在内容，而且这内容是前一次的 写入后 的内容（表示前一次内容被写进去了）。

在这里插入图片描述

2.2、boost 库实现

// boostDemo.h 

#pragma once
#include <iostream>
#include <string>
#include <boost\interprocess\shared_memory_object.hpp>
#include <boost\interprocess\mapped_region.hpp>
using namespace boost::interprocess;
using namespace std;

enum ALIVEN_ERR_CODE
{
	ALIVEN_RETURN_OK = 0,				//返回操作成功
	ALIVEN_RETURN_INIT_PTR_ERR = 1,		//初始化指针失败  
	ALIVEN_RETURN_PARAM_EMPTY = 2,		//参数为空（参数不合法）
	ALIVEN_RETURN_OPEN_FILE_ERR = 3,	//打开文件失败
	ALIVEN_RETURN_FILE_NOT_EXIST = 4,	//指定文件不存在
	ALIVEN_RETURN_BUILD_FILE_ERR = 5,	//创建文件失败
	ALIVEN_RETURN_CURR_APTH_IS_DIR = 6,	//当前路径是目录（不是文件）
	ALIVEN_SHARE_MEMORY_CREATE_ERR = 30,//共享内存创建失败
	ALIVEN_SHARE_MEMORY_NOT_EXIST = 31, //共享内存不存在
	ALIVEN_SHARE_MEMORY_CLEAN_ERR = 32, //共享内存清理失败
	ALIVEN_RETURN_UNKNOWN_ERR           //返回操作失败，原因未知
};

int writeCacheToMemory();
int readCacheFromMemory();
int cleanShareMemoryCache();

// boostDemo.cpp

#include "boostDemo.h"

//写入共享内存
int writeCacheToMemory()
{
	int iRet = ALIVEN_RETURN_OK;

	try
	{
		//1.创建之前，先移除，保证其在系统中是不存在的
		shared_memory_object::remove("Aliven_ShareMemory");

		//2.创建
		shared_memory_object shm(create_only, "Aliven_ShareMemory", read_write);

		//3. 设置共享内存大小
		shm.truncate(1024);

		//4. 映射共享内存片段
		mapped_region region(shm, read_write);

		//5. 初始化共享内存空间
		std::memset(region.get_address(), 0, region.get_size());

		//6. 向共享内存中写入数据
		std::string *str = static_cast<std::string *>(region.get_address());
		*str = "hello world.";

		std::cout << shm.get_name() << " wirte suc." << std::endl;
	}
	catch (const std::exception&)
	{
		iRet = ALIVEN_SHARE_MEMORY_CREATE_ERR;
	}

	return iRet;
}

//从共享内存中读取
int readCacheFromMemory()
{
	int iRet = ALIVEN_RETURN_OK;

	try
	{
		//1. 读取共享内存
		shared_memory_object shm(open_only, "Aliven_ShareMemory", read_only);

		//2. 映射共享内存
		mapped_region region(shm, read_only);

		//3. 获取数据
		std::string *str = static_cast<std::string *>(region.get_address());

		//5. 打印数据
		std::cout << "read " << shm.get_name() << " content : " << *str << std::endl;
	}
	catch (const std::exception&)
	{
		iRet = ALIVEN_SHARE_MEMORY_NOT_EXIST;
	}
	
	return iRet;
}

//清除共享内存
int cleanShareMemoryCache()
{
	int iRet = ALIVEN_RETURN_OK;
	if (!shared_memory_object::remove("Aliven_ShareMemory"))
	{
		iRet = ALIVEN_SHARE_MEMORY_CLEAN_ERR;
	}
	return iRet;
}

3、线程、进程间读写操作

3.1、boost 库实现

  共享内存在线程或者进程间使用时，因为其没有任何同步或者互斥机制，所以我们需要使用 信号量 来实现对共享内存的读写同步操作。

  因为进程间 与 线程间的实现类似，这里仅举例 多线程的。

// boostDemo.h 

#pragma once
#include <iostream>
#include <string>
#include <boost\interprocess\shared_memory_object.hpp>
#include <boost\interprocess\mapped_region.hpp>
using namespace boost::interprocess;
using namespace std;

enum ALIVEN_ERR_CODE
{
	ALIVEN_RETURN_OK = 0,				//返回操作成功
	ALIVEN_RETURN_INIT_PTR_ERR = 1,		//初始化指针失败  
	ALIVEN_RETURN_PARAM_EMPTY = 2,		//参数为空（参数不合法）
	ALIVEN_RETURN_OPEN_FILE_ERR = 3,	//打开文件失败
	ALIVEN_RETURN_FILE_NOT_EXIST = 4,	//指定文件不存在
	ALIVEN_RETURN_BUILD_FILE_ERR = 5,	//创建文件失败
	ALIVEN_RETURN_CURR_APTH_IS_DIR = 6,	//当前路径是目录（不是文件）
	ALIVEN_SHARE_MEMORY_CREATE_ERR = 30,//共享内存创建失败
	ALIVEN_SHARE_MEMORY_NOT_EXIST = 31, //共享内存不存在
	ALIVEN_SHARE_MEMORY_CLEAN_ERR = 32, //共享内存清理失败
	ALIVEN_RETURN_UNKNOWN_ERR           //返回操作失败，原因未知
};

#define SHM_BUFFER 1024

//数据类型
typedef struct stu_ShmData 
{
	int iSignal;  //信号量  0-可读  1-可写
	char szBuffer[SHM_BUFFER];  //数据空间
}STU_SHM_DATA;

int writeCacheToMemoryT();
int readCacheFromMemoryT();

// boostDemo.cpp

#include "boostDemo.h"

int writeCacheToMemoryT()
{
	int iRet = ALIVEN_RETURN_OK;
	
	try
	{
		shared_memory_object::remove("Aliven_ShareMemoryT");
		shared_memory_object shm(create_only, "Aliven_ShareMemoryT", read_write);
		shm.truncate(sizeof(STU_SHM_DATA));
		mapped_region region(shm, read_write);
		std::memset(region.get_address(), 0, region.get_size());
		STU_SHM_DATA *st = static_cast<STU_SHM_DATA *>(region.get_address());

		st->iSignal = 1;
		int iCount = 3;
		while (iCount > 0)
		{
			if (st->iSignal != 0)
			{
				memcpy_s(st->szBuffer, SHM_BUFFER, "12345", 6);
				st->iSignal = 0;
				std::cout << "write content to shm - " << iCount << std::endl;
				--iCount;
			} 
			else
			{
				Sleep(10);
			}
		}

	}
	catch (const std::exception&)
	{
		iRet = ALIVEN_SHARE_MEMORY_CREATE_ERR;
	}

	return iRet;
}
int readCacheFromMemoryT()
{
	int iRet = ALIVEN_RETURN_OK;
	
	try
	{
		shared_memory_object shm(open_only, "Aliven_ShareMemoryT", read_write);
		mapped_region region(shm, read_write);

		STU_SHM_DATA *st = static_cast<STU_SHM_DATA *>(region.get_address());

		st->iSignal = 0;
		int iCount = 3;
		while (iCount > 0)
		{
			if (st->iSignal != 1)
			{
				std::cout << "current read " << iCount << " txt is : " << st->szBuffer << std::endl;
				st->iSignal = 1;
				--iCount;
			} 
			else
			{
				Sleep(10);
			}
		}
	}
	catch (const std::exception&)
	{
		iRet = ALIVEN_SHARE_MEMORY_CREATE_ERR;
	}

	return iRet;
}

#include "stdafx.h"
#include <thread>
#include <mutex>

int main(int argc, char *argv[])
{
	//多线程
	std::thread th1(writeCacheToMemoryT);
	std::thread th2(readCacheFromMemoryT);

	th1.detach();
	th2.detach();

	system("pause");
	return 0;
}

在这里插入图片描述

悦读

道可道，非常道；名可名，非常名。 无名，天地之始，有名，万物之母。 故常无欲，以观其妙，常有欲，以观其徼。 此两者，同出而异名，同谓之玄，玄之又玄，众妙之门。

最新收录
Docker运维技术基本实践 原创
spring5.3.x源码阅读环境搭建
PHP笔试题（下）
网站长尾词：挖掘与利用的黄金策略
基于Spring Boot的微信小程序自习教室管理系统(源码+lw+部署文档+讲解等)
CVPR 2022 57 篇论文分方向整理 + 打包下载｜涵盖目标检测、语义分割、人群计数、异常检测等方向
鸿蒙特色实战3共享单车案例
GPT-4o vs. Gemini1.5Pro：哪个AI更适合你？深度对比评测
2024年前端最全前端预防XSS攻击全攻略_反射型xss前端如何限制，字节前端面试必问
机器学习： LightGBM模型（优化版）——高效且强大的树形模型
;