xref: /dpdk/lib/eal/unix/eal_firmware.c (revision c56185fc183fc0532d2f03aaf04bbf0989ea91a5)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2021 Red Hat, Inc.
3  */
4 
5 #ifdef RTE_HAS_LIBARCHIVE
6 #include <archive.h>
7 #endif
8 #include <fcntl.h>
9 #include <stdio.h>
10 #include <stdlib.h>
11 #include <unistd.h>
12 
13 #include <rte_common.h>
14 #include <rte_log.h>
15 
16 #include "eal_firmware.h"
17 
18 #ifdef RTE_HAS_LIBARCHIVE
19 
20 struct firmware_read_ctx {
21 	struct archive *a;
22 };
23 
24 static int
25 firmware_open(struct firmware_read_ctx *ctx, const char *name, size_t blocksize)
26 {
27 	struct archive_entry *e;
28 	int err;
29 
30 	ctx->a = archive_read_new();
31 	if (ctx->a == NULL)
32 		return -1;
33 
34 	if (archive_read_support_format_raw(ctx->a) != ARCHIVE_OK)
35 		goto error;
36 
37 	err = archive_read_support_filter_xz(ctx->a);
38 	if (err != ARCHIVE_OK && err != ARCHIVE_WARN)
39 		goto error;
40 
41 	if (archive_read_open_filename(ctx->a, name, blocksize) != ARCHIVE_OK)
42 		goto error;
43 
44 	if (archive_read_next_header(ctx->a, &e) != ARCHIVE_OK)
45 		goto error;
46 
47 	return 0;
48 
49 error:
50 	archive_read_free(ctx->a);
51 	ctx->a = NULL;
52 	return -1;
53 }
54 
55 static ssize_t
56 firmware_read_block(struct firmware_read_ctx *ctx, void *buf, size_t count)
57 {
58 	return archive_read_data(ctx->a, buf, count);
59 }
60 
61 static void
62 firmware_close(struct firmware_read_ctx *ctx)
63 {
64 	archive_read_free(ctx->a);
65 	ctx->a = NULL;
66 }
67 
68 #else /* !RTE_HAS_LIBARCHIVE */
69 
70 struct firmware_read_ctx {
71 	int fd;
72 };
73 
74 static int
75 firmware_open(struct firmware_read_ctx *ctx, const char *name,
76 	__rte_unused size_t blocksize)
77 {
78 	ctx->fd = open(name, O_RDONLY);
79 	if (ctx->fd < 0)
80 		return -1;
81 	return 0;
82 }
83 
84 static ssize_t
85 firmware_read_block(struct firmware_read_ctx *ctx, void *buf, size_t count)
86 {
87 	return read(ctx->fd, buf, count);
88 }
89 
90 static void
91 firmware_close(struct firmware_read_ctx *ctx)
92 {
93 	close(ctx->fd);
94 	ctx->fd = -1;
95 }
96 
97 #endif /* !RTE_HAS_LIBARCHIVE */
98 
99 static int
100 firmware_read(const char *name, void **buf, size_t *bufsz)
101 {
102 	const size_t blocksize = 4096;
103 	struct firmware_read_ctx ctx;
104 	int ret = -1;
105 	int err;
106 
107 	*buf = NULL;
108 	*bufsz = 0;
109 
110 	if (firmware_open(&ctx, name, blocksize) < 0)
111 		return -1;
112 
113 	do {
114 		void *tmp;
115 
116 		tmp = realloc(*buf, *bufsz + blocksize);
117 		if (tmp == NULL) {
118 			free(*buf);
119 			*buf = NULL;
120 			*bufsz = 0;
121 			goto out;
122 		}
123 		*buf = tmp;
124 
125 		err = firmware_read_block(&ctx, RTE_PTR_ADD(*buf, *bufsz), blocksize);
126 		if (err < 0) {
127 			free(*buf);
128 			*buf = NULL;
129 			*bufsz = 0;
130 			goto out;
131 		}
132 		*bufsz += err;
133 
134 	} while (err != 0);
135 
136 	ret = 0;
137 out:
138 	firmware_close(&ctx);
139 	return ret;
140 }
141 
142 int
143 rte_firmware_read(const char *name, void **buf, size_t *bufsz)
144 {
145 	char path[PATH_MAX];
146 	int ret;
147 
148 	ret = firmware_read(name, buf, bufsz);
149 	if (ret < 0) {
150 		snprintf(path, sizeof(path), "%s.xz", name);
151 		path[PATH_MAX - 1] = '\0';
152 #ifndef RTE_HAS_LIBARCHIVE
153 		if (access(path, F_OK) == 0) {
154 			RTE_LOG(WARNING, EAL, "libarchive not linked, %s cannot be decompressed\n",
155 				path);
156 		}
157 #else
158 		ret = firmware_read(path, buf, bufsz);
159 #endif
160 	}
161 	return ret;
162 }
163