include/minix/ds.h

   1 /* Prototypes and definitions for DS interface. */
   2
   3 #ifndef _MINIX_DS_H
   4 #define _MINIX_DS_H
   5
   6 #include <minix/types.h>
   7 #include <minix/endpoint.h>
   8
   9 /* Flags. */
  10 #define DSF_IN_USE              0x001   /* entry is in use */
  11 #define DSF_PRIV_RETRIEVE       0x002   /* only owner can retrieve */
  12 #define DSF_PRIV_OVERWRITE      0x004   /* only owner can overwrite */
  13 #define DSF_PRIV_SNAPSHOT       0x004   /* only owner can take a snapshot */
  14 #define DSF_PRIV_SUBSCRIBE      0x008   /* only owner can subscribe */
  15 #define DSF_TYPE_U32            0x010   /* u32 data type */
  16 #define DSF_TYPE_STR            0x020   /* string data type */
  17 #define DSF_TYPE_MEM            0x040   /* memory range data type */
  18 #define DSF_TYPE_MAP            0x080   /* mapped memory range data type */
  19 #define DSF_TYPE_LABEL          0x100   /* label data type */
  20
  21 #define DSF_MASK_TYPE           0xFF0   /* mask for type flags. */
  22 #define DSF_MASK_INTERNAL       0xFFF   /* mask for internal flags. */
  23
  24 #define DSF_OVERWRITE           0x01000 /* overwrite if entry exists */
  25 #define DSF_INITIAL             0x02000 /* check subscriptions immediately */
  26
  27 #define DSMF_MAP_MAPPED         0x10000 /* map mapped memory range */
  28 #define DSMF_COPY_MAPPED        0x20000 /* copy mapped memory range */
  29 #define DSMF_COPY_SNAPSHOT      0x40000 /* copy snapshot */
  30
  31 /* DS constants. */
  32 #define DS_MAX_KEYLEN 80        /* Max length of a key, including '\0'. */
  33
  34 /* DS events. */
  35 #define DS_DRIVER_UP            1
  36
  37 /* ds.c */
  38
  39 /* U32 */
  40 int ds_publish_u32(const char *name, u32_t val, int flags);
  41 int ds_retrieve_u32(const char *name, u32_t *val);
  42 int ds_delete_u32(const char *ds_name);
  43
  44 /* STRING */
  45 int ds_publish_str(const char *name, char *val, int flags);
  46 int ds_retrieve_str(const char *name, char *val, size_t len);
  47 int ds_delete_str(const char *ds_name);
  48
  49 /* MEM */
  50 int ds_publish_mem(const char *ds_name, void *vaddr, size_t length, int
  51         flags);
  52 int ds_retrieve_mem(const char *ds_name, char *vaddr, size_t *length);
  53 int ds_delete_mem(const char *ds_name);
  54
  55 /* MAP */
  56 int ds_publish_map(const char *ds_name, void *vaddr, size_t length, int
  57         flags);
  58 int ds_snapshot_map(const char *ds_name, int *nr_snapshot);
  59 int ds_retrieve_map(const char *ds_name, char *vaddr, size_t *length,
  60         int nr_snapshot, int flags);
  61 int ds_delete_map(const char *ds_name);
  62
  63 /* LABEL */
  64 int ds_publish_label(const char *ds_name, endpoint_t endpoint, int
  65         flags);
  66 int ds_retrieve_label_name(char *ds_name, endpoint_t endpoint);
  67 int ds_retrieve_label_endpt(const char *ds_name, endpoint_t *endpoint);
  68 int ds_delete_label(const char *ds_name);
  69
  70 /* Subscribe and check. */
  71 int ds_subscribe(const char *regex, int flags);
  72 int ds_check(char *ds_name, int *type, endpoint_t *owner_e);
  73
  74 #endif /* _MINIX_DS_H */
  75