Cleanup: clarify strcpy/strcpy_from_user local variables
[lttng-modules.git] / include / ringbuffer / backend_internal.h
index aab408fb2697e67da4042bfd113e3cdc92df3224..fb60f2abc3e9050d27371e3b730efb36011b644c 100644 (file)
 
 /* Ring buffer and channel backend create/free */
 
-int lib_ring_buffer_backend_create(struct lib_ring_buffer_backend *bufb,
+int lib_ring_buffer_backend_create(struct lttng_kernel_ring_buffer_backend *bufb,
                                   struct channel_backend *chan, int cpu);
 void channel_backend_unregister_notifiers(struct channel_backend *chanb);
-void lib_ring_buffer_backend_free(struct lib_ring_buffer_backend *bufb);
+void lib_ring_buffer_backend_free(struct lttng_kernel_ring_buffer_backend *bufb);
 int channel_backend_init(struct channel_backend *chanb,
                         const char *name,
-                        const struct lib_ring_buffer_config *config,
+                        const struct lttng_kernel_ring_buffer_config *config,
                         void *priv, size_t subbuf_size,
                         size_t num_subbuf);
 void channel_backend_free(struct channel_backend *chanb);
 
-void lib_ring_buffer_backend_reset(struct lib_ring_buffer_backend *bufb);
+void lib_ring_buffer_backend_reset(struct lttng_kernel_ring_buffer_backend *bufb);
 void channel_backend_reset(struct channel_backend *chanb);
 
 int lib_ring_buffer_backend_init(void);
 void lib_ring_buffer_backend_exit(void);
 
-extern void _lib_ring_buffer_write(struct lib_ring_buffer_backend *bufb,
+extern void _lib_ring_buffer_write(struct lttng_kernel_ring_buffer_backend *bufb,
                                   size_t offset, const void *src, size_t len,
                                   size_t pagecpy);
-extern void _lib_ring_buffer_memset(struct lib_ring_buffer_backend *bufb,
+extern void _lib_ring_buffer_memset(struct lttng_kernel_ring_buffer_backend *bufb,
                                    size_t offset, int c, size_t len,
                                    size_t pagecpy);
-extern void _lib_ring_buffer_strcpy(struct lib_ring_buffer_backend *bufb,
-                                  size_t offset, const char *src, size_t len,
-                                  size_t pagecpy, int pad);
-extern void _lib_ring_buffer_copy_from_user_inatomic(struct lib_ring_buffer_backend *bufb,
+extern void _lib_ring_buffer_strcpy(struct lttng_kernel_ring_buffer_backend *bufb,
+                                  size_t offset, const char *src, size_t len, int pad);
+extern void _lib_ring_buffer_pstrcpy(struct lttng_kernel_ring_buffer_backend *bufb,
+                                  size_t offset, const char *src, size_t len, int pad);
+extern void _lib_ring_buffer_copy_from_user_inatomic(struct lttng_kernel_ring_buffer_backend *bufb,
                                            size_t offset, const void *src,
                                            size_t len, size_t pagecpy);
-extern void _lib_ring_buffer_strcpy_from_user_inatomic(struct lib_ring_buffer_backend *bufb,
-               size_t offset, const char __user *src, size_t len,
-               size_t pagecpy, int pad);
+extern void _lib_ring_buffer_strcpy_from_user_inatomic(struct lttng_kernel_ring_buffer_backend *bufb,
+               size_t offset, const char __user *src, size_t len, int pad);
+extern void _lib_ring_buffer_pstrcpy_from_user_inatomic(struct lttng_kernel_ring_buffer_backend *bufb,
+                                  size_t offset, const char __user *src, size_t len, int pad);
 
 /*
  * Subbuffer ID bits for overwrite mode. Need to fit within a single word to be
@@ -93,7 +95,7 @@ extern void _lib_ring_buffer_strcpy_from_user_inatomic(struct lib_ring_buffer_ba
  * mode).
  */
 static inline
-unsigned long subbuffer_id(const struct lib_ring_buffer_config *config,
+unsigned long subbuffer_id(const struct lttng_kernel_ring_buffer_config *config,
                           unsigned long offset, unsigned long noref,
                           unsigned long index)
 {
@@ -110,14 +112,14 @@ unsigned long subbuffer_id(const struct lib_ring_buffer_config *config,
  * bits are identical, else 0.
  */
 static inline
-int subbuffer_id_compare_offset(const struct lib_ring_buffer_config *config,
+int subbuffer_id_compare_offset(const struct lttng_kernel_ring_buffer_config *config,
                                unsigned long id, unsigned long offset)
 {
        return (id & SB_ID_OFFSET_MASK) == (offset << SB_ID_OFFSET_SHIFT);
 }
 
 static inline
-unsigned long subbuffer_id_get_index(const struct lib_ring_buffer_config *config,
+unsigned long subbuffer_id_get_index(const struct lttng_kernel_ring_buffer_config *config,
                                     unsigned long id)
 {
        if (config->mode == RING_BUFFER_OVERWRITE)
@@ -127,7 +129,7 @@ unsigned long subbuffer_id_get_index(const struct lib_ring_buffer_config *config
 }
 
 static inline
-unsigned long subbuffer_id_is_noref(const struct lib_ring_buffer_config *config,
+unsigned long subbuffer_id_is_noref(const struct lttng_kernel_ring_buffer_config *config,
                                    unsigned long id)
 {
        if (config->mode == RING_BUFFER_OVERWRITE)
@@ -141,7 +143,7 @@ unsigned long subbuffer_id_is_noref(const struct lib_ring_buffer_config *config,
  * needed.
  */
 static inline
-void subbuffer_id_set_noref(const struct lib_ring_buffer_config *config,
+void subbuffer_id_set_noref(const struct lttng_kernel_ring_buffer_config *config,
                            unsigned long *id)
 {
        if (config->mode == RING_BUFFER_OVERWRITE)
@@ -149,7 +151,7 @@ void subbuffer_id_set_noref(const struct lib_ring_buffer_config *config,
 }
 
 static inline
-void subbuffer_id_set_noref_offset(const struct lib_ring_buffer_config *config,
+void subbuffer_id_set_noref_offset(const struct lttng_kernel_ring_buffer_config *config,
                                   unsigned long *id, unsigned long offset)
 {
        unsigned long tmp;
@@ -166,7 +168,7 @@ void subbuffer_id_set_noref_offset(const struct lib_ring_buffer_config *config,
 
 /* No volatile access, since already used locally */
 static inline
-void subbuffer_id_clear_noref(const struct lib_ring_buffer_config *config,
+void subbuffer_id_clear_noref(const struct lttng_kernel_ring_buffer_config *config,
                              unsigned long *id)
 {
        if (config->mode == RING_BUFFER_OVERWRITE)
@@ -181,7 +183,7 @@ void subbuffer_id_clear_noref(const struct lib_ring_buffer_config *config,
  * -EPERM on failure.
  */
 static inline
-int subbuffer_id_check_index(const struct lib_ring_buffer_config *config,
+int subbuffer_id_check_index(const struct lttng_kernel_ring_buffer_config *config,
                             unsigned long num_subbuf)
 {
        if (config->mode == RING_BUFFER_OVERWRITE)
@@ -191,22 +193,22 @@ int subbuffer_id_check_index(const struct lib_ring_buffer_config *config,
 }
 
 static inline
-void lib_ring_buffer_backend_get_pages(const struct lib_ring_buffer_config *config,
-                       struct lib_ring_buffer_ctx *ctx,
-                       struct lib_ring_buffer_backend_pages **backend_pages)
+void lib_ring_buffer_backend_get_pages(const struct lttng_kernel_ring_buffer_config *config,
+                       struct lttng_kernel_ring_buffer_ctx *ctx,
+                       struct lttng_kernel_ring_buffer_backend_pages **backend_pages)
 {
-       struct lib_ring_buffer_backend *bufb = &ctx->buf->backend;
-       struct channel_backend *chanb = &ctx->chan->backend;
-       size_t sbidx, offset = ctx->buf_offset;
+       struct lttng_kernel_ring_buffer_backend *bufb = &ctx->priv.buf->backend;
+       struct channel_backend *chanb = &ctx->priv.chan->backend;
+       size_t sbidx, offset = ctx->priv.buf_offset;
        unsigned long sb_bindex, id;
-       struct lib_ring_buffer_backend_pages *rpages;
+       struct lttng_kernel_ring_buffer_backend_pages *rpages;
 
        offset &= chanb->buf_size - 1;
        sbidx = offset >> chanb->subbuf_size_order;
        id = bufb->buf_wsb[sbidx].id;
        sb_bindex = subbuffer_id_get_index(config, id);
        rpages = bufb->array[sb_bindex];
-       CHAN_WARN_ON(ctx->chan,
+       CHAN_WARN_ON(ctx->priv.chan,
                     config->mode == RING_BUFFER_OVERWRITE
                     && subbuffer_id_is_noref(config, id));
        *backend_pages = rpages;
@@ -214,11 +216,11 @@ void lib_ring_buffer_backend_get_pages(const struct lib_ring_buffer_config *conf
 
 /* Get backend pages from cache. */
 static inline
-struct lib_ring_buffer_backend_pages *
-       lib_ring_buffer_get_backend_pages_from_ctx(const struct lib_ring_buffer_config *config,
-               struct lib_ring_buffer_ctx *ctx)
+struct lttng_kernel_ring_buffer_backend_pages *
+       lib_ring_buffer_get_backend_pages_from_ctx(const struct lttng_kernel_ring_buffer_config *config,
+               struct lttng_kernel_ring_buffer_ctx *ctx)
 {
-       return ctx->backend_pages;
+       return ctx->priv.backend_pages;
 }
 
 /*
@@ -227,8 +229,8 @@ struct lib_ring_buffer_backend_pages *
  */
 #ifdef LTTNG_RING_BUFFER_COUNT_EVENTS
 static inline
-void subbuffer_count_record(const struct lib_ring_buffer_config *config,
-                           struct lib_ring_buffer_backend *bufb,
+void subbuffer_count_record(const struct lttng_kernel_ring_buffer_config *config,
+                           struct lttng_kernel_ring_buffer_backend *bufb,
                            unsigned long idx)
 {
        unsigned long sb_bindex;
@@ -236,22 +238,14 @@ void subbuffer_count_record(const struct lib_ring_buffer_config *config,
        sb_bindex = subbuffer_id_get_index(config, bufb->buf_wsb[idx].id);
        v_inc(config, &bufb->array[sb_bindex]->records_commit);
 }
-#else /* LTTNG_RING_BUFFER_COUNT_EVENTS */
-static inline
-void subbuffer_count_record(const struct lib_ring_buffer_config *config,
-                           struct lib_ring_buffer_backend *bufb,
-                           unsigned long idx)
-{
-}
-#endif /* #else LTTNG_RING_BUFFER_COUNT_EVENTS */
 
 /*
  * Reader has exclusive subbuffer access for record consumption. No need to
  * perform the decrement atomically.
  */
 static inline
-void subbuffer_consume_record(const struct lib_ring_buffer_config *config,
-                             struct lib_ring_buffer_backend *bufb)
+void subbuffer_consume_record(const struct lttng_kernel_ring_buffer_config *config,
+                             struct lttng_kernel_ring_buffer_backend *bufb)
 {
        unsigned long sb_bindex;
 
@@ -262,11 +256,24 @@ void subbuffer_consume_record(const struct lib_ring_buffer_config *config,
        _v_dec(config, &bufb->array[sb_bindex]->records_unread);
        v_inc(config, &bufb->records_read);
 }
+#else /* LTTNG_RING_BUFFER_COUNT_EVENTS */
+static inline
+void subbuffer_count_record(const struct lttng_kernel_ring_buffer_config *config,
+                           struct lttng_kernel_ring_buffer_backend *bufb,
+                           unsigned long idx)
+{
+}
+static inline
+void subbuffer_consume_record(const struct lttng_kernel_ring_buffer_config *config,
+                             struct lttng_kernel_ring_buffer_backend *bufb)
+{
+}
+#endif /* #else LTTNG_RING_BUFFER_COUNT_EVENTS */
 
 static inline
 unsigned long subbuffer_get_records_count(
-                               const struct lib_ring_buffer_config *config,
-                               struct lib_ring_buffer_backend *bufb,
+                               const struct lttng_kernel_ring_buffer_config *config,
+                               struct lttng_kernel_ring_buffer_backend *bufb,
                                unsigned long idx)
 {
        unsigned long sb_bindex;
@@ -284,11 +291,11 @@ unsigned long subbuffer_get_records_count(
  */
 static inline
 unsigned long subbuffer_count_records_overrun(
-                               const struct lib_ring_buffer_config *config,
-                               struct lib_ring_buffer_backend *bufb,
+                               const struct lttng_kernel_ring_buffer_config *config,
+                               struct lttng_kernel_ring_buffer_backend *bufb,
                                unsigned long idx)
 {
-       struct lib_ring_buffer_backend_pages *pages;
+       struct lttng_kernel_ring_buffer_backend_pages *pages;
        unsigned long overruns, sb_bindex;
 
        sb_bindex = subbuffer_id_get_index(config, bufb->buf_wsb[idx].id);
@@ -302,12 +309,12 @@ unsigned long subbuffer_count_records_overrun(
 }
 
 static inline
-void subbuffer_set_data_size(const struct lib_ring_buffer_config *config,
-                            struct lib_ring_buffer_backend *bufb,
+void subbuffer_set_data_size(const struct lttng_kernel_ring_buffer_config *config,
+                            struct lttng_kernel_ring_buffer_backend *bufb,
                             unsigned long idx,
                             unsigned long data_size)
 {
-       struct lib_ring_buffer_backend_pages *pages;
+       struct lttng_kernel_ring_buffer_backend_pages *pages;
        unsigned long sb_bindex;
 
        sb_bindex = subbuffer_id_get_index(config, bufb->buf_wsb[idx].id);
@@ -317,10 +324,10 @@ void subbuffer_set_data_size(const struct lib_ring_buffer_config *config,
 
 static inline
 unsigned long subbuffer_get_read_data_size(
-                               const struct lib_ring_buffer_config *config,
-                               struct lib_ring_buffer_backend *bufb)
+                               const struct lttng_kernel_ring_buffer_config *config,
+                               struct lttng_kernel_ring_buffer_backend *bufb)
 {
-       struct lib_ring_buffer_backend_pages *pages;
+       struct lttng_kernel_ring_buffer_backend_pages *pages;
        unsigned long sb_bindex;
 
        sb_bindex = subbuffer_id_get_index(config, bufb->buf_rsb.id);
@@ -330,11 +337,11 @@ unsigned long subbuffer_get_read_data_size(
 
 static inline
 unsigned long subbuffer_get_data_size(
-                               const struct lib_ring_buffer_config *config,
-                               struct lib_ring_buffer_backend *bufb,
+                               const struct lttng_kernel_ring_buffer_config *config,
+                               struct lttng_kernel_ring_buffer_backend *bufb,
                                unsigned long idx)
 {
-       struct lib_ring_buffer_backend_pages *pages;
+       struct lttng_kernel_ring_buffer_backend_pages *pages;
        unsigned long sb_bindex;
 
        sb_bindex = subbuffer_id_get_index(config, bufb->buf_wsb[idx].id);
@@ -343,8 +350,8 @@ unsigned long subbuffer_get_data_size(
 }
 
 static inline
-void subbuffer_inc_packet_count(const struct lib_ring_buffer_config *config,
-                               struct lib_ring_buffer_backend *bufb,
+void subbuffer_inc_packet_count(const struct lttng_kernel_ring_buffer_config *config,
+                               struct lttng_kernel_ring_buffer_backend *bufb,
                                unsigned long idx)
 {
        bufb->buf_cnt[idx].seq_cnt++;
@@ -355,8 +362,8 @@ void subbuffer_inc_packet_count(const struct lib_ring_buffer_config *config,
  *                               writer.
  */
 static inline
-void lib_ring_buffer_clear_noref(const struct lib_ring_buffer_config *config,
-                                struct lib_ring_buffer_backend *bufb,
+void lib_ring_buffer_clear_noref(const struct lttng_kernel_ring_buffer_config *config,
+                                struct lttng_kernel_ring_buffer_backend *bufb,
                                 unsigned long idx)
 {
        unsigned long id, new_id;
@@ -368,7 +375,7 @@ void lib_ring_buffer_clear_noref(const struct lib_ring_buffer_config *config,
         * Performing a volatile access to read the sb_pages, because we want to
         * read a coherent version of the pointer and the associated noref flag.
         */
-       id = READ_ONCE(bufb->buf_wsb[idx].id);
+       id = LTTNG_READ_ONCE(bufb->buf_wsb[idx].id);
        for (;;) {
                /* This check is called on the fast path for each record. */
                if (likely(!subbuffer_id_is_noref(config, id))) {
@@ -394,8 +401,8 @@ void lib_ring_buffer_clear_noref(const struct lib_ring_buffer_config *config,
  *                                    called by writer.
  */
 static inline
-void lib_ring_buffer_set_noref_offset(const struct lib_ring_buffer_config *config,
-                                     struct lib_ring_buffer_backend *bufb,
+void lib_ring_buffer_set_noref_offset(const struct lttng_kernel_ring_buffer_config *config,
+                                     struct lttng_kernel_ring_buffer_backend *bufb,
                                      unsigned long idx, unsigned long offset)
 {
        if (config->mode != RING_BUFFER_OVERWRITE)
@@ -426,8 +433,8 @@ void lib_ring_buffer_set_noref_offset(const struct lib_ring_buffer_config *confi
  * update_read_sb_index - Read-side subbuffer index update.
  */
 static inline
-int update_read_sb_index(const struct lib_ring_buffer_config *config,
-                        struct lib_ring_buffer_backend *bufb,
+int update_read_sb_index(const struct lttng_kernel_ring_buffer_config *config,
+                        struct lttng_kernel_ring_buffer_backend *bufb,
                         struct channel_backend *chanb,
                         unsigned long consumed_idx,
                         unsigned long consumed_count)
This page took 0.039058 seconds and 4 git commands to generate.