Update comments regarding the power of 2 constraint on sub-buffer sizes

Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/include/lttng/channel.h b/include/lttng/channel.h
index 6ab0c7b62a5a0a5bd4ad867b91ce0996f42ef27b..bb5bbcd382f47723eae934e94da69fc9eb11375e 100644 (file)
--- a/include/lttng/channel.h
+++ b/include/lttng/channel.h
@@ -33,7 +33,7 @@ extern "C" {
 #define LTTNG_CHANNEL_ATTR_PADDING1        LTTNG_SYMBOL_NAME_LEN + 12
 struct lttng_channel_attr {
        int overwrite;                      /* 1: overwrite, 0: discard */
-       uint64_t subbuf_size;               /* bytes */
+       uint64_t subbuf_size;               /* bytes, power of 2 */
        uint64_t num_subbuf;                /* power of 2 */
        unsigned int switch_timer_interval; /* usec */
        unsigned int read_timer_interval;   /* usec */

diff --git a/src/bin/lttng-sessiond/lttng-ust-abi.h b/src/bin/lttng-sessiond/lttng-ust-abi.h
index 81b61492a8ff1144d1c7f17af42fd62d569e0c82..27771e25da55d29ecca9b4a272f16212db8d54d4 100644 (file)
--- a/src/bin/lttng-sessiond/lttng-ust-abi.h
+++ b/src/bin/lttng-sessiond/lttng-ust-abi.h
@@ -166,7 +166,7 @@ struct lttng_ust_context {
  */
 #define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
 struct lttng_ust_channel_attr {
-       uint64_t subbuf_size;                   /* bytes */
+       uint64_t subbuf_size;                   /* bytes, power of 2 */
        uint64_t num_subbuf;                    /* power of 2 */
        int overwrite;                          /* 1: overwrite, 0: discard */
        unsigned int switch_timer_interval;     /* usec */

diff --git a/src/bin/lttng-sessiond/lttng-ust-ctl.h b/src/bin/lttng-sessiond/lttng-ust-ctl.h
index 7f59b86665523610b30a9d561ff326ef36521ca2..3d20c38a1541e0766b6216c92704329426f4dae6 100644 (file)
--- a/src/bin/lttng-sessiond/lttng-ust-ctl.h
+++ b/src/bin/lttng-sessiond/lttng-ust-ctl.h
@@ -45,7 +45,7 @@ struct lttng_ust_lib_ring_buffer;
 
 struct ustctl_consumer_channel_attr {
        enum lttng_ust_chan_type type;
-       uint64_t subbuf_size;                   /* bytes */
+       uint64_t subbuf_size;                   /* bytes, power of 2 */
        uint64_t num_subbuf;                    /* power of 2 */
        int overwrite;                          /* 1: overwrite, 0: discard */
        unsigned int switch_timer_interval;     /* usec */