#include <stddef.h>
#include <stdio.h>
#include "serene/utils.h"

Include dependency graph for srn_mmap.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	srn_mmap_buffer_t
	Memory mapped buffer. More...

Macros
#define	PMAP_WIN32 0
#define	SRN_PROT_NONE 0x0
#define	SRN_PROT_READ 0x1
#define	SRN_PROT_WRITE 0x2
#define	SRN_PROT_EXEC 0x4
#define	SRN_MAP_FILE 0
#define	SRN_MAP_SHARED 1
#define	SRN_MAP_PRIVATE 2
#define	SRN_MAP_TYPE 0xf
#define	SRN_MAP_FIXED 0x10
#define	SRN_MMAP_VALIDATE(out, len, prot, flags)

Typedefs
typedef struct srn_mmap_buffer_t	srn_mmap_buffer_t
	Memory mapped buffer.

Functions
srn_error_t *	srn_mmap (srn_context_t ctx, srn_mmap_buffer_t out, size_t len, int prot, int flags, int fd, off64_t offset)
int	srn_munmap (srn_mmap_buffer_t *map)

Macro Definition Documentation

◆ PMAP_WIN32

#define PMAP_WIN32 0

Definition at line 30 of file srn_mmap.h.

◆ SRN_MAP_FILE

#define SRN_MAP_FILE 0

Definition at line 44 of file srn_mmap.h.

◆ SRN_MAP_FIXED

#define SRN_MAP_FIXED 0x10

Definition at line 48 of file srn_mmap.h.

◆ SRN_MAP_PRIVATE

#define SRN_MAP_PRIVATE 2

Definition at line 46 of file srn_mmap.h.

◆ SRN_MAP_SHARED

#define SRN_MAP_SHARED 1

Definition at line 45 of file srn_mmap.h.

◆ SRN_MAP_TYPE

#define SRN_MAP_TYPE 0xf

Definition at line 47 of file srn_mmap.h.

◆ SRN_MMAP_VALIDATE

#define SRN_MMAP_VALIDATE	(	out,
		len,
		prot,
		flags )

Value:

do {                                                                                \
  PANIC_IF(                                                                         \
    (out) == nullptr || (len) == 0,                                                 \
    "mmap requires a non-null output buffer and a positive length"                  \
  );                                                                                \
  PANIC_IF(                                                                         \
    !(((prot) & SRN_PROT_WRITE) || ((prot) & SRN_PROT_READ)),                       \
    "mmap requires read or write protection"                                        \
  );                                                                                \
  PANIC_IF(((flags) & SRN_MAP_FIXED) != 0, "mmap does not support fixed mappings"); \
} while (0)

Definition at line 68 of file srn_mmap.h.

#define SRN_MMAP_VALIDATE(out, len, prot, flags)                                      \
  do {                                                                                \
    PANIC_IF(                                                                         \
      (out) == nullptr || (len) == 0,                                                 \
      "mmap requires a non-null output buffer and a positive length"                  \
    );                                                                                \
    PANIC_IF(                                                                         \
      !(((prot) & SRN_PROT_WRITE) || ((prot) & SRN_PROT_READ)),                       \
      "mmap requires read or write protection"                                        \
    );                                                                                \
    PANIC_IF(((flags) & SRN_MAP_FIXED) != 0, "mmap does not support fixed mappings"); \
  } while (0)

◆ SRN_PROT_EXEC

#define SRN_PROT_EXEC 0x4

Definition at line 41 of file srn_mmap.h.

◆ SRN_PROT_NONE

#define SRN_PROT_NONE 0x0

Definition at line 38 of file srn_mmap.h.

◆ SRN_PROT_READ

#define SRN_PROT_READ 0x1

Definition at line 39 of file srn_mmap.h.

◆ SRN_PROT_WRITE

#define SRN_PROT_WRITE 0x2

Definition at line 40 of file srn_mmap.h.

Typedef Documentation

◆ srn_mmap_buffer_t

typedef struct srn_mmap_buffer_t srn_mmap_buffer_t

Memory mapped buffer.

Function Documentation

◆ srn_mmap()

srn_error_t * srn_mmap	(	srn_context_t *	ctx,
		srn_mmap_buffer_t *	out,
		size_t	len,
		int	prot,
		int	flags,
		int	fd,
		off64_t	offset )

extern

Definition at line 30 of file srn_mmap.c.

  {
  int mprot = PROT_READ;
  int mflag = 0;
 
  SRN_MMAP_VALIDATE(out, len, prot, flags);
 
  out->data = nullptr;
  out->len  = 0;
 
  if (prot & SRN_PROT_WRITE) {
    mprot |= PROT_WRITE;
  }
 
  if ((flags & SRN_MAP_TYPE) == SRN_MAP_SHARED) {
    mflag = MAP_SHARED;
  } else if ((flags & SRN_MAP_TYPE) == SRN_MAP_PRIVATE) {
    mflag = MAP_PRIVATE;
  } else {
    mflag = MAP_SHARED;
  }
 
  out->data = mmap(NULL, len, mprot, mflag, fd, offset);
 
  if (!out->data || out->data == MAP_FAILED) {
    auto err = ERR(ctx, MEMORY_MAP_FAILED, "failed to mmap. Could not write data");
    return err;
  }
 
  out->len = len;
 
  return nullptr;
}

◆ srn_munmap()

int srn_munmap ( srn_mmap_buffer_t * map )