option parser: Empty stub of the documentation

[libucw.git] / ucw / mempool.h

diff --git a/ucw/mempool.h b/ucw/mempool.h
index e9755983c6e5c756ac7cf9a0c678c34f243a25c0..350054e3fc481d0eb8a8879daabb1c1d021f7178 100644 (file)
--- a/ucw/mempool.h
+++ b/ucw/mempool.h
@@ -54,6 +54,8 @@ struct mempool_stats {                        /** Mempool statistics. See @mp_stats(). **/
  * @chunk_size must be in the interval `[1, UINT_MAX / 2]`.
  * It will allocate memory by this large chunks and take
  * memory to satisfy requests from them.
+ *
+ * Memory pools can be treated as <<trans:respools,resources>>, see <<trans:res_mempool()>>.
  **/
 void mp_init(struct mempool *pool, uns chunk_size);
 
@@ -62,6 +64,8 @@ void mp_init(struct mempool *pool, uns chunk_size);
  * See @mp_init() for @chunk_size limitations.
  *
  * The new mempool structure is allocated on the new mempool.
+ *
+ * Memory pools can be treated as <<trans:respools,resources>>, see <<trans:res_mempool()>>.
  **/
 struct mempool *mp_new(uns chunk_size);
 
@@ -128,7 +132,7 @@ static inline void *mp_alloc_fast(struct mempool *pool, uns size)
   if (size <= avail)
     {
       pool->state.free[0] = avail - size;
-      return pool->state.last[0] - avail;
+      return (byte *)pool->state.last[0] - avail;
     }
   else
     return mp_alloc_internal(pool, size);
@@ -141,7 +145,7 @@ static inline void *mp_alloc_fast_noalign(struct mempool *pool, uns size)
 {
   if (size <= pool->state.free[0])
     {
-      void *ptr = pool->state.last[0] - pool->state.free[0];
+      void *ptr = (byte *)pool->state.last[0] - pool->state.free[0];
       pool->state.free[0] -= size;
       return ptr;
     }
@@ -198,7 +202,7 @@ static inline void *mp_start_fast(struct mempool *pool, uns size)
     {
       pool->idx = 0;
       pool->state.free[0] = avail;
-      return pool->state.last[0] - avail;
+      return (byte *)pool->state.last[0] - avail;
     }
   else
     return mp_start_internal(pool, size);
@@ -212,7 +216,7 @@ static inline void *mp_start_fast_noalign(struct mempool *pool, uns size)
   if (size <= pool->state.free[0])
     {
       pool->idx = 0;
-      return pool->state.last[0] - pool->state.free[0];
+      return (byte *)pool->state.last[0] - pool->state.free[0];
     }
   else
     return mp_start_internal(pool, size);
@@ -223,7 +227,7 @@ static inline void *mp_start_fast_noalign(struct mempool *pool, uns size)
  **/
 static inline void *mp_ptr(struct mempool *pool)
 {
-  return pool->state.last[pool->idx] - pool->state.free[pool->idx];
+  return (byte *)pool->state.last[pool->idx] - pool->state.free[pool->idx];
 }
 
 /**
@@ -260,7 +264,7 @@ static inline void *mp_expand(struct mempool *pool)
  **/
 static inline void *mp_spread(struct mempool *pool, void *p, uns size)
 {
-  return (((uns)(pool->state.last[pool->idx] - p) >= size) ? p : mp_spread_internal(pool, p, size));
+  return (((uns)((byte *)pool->state.last[pool->idx] - (byte *)p) >= size) ? p : mp_spread_internal(pool, p, size));
 }
 
 /**
@@ -271,7 +275,7 @@ static inline void *mp_spread(struct mempool *pool, void *p, uns size)
 static inline void *mp_end(struct mempool *pool, void *end)
 {
   void *p = mp_ptr(pool);
-  pool->state.free[pool->idx] = pool->state.last[pool->idx] - end;
+  pool->state.free[pool->idx] = (byte *)pool->state.last[pool->idx] - (byte *)end;
   return p;
 }
 
@@ -281,7 +285,7 @@ static inline void *mp_end(struct mempool *pool, void *end)
 static inline uns mp_size(struct mempool *pool, void *ptr)
 {
   uns idx = mp_idx(pool, ptr);
-  return pool->state.last[idx] - ptr - pool->state.free[idx];
+  return ((byte *)pool->state.last[idx] - (byte *)ptr) - pool->state.free[idx];
 }
 
 /**
@@ -297,7 +301,7 @@ uns mp_open(struct mempool *pool, void *ptr);
 static inline uns mp_open_fast(struct mempool *pool, void *ptr)
 {
   pool->idx = mp_idx(pool, ptr);
-  uns size = pool->state.last[pool->idx] - ptr - pool->state.free[pool->idx];
+  uns size = ((byte *)pool->state.last[pool->idx] - (byte *)ptr) - pool->state.free[pool->idx];
   pool->state.free[pool->idx] += size;
   return size;
 }
@@ -321,7 +325,7 @@ static inline void *mp_realloc_fast(struct mempool *pool, void *ptr, uns size)
 {
   mp_open_fast(pool, ptr);
   ptr = mp_grow(pool, size);
-  mp_end(pool, ptr + size);
+  mp_end(pool, (byte *)ptr + size);
   return ptr;
 }
 
@@ -336,7 +340,7 @@ static inline void *mp_realloc_fast(struct mempool *pool, void *ptr, uns size)
 
 /**
  * Save the current state of a memory pool.
- * Do not call this function with an opened growing buffer. 
+ * Do not call this function with an opened growing buffer.
  **/
 static inline void mp_save(struct mempool *pool, struct mempool_state *state)
 {
@@ -384,7 +388,7 @@ void mp_pop(struct mempool *pool);
  * -----------------
  ***/
 
-char *mp_strdup(struct mempool *, const char *) LIKE_MALLOC;           /** Makes a copy of a string on a mempool. **/
+char *mp_strdup(struct mempool *, const char *) LIKE_MALLOC;           /** Makes a copy of a string on a mempool. Returns NULL for NULL string. **/
 void *mp_memdup(struct mempool *, const void *, uns) LIKE_MALLOC;      /** Makes a copy of a memory block on a mempool. **/
 /**
  * Concatenates all passed strings. The last parameter must be NULL.
@@ -406,6 +410,11 @@ static inline char *LIKE_MALLOC mp_strcat(struct mempool *mp, const char *x, con
  * tells how many there is of them.
  **/
 char *mp_strjoin(struct mempool *p, char **a, uns n, uns sep) LIKE_MALLOC;
+/**
+ * Convert memory block to a string. Makes a copy of the given memory block
+ * in the mempool @p, adding an extra terminating zero byte at the end.
+ **/
+char *mp_str_from_mem(struct mempool *p, const void *mem, uns len) LIKE_MALLOC;
 
 
 /***