abf37ae15dfa7748f508318efcfa4fbdc6707658
[vboot.git] / futility / dump_kernel_config_lib.c
1 /* Copyright 2012 The Chromium OS Authors. All rights reserved.
2  * Use of this source code is governed by a BSD-style license that can be
3  * found in the LICENSE file.
4  *
5  * Exports the kernel commandline from a given partition/image.
6  */
7
8 #include <fcntl.h>
9 #include <stdio.h>
10 #include <string.h>
11 #include <sys/mman.h>
12 #include <sys/stat.h>
13 #include <sys/sysmacros.h>
14 #include <sys/types.h>
15 #include <unistd.h>
16
17 #include "host_common.h"
18 #include "kernel_blob.h"
19 #include "vboot_api.h"
20 #include "vboot_host.h"
21
22 #ifdef USE_MTD
23 #include <linux/major.h>
24 #include <mtd/mtd-user.h>
25 #include <mtdutils.h>
26 #endif
27
28 typedef ssize_t (*ReadFullyFn)(void *ctx, void *buf, size_t count);
29
30 static ssize_t ReadFullyWithRead(void *ctx, void *buf, size_t count)
31 {
32         ssize_t nr_read = 0;
33         int fd = *((int*)ctx);
34         while (nr_read < count) {
35                 ssize_t to_read = count - nr_read;
36                 ssize_t chunk = read(fd, buf + nr_read, to_read);
37                 if (chunk < 0) {
38                         return -1;
39                 } else if (chunk == 0) {
40                         break;
41                 }
42                 nr_read += chunk;
43         }
44         return nr_read;
45 }
46
47 #ifdef USE_MTD
48 static ssize_t ReadFullyWithMtdRead(void *ctx, void *buf, size_t count)
49 {
50         MtdReadContext *mtd_ctx = (MtdReadContext*)ctx;
51         return mtd_read_data(mtd_ctx, buf, count);
52 }
53 #endif
54
55 /* Skip the stream by calling |read_fn| many times. Return 0 on success. */
56 static int SkipWithRead(void *ctx, ReadFullyFn read_fn, size_t count)
57 {
58         char buf[1024];
59         ssize_t nr_skipped = 0;
60         while (nr_skipped < count) {
61                 ssize_t to_read = count - nr_skipped;
62                 if (to_read > sizeof(buf)) {
63                         to_read = sizeof(buf);
64                 }
65                 if (read_fn(ctx, buf, to_read) != to_read) {
66                         return -1;
67                 }
68                 nr_skipped += to_read;
69         }
70         return 0;
71 }
72
73 static char *FindKernelConfigFromStream(void *ctx, ReadFullyFn read_fn,
74                                         uint64_t kernel_body_load_address)
75 {
76         VbKeyBlockHeader key_block;
77         VbKernelPreambleHeader preamble;
78         uint32_t now = 0;
79         uint32_t offset = 0;
80
81         /* Skip the key block */
82         if (read_fn(ctx, &key_block, sizeof(key_block)) != sizeof(key_block)) {
83                 VbExError("not enough data to fill key block header\n");
84                 return NULL;
85         }
86         ssize_t to_skip = key_block.key_block_size - sizeof(key_block);
87         if (to_skip < 0 || SkipWithRead(ctx, read_fn, to_skip)) {
88                 VbExError("key_block_size advances past the end of the blob\n");
89                 return NULL;
90         }
91         now += key_block.key_block_size;
92
93         /* Open up the preamble */
94         if (read_fn(ctx, &preamble, sizeof(preamble)) != sizeof(preamble)) {
95                 VbExError("not enough data to fill preamble\n");
96                 return NULL;
97         }
98         to_skip = preamble.preamble_size - sizeof(preamble);
99         if (to_skip < 0 || SkipWithRead(ctx, read_fn, to_skip)) {
100                 VbExError("preamble_size advances past the end of the blob\n");
101                 return NULL;
102         }
103         now += preamble.preamble_size;
104
105         /* Read body_load_address from preamble if no
106          * kernel_body_load_address */
107         if (kernel_body_load_address == USE_PREAMBLE_LOAD_ADDR)
108                 kernel_body_load_address = preamble.body_load_address;
109
110         /* The x86 kernels have a pointer to the kernel commandline in the
111          * zeropage table, but that's irrelevant for ARM. Both types keep the
112          * config blob in the same place, so just go find it. */
113         offset = preamble.bootloader_address -
114             (kernel_body_load_address + CROS_PARAMS_SIZE +
115              CROS_CONFIG_SIZE) + now;
116         to_skip = offset - now;
117         if (to_skip < 0 || SkipWithRead(ctx, read_fn, to_skip)) {
118                 VbExError("params are outside of the memory blob: %x\n",
119                           offset);
120                 return NULL;
121         }
122         char *ret = malloc(CROS_CONFIG_SIZE);
123         if (!ret) {
124                 VbExError("No memory\n");
125                 return NULL;
126         }
127         if (read_fn(ctx, ret, CROS_CONFIG_SIZE) != CROS_CONFIG_SIZE) {
128                 VbExError("Cannot read kernel config\n");
129                 free(ret);
130                 ret = NULL;
131         }
132         return ret;
133 }
134
135 char *FindKernelConfig(const char *infile, uint64_t kernel_body_load_address)
136 {
137         char *newstr = NULL;
138
139         int fd = open(infile, O_RDONLY | O_CLOEXEC | O_LARGEFILE);
140         if (fd < 0) {
141                 VbExError("Cannot open %s\n", infile);
142                 return NULL;
143         }
144
145         void *ctx = &fd;
146         ReadFullyFn read_fn = ReadFullyWithRead;
147
148 #ifdef USE_MTD
149         struct stat stat_buf;
150         if (fstat(fd, &stat_buf)) {
151                 VbExError("Cannot stat %s\n", infile);
152                 return NULL;
153         }
154
155         int is_mtd = (major(stat_buf.st_rdev) == MTD_CHAR_MAJOR);
156         if (is_mtd) {
157                 ctx = mtd_read_descriptor(fd, infile);
158                 if (!ctx) {
159                         VbExError("Cannot read from MTD device %s\n", infile);
160                         return NULL;
161                 }
162                 read_fn = ReadFullyWithMtdRead;
163         }
164 #endif
165
166         newstr = FindKernelConfigFromStream(ctx, read_fn,
167                                             kernel_body_load_address);
168
169 #ifdef USE_MTD
170         if (is_mtd) {
171                 mtd_read_close(ctx);
172         }
173 #endif
174         close(fd);
175
176         return newstr;
177 }