Make lttng_dynamic_buffer_append_buffer const-correct

[lttng-tools.git] / src / common / dynamic-buffer.h

diff --git a/src/common/dynamic-buffer.h b/src/common/dynamic-buffer.h
index d42a6a61df8401ba62732d3a79a8b8f3ea44b875..1352a67c103a49206f5feca938761bc261fbb542 100644 (file)
--- a/src/common/dynamic-buffer.h
+++ b/src/common/dynamic-buffer.h
@@ -1,18 +1,8 @@
 /*
- * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only
  *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
- * for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef LTTNG_DYNAMIC_BUFFER_H
@@ -56,11 +46,11 @@ int lttng_dynamic_buffer_append(struct lttng_dynamic_buffer *buffer,
  */
 LTTNG_HIDDEN
 int lttng_dynamic_buffer_append_buffer(struct lttng_dynamic_buffer *dst_buffer,
-               struct lttng_dynamic_buffer *src_buffer);
+               const struct lttng_dynamic_buffer *src_buffer);
 
 /*
  * Set the buffer's size to new_size. The capacity of the buffer will
- * be expanded (if necessary) to accomodate new_size. Areas acquired by
+ * be expanded (if necessary) to accommodates new_size. Areas acquired by
  * a size increase will be zeroed.
  *
  * Be careful to expand the buffer's size _before_ calling out external
@@ -79,7 +69,7 @@ int lttng_dynamic_buffer_set_size(struct lttng_dynamic_buffer *buffer,
                size_t new_size);
 
 /*
- * Set the buffer's capacity to accomodate the new_capacity, allocating memory
+ * Set the buffer's capacity to accommodates the new_capacity, allocating memory
  * as necessary. The buffer's content is preserved. Setting a buffer's capacity
  * is meant as a _hint_ to the underlying buffer and is only optimization; no
  * guarantee is offered that subsequent calls to append or set_size will succeed.
@@ -94,4 +84,9 @@ int lttng_dynamic_buffer_set_capacity(struct lttng_dynamic_buffer *buffer,
 LTTNG_HIDDEN
 void lttng_dynamic_buffer_reset(struct lttng_dynamic_buffer *buffer);
 
+/* Get the space left in the buffer before a new resize is needed. */
+LTTNG_HIDDEN
+size_t lttng_dynamic_buffer_get_capacity_left(
+               struct lttng_dynamic_buffer *buffer);
+
 #endif /* LTTNG_DYNAMIC_BUFFER_H */