photon_buffer_internal.h

Go to the documentation of this file.

// =============================================================================
//  Photon RDMA Library (libphoton)
//
//  Copyright (c) 2016, Trustees of Indiana University,
//  All rights reserved.
//
//  This software may be modified and distributed under the terms of the BSD
//  license.  See the COPYING file for details.
//
//  This software was created at the Indiana University Center for Research in
//  Extreme Scale Technologies (CREST).
// =============================================================================

#ifndef PHOTON_BUFFER_INTERNAL_H
#define PHOTON_BUFFER_INTERNAL_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include "config.h"
#include "photon.h"

#define BUFFER_IFACES_MAX 16
  
#define BUFFER_FLAG_NIL     0x0000
#define BUFFER_FLAG_NOTIFY  (1<<1)

struct photon_acct_t {
  volatile uint64_t rcur;
  uint32_t rloc;
  uint32_t event_prefix;
};

typedef struct photon_buffer_internal_t {
  struct photon_buffer_t buf;
  // keep a reference to the registered mem handle
  void *priv_ptr;
  int priv_size;
} photon_buffer_internal;
  
struct photon_buffer_interface_t {
  int (*buffer_create)(photon_buffer_internal *bint, int flags);
  void (*buffer_free)(photon_buffer_internal *bint);
  int (*buffer_register)(photon_buffer_internal *bint, int flags);
  int (*buffer_unregister)(photon_buffer_internal *bint);
};
  
typedef struct photon_buffer_handle_t {
  struct photon_buffer_internal_t bint;
  uint16_t is_registered;
  uint16_t ref_count;
  uint32_t iface_count;
  struct photon_buffer_interface_t **ifaces;
} photon_buffer_handle;

typedef struct photon_buffer_internal_t * photonBI;
typedef struct photon_buffer_interface_t * photonBufferInterface;
typedef struct photon_buffer_handle_t * photonBufferHandle;
  
// internal buffer API
int photon_buffer_init(photonBufferInterface bi);
photonBufferHandle photon_buffer_create(void *addr, uint64_t size, int flags);
void photon_buffer_free(photonBufferHandle buf);
int photon_buffer_register(photonBufferHandle buf, int flags);
int photon_buffer_unregister(photonBufferHandle buf);

#ifdef __cplusplus
}
#endif

#endif