1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-23 17:34:34 +03:00
samba-mirror/lib/util/util.h
Volker Lendecke bbcc9b326e lib: Add dump_data_addbuf()
Helper function to build up debug strings

Signed-off-by: Volker Lendecke <vl@samba.org>
Reviewed-by: Jeremy Allison <jra@samba.org>
2023-03-09 18:10:33 +00:00

95 lines
2.8 KiB
C

/*
Unix SMB/CIFS implementation.
Utility functions for Samba
Copyright (C) Andrew Tridgell 1992-1999
Copyright (C) Jelmer Vernooij 2005
Copyright (C) Swen Schillig 2019
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __UTIL_SAMBA_UTIL_H__
#define __UTIL_SAMBA_UTIL_H__
/**
* Write dump of binary data to a callback
*/
void dump_data_cb(const uint8_t *buf, int len,
bool omit_zero_bytes,
void (*cb)(const char *buf, void *private_data),
void *private_data);
/**
* Write dump of binary data to a FILE
*/
void dump_data_file(const uint8_t *buf, int len, bool omit_zero_bytes,
FILE *f);
/**
* Write dump of binary data to the log file.
*
* The data is only written if the log level is at least level.
*/
_PUBLIC_ void dump_data(int level, const uint8_t *buf,int len);
/**
* Write dump of binary data to the log file.
*
* The data is only written if the log level is at least level for
* debug class dbgc_class.
*/
_PUBLIC_ void dump_data_dbgc(int dbgc_class, int level, const uint8_t *buf, int len);
/**
* Write dump of compared binary data to a callback
*/
void dump_data_diff_cb(const uint8_t *buf1, size_t len1,
const uint8_t *buf2, size_t len2,
bool omit_zero_bytes,
void (*cb)(const char *buf, void *private_data),
void *private_data);
/**
* Write dump of compared binary data to the log file.
*
* The data is only written if the log level is at least level for
* debug class dbgc_class.
*/
_PUBLIC_ void dump_data_diff(int dbgc_class, int level,
bool omit_zero_bytes,
const uint8_t *buf1, size_t len1,
const uint8_t *buf2, size_t len2);
/**
* Write dump of compared binary data to the given file handle
*/
_PUBLIC_ void dump_data_file_diff(FILE *f,
bool omit_zero_bytes,
const uint8_t *buf1, size_t len1,
const uint8_t *buf2, size_t len2);
/**
* Write a password to the log file.
*
* @note Only actually does something if DEBUG_PASSWORD was defined during
* compile-time.
*/
_PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len);
/**
* Dump data to "str" via talloc_asprintf_addbuf()
*/
_PUBLIC_ void dump_data_addbuf(const uint8_t *buf, size_t buflen, char **str);
#endif