include/sg_pr2serr.h - main - githubmirror/sg3_utils

include/sg_pr2serr.h
80 строк3 KB
Douglas Gilbert
sg_map: fix sg<->sd mapping for LUNs greater than 255
25 июн 2026, 20:45
25 июн 2026, 20:45c445f0f
#ifndef SG_PR2SERR_H
#define SG_PR2SERR_H

/*
 * Copyright (c) 2004-2026 Douglas Gilbert.
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#include <inttypes.h>
#include <stdio.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

/* pr2serr and pr2ws are convenience functions that replace the somewhat
 * long-winded fprintf(stderr, ....). The second form (i.e. pr2ws() ) is for
 * internal library use and may place its output somewhere other than stderr;
 * it depends on the external variable sg_warnings_strm which can be set
 * with sg_set_warnings_strm(). By default it uses stderr.
 * Note that this header and its implementation do not depend on sg_lib.[hc]
 * or any other sg3_utils components. */

#if __USE_MINGW_ANSI_STDIO -0 == 1
#define __printf(a, b) __attribute__((__format__(gnu_printf, a, b)))
#elif defined(__GNUC__) || defined(__clang__)
#define __printf(a, b) __attribute__((__format__(printf, a, b)))
#else
#define __printf(a, b)
#endif

int pr2serr(const char * fmt, ...) __printf(1, 2);

extern FILE * sg_warnings_strm;

/* Only difference between pr2serr() and pr2ws() is that the former always
 * send output to stderr. By default, pr2ws() also sends it output to
 * stderr. The sg_set_warnings_strm() function found in sg_lib.h (if used)
 * set another FILE * value. The functions in sg_lib.h send their error
 * output to pr2ws() . */
int pr2ws(const char * fmt, ...) __printf(1, 2);

/* Want safe, 'n += snprintf(b + n, blen - n, ...);' pattern that can
 * be called repeatedly. However snprintf() takes an unsigned second argument
 * (size_t) that explodes if 'blen - n' goes negative. This function instead
 * uses signed integers (second argument and return value) and is safe if the
 * second argument is negative. It returns number of chars actually
 * placed in cp excluding the trailing null char. So for cp_max_len > 0 the
 * return value is always < cp_max_len; for cp_max_len <= 1 the return value
 * is 0 and no chars are written to cp. Note this means that when
 * cp_max_len = 1, this function assumes that cp[0] is the null character
 * and does nothing (and returns 0). Linux kernel has a similar function
 * called  scnprintf().  */
int sg_scnpr(char * cp, int cp_max_len, const char * fmt, ...) __printf(3, 4);

/* This function is similar to sg_scnpr() but takes the "n" in that pattern
 * as an extra, third argument where it is renamed 'off'. This function will
 * start writing chars at 'fcp + off' for no more than 'fcp_len - off - 1'
 * characters. The return value is the same as sg_scnpr(). */
int sg_scn3pr(char * fcp, int fcp_len, int off,
              const char * fmt, ...) __printf(4, 5);

/* Safer form of strncpy() modelled on Linux kernel strscpy() function.
 * Returns 0 if count is 1 or less (notice count is an int so that includes
 * negative values) and doesn't touch dest. Otherwise copies up to count-1
 * characters from src to dest; stopping if a null char has just been
 * copied. If count-1 copies are reached, a null character is written to
 * dest. So in the case where count is 1, a null character is written to
 * dest[0] and 0 is returned. dest must be large enough to accept count
 * characters. Returns characters copied excluding trailing null char. */
int sg_strscpy(char * dest, const char * src, int count);

#ifdef __cplusplus
}
#endif

#endif