kata-containers/s390-tools
1
0
Fork 0
mirror of https://github.com/ibm-s390-linux/s390-tools.git synced 2026-08-05 02:14:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

libutil: Move some zdev file reading functions into util

Browse Source 
In preparation for sharing some zdev udev code with other libraries, move
some file operation code from zdev into util_file.

Reviewed-by: Jan Höppner <hoeppner@linux.ibm.com>
Reviewed-by: Tony Krowiak <akrowiak@linux.ibm.com>
Reviewed-by: Peter Oberparleiter <oberpar@linux.ibm.com>
Signed-off-by: Matthew Rosato <mjrosato@linux.ibm.com>
Signed-off-by: Jan Höppner <hoeppner@linux.ibm.com>
This commit is contained in:
Matthew Rosato
2021-09-15 11:49:44 -04:00
committed by Jan Höppner
parent a739584d6f
commit f64b4087dd
5 changed files with 152 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/lib/util_file.h
View File

@@ -11,6 +11,8 @@
#ifndef LIB_UTIL_FILE_H
#define LIB_UTIL_FILE_H
#include "lib/util_exit_code.h"
int util_file_read_line(char *str, size_t size, const char *fmt, ...);
int util_file_read_i(int *val, int base, const char *fmt, ...);
int util_file_read_l(long *val, int base, const char *fmt, ...);
@@ -26,4 +28,10 @@ int util_file_write_ul(unsigned long val, int base, const char *fmt, ...);
int util_file_write_ull(unsigned long long val, int base, const char *fmt, ...);
int util_file_read_va(const char *path, const char *fmt, ...);
util_exit_code_t util_file_read_fd_buf(FILE *fd, void **buffer_ptr,
size_t *size_ptr);
char *util_file_read_fd(FILE *fd, int chomp);
char *util_file_read_text_file(const char *path, int chomp);
#endif /** LIB_UTIL_FILE_H @} */

132
libutil/util_file.c
View File

@@ -9,6 +9,7 @@
* it under the terms of the MIT license. See LICENSE for details.
*/
#include <ctype.h>
#include <errno.h>
#include <limits.h>
#include <linux/limits.h>
@@ -21,11 +22,16 @@
#include <unistd.h>
#include "lib/util_base.h"
#include "lib/util_exit_code.h"
#include "lib/util_file.h"
#include "lib/util_libc.h"
#include "lib/util_panic.h"
#include "lib/util_prg.h"
#define READ_CHUNK_SIZE 4096
extern const char *toolname;
/*
* Read the first line of a file into given buffer
*/
@@ -536,3 +542,129 @@ int util_file_read_va(const char *path, const char *fmt, ...)
return -1;
return ret;
}
/**
* Print an error message indicating an out-of-memory situation and exit.
*/
static void oom(void)
{
fprintf(stderr, "Out of memory\n");
/* We can't rely on our clean-up routines to work reliably during an
* OOM situation, so just exit here.
*/
exit(UTIL_EXIT_OUT_OF_MEMORY);
}
/**
* Read all data from @fd and return address of resulting buffer in
* @buffer_ptr. If @size_ptr is non-zero, use it to store the size of the
* resulting buffer. Return %UTIL_EXIT_OK on success.
*
* @param[in] fd File descriptor to read data from
* @param[in, out] buffer_ptr Buffer to read data into
* @param[in, out] size_ptr Buffer to save size of data read into buffer_ptr
*
* @retval 0 read was successful
* @retval UTIL_EXIT_RUNTIME_ERROR error while reading file
*/
util_exit_code_t util_file_read_fd_buf(FILE *fd, void **buffer_ptr,
size_t *size_ptr)
{
char *buffer = NULL;
size_t done = 0;
while (!feof(fd)) {
buffer = realloc(buffer, done + READ_CHUNK_SIZE);
if (!buffer)
oom();
done += fread(&buffer[done], 1, READ_CHUNK_SIZE, fd);
if (ferror(fd)) {
free(buffer);
return UTIL_EXIT_RUNTIME_ERROR;
}
}
buffer = realloc(buffer, done);
if (!buffer && done > 0)
oom();
*buffer_ptr = buffer;
if (size_ptr)
*size_ptr = done;
return UTIL_EXIT_OK;
}
/**
* Read text from @fd and return resulting NULL-terminated text buffer.
* If @chomp is non-zero, remove trailing newline character. Return %NULL
* on error or when unprintable characters are read.
*
* @param[in] fd File descriptor to read data from
* @param[in] chomp Flag to indicate trailing newlines should be removed
*
* @retval NULL Error reading from fd
* @retval != 0 Data read successfully, buffer returned
*/
char *util_file_read_fd(FILE *fd, int chomp)
{
char *buffer;
size_t done, i;
if (util_file_read_fd_buf(fd, (void **) &buffer, &done))
return NULL;
/* Check if this is a text file at all (required to filter out
* binary sysfs attributes).
*/
for (i = 0; i < done; i++) {
if (!isgraph(buffer[i]) && !isspace(buffer[i])) {
free(buffer);
return NULL;
}
}
/* Remove trailing new-line character if requested. */
if (chomp && done > 0 && buffer[done - 1] == '\n')
done--;
/* NULL-terminate. */
buffer = realloc(buffer, done + 1);
if (!buffer)
oom();
buffer[done] = 0;
return buffer;
}
/**
* Read file as text and return NULL-terminated contents. Remove trailing
* newline if CHOMP is specified.
*
* @param[in] path Path to the file that will be read from
* @param[in] chomp Flag to indicate trailing newlines should be removed
*
* @retval NULL Error reading from file
* @retval != 0 File read successfully, contents returned in buffer
*/
char *util_file_read_text_file(const char *path, int chomp)
{
char *buffer = NULL;
FILE *fd;
fd = fopen(path, "r");
if (!fd)
goto out;
buffer = util_file_read_fd(fd, chomp);
fclose(fd);
out:
if (!buffer) {
fprintf(stderr, "Could not read file %s: %s\n", path,
strerror(errno));
}
return buffer;
}

1
zdev/include/misc.h
View File

@@ -173,7 +173,6 @@ bool misc_read_dir(const char *, struct util_list *,
bool (*)(const char *, void *), void *);
bool file_is_devnode(const char *);
exit_code_t remove_file(const char *);
exit_code_t misc_read_fd(FILE *fd, void **buffer, size_t *size_ptr);
char *misc_read_text_file(const char *, int, err_t);
char *misc_read_cmd_output(const char *, int, err_t);
char *config_read_cmd_output(const char *, int, err_t);

8
zdev/src/firmware.c
View File

@@ -19,6 +19,8 @@
#include <sys/types.h>
#include <unistd.h>
#include "lib/util_file.h"
#include "attrib.h"
#include "ccw.h"
#include "ccwgroup.h"
@@ -187,7 +189,8 @@ static exit_code_t read_fw(struct fw_file *file, FILE *fd, const char *filename)
for (retry = 0; retry < READ_RETRY; retry++) {
/* Read complete file once */
rc = misc_read_fd(fd, (void **) &buffer, &size);
rc = (exit_code_t) util_file_read_fd_buf(fd, (void **) &buffer,
&size);
if (rc) {
warn("%s: Could not read file", filename);
return rc;
@@ -203,7 +206,8 @@ static exit_code_t read_fw(struct fw_file *file, FILE *fd, const char *filename)
/* Could be a pipe, socket, or FIFO - accept v1. */
break;
}
rc = misc_read_fd(fd, (void **) &buffer2, &size2);
rc = (exit_code_t) util_file_read_fd_buf(fd, (void **) &buffer2,
&size2);
if (rc || !buffer2) {
/* Could not get second version - accept v1. */
break;

75
zdev/src/misc.c
View File

@@ -26,6 +26,8 @@
#include <time.h>
#include <unistd.h>
#include "lib/util_file.h"
#include "dasd.h"
#include "device.h"
#include "devtype.h"
@@ -97,71 +99,6 @@ static void dryrun_end_data(void)
fprintf(fd, "%c", DRYRUN_DATA_END);
}
#define READ_CHUNK_SIZE 4096
/* Read all data from @fd and return address of resulting buffer in
* @buffer_ptr. If @size_ptr is non-zero, use it to store the size of the
* resulting buffer. Return %EXIT_OK on success. */
exit_code_t misc_read_fd(FILE *fd, void **buffer_ptr, size_t *size_ptr)
{
char *buffer = NULL;
size_t done = 0;
while (!feof(fd)) {
buffer = realloc(buffer, done + READ_CHUNK_SIZE);
if (!buffer)
oom();
done += fread(&buffer[done], 1, READ_CHUNK_SIZE, fd);
if (ferror(fd)) {
free(buffer);
return EXIT_RUNTIME_ERROR;
}
}
buffer = realloc(buffer, done);
if (!buffer && done > 0)
oom();
*buffer_ptr = buffer;
if (size_ptr)
*size_ptr = done;
return EXIT_OK;
}
/* Read text from @fd and return resulting NULL-terminated text buffer.
* If @chomp is non-zero, remove trailing newline character. Return %NULL
* on error or when unprintable characters are read. */
static char *read_fd(FILE *fd, int chomp)
{
char *buffer;
size_t done, i;
if (misc_read_fd(fd, (void **) &buffer, &done))
return NULL;
/* Check if this is a text file at all (required to filter out
* binary sysfs attributes). */
for (i = 0; i < done; i++) {
if (!isgraph(buffer[i]) && !isspace(buffer[i])) {
free(buffer);
return NULL;
}
}
/* Remove trailing new-line character if requested. */
if (chomp && done > 0 && buffer[done - 1] == '\n')
done--;
/* NULL-terminate. */
buffer = realloc(buffer, done + 1);
if (!buffer)
oom();
buffer[done] = 0;
return buffer;
}
static int count_newline(const char *str)
{
int i, newline;
@@ -182,7 +119,7 @@ static void dryrun_print(void)
int cmd, newline;
fseek(dryrun_file, 0, SEEK_SET);
txt = read_fd(dryrun_file, 0);
txt = util_file_read_fd(dryrun_file, 0);
if (!txt)
return;
@@ -979,7 +916,7 @@ char *misc_read_text_file(const char *path, int chomp, err_t err)
if (!fd)
goto out;
buffer = read_fd(fd, chomp);
buffer = util_file_read_fd(fd, chomp);
misc_fclose(fd);
out:
@@ -1003,7 +940,7 @@ char *misc_read_cmd_output(const char *cmd, int chomp, err_t err)
if (!fd)
goto out;
buffer = read_fd(fd, chomp);
buffer = util_file_read_fd(fd, chomp);
pclose(fd);
out:
@@ -1027,7 +964,7 @@ char *config_read_cmd_output(const char *cmd, int chomp, err_t err)
if (!fd)
goto out;
buffer = read_fd(fd, chomp);
buffer = util_file_read_fd(fd, chomp);
misc_pclose(fd);
out: