1 /*
2 * Copyright (c) 2021-2022 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28
29 #include <libkern/c++/OSBoundedPtr.h>
30
31 #define NVRAM_CHRP_APPLE_HEADER_NAME_V1 "nvram"
32 #define NVRAM_CHRP_APPLE_HEADER_NAME_V2 "2nvram"
33
34 #define NVRAM_CHRP_PARTITION_NAME_COMMON_V1 "common"
35 #define NVRAM_CHRP_PARTITION_NAME_SYSTEM_V1 "system"
36 #define NVRAM_CHRP_PARTITION_NAME_COMMON_V2 "2common"
37 #define NVRAM_CHRP_PARTITION_NAME_SYSTEM_V2 "2system"
38
39 #define NVRAM_CHRP_LENGTH_BLOCK_SIZE 0x10 // CHRP length field is in 16 byte blocks
40
41 typedef struct chrp_nvram_header { //16 bytes
42 uint8_t sig;
43 uint8_t cksum; // checksum on sig, len, and name
44 uint16_t len; // total length of the partition in 16 byte blocks starting with the signature
45 // and ending with the last byte of data area, ie len includes its own header size
46 char name[12];
47 uint8_t data[0];
48 } chrp_nvram_header_t;
49
50 typedef struct apple_nvram_header { // 16 + 16 bytes
51 struct chrp_nvram_header chrp;
52 uint32_t adler;
53 uint32_t generation;
54 uint8_t padding[8];
55 } apple_nvram_header_t;
56
57 typedef struct {
58 NVRAMPartitionType type;
59 uint32_t offset;
60 uint32_t size;
61 } NVRAMRegionInfo;
62
63 class IONVRAMCHRPHandler : public IODTNVRAMFormatHandler, IOTypedOperatorsMixin<IONVRAMCHRPHandler>
64 {
65 private:
66 bool _newData;
67 bool _reload;
68 IONVRAMController *_nvramController;
69 IODTNVRAM *_provider;
70 NVRAMVersion _version;
71 uint32_t _generation;
72
73 uint8_t *_nvramImage;
74
75 uint32_t _commonPartitionOffset;
76 uint32_t _commonPartitionSize;
77
78 uint32_t _systemPartitionOffset;
79 uint32_t _systemPartitionSize;
80
81 OSSharedPtr<OSDictionary> _varDict;
82
83 uint32_t _commonUsed;
84 uint32_t _systemUsed;
85
86 IORWLock *_variableLock;
87 IOLock *_controllerLock;
88
89 uint32_t findCurrentBank(uint32_t *gen);
90 IOReturn unserializeImage(const uint8_t *image, IOByteCount length);
91 IOReturn serializeVariables(void);
92
93 IOReturn reloadInternal(void);
94 IOReturn setVariableInternal(const uuid_t varGuid, const char *variableName, OSObject *object);
95
96 static OSSharedPtr<OSData> unescapeBytesToData(const uint8_t *bytes, uint32_t length);
97 static OSSharedPtr<OSData> escapeDataToData(OSData * value);
98
99 static bool convertPropToObject(const uint8_t *propName, uint32_t propNameLength, const uint8_t *propData, uint32_t propDataLength,
100 LIBKERN_RETURNS_RETAINED const OSSymbol **propSymbol, LIBKERN_RETURNS_RETAINED OSObject **propObject);
101 static bool convertPropToObject(const uint8_t *propName, uint32_t propNameLength, const uint8_t *propData, uint32_t propDataLength,
102 OSSharedPtr<const OSSymbol>& propSymbol, OSSharedPtr<OSObject>& propObject);
103 static bool convertObjectToProp(uint8_t *buffer, uint32_t *length, const OSSymbol *propSymbol, OSObject *propObject);
104 static bool convertObjectToProp(uint8_t *buffer, uint32_t *length, const char *propSymbol, OSObject *propObject);
105
106 public:
107 virtual
108 ~IONVRAMCHRPHandler() APPLE_KEXT_OVERRIDE;
109 IONVRAMCHRPHandler();
110 static bool isValidImage(const uint8_t *image, IOByteCount length);
111 static IONVRAMCHRPHandler *init(IODTNVRAM *provider, const uint8_t *image, IOByteCount length);
112
113 virtual IOReturn unserializeVariables(void) APPLE_KEXT_OVERRIDE;
114 virtual IOReturn setVariable(const uuid_t varGuid, const char *variableName, OSObject *object) APPLE_KEXT_OVERRIDE;
115 virtual bool setController(IONVRAMController *controller) APPLE_KEXT_OVERRIDE;
116 virtual IOReturn sync(void) APPLE_KEXT_OVERRIDE;
117 virtual IOReturn flush(const uuid_t guid, IONVRAMOperation op) APPLE_KEXT_OVERRIDE;
118 virtual void reload(void) APPLE_KEXT_OVERRIDE;
119 virtual uint32_t getGeneration(void) const APPLE_KEXT_OVERRIDE;
120 virtual uint32_t getVersion(void) const APPLE_KEXT_OVERRIDE;
121 virtual uint32_t getSystemUsed(void) const APPLE_KEXT_OVERRIDE;
122 virtual uint32_t getCommonUsed(void) const APPLE_KEXT_OVERRIDE;
123 virtual bool getSystemPartitionActive(void) const APPLE_KEXT_OVERRIDE;
124 virtual IOReturn getVarDict(OSSharedPtr<OSDictionary> &varDictCopy) APPLE_KEXT_OVERRIDE;
125 };
126
127 static const char *
get_bank_version_string(int version)128 get_bank_version_string(int version)
129 {
130 switch (version) {
131 case kNVRAMVersion1:
132 return NVRAM_CHRP_APPLE_HEADER_NAME_V1;
133 case kNVRAMVersion2:
134 return NVRAM_CHRP_APPLE_HEADER_NAME_V2;
135 default:
136 return "Unknown";
137 }
138 }
139
140 static uint32_t
adler32(const uint8_t * buffer,size_t length)141 adler32(const uint8_t *buffer, size_t length)
142 {
143 uint32_t offset;
144 uint32_t adler, lowHalf, highHalf;
145
146 lowHalf = 1;
147 highHalf = 0;
148
149 for (offset = 0; offset < length; offset++) {
150 if ((offset % 5000) == 0) {
151 lowHalf %= 65521L;
152 highHalf %= 65521L;
153 }
154
155 lowHalf += buffer[offset];
156 highHalf += lowHalf;
157 }
158
159 lowHalf %= 65521L;
160 highHalf %= 65521L;
161
162 adler = (highHalf << 16) | lowHalf;
163
164 return adler;
165 }
166
167 static uint32_t
nvram_get_adler(uint8_t * buf,int version)168 nvram_get_adler(uint8_t *buf, int version)
169 {
170 return ((struct apple_nvram_header *)buf)->adler;
171 }
172
173 static uint32_t
adler32_with_version(const uint8_t * buf,size_t len,int version)174 adler32_with_version(const uint8_t *buf, size_t len, int version)
175 {
176 size_t offset;
177
178 switch (version) {
179 case kNVRAMVersion1:
180 case kNVRAMVersion2:
181 offset = offsetof(struct apple_nvram_header, generation);
182 break;
183 default:
184 return 0;
185 }
186
187 return adler32(buf + offset, len - offset);
188 }
189
190 static uint8_t
chrp_checksum(const struct chrp_nvram_header * hdr)191 chrp_checksum(const struct chrp_nvram_header *hdr)
192 {
193 uint16_t sum;
194 const uint8_t *p;
195 const uint8_t *begin = (const uint8_t *)hdr + offsetof(struct chrp_nvram_header, len);
196 const uint8_t *end = (const uint8_t *)hdr + offsetof(struct chrp_nvram_header, data);
197
198 // checksum the header (minus the checksum itself)
199 sum = hdr->sig;
200 for (p = begin; p < end; p++) {
201 sum += *p;
202 }
203 while (sum > 0xff) {
204 sum = (sum & 0xff) + (sum >> 8);
205 }
206
207 return sum & 0xff;
208 }
209
210 static IOReturn
nvram_validate_header_v1v2(const uint8_t * buf,uint32_t * generation,int version)211 nvram_validate_header_v1v2(const uint8_t * buf, uint32_t *generation, int version)
212 {
213 IOReturn result = kIOReturnError;
214 uint8_t checksum;
215 const char *header_string = get_bank_version_string(version);
216 struct chrp_nvram_header *chrp_header = (struct chrp_nvram_header *)buf;
217 uint32_t local_gen = 0;
218
219 require(buf != nullptr, exit);
220
221 // <rdar://problem/73454488> Recovery Mode [Internal Build] 18D52-->18E141 [J307/308 Only]
222 // we can only compare the first "nvram" parts of the name as some devices have additional junk from
223 // a previous build likely copying past bounds of the "nvram" name in the const section
224 if (memcmp(header_string, chrp_header->name, strlen(header_string)) == 0) {
225 checksum = chrp_checksum(chrp_header);
226 if (checksum == chrp_header->cksum) {
227 result = kIOReturnSuccess;
228 local_gen = ((struct apple_nvram_header*)buf)->generation;
229
230 DEBUG_INFO("Found %s gen=%u\n", header_string, local_gen);
231
232 if (generation) {
233 *generation = local_gen;
234 }
235 } else {
236 DEBUG_INFO("invalid checksum in header, found %#02x, expected %#02x\n", chrp_header->cksum, checksum);
237 }
238 } else {
239 DEBUG_INFO("invalid bank for \"%s\", name = %#02x %#02x %#02x %#02x\n", header_string,
240 chrp_header->name[0],
241 chrp_header->name[1],
242 chrp_header->name[2],
243 chrp_header->name[3]);
244 }
245
246 exit:
247 return result;
248 }
249
250 static void
nvram_set_apple_header(uint8_t * buf,size_t len,uint32_t generation,int version)251 nvram_set_apple_header(uint8_t *buf, size_t len, uint32_t generation, int version)
252 {
253 if (version == kNVRAMVersion1 ||
254 version == kNVRAMVersion2) {
255 struct apple_nvram_header *apple_hdr = (struct apple_nvram_header *)buf;
256 generation += 1;
257 apple_hdr->generation = generation;
258 apple_hdr->adler = adler32_with_version(buf, len, version);
259 }
260 }
261
262 static NVRAMVersion
validateNVRAMVersion(const uint8_t * buf,size_t len,uint32_t * generation)263 validateNVRAMVersion(const uint8_t *buf, size_t len, uint32_t *generation)
264 {
265 NVRAMVersion version = kNVRAMVersionUnknown;
266
267 if (nvram_validate_header_v1v2(buf, generation, kNVRAMVersion1) == kIOReturnSuccess) {
268 version = kNVRAMVersion1;
269 goto exit;
270 }
271
272 if (nvram_validate_header_v1v2(buf, generation, kNVRAMVersion2) == kIOReturnSuccess) {
273 version = kNVRAMVersion2;
274 goto exit;
275 }
276
277 DEBUG_INFO("Unable to determine version\n");
278
279 exit:
280 DEBUG_INFO("version=%u\n", version);
281 return version;
282 }
283
~IONVRAMCHRPHandler()284 IONVRAMCHRPHandler::~IONVRAMCHRPHandler()
285 {
286 }
287
288 bool
isValidImage(const uint8_t * image,IOByteCount length)289 IONVRAMCHRPHandler::isValidImage(const uint8_t *image, IOByteCount length)
290 {
291 return validateNVRAMVersion(image, length, nullptr) != kNVRAMVersionUnknown;
292 }
293
294 IONVRAMCHRPHandler*
init(IODTNVRAM * provider,const uint8_t * image,IOByteCount length)295 IONVRAMCHRPHandler::init(IODTNVRAM *provider, const uint8_t *image, IOByteCount length)
296 {
297 bool propertiesOk;
298
299 IONVRAMCHRPHandler *handler = new IONVRAMCHRPHandler();
300
301 handler->_provider = provider;
302
303 handler->_variableLock = IORWLockAlloc();
304 require(handler->_variableLock != nullptr, exit);
305
306 handler->_controllerLock = IOLockAlloc();
307 require(handler->_controllerLock != nullptr, exit);
308
309 propertiesOk = handler->getNVRAMProperties();
310 require_action(propertiesOk, exit, DEBUG_ERROR("Unable to get NVRAM properties\n"));
311 require_action(length == handler->_bankSize, exit, DEBUG_ERROR("length 0x%llx != _bankSize 0x%x\n", length, handler->_bankSize));
312
313 if ((image != nullptr) && (length != 0)) {
314 if (handler->unserializeImage(image, length) != kIOReturnSuccess) {
315 DEBUG_ALWAYS("Unable to unserialize image, len=%#x\n", (unsigned int)length);
316 }
317 }
318
319 return handler;
320
321 exit:
322 delete handler;
323
324 return nullptr;
325 }
326
IONVRAMCHRPHandler()327 IONVRAMCHRPHandler::IONVRAMCHRPHandler() :
328 _commonPartitionSize(0x800)
329 {
330 }
331
332 IOReturn
flush(const uuid_t guid,IONVRAMOperation op)333 IONVRAMCHRPHandler::flush(const uuid_t guid, IONVRAMOperation op)
334 {
335 IOReturn ret = kIOReturnSuccess;
336 bool flushSystem;
337 bool flushCommon;
338
339 flushSystem = getSystemPartitionActive() && (uuid_compare(guid, gAppleSystemVariableGuid) == 0);
340 flushCommon = uuid_compare(guid, gAppleNVRAMGuid) == 0;
341
342 DEBUG_INFO("flushSystem=%d, flushCommon=%d\n", flushSystem, flushCommon);
343
344 NVRAMWRITELOCK(_variableLock);
345 if (flushSystem || flushCommon) {
346 const OSSymbol *canonicalKey;
347 OSSharedPtr<OSDictionary> dictCopy;
348 OSSharedPtr<OSCollectionIterator> iter;
349 uuid_string_t uuidString;
350
351 dictCopy = OSDictionary::withDictionary(_varDict.get());
352 iter = OSCollectionIterator::withCollection(dictCopy.get());
353 require_action(dictCopy && iter, exit, ret = kIOReturnNoMemory);
354
355 while ((canonicalKey = OSDynamicCast(OSSymbol, iter->getNextObject()))) {
356 const char *varName;
357 uuid_t varGuid;
358 bool clear;
359
360 parseVariableName(canonicalKey->getCStringNoCopy(), &varGuid, &varName);
361
362 uuid_unparse(varGuid, uuidString);
363
364 clear = ((flushSystem && (uuid_compare(varGuid, gAppleSystemVariableGuid) == 0)) ||
365 (flushCommon && (uuid_compare(varGuid, gAppleSystemVariableGuid) != 0))) &&
366 verifyPermission(op, varGuid, varName, getSystemPartitionActive(), true);
367
368 if (clear) {
369 DEBUG_INFO("Clearing entry for %s:%s\n", uuidString, varName);
370 setVariableInternal(varGuid, varName, nullptr);
371 } else {
372 DEBUG_INFO("Keeping entry for %s:%s\n", uuidString, varName);
373 }
374 }
375 }
376
377 exit:
378 NVRAMRWUNLOCK(_variableLock);
379 return ret;
380 }
381
382 IOReturn
reloadInternal(void)383 IONVRAMCHRPHandler::reloadInternal(void)
384 {
385 uint32_t controllerBank;
386 uint32_t controllerGen;
387
388 NVRAMLOCKASSERTHELD(_controllerLock);
389
390 controllerBank = findCurrentBank(&controllerGen);
391
392 if (_currentBank != controllerBank) {
393 DEBUG_ERROR("_currentBank 0x%x != controllerBank 0x%x\n", _currentBank, controllerBank);
394 }
395
396 if (_generation != controllerGen) {
397 DEBUG_ERROR("_generation 0x%x != controllerGen 0x%x\n", _generation, controllerGen);
398 }
399
400 _currentBank = controllerBank;
401 _generation = controllerGen;
402
403 return kIOReturnSuccess;
404 }
405
406 void
reload(void)407 IONVRAMCHRPHandler::reload(void)
408 {
409 _reload = true;
410
411 DEBUG_INFO("reload marked\n");
412 }
413
414 IOReturn
unserializeImage(const uint8_t * image,IOByteCount length)415 IONVRAMCHRPHandler::unserializeImage(const uint8_t *image, IOByteCount length)
416 {
417 IOReturn ret = kIOReturnInvalid;
418 uint32_t partitionOffset, partitionLength;
419 uint32_t currentLength, currentOffset = 0;
420 uint32_t hdr_adler, calculated_adler;
421
422 _commonPartitionOffset = 0xFFFFFFFF;
423 _systemPartitionOffset = 0xFFFFFFFF;
424
425 _version = validateNVRAMVersion(image, _bankSize, &_generation);
426 require(_version != kNVRAMVersionUnknown, exit);
427
428 if (_nvramImage) {
429 IOFreeData(_nvramImage, _bankSize);
430 }
431
432 _nvramImage = IONewData(uint8_t, length);
433 _bankSize = (uint32_t)length;
434 bcopy(image, _nvramImage, _bankSize);
435
436 hdr_adler = nvram_get_adler(_nvramImage, _version);
437 calculated_adler = adler32_with_version(_nvramImage, _bankSize, _version);
438
439 if (hdr_adler != calculated_adler) {
440 panic("header adler %#08X != calculated_adler %#08X\n", hdr_adler, calculated_adler);
441 }
442
443 // Look through the partitions to find the common and system partitions.
444 while (currentOffset < _bankSize) {
445 bool common_partition;
446 bool system_partition;
447 const chrp_nvram_header_t * header = (chrp_nvram_header_t *)(_nvramImage + currentOffset);
448 const uint8_t common_v1_name[sizeof(header->name)] = {NVRAM_CHRP_PARTITION_NAME_COMMON_V1};
449 const uint8_t common_v2_name[sizeof(header->name)] = {NVRAM_CHRP_PARTITION_NAME_COMMON_V2};
450 const uint8_t system_v1_name[sizeof(header->name)] = {NVRAM_CHRP_PARTITION_NAME_SYSTEM_V1};
451 const uint8_t system_v2_name[sizeof(header->name)] = {NVRAM_CHRP_PARTITION_NAME_SYSTEM_V2};
452
453 currentLength = header->len * NVRAM_CHRP_LENGTH_BLOCK_SIZE;
454
455 if (currentLength < sizeof(chrp_nvram_header_t)) {
456 break;
457 }
458
459 partitionOffset = currentOffset + sizeof(chrp_nvram_header_t);
460 partitionLength = currentLength - sizeof(chrp_nvram_header_t);
461
462 if ((partitionOffset + partitionLength) > _bankSize) {
463 break;
464 }
465
466 common_partition = (memcmp(header->name, common_v1_name, sizeof(header->name)) == 0) ||
467 (memcmp(header->name, common_v2_name, sizeof(header->name)) == 0);
468 system_partition = (memcmp(header->name, system_v1_name, sizeof(header->name)) == 0) ||
469 (memcmp(header->name, system_v2_name, sizeof(header->name)) == 0);
470
471 if (common_partition) {
472 _commonPartitionOffset = partitionOffset;
473 _commonPartitionSize = partitionLength;
474 } else if (system_partition) {
475 _systemPartitionOffset = partitionOffset;
476 _systemPartitionSize = partitionLength;
477 }
478 currentOffset += currentLength;
479 }
480
481 ret = kIOReturnSuccess;
482
483 exit:
484 _varDict = OSDictionary::withCapacity(1);
485
486 DEBUG_ALWAYS("NVRAM : commonPartitionOffset - %#x, commonPartitionSize - %#x, systemPartitionOffset - %#x, systemPartitionSize - %#x\n",
487 _commonPartitionOffset, _commonPartitionSize, _systemPartitionOffset, _systemPartitionSize);
488
489 return ret;
490 }
491
492 IOReturn
unserializeVariables(void)493 IONVRAMCHRPHandler::unserializeVariables(void)
494 {
495 uint32_t cnt, cntStart;
496 const uint8_t *propName, *propData;
497 uint32_t propNameLength, propDataLength, regionIndex;
498 OSSharedPtr<const OSSymbol> propSymbol;
499 OSSharedPtr<OSObject> propObject;
500 NVRAMRegionInfo *currentRegion;
501 NVRAMRegionInfo variableRegions[] = { { kIONVRAMPartitionCommon, _commonPartitionOffset, _commonPartitionSize},
502 { kIONVRAMPartitionSystem, _systemPartitionOffset, _systemPartitionSize} };
503
504 DEBUG_INFO("...\n");
505
506 for (regionIndex = 0; regionIndex < ARRAY_SIZE(variableRegions); regionIndex++) {
507 currentRegion = &variableRegions[regionIndex];
508 const uint8_t * imageData = _nvramImage + currentRegion->offset;
509
510 if (currentRegion->size == 0) {
511 continue;
512 }
513
514 DEBUG_INFO("region = %d\n", currentRegion->type);
515 cnt = 0;
516 while (cnt < currentRegion->size) {
517 cntStart = cnt;
518 // Break if there is no name.
519 if (imageData[cnt] == '\0') {
520 break;
521 }
522
523 // Find the length of the name.
524 propName = imageData + cnt;
525 for (propNameLength = 0; (cnt + propNameLength) < currentRegion->size;
526 propNameLength++) {
527 if (imageData[cnt + propNameLength] == '=') {
528 break;
529 }
530 }
531
532 // Break if the name goes past the end of the partition.
533 if ((cnt + propNameLength) >= currentRegion->size) {
534 break;
535 }
536 cnt += propNameLength + 1;
537
538 propData = imageData + cnt;
539 for (propDataLength = 0; (cnt + propDataLength) < currentRegion->size;
540 propDataLength++) {
541 if (imageData[cnt + propDataLength] == '\0') {
542 break;
543 }
544 }
545
546 // Break if the data goes past the end of the partition.
547 if ((cnt + propDataLength) >= currentRegion->size) {
548 break;
549 }
550 cnt += propDataLength + 1;
551
552 if (convertPropToObject(propName, propNameLength, propData, propDataLength, propSymbol, propObject)) {
553 OSSharedPtr<const OSSymbol> canonicalKey;
554 const char *varName = propSymbol.get()->getCStringNoCopy();
555 uint32_t variableLength = cnt - cntStart;
556
557 DEBUG_INFO("adding %s, variableLength=%#x,dataLength=%#x\n", varName, variableLength, propDataLength);
558
559 if (currentRegion->type == kIONVRAMPartitionCommon) {
560 canonicalKey = keyWithGuidAndCString(gAppleNVRAMGuid, varName);
561 } else if (currentRegion->type == kIONVRAMPartitionSystem) {
562 canonicalKey = keyWithGuidAndCString(gAppleSystemVariableGuid, varName);
563 }
564
565 DEBUG_INFO("adding %s, dataLength=%u\n", varName, propDataLength);
566 _varDict->setObject(canonicalKey.get(), propObject.get());
567 if (_provider->_diags) {
568 _provider->_diags->logVariable(currentRegion->type,
569 kIONVRAMOperationInit, varName,
570 (void *)(uintptr_t)(cnt - cntStart));
571 }
572
573 if (currentRegion->type == kIONVRAMPartitionSystem) {
574 _systemUsed += variableLength;
575 } else if (currentRegion->type == kIONVRAMPartitionCommon) {
576 _commonUsed += variableLength;
577 }
578 }
579 }
580 }
581
582 if (_provider->_diags) {
583 OSSharedPtr<OSNumber> val = OSNumber::withNumber(getSystemUsed(), 32);
584 _provider->_diags->setProperty(kNVRAMSystemUsedKey, val.get());
585 DEBUG_INFO("%s=%u\n", kNVRAMSystemUsedKey, getSystemUsed());
586
587 val = OSNumber::withNumber(getCommonUsed(), 32);
588 _provider->_diags->setProperty(kNVRAMCommonUsedKey, val.get());
589 DEBUG_INFO("%s=%u\n", kNVRAMCommonUsedKey, getCommonUsed());
590 }
591
592 // Create the boot-args property if it is not in the dictionary.
593 if (_provider->getProperty(kIONVRAMBootArgsKey) == nullptr) {
594 propSymbol = OSSymbol::withCString(kIONVRAMBootArgsKey);
595 propObject = OSString::withCStringNoCopy("");
596
597 _provider->setProperty(propSymbol.get(), propObject.get());
598 }
599
600 _newData = true;
601
602 DEBUG_INFO("%s _varDict=%p\n", __FUNCTION__, _varDict ? _varDict.get() : nullptr);
603
604 return kIOReturnSuccess;
605 }
606
607 IOReturn
serializeVariables(void)608 IONVRAMCHRPHandler::serializeVariables(void)
609 {
610 IOReturn ret;
611 bool ok = false;
612 uint32_t length, maxLength, regionIndex;
613 uint8_t *buffer, *tmpBuffer;
614 const OSSymbol *tmpSymbol;
615 OSObject *tmpObject;
616 OSSharedPtr<OSCollectionIterator> iter;
617 OSSharedPtr<OSNumber> generation;
618 uint8_t *nvramImage;
619 NVRAMRegionInfo *currentRegion;
620 NVRAMRegionInfo variableRegions[] = { { kIONVRAMPartitionCommon, _commonPartitionOffset, _commonPartitionSize},
621 { kIONVRAMPartitionSystem, _systemPartitionOffset, _systemPartitionSize} };
622 NVRAMLOCKASSERTHELD(_controllerLock);
623
624 require_action(_nvramController != nullptr, exit, (ret = kIOReturnNotReady, DEBUG_ERROR("No _nvramController\n")));
625 require_action(_newData == true, exit, (ret = kIOReturnSuccess, DEBUG_INFO("No _newData to sync\n")));
626 require_action(_bankSize != 0, exit, (ret = kIOReturnSuccess, DEBUG_INFO("No nvram size info\n")));
627 require_action(_nvramImage != nullptr, exit, (ret = kIOReturnSuccess, DEBUG_INFO("No nvram image info\n")));
628
629 nvramImage = IONewZeroData(uint8_t, _bankSize);
630 require_action(nvramImage != nullptr, exit, (ret = kIOReturnNoMemory, DEBUG_ERROR("Can't create NVRAM image copy\n")));
631
632 DEBUG_INFO("...\n");
633
634 bcopy(_nvramImage, nvramImage, _bankSize);
635
636 NVRAMREADLOCK(_variableLock);
637 for (regionIndex = 0; regionIndex < ARRAY_SIZE(variableRegions); regionIndex++) {
638 currentRegion = &variableRegions[regionIndex];
639
640 if (currentRegion->size == 0) {
641 continue;
642 }
643
644 DEBUG_INFO("region = %d\n", currentRegion->type);
645 buffer = tmpBuffer = nvramImage + currentRegion->offset;
646
647 bzero(buffer, currentRegion->size);
648
649 ok = true;
650 maxLength = currentRegion->size;
651
652 iter = OSCollectionIterator::withCollection(_varDict.get());
653 if (iter == nullptr) {
654 ok = false;
655 }
656
657 while (ok) {
658 uuid_t entryGuid;
659 const char *entryName;
660
661 tmpSymbol = OSDynamicCast(OSSymbol, iter->getNextObject());
662
663 if (tmpSymbol == nullptr) {
664 break;
665 }
666
667 DEBUG_INFO("_varDict entry %s\n", tmpSymbol->getCStringNoCopy());
668
669 parseVariableName(tmpSymbol, &entryGuid, &entryName);
670
671 if (getSystemPartitionActive()) {
672 if (currentRegion->type == kIONVRAMPartitionSystem) {
673 if (uuid_compare(entryGuid, gAppleSystemVariableGuid) != 0) {
674 DEBUG_INFO("Skipping %s because not system var\n", entryName);
675 continue;
676 }
677 } else if (currentRegion->type == kIONVRAMPartitionCommon) {
678 if (uuid_compare(entryGuid, gAppleSystemVariableGuid) == 0) {
679 DEBUG_INFO("Skipping %s for common region\n", entryName);
680 continue;
681 }
682 }
683 }
684
685 DEBUG_INFO("adding variable %s\n", entryName);
686
687 tmpObject = _varDict->getObject(tmpSymbol);
688
689 length = maxLength;
690 ok = convertObjectToProp(tmpBuffer, &length, entryName, tmpObject);
691 if (ok) {
692 tmpBuffer += length;
693 maxLength -= length;
694 }
695 }
696
697 if (!ok) {
698 ret = kIOReturnNoSpace;
699 IODeleteData(nvramImage, uint8_t, _bankSize);
700 break;
701 }
702
703 if (currentRegion->type == kIONVRAMPartitionSystem) {
704 _systemUsed = (uint32_t)(tmpBuffer - buffer);
705 } else if (currentRegion->type == kIONVRAMPartitionCommon) {
706 _commonUsed = (uint32_t)(tmpBuffer - buffer);
707 }
708 }
709 NVRAMRWUNLOCK(_variableLock);
710
711 DEBUG_INFO("ok=%d\n", ok);
712 require(ok, exit);
713
714 nvram_set_apple_header(nvramImage, _bankSize, ++_generation, _version);
715
716 _currentBank = (_currentBank + 1) % _bankCount;
717
718 ret = _nvramController->select(_currentBank);
719 DEBUG_IFERROR(ret, "_currentBank=%#x, select=%#x\n", _currentBank, ret);
720
721 ret = _nvramController->eraseBank();
722 DEBUG_IFERROR(ret, "eraseBank=%#x\n", ret);
723
724 ret = _nvramController->write(0, nvramImage, _bankSize);
725 DEBUG_IFERROR(ret, "write=%#x\n", ret);
726
727 _nvramController->sync();
728
729 if (_nvramImage) {
730 IODeleteData(_nvramImage, uint8_t, _bankSize);
731 }
732
733 _nvramImage = nvramImage;
734
735 _newData = false;
736
737 exit:
738 return ret;
739 }
740
741 IOReturn
setVariableInternal(const uuid_t varGuid,const char * variableName,OSObject * object)742 IONVRAMCHRPHandler::setVariableInternal(const uuid_t varGuid, const char *variableName, OSObject *object)
743 {
744 uint32_t newSize = 0;
745 uint32_t existingSize = 0;
746 bool remove = (object == nullptr);
747 OSObject *existing;
748 OSSharedPtr<const OSSymbol> canonicalKey;
749 bool systemVar;
750
751 // Anyone calling setVariableInternal should've already held the lock for write.
752 NVRAMRWLOCKASSERTEXCLUSIVE(_variableLock);
753
754 systemVar = (uuid_compare(varGuid, gAppleSystemVariableGuid) == 0);
755 canonicalKey = keyWithGuidAndCString(varGuid, variableName);
756
757 if ((existing = _varDict->getObject(canonicalKey.get()))) {
758 convertObjectToProp(nullptr, &existingSize, variableName, existing);
759 }
760
761 if (remove == false) {
762 convertObjectToProp(nullptr, &newSize, variableName, object);
763
764 DEBUG_INFO("setting %s, systemVar=%d, existingSize=%u, newSize=%u\n", canonicalKey.get()->getCStringNoCopy(), systemVar, existingSize, newSize);
765
766 if (systemVar) {
767 if ((newSize + _systemUsed - existingSize) > _systemPartitionSize) {
768 DEBUG_ERROR("No space left in system partition, need=%#x, _systemUsed=%#x, _systemPartitionSize=%#x\n",
769 newSize, _systemUsed, _systemPartitionSize);
770 return kIOReturnNoSpace;
771 } else {
772 _systemUsed = _systemUsed + newSize - existingSize;
773 }
774 } else {
775 if ((newSize + _commonUsed - existingSize) > _commonPartitionSize) {
776 DEBUG_ERROR("No space left in common partition, need=%#x, _commonUsed=%#x, _commonPartitionSize=%#x\n",
777 newSize, _commonUsed, _commonPartitionSize);
778 return kIOReturnNoSpace;
779 } else {
780 _commonUsed = _commonUsed + newSize - existingSize;
781 }
782 }
783
784 _varDict->setObject(canonicalKey.get(), object);
785
786 if (_provider->_diags) {
787 _provider->_diags->logVariable(getPartitionTypeForGUID(varGuid),
788 kIONVRAMOperationWrite, variableName,
789 (void *)(uintptr_t)newSize);
790 }
791 } else {
792 DEBUG_INFO("removing %s, systemVar=%d, existingSize=%u\n", canonicalKey.get()->getCStringNoCopy(), systemVar, existingSize);
793
794 if (systemVar) {
795 _systemUsed -= existingSize;
796 } else {
797 _commonUsed -= existingSize;
798 }
799
800 _varDict->removeObject(canonicalKey.get());
801
802 if (_provider->_diags) {
803 _provider->_diags->logVariable(getPartitionTypeForGUID(varGuid),
804 kIONVRAMOperationDelete, variableName,
805 nullptr);
806 }
807 }
808
809 if (_provider->_diags) {
810 OSSharedPtr<OSNumber> val = OSNumber::withNumber(getSystemUsed(), 32);
811 _provider->_diags->setProperty(kNVRAMSystemUsedKey, val.get());
812 DEBUG_INFO("%s=%u\n", kNVRAMSystemUsedKey, getSystemUsed());
813
814 val = OSNumber::withNumber(getCommonUsed(), 32);
815 _provider->_diags->setProperty(kNVRAMCommonUsedKey, val.get());
816 DEBUG_INFO("%s=%u\n", kNVRAMCommonUsedKey, getCommonUsed());
817 }
818
819 _newData = true;
820
821 return kIOReturnSuccess;
822 }
823
824 IOReturn
setVariable(const uuid_t varGuid,const char * variableName,OSObject * object)825 IONVRAMCHRPHandler::setVariable(const uuid_t varGuid, const char *variableName, OSObject *object)
826 {
827 uuid_t destGuid;
828 IOReturn ret = kIOReturnError;
829
830 if (getSystemPartitionActive()) {
831 // System region case, if they're using the GUID directly or it's on the system allow list
832 // force it to use the System GUID
833 if ((uuid_compare(varGuid, gAppleSystemVariableGuid) == 0) || variableInAllowList(variableName)) {
834 uuid_copy(destGuid, gAppleSystemVariableGuid);
835 } else {
836 uuid_copy(destGuid, varGuid);
837 }
838 } else {
839 // No system region, store System GUID as Common GUID
840 if ((uuid_compare(varGuid, gAppleSystemVariableGuid) == 0) || variableInAllowList(variableName)) {
841 uuid_copy(destGuid, gAppleNVRAMGuid);
842 } else {
843 uuid_copy(destGuid, varGuid);
844 }
845 }
846 NVRAMWRITELOCK(_variableLock);
847 ret = setVariableInternal(destGuid, variableName, object);
848 NVRAMRWUNLOCK(_variableLock);
849
850 return ret;
851 }
852
853 uint32_t
findCurrentBank(uint32_t * gen)854 IONVRAMCHRPHandler::findCurrentBank(uint32_t *gen)
855 {
856 struct apple_nvram_header storeHeader;
857 uint32_t maxGen = 0;
858 uint32_t currentBank = 0;
859
860 NVRAMLOCKASSERTHELD(_controllerLock);
861
862 for (unsigned int i = 0; i < _bankCount; i++) {
863 NVRAMVersion bankVer;
864 uint32_t bankGen = 0;
865
866 _nvramController->select(i);
867 _nvramController->read(0, (uint8_t *)&storeHeader, sizeof(storeHeader));
868 bankVer = validateNVRAMVersion((uint8_t *)&storeHeader, sizeof(storeHeader), &bankGen);
869
870 if ((bankVer != kNVRAMVersionUnknown) && (bankGen >= maxGen)) {
871 currentBank = i;
872 maxGen = bankGen;
873 }
874 }
875
876 DEBUG_ALWAYS("currentBank=%#x, gen=%#x\n", currentBank, maxGen);
877
878 *gen = maxGen;
879 return currentBank;
880 }
881
882 bool
setController(IONVRAMController * controller)883 IONVRAMCHRPHandler::setController(IONVRAMController *controller)
884 {
885 IOReturn ret;
886
887 NVRAMLOCK(_controllerLock);
888
889 if (_nvramController == NULL) {
890 _nvramController = controller;
891 }
892
893 DEBUG_INFO("Controller name: %s\n", _nvramController->getName());
894
895 ret = reloadInternal();
896 if (ret != kIOReturnSuccess) {
897 DEBUG_ERROR("reloadInternal failed, ret=0x%08x\n", ret);
898 }
899
900 NVRAMUNLOCK(_controllerLock);
901
902 return true;
903 }
904
905 IOReturn
sync(void)906 IONVRAMCHRPHandler::sync(void)
907 {
908 IOReturn ret;
909
910 NVRAMLOCK(_controllerLock);
911
912 if (_reload) {
913 ret = reloadInternal();
914 require_noerr_action(ret, exit, DEBUG_ERROR("Reload failed, ret=%#x", ret));
915
916 _reload = false;
917 }
918
919 ret = serializeVariables();
920 require_noerr_action(ret, exit, DEBUG_ERROR("serializeVariables failed, ret=%#x", ret));
921
922 exit:
923 NVRAMUNLOCK(_controllerLock);
924 return ret;
925 }
926
927 uint32_t
getGeneration(void) const928 IONVRAMCHRPHandler::getGeneration(void) const
929 {
930 return _generation;
931 }
932
933 uint32_t
getVersion(void) const934 IONVRAMCHRPHandler::getVersion(void) const
935 {
936 return _version;
937 }
938
939 uint32_t
getSystemUsed(void) const940 IONVRAMCHRPHandler::getSystemUsed(void) const
941 {
942 return _systemUsed;
943 }
944
945 uint32_t
getCommonUsed(void) const946 IONVRAMCHRPHandler::getCommonUsed(void) const
947 {
948 return _commonUsed;
949 }
950
951 bool
getSystemPartitionActive(void) const952 IONVRAMCHRPHandler::getSystemPartitionActive(void) const
953 {
954 return _systemPartitionSize != 0;
955 }
956
957 OSSharedPtr<OSData>
unescapeBytesToData(const uint8_t * bytes,uint32_t length)958 IONVRAMCHRPHandler::unescapeBytesToData(const uint8_t *bytes, uint32_t length)
959 {
960 OSSharedPtr<OSData> data;
961 uint32_t totalLength = 0;
962 uint32_t offset, offset2;
963 uint8_t byte;
964 bool ok;
965
966 // Calculate the actual length of the data.
967 ok = true;
968 totalLength = 0;
969 for (offset = 0; offset < length;) {
970 byte = bytes[offset++];
971 if (byte == 0xFF) {
972 byte = bytes[offset++];
973 if (byte == 0x00) {
974 ok = false;
975 break;
976 }
977 offset2 = byte & 0x7F;
978 } else {
979 offset2 = 1;
980 }
981 totalLength += offset2;
982 }
983
984 if (ok) {
985 // Create an empty OSData of the correct size.
986 data = OSData::withCapacity(totalLength);
987 if (data != nullptr) {
988 for (offset = 0; offset < length;) {
989 byte = bytes[offset++];
990 if (byte == 0xFF) {
991 byte = bytes[offset++];
992 offset2 = byte & 0x7F;
993 byte = (byte & 0x80) ? 0xFF : 0x00;
994 } else {
995 offset2 = 1;
996 }
997 data->appendByte(byte, offset2);
998 }
999 }
1000 }
1001
1002 return data;
1003 }
1004
1005 OSSharedPtr<OSData>
escapeDataToData(OSData * value)1006 IONVRAMCHRPHandler::escapeDataToData(OSData * value)
1007 {
1008 OSSharedPtr<OSData> result;
1009 OSBoundedPtr<const uint8_t> startPtr;
1010 const uint8_t *endPtr;
1011 const uint8_t *valueBytesPtr;
1012 OSBoundedPtr<const uint8_t> wherePtr;
1013 uint8_t byte;
1014 bool ok = true;
1015
1016 valueBytesPtr = (const uint8_t *) value->getBytesNoCopy();
1017 endPtr = valueBytesPtr + value->getLength();
1018 wherePtr = OSBoundedPtr<const uint8_t>(valueBytesPtr, valueBytesPtr, endPtr);
1019
1020 result = OSData::withCapacity((unsigned int)(endPtr - wherePtr));
1021 if (!result) {
1022 return result;
1023 }
1024
1025 while (wherePtr < endPtr) {
1026 startPtr = wherePtr;
1027 byte = *wherePtr++;
1028 if ((byte == 0x00) || (byte == 0xFF)) {
1029 for (;
1030 ((wherePtr - startPtr) < 0x7F) && (wherePtr < endPtr) && (byte == *wherePtr);
1031 wherePtr++) {
1032 }
1033 ok &= result->appendByte(0xff, 1);
1034 byte = (byte & 0x80) | ((uint8_t)(wherePtr - startPtr));
1035 }
1036 ok &= result->appendByte(byte, 1);
1037 }
1038 ok &= result->appendByte(0, 1);
1039
1040 if (!ok) {
1041 result.reset();
1042 }
1043
1044 return result;
1045 }
1046
1047 bool
convertPropToObject(const uint8_t * propName,uint32_t propNameLength,const uint8_t * propData,uint32_t propDataLength,const OSSymbol ** propSymbol,OSObject ** propObject)1048 IONVRAMCHRPHandler::convertPropToObject(const uint8_t *propName, uint32_t propNameLength,
1049 const uint8_t *propData, uint32_t propDataLength,
1050 const OSSymbol **propSymbol,
1051 OSObject **propObject)
1052 {
1053 OSSharedPtr<const OSString> delimitedName;
1054 OSSharedPtr<const OSSymbol> tmpSymbol;
1055 OSSharedPtr<OSNumber> tmpNumber;
1056 OSSharedPtr<OSString> tmpString;
1057 OSSharedPtr<OSObject> tmpObject = nullptr;
1058
1059 delimitedName = OSString::withCString((const char *)propName, propNameLength);
1060 tmpSymbol = OSSymbol::withString(delimitedName.get());
1061
1062 if (tmpSymbol == nullptr) {
1063 return false;
1064 }
1065
1066 switch (getVariableType(tmpSymbol.get())) {
1067 case kOFVariableTypeBoolean:
1068 if (!strncmp("true", (const char *)propData, propDataLength)) {
1069 tmpObject.reset(kOSBooleanTrue, OSRetain);
1070 } else if (!strncmp("false", (const char *)propData, propDataLength)) {
1071 tmpObject.reset(kOSBooleanFalse, OSRetain);
1072 }
1073 break;
1074
1075 case kOFVariableTypeNumber:
1076 tmpNumber = OSNumber::withNumber(strtol((const char *)propData, nullptr, 0), 32);
1077 if (tmpNumber != nullptr) {
1078 tmpObject = tmpNumber;
1079 }
1080 break;
1081
1082 case kOFVariableTypeString:
1083 tmpString = OSString::withCString((const char *)propData, propDataLength);
1084 if (tmpString != nullptr) {
1085 tmpObject = tmpString;
1086 }
1087 break;
1088
1089 case kOFVariableTypeData:
1090 tmpObject = unescapeBytesToData(propData, propDataLength);
1091 break;
1092
1093 default:
1094 break;
1095 }
1096
1097 if (tmpObject == nullptr) {
1098 tmpSymbol.reset();
1099 return false;
1100 }
1101
1102 *propSymbol = tmpSymbol.detach();
1103 *propObject = tmpObject.detach();
1104
1105 return true;
1106 }
1107
1108 bool
convertPropToObject(const uint8_t * propName,uint32_t propNameLength,const uint8_t * propData,uint32_t propDataLength,OSSharedPtr<const OSSymbol> & propSymbol,OSSharedPtr<OSObject> & propObject)1109 IONVRAMCHRPHandler::convertPropToObject(const uint8_t *propName, uint32_t propNameLength,
1110 const uint8_t *propData, uint32_t propDataLength,
1111 OSSharedPtr<const OSSymbol>& propSymbol,
1112 OSSharedPtr<OSObject>& propObject)
1113 {
1114 const OSSymbol* propSymbolRaw = nullptr;
1115 OSObject* propObjectRaw = nullptr;
1116
1117 bool ok = convertPropToObject(propName, propNameLength, propData, propDataLength,
1118 &propSymbolRaw, &propObjectRaw);
1119
1120 propSymbol.reset(propSymbolRaw, OSNoRetain);
1121 propObject.reset(propObjectRaw, OSNoRetain);
1122
1123 return ok;
1124 }
1125
1126 bool
convertObjectToProp(uint8_t * buffer,uint32_t * length,const OSSymbol * propSymbol,OSObject * propObject)1127 IONVRAMCHRPHandler::convertObjectToProp(uint8_t *buffer, uint32_t *length,
1128 const OSSymbol *propSymbol, OSObject *propObject)
1129 {
1130 return convertObjectToProp(buffer, length, propSymbol->getCStringNoCopy(), propObject);
1131 }
1132
1133 bool
convertObjectToProp(uint8_t * buffer,uint32_t * length,const char * propName,OSObject * propObject)1134 IONVRAMCHRPHandler::convertObjectToProp(uint8_t *buffer, uint32_t *length,
1135 const char *propName, OSObject *propObject)
1136 {
1137 uint32_t propNameLength, propDataLength, remaining, offset;
1138 IONVRAMVariableType propType;
1139 OSBoolean *tmpBoolean = nullptr;
1140 OSNumber *tmpNumber = nullptr;
1141 OSString *tmpString = nullptr;
1142 OSSharedPtr<OSData> tmpData;
1143
1144 propNameLength = (uint32_t)strlen(propName);
1145 propType = getVariableType(propName);
1146 offset = 0;
1147 remaining = 0;
1148
1149 // Get the size of the data.
1150 propDataLength = 0xFFFFFFFF;
1151 switch (propType) {
1152 case kOFVariableTypeBoolean:
1153 tmpBoolean = OSDynamicCast(OSBoolean, propObject);
1154 if (tmpBoolean != nullptr) {
1155 propDataLength = 5;
1156 }
1157 break;
1158
1159 case kOFVariableTypeNumber:
1160 tmpNumber = OSDynamicCast(OSNumber, propObject);
1161 if (tmpNumber != nullptr) {
1162 propDataLength = 10;
1163 }
1164 break;
1165
1166 case kOFVariableTypeString:
1167 tmpString = OSDynamicCast(OSString, propObject);
1168 if (tmpString != nullptr) {
1169 propDataLength = tmpString->getLength();
1170 }
1171 break;
1172
1173 case kOFVariableTypeData:
1174 tmpData.reset(OSDynamicCast(OSData, propObject), OSNoRetain);
1175 if (tmpData != nullptr) {
1176 tmpData = escapeDataToData(tmpData.detach());
1177 // escapeDataToData() adds the NULL byte to the data
1178 // subtract 1 here to keep offset consistent with the other cases
1179 propDataLength = tmpData->getLength() - 1;
1180 }
1181 break;
1182
1183 default:
1184 break;
1185 }
1186
1187 // Make sure the propertySize is known and will fit.
1188 if (propDataLength == 0xFFFFFFFF) {
1189 return false;
1190 }
1191
1192 if (buffer) {
1193 // name + '=' + data + '\0'
1194 if ((propNameLength + propDataLength + 2) > *length) {
1195 return false;
1196 }
1197
1198 remaining = *length;
1199 }
1200
1201 *length = 0;
1202
1203 // Copy the property name equal sign.
1204 offset += snprintf((char *)buffer, remaining, "%s=", propName);
1205 if (buffer) {
1206 if (remaining > offset) {
1207 buffer += offset;
1208 remaining = remaining - offset;
1209 } else {
1210 return false;
1211 }
1212 }
1213
1214 switch (propType) {
1215 case kOFVariableTypeBoolean:
1216 if (tmpBoolean->getValue()) {
1217 offset += strlcpy((char *)buffer, "true", remaining);
1218 } else {
1219 offset += strlcpy((char *)buffer, "false", remaining);
1220 }
1221 break;
1222
1223 case kOFVariableTypeNumber:
1224 {
1225 uint32_t tmpValue = tmpNumber->unsigned32BitValue();
1226 if (tmpValue == 0xFFFFFFFF) {
1227 offset += strlcpy((char *)buffer, "-1", remaining);
1228 } else if (tmpValue < 1000) {
1229 offset += snprintf((char *)buffer, remaining, "%d", (uint32_t)tmpValue);
1230 } else {
1231 offset += snprintf((char *)buffer, remaining, "%#x", (uint32_t)tmpValue);
1232 }
1233 }
1234 break;
1235
1236 case kOFVariableTypeString:
1237 offset += strlcpy((char *)buffer, tmpString->getCStringNoCopy(), remaining);
1238 break;
1239
1240 case kOFVariableTypeData:
1241 if (buffer) {
1242 bcopy(tmpData->getBytesNoCopy(), buffer, propDataLength);
1243 }
1244 tmpData.reset();
1245 offset += propDataLength;
1246 break;
1247
1248 default:
1249 break;
1250 }
1251
1252 *length = offset + 1;
1253
1254 return true;
1255 }
1256
1257 IOReturn
getVarDict(OSSharedPtr<OSDictionary> & varDictCopy)1258 IONVRAMCHRPHandler::getVarDict(OSSharedPtr<OSDictionary> &varDictCopy)
1259 {
1260 IOReturn ret = kIOReturnNotFound;
1261
1262 NVRAMREADLOCK(_variableLock);
1263 if (_varDict) {
1264 varDictCopy = OSDictionary::withDictionary(_varDict.get());
1265 if (varDictCopy) {
1266 if (OSDictionary::withCapacity(varDictCopy->getCount()) != nullptr) {
1267 ret = kIOReturnSuccess;
1268 }
1269 }
1270 }
1271 NVRAMRWUNLOCK(_variableLock);
1272
1273 return ret;
1274 }
1275