Rename shm_handle to lttng_ust_shm_handle

[lttng-ust.git] / libringbuffer / shm.h

diff --git a/libringbuffer/shm.h b/libringbuffer/shm.h
index 9f72a5a248657f73c3176877d2e6357930dd10db..22d3accc1b5779e10c5bbfb969acffd5196809bb 100644 (file)
--- a/libringbuffer/shm.h
+++ b/libringbuffer/shm.h
@@ -17,6 +17,11 @@
 /*
  * Pointer dereferencing. We don't trust the shm_ref, so we validate
  * both the index and offset with known boundaries.
+ *
+ * "shmp" and "shmp_index" guarantee that it's safe to use the pointer
+ * target type, even in the occurrence of shm_ref modification by an
+ * untrusted process having write access to the shm_ref. We return a
+ * NULL pointer if the ranges are invalid.
  */
 static inline
 char *_shmp_offset(struct shm_object_table *table, struct shm_ref *ref,
@@ -55,6 +60,8 @@ void _set_shmp(struct shm_ref *ref, struct shm_ref src)
 #define set_shmp(ref, src)     _set_shmp(&(ref)._ref, src)
 
 struct shm_object_table *shm_object_table_create(size_t max_nb_obj);
+struct shm_object *shm_object_table_append_shadow(struct shm_object_table *table,
+                       int shm_fd, int wait_fd, size_t memory_map_size);
 void shm_object_table_destroy(struct shm_object_table *table);
 struct shm_object *shm_object_table_append(struct shm_object_table *table,
                                           size_t memory_map_size);
@@ -70,7 +77,7 @@ struct shm_ref zalloc_shm(struct shm_object *obj, size_t len);
 void align_shm(struct shm_object *obj, size_t align);
 
 static inline
-int shm_get_wakeup_fd(struct shm_handle *handle, struct shm_ref *ref)
+int shm_get_wakeup_fd(struct lttng_ust_shm_handle *handle, struct shm_ref *ref)
 {
        struct shm_object_table *table = handle->table;
        struct shm_object *obj;
@@ -85,7 +92,7 @@ int shm_get_wakeup_fd(struct shm_handle *handle, struct shm_ref *ref)
 }
 
 static inline
-int shm_get_wait_fd(struct shm_handle *handle, struct shm_ref *ref)
+int shm_get_wait_fd(struct lttng_ust_shm_handle *handle, struct shm_ref *ref)
 {
        struct shm_object_table *table = handle->table;
        struct shm_object *obj;
@@ -98,4 +105,22 @@ int shm_get_wait_fd(struct shm_handle *handle, struct shm_ref *ref)
        return obj->wait_fd[0];
 }
 
+static inline
+int shm_get_object_data(struct lttng_ust_shm_handle *handle, struct shm_ref *ref,
+               int *shm_fd, int *wait_fd, uint64_t *memory_map_size)
+{
+       struct shm_object_table *table = handle->table;
+       struct shm_object *obj;
+       size_t index;
+
+       index = (size_t) ref->index;
+       if (unlikely(index >= table->allocated_len))
+               return -EPERM;
+       obj = &table->objects[index];
+       *shm_fd = obj->shm_fd;
+       *wait_fd = obj->wait_fd[0];
+       *memory_map_size = obj->allocated_len;
+       return 0;
+}
+
 #endif /* _LIBRINGBUFFER_SHM_H */