X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Fbuffer-view.h;h=47f09b430c5be1c3b538c86d5eae20b1546a217d;hp=878b845bc77412bb801f81207a1bd38b5a0fd13e;hb=7c1f6da21f4d46d9c834820a2b26f0634c7365a9;hpb=b35aac846ef0c3109e964f5babd59cdbabe373cc diff --git a/src/common/buffer-view.h b/src/common/buffer-view.h index 878b845bc..47f09b430 100644 --- a/src/common/buffer-view.h +++ b/src/common/buffer-view.h @@ -1,26 +1,17 @@ /* - * Copyright (C) 2017 - Jérémie Galarneau + * Copyright (C) 2017 Jérémie Galarneau * - * 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_BUFFER_VIEW_H #define LTTNG_BUFFER_VIEW_H +#include +#include #include #include -#include struct lttng_dynamic_buffer; @@ -44,6 +35,18 @@ LTTNG_HIDDEN struct lttng_buffer_view lttng_buffer_view_init( const char *src, size_t offset, ptrdiff_t len); +/** + * Checks if a buffer view is safe to access. + * + * After calling the buffer view creation functions, callers should verify + * if the resquested length (if any is explicitly provided) could be mapped + * to a new view. + * + * @view Buffer view to validate + */ +LTTNG_HIDDEN +bool lttng_buffer_view_is_valid(const struct lttng_buffer_view *view); + /** * Return a buffer view referencing a subset of the memory referenced by another * view. @@ -80,4 +83,18 @@ struct lttng_buffer_view lttng_buffer_view_from_dynamic_buffer( const struct lttng_dynamic_buffer *src, size_t offset, ptrdiff_t len); +/** + * Verify that `buf` contains a string starting at `str` of length + * `len_with_null_terminator`. + * + * @buf The buffer view + * @str The start of the string + * @len_with_null_terminator Expected length of the string, including the + * NULL terminator. + */ +LTTNG_HIDDEN +bool lttng_buffer_view_contains_string(const struct lttng_buffer_view *buf, + const char *str, + size_t len_with_null_terminator); + #endif /* LTTNG_BUFFER_VIEW_H */