mirror of
https://github.com/ibm-s390-linux/s390-tools.git
synced 2026-08-05 02:14:52 +00:00
dea5f80215
Remove all the code just pvattest-C used from libpv. z(get)dump is the only user as of now. Acked-by: Marc Hartmayer <mhartmay@linux.ibm.com> Signed-off-by: Steffen Eiden <seiden@linux.ibm.com>
127 lines
3.3 KiB
C
127 lines
3.3 KiB
C
/*
|
|
* Glib convenience functions
|
|
* Shall be used instead of manually including glib.
|
|
*
|
|
* Copyright IBM Corp. 2022
|
|
*
|
|
* s390-tools is free software; you can redistribute it and/or modify
|
|
* it under the terms of the MIT license. See LICENSE for details.
|
|
*/
|
|
#ifndef LIBPV_GLIB_HELPER_H
|
|
#define LIBPV_GLIB_HELPER_H
|
|
|
|
#if defined(GLIB_VERSION_MIN_REQUIRED)
|
|
#if GLIB_VERSION_MIN_REQUIRED < GLIB_VERSION_2_56
|
|
#error "GLIB_VERSION must be at least 2.56"
|
|
#endif
|
|
#else
|
|
#define GLIB_VERSION_MIN_REQUIRED GLIB_VERSION_2_56
|
|
#endif
|
|
|
|
#define GLIB_VERSION_MAX_ALLOWED GLIB_VERSION_2_56
|
|
|
|
#ifdef __G_LIB_H__
|
|
#error "glib.h must be included via libpv/glib-helper.h"
|
|
#endif
|
|
|
|
#include <glib.h>
|
|
#include <gmodule.h>
|
|
#include <stdio.h>
|
|
|
|
#ifdef __clang__
|
|
#define WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(...) \
|
|
DO_PRAGMA(clang diagnostic push) \
|
|
DO_PRAGMA(clang diagnostic ignored "-Wunused-function") \
|
|
G_DEFINE_AUTOPTR_CLEANUP_FUNC(__VA_ARGS__) \
|
|
DO_PRAGMA(clang diagnostic pop)
|
|
#else
|
|
#define WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(...) G_DEFINE_AUTOPTR_CLEANUP_FUNC(__VA_ARGS__)
|
|
#endif
|
|
|
|
#define DO_PRAGMA(x) _Pragma(#x)
|
|
|
|
#define pv_wrapped_g_assert(__expr) g_assert(__expr)
|
|
|
|
/** pv_sec_gbytes_new_take:
|
|
*
|
|
* #g_bytes_new_take() with secure cleanup
|
|
*/
|
|
GBytes *pv_sec_gbytes_new_take(void *data, size_t size);
|
|
|
|
/** pv_sec_gbytes_new:
|
|
*
|
|
* #g_bytes_new() with secure cleanup
|
|
*/
|
|
GBytes *pv_sec_gbytes_new(const void *data, size_t size);
|
|
|
|
/** pv_file_get_content_as_secure_bytes:
|
|
*
|
|
* @filename: path to file for reading in
|
|
*
|
|
* read file and save as secure gbytes
|
|
*
|
|
* Return:
|
|
* Content of file as #GBytes with secure cleanup
|
|
*/
|
|
GBytes *pv_file_get_content_as_secure_bytes(const char *filename);
|
|
|
|
/** pv_file_get_content_as_g_bytes:
|
|
*
|
|
* @filename: path to file for reading in
|
|
*
|
|
* read file and save as gbytes
|
|
*
|
|
* Return:
|
|
* Content of file as #GBytes
|
|
*/
|
|
GBytes *pv_file_get_content_as_g_bytes(const char *filename, GError **error);
|
|
|
|
/** pv_file_seek:
|
|
*
|
|
* fseek with error reporting
|
|
*/
|
|
int pv_file_seek(FILE *file, long offset, int whence, GError **error);
|
|
|
|
/** pv_file_write:
|
|
*
|
|
* fwrite with error reporting
|
|
*/
|
|
size_t pv_file_write(FILE *file, const void *ptr, size_t size, GError **error);
|
|
|
|
/** pv_file_close:
|
|
*
|
|
* fclose with error reporting
|
|
*/
|
|
long pv_file_close(FILE *file, GError **error);
|
|
|
|
/** pv_file_tell:
|
|
*
|
|
* ftell with error reporting
|
|
*/
|
|
long pv_file_tell(FILE *file, GError **error);
|
|
|
|
/** pv_file_open:
|
|
*
|
|
* fopen with error reporting
|
|
*/
|
|
FILE *pv_file_open(const char *filename, const char *mode, GError **error);
|
|
|
|
/** pv_gbytes_memcpy:
|
|
*
|
|
* memcpy with size check. In case @dst_size is smaller than the size of @src
|
|
* the error value %NULL is returned and @copied and @dst are left unchanged.
|
|
*
|
|
* If @dst and @src data overlap, the behavior is undefined.
|
|
*/
|
|
void *pv_gbytes_memcpy(void *dst, size_t dst_size, GBytes *src, size_t *copied);
|
|
|
|
#define PV_GLIB_HELPER_ERROR g_quark_from_static_string("pv-glib-helper_error-quark")
|
|
typedef enum {
|
|
PV_GLIB_HELPER_FILE_ERROR,
|
|
} pv_glib_helper_error_e;
|
|
|
|
void pv_auto_close_file(FILE *file);
|
|
WRAPPED_G_DEFINE_AUTOPTR_CLEANUP_FUNC(FILE, pv_auto_close_file)
|
|
|
|
#endif /* LIBPV_GLIB_HELPER_H */
|