blob: f33c0110cfd58eb4494fe39b41a4dda3ef91f29d [file] [log] [blame]
Gilad Arnoldd7b513d2012-05-10 14:25:27 -07001// Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
adlr@google.com3defe6a2009-12-04 20:57:17 +00002// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
Gilad Arnoldcf175a02014-07-10 16:48:47 -07005#ifndef UPDATE_ENGINE_UTILS_H_
6#define UPDATE_ENGINE_UTILS_H_
adlr@google.com3defe6a2009-12-04 20:57:17 +00007
Han Shen2643cb72012-06-26 14:45:33 -07008#include <errno.h>
Alex Vakulenkod2779df2014-06-16 13:19:00 -07009#include <unistd.h>
10
11#include <algorithm>
12#include <map>
Ben Chan02f7c1d2014-10-18 15:18:02 -070013#include <memory>
adlr@google.com3defe6a2009-12-04 20:57:17 +000014#include <set>
15#include <string>
16#include <vector>
Darin Petkovc6c135c2010-08-11 13:36:18 -070017
Alex Vakulenko75039d72014-03-25 12:36:28 -070018#include <base/files/file_path.h>
Chris Sosafc661a12013-02-26 14:43:21 -080019#include <base/posix/eintr_wrapper.h>
Alex Vakulenko75039d72014-03-25 12:36:28 -070020#include <base/time/time.h>
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -080021#include <chromeos/secure_blob.h>
Andrew de los Reyesc7020782010-04-28 10:46:04 -070022#include <glib.h>
Jay Srinivasanf0572052012-10-23 18:12:56 -070023#include "metrics/metrics_library.h"
Darin Petkovc6c135c2010-08-11 13:36:18 -070024
adlr@google.com3defe6a2009-12-04 20:57:17 +000025#include "update_engine/action.h"
David Zeuthenb281f072014-04-02 10:20:19 -070026#include "update_engine/action_processor.h"
27#include "update_engine/connection_manager.h"
Jay Srinivasan19409b72013-04-12 19:23:36 -070028#include "update_engine/constants.h"
Nam T. Nguyenf1d582e2014-12-08 15:07:17 -080029#include "update_engine/file_descriptor.h"
David Zeuthen33bae492014-02-25 16:16:18 -080030#include "update_engine/metrics.h"
Allie Wood56873452015-03-27 17:48:40 -070031#include "update_engine/update_metadata.pb.h"
adlr@google.com3defe6a2009-12-04 20:57:17 +000032
33namespace chromeos_update_engine {
34
Jay Srinivasan55f50c22013-01-10 19:24:35 -080035class SystemState;
36
adlr@google.com3defe6a2009-12-04 20:57:17 +000037namespace utils {
38
David Zeuthen27a48bc2013-08-06 12:06:29 -070039// Converts a struct timespec representing a number of seconds since
40// the Unix epoch to a base::Time. Sub-microsecond time is rounded
41// down.
42base::Time TimeFromStructTimespec(struct timespec *ts);
43
Alex Vakulenko88b591f2014-08-28 16:48:57 -070044// Converts a vector of strings to a NUL-terminated array of
David Zeuthen27a48bc2013-08-06 12:06:29 -070045// strings. The resulting array should be freed with g_strfreev()
46// when are you done with it.
Alex Deymof329b932014-10-30 01:37:48 -070047gchar** StringVectorToGStrv(const std::vector<std::string> &vec_str);
David Zeuthen27a48bc2013-08-06 12:06:29 -070048
Alex Deymof329b932014-10-30 01:37:48 -070049// Formats |vec_str| as a string of the form ["<elem1>", "<elem2>"].
David Zeuthen27a48bc2013-08-06 12:06:29 -070050// Does no escaping, only use this for presentation in error messages.
Alex Deymof329b932014-10-30 01:37:48 -070051std::string StringVectorToString(const std::vector<std::string> &vec_str);
David Zeuthen27a48bc2013-08-06 12:06:29 -070052
David Zeuthen8f191b22013-08-06 12:27:50 -070053// Calculates the p2p file id from payload hash and size
54std::string CalculateP2PFileId(const std::string& payload_hash,
55 size_t payload_size);
56
J. Richard Barnette63137e52013-10-28 10:57:29 -070057// Parse the firmware version from one line of output from the
58// "mosys" command.
59std::string ParseECVersion(std::string input_line);
60
J. Richard Barnette30842932013-10-28 15:04:23 -070061// Given the name of the block device of a boot partition, return the
62// name of the associated kernel partition (e.g. given "/dev/sda3",
63// return "/dev/sda2").
64const std::string KernelDeviceOfBootDevice(const std::string& boot_device);
65
Andrew de los Reyes970bb282009-12-09 16:34:04 -080066// Writes the data passed to path. The file at path will be overwritten if it
67// exists. Returns true on success, false otherwise.
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -080068bool WriteFile(const char* path, const void* data, int data_len);
Andrew de los Reyes970bb282009-12-09 16:34:04 -080069
Andrew de los Reyes09e56d62010-04-23 13:45:53 -070070// Calls write() or pwrite() repeatedly until all count bytes at buf are
71// written to fd or an error occurs. Returns true on success.
72bool WriteAll(int fd, const void* buf, size_t count);
73bool PWriteAll(int fd, const void* buf, size_t count, off_t offset);
74
Nam T. Nguyenf1d582e2014-12-08 15:07:17 -080075bool WriteAll(FileDescriptorPtr fd, const void* buf, size_t count);
76bool PWriteAll(FileDescriptorPtr fd,
77 const void* buf,
78 size_t count,
79 off_t offset);
80
Andrew de los Reyes09e56d62010-04-23 13:45:53 -070081// Calls pread() repeatedly until count bytes are read, or EOF is reached.
82// Returns number of bytes read in *bytes_read. Returns true on success.
83bool PReadAll(int fd, void* buf, size_t count, off_t offset,
84 ssize_t* out_bytes_read);
Andrew de los Reyesb10320d2010-03-31 16:44:44 -070085
Nam T. Nguyenf1d582e2014-12-08 15:07:17 -080086bool PReadAll(FileDescriptorPtr fd, void* buf, size_t count, off_t offset,
87 ssize_t* out_bytes_read);
88
Gilad Arnold19a45f02012-07-19 12:36:10 -070089// Opens |path| for reading and appends its entire content to the container
90// pointed to by |out_p|. Returns true upon successfully reading all of the
91// file's content, false otherwise, in which case the state of the output
Darin Petkov8e447e02013-04-16 16:23:50 +020092// container is unknown. ReadFileChunk starts reading the file from |offset|; if
93// |size| is not -1, only up to |size| bytes are read in.
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -080094bool ReadFile(const std::string& path, chromeos::Blob* out_p);
Gilad Arnold19a45f02012-07-19 12:36:10 -070095bool ReadFile(const std::string& path, std::string* out_p);
Darin Petkov8e447e02013-04-16 16:23:50 +020096bool ReadFileChunk(const std::string& path, off_t offset, off_t size,
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -080097 chromeos::Blob* out_p);
Gilad Arnold19a45f02012-07-19 12:36:10 -070098
99// Invokes |cmd| in a pipe and appends its stdout to the container pointed to by
100// |out_p|. Returns true upon successfully reading all of the output, false
101// otherwise, in which case the state of the output container is unknown.
Gilad Arnold19a45f02012-07-19 12:36:10 -0700102bool ReadPipe(const std::string& cmd, std::string* out_p);
adlr@google.com3defe6a2009-12-04 20:57:17 +0000103
Gabe Blackb92cd2e2014-09-08 02:47:41 -0700104// Returns the size of the block device at path, or the file descriptor fd. If
105// an error occurs, -1 is returned.
106off_t BlockDevSize(const std::string& path);
107off_t BlockDevSize(int fd);
108
109// Returns the size of the file at path, or the file desciptor fd. If the file
110// is actually a block device, this function will automatically call
111// BlockDevSize. If the file doesn't exist or some error occurrs, -1 is
112// returned.
Andrew de los Reyesf4c7ef12010-04-30 10:37:00 -0700113off_t FileSize(const std::string& path);
Gabe Blackb92cd2e2014-09-08 02:47:41 -0700114off_t FileSize(int fd);
Andrew de los Reyesf4c7ef12010-04-30 10:37:00 -0700115
adlr@google.com3defe6a2009-12-04 20:57:17 +0000116std::string ErrnoNumberAsString(int err);
117
adlr@google.com3defe6a2009-12-04 20:57:17 +0000118// Returns true if the file exists for sure. Returns false if it doesn't exist,
119// or an error occurs.
120bool FileExists(const char* path);
121
Darin Petkov30291ed2010-11-12 10:23:06 -0800122// Returns true if |path| exists and is a symbolic link.
123bool IsSymlink(const char* path);
124
Nam T. Nguyena78b28c2015-03-06 22:30:12 -0800125// Try attaching UBI |volume_num|. If there is any error executing required
126// commands to attach the volume, this function returns false. This function
127// only returns true if "/dev/ubi%d_0" becomes available in |timeout| seconds.
128bool TryAttachingUbiVolume(int volume_num, int timeout);
129
Gilad Arnoldd04f8e22014-01-09 13:13:40 -0800130// If |base_filename_template| is neither absolute (starts with "/") nor
131// explicitly relative to the current working directory (starts with "./" or
132// "../"), then it is prepended the value of TMPDIR, which defaults to /tmp if
133// it isn't set or is empty. It then calls mkstemp(3) with the resulting
134// template. Writes the name of a new temporary file to |filename|. If |fd| is
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700135// non-null, the file descriptor returned by mkstemp is written to it and
136// kept open; otherwise, it is closed. The template must end with "XXXXXX".
137// Returns true on success.
Gilad Arnoldd04f8e22014-01-09 13:13:40 -0800138bool MakeTempFile(const std::string& base_filename_template,
Andrew de los Reyesb10320d2010-03-31 16:44:44 -0700139 std::string* filename,
140 int* fd);
141
Gilad Arnoldd04f8e22014-01-09 13:13:40 -0800142// If |base_filename_template| is neither absolute (starts with "/") nor
143// explicitly relative to the current working directory (starts with "./" or
144// "../"), then it is prepended the value of TMPDIR, which defaults to /tmp if
145// it isn't set or is empty. It then calls mkdtemp() with the resulting
146// template. Writes the name of the new temporary directory to |dirname|.
147// The template must end with "XXXXXX". Returns true on success.
148bool MakeTempDirectory(const std::string& base_dirname_template,
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700149 std::string* dirname);
150
Alex Vakulenko4f5b1442014-02-21 12:19:44 -0800151// Returns the disk device name for a partition. For example,
152// GetDiskName("/dev/sda3") returns "/dev/sda". Returns an empty string
153// if the input device is not of the "/dev/xyz#" form.
154std::string GetDiskName(const std::string& partition_name);
Andrew de los Reyesf9714432010-05-04 10:21:23 -0700155
Alex Vakulenko4f5b1442014-02-21 12:19:44 -0800156// Returns the partition number, of partition device name. For example,
157// GetPartitionNumber("/dev/sda3") returns 3.
158// Returns 0 on failure
159int GetPartitionNumber(const std::string& partition_name);
160
161// Splits the partition device name into the block device name and partition
162// number. For example, "/dev/sda3" will be split into {"/dev/sda", 3} and
163// "/dev/mmcblk0p2" into {"/dev/mmcblk0", 2}
164// Returns false when malformed device name is passed in.
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700165// If both output parameters are omitted (null), can be used
Alex Vakulenko4f5b1442014-02-21 12:19:44 -0800166// just to test the validity of the device name. Note that the function
167// simply checks if the device name looks like a valid device, no other
168// checks are performed (i.e. it doesn't check if the device actually exists).
169bool SplitPartitionName(const std::string& partition_name,
170 std::string* out_disk_name,
171 int* out_partition_num);
172
173// Builds a partition device name from the block device name and partition
174// number. For example:
175// {"/dev/sda", 1} => "/dev/sda1"
176// {"/dev/mmcblk2", 12} => "/dev/mmcblk2p12"
177// Returns empty string when invalid parameters are passed in
178std::string MakePartitionName(const std::string& disk_name,
179 int partition_num);
Andrew de los Reyesf9714432010-05-04 10:21:23 -0700180
Nam T. Nguyena78b28c2015-03-06 22:30:12 -0800181// Similar to "MakePartitionName" but returns a name that is suitable for
182// mounting. On NAND system we can write to "/dev/ubiX_0", which is what
183// MakePartitionName returns, but we cannot mount that device. To mount, we
184// have to use "/dev/ubiblockX_0" for rootfs. Stateful and OEM partitions are
185// mountable with "/dev/ubiX_0". The input is a partition device such as
186// /dev/sda3. Return empty string on error.
187std::string MakePartitionNameForMount(const std::string& part_name);
188
Darin Petkovf74eb652010-08-04 12:08:38 -0700189// Returns the sysfs block device for a root block device. For
190// example, SysfsBlockDevice("/dev/sda") returns
191// "/sys/block/sda". Returns an empty string if the input device is
192// not of the "/dev/xyz" form.
193std::string SysfsBlockDevice(const std::string& device);
194
195// Returns true if the root |device| (e.g., "/dev/sdb") is known to be
196// removable, false otherwise.
197bool IsRemovableDevice(const std::string& device);
198
adlr@google.com3defe6a2009-12-04 20:57:17 +0000199// Synchronously mount or unmount a filesystem. Return true on success.
Alex Deymo4c82df32014-11-10 22:25:57 -0800200// When mounting, it will attempt to mount the the device as "ext3", "ext2" and
201// "squashfs", with the passed |flags| options.
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700202bool MountFilesystem(const std::string& device, const std::string& mountpoint,
Alex Vakulenkod2779df2014-06-16 13:19:00 -0700203 unsigned long flags); // NOLINT(runtime/int)
Andrew de los Reyes4fe15d02009-12-10 19:01:36 -0800204bool UnmountFilesystem(const std::string& mountpoint);
adlr@google.com3defe6a2009-12-04 20:57:17 +0000205
Alex Deymo192393b2014-11-10 15:58:38 -0800206// Returns the block count and the block byte size of the file system on
Darin Petkovd3f8c892010-10-12 21:38:45 -0700207// |device| (which may be a real device or a path to a filesystem image) or on
208// an opened file descriptor |fd|. The actual file-system size is |block_count|
209// * |block_size| bytes. Returns true on success, false otherwise.
210bool GetFilesystemSize(const std::string& device,
211 int* out_block_count,
212 int* out_block_size);
213bool GetFilesystemSizeFromFD(int fd,
214 int* out_block_count,
215 int* out_block_size);
216
Alex Deymo192393b2014-11-10 15:58:38 -0800217// Determines the block count and block size of the ext3 fs. At least 2048 bytes
218// are required to parse the first superblock. Returns whether the buffer
219// contains a valid ext3 filesystem and the values were parsed.
220bool GetExt3Size(const uint8_t* buffer, size_t buffer_size,
221 int* out_block_count,
222 int* out_block_size);
223
224// Determines the block count and block size of the squashfs v4 fs. At least 96
225// bytes are required to parse the header of the filesystem. Since squashfs
226// doesn't define a physical block size, a value of 4096 is used for the block
227// size, which is the default padding when creating the filesystem.
228// Returns whether the buffer contains a valid squashfs v4 header and the size
229// was parsed. Only little endian squashfs is supported.
230bool GetSquashfs4Size(const uint8_t* buffer, size_t buffer_size,
231 int* out_block_count,
232 int* out_block_size);
233
Alex Deymode942f32015-03-13 11:57:15 -0700234// Returns whether the filesystem is an ext[234] filesystem. In case of failure,
235// such as if the file |device| doesn't exists or can't be read, it returns
236// false.
237bool IsExtFilesystem(const std::string& device);
238
239// Returns whether the filesystem is a squashfs filesystem. In case of failure,
240// such as if the file |device| doesn't exists or can't be read, it returns
241// false.
242bool IsSquashfsFilesystem(const std::string& device);
243
Alex Deymo032e7722014-03-25 17:53:56 -0700244// Returns a human-readable string with the file format based on magic constants
245// on the header of the file.
246std::string GetFileFormat(const std::string& path);
247
Jay Srinivasan480ddfa2012-06-01 19:15:26 -0700248// Returns the string representation of the given UTC time.
249// such as "11/14/2011 14:05:30 GMT".
250std::string ToString(const base::Time utc_time);
251
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700252// Returns true or false depending on the value of b.
253std::string ToString(bool b);
254
Jay Srinivasan19409b72013-04-12 19:23:36 -0700255// Returns a string representation of the given enum.
256std::string ToString(DownloadSource source);
257
Alex Deymo1c656c42013-06-28 11:02:14 -0700258// Returns a string representation of the given enum.
259std::string ToString(PayloadType payload_type);
260
Andrew de los Reyes712b3ac2011-01-07 13:47:52 -0800261// Schedules a Main Loop callback to trigger the crash reporter to perform an
262// upload as if this process had crashed.
263void ScheduleCrashReporterUpload();
264
Darin Petkov5c0a8af2010-08-24 13:39:13 -0700265// Fuzzes an integer |value| randomly in the range:
266// [value - range / 2, value + range - range / 2]
267int FuzzInt(int value, unsigned int range);
268
adlr@google.com3defe6a2009-12-04 20:57:17 +0000269// Log a string in hex to LOG(INFO). Useful for debugging.
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -0800270void HexDumpArray(const uint8_t* const arr, const size_t length);
adlr@google.com3defe6a2009-12-04 20:57:17 +0000271inline void HexDumpString(const std::string& str) {
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -0800272 HexDumpArray(reinterpret_cast<const uint8_t*>(str.data()), str.size());
adlr@google.com3defe6a2009-12-04 20:57:17 +0000273}
Alex Vakulenkof68bbbc2015-02-09 12:53:18 -0800274inline void HexDumpVector(const chromeos::Blob& vect) {
275 HexDumpArray(vect.data(), vect.size());
adlr@google.com3defe6a2009-12-04 20:57:17 +0000276}
277
adlr@google.com3defe6a2009-12-04 20:57:17 +0000278template<typename KeyType, typename ValueType>
279bool MapContainsKey(const std::map<KeyType, ValueType>& m, const KeyType& k) {
280 return m.find(k) != m.end();
281}
Andrew de los Reyes4fe15d02009-12-10 19:01:36 -0800282template<typename KeyType>
283bool SetContainsKey(const std::set<KeyType>& s, const KeyType& k) {
284 return s.find(k) != s.end();
285}
adlr@google.com3defe6a2009-12-04 20:57:17 +0000286
Andrew de los Reyes0ce161b2010-02-22 15:27:01 -0800287template<typename T>
288bool VectorContainsValue(const std::vector<T>& vect, const T& value) {
Darin Petkovc1a8b422010-07-19 11:34:49 -0700289 return std::find(vect.begin(), vect.end(), value) != vect.end();
Andrew de los Reyes0ce161b2010-02-22 15:27:01 -0800290}
291
Andrew de los Reyesb10320d2010-03-31 16:44:44 -0700292template<typename T>
293bool VectorIndexOf(const std::vector<T>& vect, const T& value,
294 typename std::vector<T>::size_type* out_index) {
295 typename std::vector<T>::const_iterator it = std::find(vect.begin(),
296 vect.end(),
297 value);
298 if (it == vect.end()) {
299 return false;
300 } else {
301 *out_index = it - vect.begin();
302 return true;
303 }
304}
305
Andrew de los Reyescc92cd32010-10-05 16:56:14 -0700306template<typename ValueType>
307void ApplyMap(std::vector<ValueType>* collection,
308 const std::map<ValueType, ValueType>& the_map) {
309 for (typename std::vector<ValueType>::iterator it = collection->begin();
310 it != collection->end(); ++it) {
311 typename std::map<ValueType, ValueType>::const_iterator map_it =
312 the_map.find(*it);
313 if (map_it != the_map.end()) {
314 *it = map_it->second;
315 }
316 }
317}
318
Chris Sosa4f8ee272012-11-30 13:01:54 -0800319// Cgroups cpu shares constants. 1024 is the default shares a standard process
320// gets and 2 is the minimum value. We set High as a value that gives the
321// update-engine 2x the cpu share of a standard process.
322enum CpuShares {
323 kCpuSharesHigh = 2048,
324 kCpuSharesNormal = 1024,
325 kCpuSharesLow = 2,
Darin Petkovc6c135c2010-08-11 13:36:18 -0700326};
327
Chris Sosa4f8ee272012-11-30 13:01:54 -0800328// Sets the current process shares to |shares|. Returns true on
Darin Petkovc6c135c2010-08-11 13:36:18 -0700329// success, false otherwise.
Chris Sosa4f8ee272012-11-30 13:01:54 -0800330bool SetCpuShares(CpuShares shares);
Andrew de los Reyesf9185172010-05-03 11:07:05 -0700331
Gilad Arnoldd7b513d2012-05-10 14:25:27 -0700332// Converts seconds into human readable notation including days, hours, minutes
333// and seconds. For example, 185 will yield 3m5s, 4300 will yield 1h11m40s, and
334// 360000 will yield 4d4h0m0s. Zero padding not applied. Seconds are always
335// shown in the result.
336std::string FormatSecs(unsigned secs);
337
338// Converts a TimeDelta into human readable notation including days, hours,
339// minutes, seconds and fractions of a second down to microsecond granularity,
340// as necessary; for example, an output of 5d2h0m15.053s means that the input
341// time was precise to the milliseconds only. Zero padding not applied, except
342// for fractions. Seconds are always shown, but fractions thereof are only shown
David Zeuthen973449e2014-08-18 16:18:23 -0400343// when applicable. If |delta| is negative, the output will have a leading '-'
344// followed by the absolute duration.
Gilad Arnoldd7b513d2012-05-10 14:25:27 -0700345std::string FormatTimeDelta(base::TimeDelta delta);
Gilad Arnold1ebd8132012-03-05 10:19:29 -0800346
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -0800347// This method transforms the given error code to be suitable for UMA and
348// for error classification purposes by removing the higher order bits and
349// aggregating error codes beyond the enum range, etc. This method is
350// idempotent, i.e. if called with a value previously returned by this method,
351// it'll return the same value again.
David Zeuthena99981f2013-04-29 13:42:47 -0700352ErrorCode GetBaseErrorCode(ErrorCode code);
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -0800353
David Zeuthen33bae492014-02-25 16:16:18 -0800354// Transforms a ErrorCode value into a metrics::DownloadErrorCode.
355// This obviously only works for errors related to downloading so if |code|
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700356// is e.g. |ErrorCode::kFilesystemCopierError| then
David Zeuthen33bae492014-02-25 16:16:18 -0800357// |kDownloadErrorCodeInputMalformed| is returned.
358metrics::DownloadErrorCode GetDownloadErrorCode(ErrorCode code);
359
360// Transforms a ErrorCode value into a metrics::AttemptResult.
361//
362// If metrics::AttemptResult::kPayloadDownloadError is returned, you
363// can use utils::GetDownloadError() to get more detail.
364metrics::AttemptResult GetAttemptResult(ErrorCode code);
365
David Zeuthenb281f072014-04-02 10:20:19 -0700366// Calculates the internet connection type given |type| and |tethering|.
367metrics::ConnectionType GetConnectionType(NetworkConnectionType type,
368 NetworkTethering tethering);
369
Jay Srinivasan55f50c22013-01-10 19:24:35 -0800370// Sends the error code to UMA using the metrics interface object in the given
371// system state. It also uses the system state to determine the right UMA
372// bucket for the error code.
David Zeuthena99981f2013-04-29 13:42:47 -0700373void SendErrorCodeToUma(SystemState* system_state, ErrorCode code);
Jay Srinivasan55f50c22013-01-10 19:24:35 -0800374
David Zeuthena99981f2013-04-29 13:42:47 -0700375// Returns a string representation of the ErrorCodes (either the base
Jay Srinivasan55f50c22013-01-10 19:24:35 -0800376// error codes or the bit flags) for logging purposes.
David Zeuthena99981f2013-04-29 13:42:47 -0700377std::string CodeToString(ErrorCode code);
Jay Srinivasan55f50c22013-01-10 19:24:35 -0800378
Gilad Arnold30dedd82013-07-03 06:19:09 -0700379// Creates the powerwash marker file with the appropriate commands in it. Uses
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700380// |file_path| as the path to the marker file if non-null, otherwise uses the
Gilad Arnold30dedd82013-07-03 06:19:09 -0700381// global default. Returns true if successfully created. False otherwise.
382bool CreatePowerwashMarkerFile(const char* file_path);
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700383
Gilad Arnold30dedd82013-07-03 06:19:09 -0700384// Deletes the marker file used to trigger Powerwash using clobber-state. Uses
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700385// |file_path| as the path to the marker file if non-null, otherwise uses the
Gilad Arnold30dedd82013-07-03 06:19:09 -0700386// global default. Returns true if successfully deleted. False otherwise.
387bool DeletePowerwashMarkerFile(const char* file_path);
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700388
Chris Sosad317e402013-06-12 13:47:09 -0700389// Assumes you want to install on the "other" device, where the other
390// device is what you get if you swap 1 for 2 or 3 for 4 or vice versa
391// for the number at the end of the boot device. E.g., /dev/sda1 -> /dev/sda2
392// or /dev/sda4 -> /dev/sda3. See
393// http://www.chromium.org/chromium-os/chromiumos-design-docs/disk-format
394bool GetInstallDev(const std::string& boot_dev, std::string* install_dev);
395
David Zeuthene7f89172013-10-31 10:21:04 -0700396// Decodes the data in |base64_encoded| and stores it in a temporary
397// file. Returns false if the given data is empty, not well-formed
398// base64 or if an error occurred. If true is returned, the decoded
399// data is stored in the file returned in |out_path|. The file should
400// be deleted when no longer needed.
401bool DecodeAndStoreBase64String(const std::string& base64_encoded,
402 base::FilePath *out_path);
403
David Zeuthen639aa362014-02-03 16:23:44 -0800404// Converts |time| to an Omaha InstallDate which is defined as "the
405// number of PST8PDT calendar weeks since Jan 1st 2007 0:00 PST, times
406// seven" with PST8PDT defined as "Pacific Time" (e.g. UTC-07:00 if
407// daylight savings is observed and UTC-08:00 otherwise.)
408//
409// If the passed in |time| variable is before Monday January 1st 2007
410// 0:00 PST, False is returned and the value returned in
411// |out_num_days| is undefined. Otherwise the number of PST8PDT
412// calendar weeks since that date times seven is returned in
413// |out_num_days| and the function returns True.
414//
415// (NOTE: This function does not currently take daylight savings time
416// into account so the result may up to one hour off. This is because
417// the glibc date and timezone routines depend on the TZ environment
418// variable and changing environment variables is not thread-safe. An
419// alternative, thread-safe API to use would be GDateTime/GTimeZone
420// available in GLib 2.26 or later.)
421bool ConvertToOmahaInstallDate(base::Time time, int *out_num_days);
422
David Zeuthen33bae492014-02-25 16:16:18 -0800423// This function returns the duration on the wallclock since the last
424// time it was called for the same |state_variable_key| value.
425//
426// If the function returns |true|, the duration (always non-negative)
427// is returned in |out_duration|. If the function returns |false|
428// something went wrong or there was no previous measurement.
429bool WallclockDurationHelper(SystemState* system_state,
430 const std::string& state_variable_key,
431 base::TimeDelta* out_duration);
432
433// This function returns the duration on the monotonic clock since the
434// last time it was called for the same |storage| pointer.
435//
436// You should pass a pointer to a 64-bit integer in |storage| which
437// should be initialized to 0.
438//
439// If the function returns |true|, the duration (always non-negative)
440// is returned in |out_duration|. If the function returns |false|
441// something went wrong or there was no previous measurement.
442bool MonotonicDurationHelper(SystemState* system_state,
443 int64_t* storage,
444 base::TimeDelta* out_duration);
445
Allie Wood78750a42015-02-11 15:42:11 -0800446// This function looks for a configuration file at |path|. If it finds that
447// file, it will try get the PAYLOAD_MINOR_VERSION value from it and set
448// |minor_version| to that value.
449//
450// The function will return |true| if it succeeds at finding the file and
451// value and setting it, and |false| otherwise.
452bool GetMinorVersion(base::FilePath path, uint32_t* minor_version);
453
Allie Wood56873452015-03-27 17:48:40 -0700454// This function reads the specified data in |extents| into |out_data|. The
455// extents are read from the file at |path|. |out_data_size| is the size of
456// |out_data|. Returns false if the number of bytes to read given in
457// |extents| does not equal |out_data_size|.
Gilad Arnold41e34742015-05-11 11:31:50 -0700458bool ReadExtents(const std::string& path, const std::vector<Extent>& extents,
Allie Wood56873452015-03-27 17:48:40 -0700459 chromeos::Blob* out_data, ssize_t out_data_size,
460 size_t block_size);
461
adlr@google.com3defe6a2009-12-04 20:57:17 +0000462} // namespace utils
463
Jay Srinivasan08fce042012-06-07 16:31:01 -0700464
adlr@google.com3defe6a2009-12-04 20:57:17 +0000465// Utility class to close a file descriptor
466class ScopedFdCloser {
467 public:
468 explicit ScopedFdCloser(int* fd) : fd_(fd), should_close_(true) {}
adlr@google.com3defe6a2009-12-04 20:57:17 +0000469 ~ScopedFdCloser() {
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800470 if (should_close_ && fd_ && (*fd_ >= 0)) {
Gilad Arnoldf9609112012-02-29 11:38:47 -0800471 if (!close(*fd_))
472 *fd_ = -1;
adlr@google.com3defe6a2009-12-04 20:57:17 +0000473 }
474 }
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800475 void set_should_close(bool should_close) { should_close_ = should_close; }
adlr@google.com3defe6a2009-12-04 20:57:17 +0000476 private:
477 int* fd_;
478 bool should_close_;
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700479 DISALLOW_COPY_AND_ASSIGN(ScopedFdCloser);
480};
481
Gilad Arnoldf9609112012-02-29 11:38:47 -0800482// An EINTR-immune file descriptor closer.
483class ScopedEintrSafeFdCloser {
484 public:
485 explicit ScopedEintrSafeFdCloser(int* fd) : fd_(fd), should_close_(true) {}
486 ~ScopedEintrSafeFdCloser() {
487 if (should_close_ && fd_ && (*fd_ >= 0)) {
Mike Frysingerbcee2ca2014-05-14 16:28:23 -0400488 if (!IGNORE_EINTR(close(*fd_)))
Gilad Arnoldf9609112012-02-29 11:38:47 -0800489 *fd_ = -1;
490 }
491 }
492 void set_should_close(bool should_close) { should_close_ = should_close; }
493 private:
494 int* fd_;
495 bool should_close_;
496 DISALLOW_COPY_AND_ASSIGN(ScopedEintrSafeFdCloser);
497};
498
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700499// Utility class to delete a file when it goes out of scope.
500class ScopedPathUnlinker {
501 public:
Darin Petkov52dcaeb2011-01-14 15:33:06 -0800502 explicit ScopedPathUnlinker(const std::string& path)
503 : path_(path),
504 should_remove_(true) {}
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700505 ~ScopedPathUnlinker() {
Darin Petkov52dcaeb2011-01-14 15:33:06 -0800506 if (should_remove_ && unlink(path_.c_str()) < 0) {
Alex Deymo18f48aa2015-04-09 10:06:31 -0700507 PLOG(ERROR) << "Unable to unlink path " << path_;
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700508 }
509 }
Darin Petkov52dcaeb2011-01-14 15:33:06 -0800510 void set_should_remove(bool should_remove) { should_remove_ = should_remove; }
511
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700512 private:
513 const std::string path_;
Darin Petkov52dcaeb2011-01-14 15:33:06 -0800514 bool should_remove_;
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700515 DISALLOW_COPY_AND_ASSIGN(ScopedPathUnlinker);
516};
517
518// Utility class to delete an empty directory when it goes out of scope.
519class ScopedDirRemover {
520 public:
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800521 explicit ScopedDirRemover(const std::string& path)
522 : path_(path),
523 should_remove_(true) {}
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700524 ~ScopedDirRemover() {
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800525 if (should_remove_ && (rmdir(path_.c_str()) < 0)) {
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700526 PLOG(ERROR) << "Unable to remove dir " << path_;
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800527 }
528 }
529 void set_should_remove(bool should_remove) { should_remove_ = should_remove; }
530
531 protected:
532 const std::string path_;
533
534 private:
535 bool should_remove_;
536 DISALLOW_COPY_AND_ASSIGN(ScopedDirRemover);
537};
538
539// Utility class to unmount a filesystem mounted on a temporary directory and
540// delete the temporary directory when it goes out of scope.
541class ScopedTempUnmounter : public ScopedDirRemover {
542 public:
543 explicit ScopedTempUnmounter(const std::string& path) :
544 ScopedDirRemover(path) {}
545 ~ScopedTempUnmounter() {
546 utils::UnmountFilesystem(path_);
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700547 }
548 private:
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800549 DISALLOW_COPY_AND_ASSIGN(ScopedTempUnmounter);
adlr@google.com3defe6a2009-12-04 20:57:17 +0000550};
551
552// A little object to call ActionComplete on the ActionProcessor when
553// it's destructed.
554class ScopedActionCompleter {
555 public:
556 explicit ScopedActionCompleter(ActionProcessor* processor,
557 AbstractAction* action)
558 : processor_(processor),
559 action_(action),
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700560 code_(ErrorCode::kError),
adlr@google.com3defe6a2009-12-04 20:57:17 +0000561 should_complete_(true) {}
562 ~ScopedActionCompleter() {
563 if (should_complete_)
Darin Petkovc1a8b422010-07-19 11:34:49 -0700564 processor_->ActionComplete(action_, code_);
adlr@google.com3defe6a2009-12-04 20:57:17 +0000565 }
David Zeuthena99981f2013-04-29 13:42:47 -0700566 void set_code(ErrorCode code) { code_ = code; }
adlr@google.com3defe6a2009-12-04 20:57:17 +0000567 void set_should_complete(bool should_complete) {
568 should_complete_ = should_complete;
569 }
David Zeuthen33bae492014-02-25 16:16:18 -0800570 ErrorCode get_code() const { return code_; }
Darin Petkovc1a8b422010-07-19 11:34:49 -0700571
adlr@google.com3defe6a2009-12-04 20:57:17 +0000572 private:
573 ActionProcessor* processor_;
574 AbstractAction* action_;
David Zeuthena99981f2013-04-29 13:42:47 -0700575 ErrorCode code_;
adlr@google.com3defe6a2009-12-04 20:57:17 +0000576 bool should_complete_;
577 DISALLOW_COPY_AND_ASSIGN(ScopedActionCompleter);
578};
579
David Zeuthen27a48bc2013-08-06 12:06:29 -0700580// A base::FreeDeleter that frees memory using g_free(). Useful when
Ben Chan02f7c1d2014-10-18 15:18:02 -0700581// integrating with GLib since it can be used with std::unique_ptr to
David Zeuthen27a48bc2013-08-06 12:06:29 -0700582// automatically free memory when going out of scope.
583struct GLibFreeDeleter : public base::FreeDeleter {
584 inline void operator()(void *ptr) const {
585 g_free(reinterpret_cast<gpointer>(ptr));
586 }
587};
588
589// A base::FreeDeleter that frees memory using g_strfreev(). Useful
Ben Chan02f7c1d2014-10-18 15:18:02 -0700590// when integrating with GLib since it can be used with std::unique_ptr to
David Zeuthen27a48bc2013-08-06 12:06:29 -0700591// automatically free memory when going out of scope.
592struct GLibStrvFreeDeleter : public base::FreeDeleter {
593 inline void operator()(void *ptr) const {
594 g_strfreev(reinterpret_cast<gchar**>(ptr));
595 }
596};
597
adlr@google.com3defe6a2009-12-04 20:57:17 +0000598} // namespace chromeos_update_engine
599
600#define TEST_AND_RETURN_FALSE_ERRNO(_x) \
601 do { \
Nam T. Nguyen2b67a592014-12-03 14:56:00 -0800602 bool _success = static_cast<bool>(_x); \
adlr@google.com3defe6a2009-12-04 20:57:17 +0000603 if (!_success) { \
604 std::string _msg = \
605 chromeos_update_engine::utils::ErrnoNumberAsString(errno); \
606 LOG(ERROR) << #_x " failed: " << _msg; \
607 return false; \
608 } \
609 } while (0)
610
611#define TEST_AND_RETURN_FALSE(_x) \
612 do { \
Nam T. Nguyen2b67a592014-12-03 14:56:00 -0800613 bool _success = static_cast<bool>(_x); \
adlr@google.com3defe6a2009-12-04 20:57:17 +0000614 if (!_success) { \
615 LOG(ERROR) << #_x " failed."; \
616 return false; \
617 } \
618 } while (0)
619
620#define TEST_AND_RETURN_ERRNO(_x) \
621 do { \
Nam T. Nguyen2b67a592014-12-03 14:56:00 -0800622 bool _success = static_cast<bool>(_x); \
adlr@google.com3defe6a2009-12-04 20:57:17 +0000623 if (!_success) { \
624 std::string _msg = \
625 chromeos_update_engine::utils::ErrnoNumberAsString(errno); \
626 LOG(ERROR) << #_x " failed: " << _msg; \
627 return; \
628 } \
629 } while (0)
630
631#define TEST_AND_RETURN(_x) \
632 do { \
Nam T. Nguyen2b67a592014-12-03 14:56:00 -0800633 bool _success = static_cast<bool>(_x); \
adlr@google.com3defe6a2009-12-04 20:57:17 +0000634 if (!_success) { \
635 LOG(ERROR) << #_x " failed."; \
636 return; \
637 } \
638 } while (0)
639
Thieu Le5c7d9752010-12-15 16:09:28 -0800640#define TEST_AND_RETURN_FALSE_ERRCODE(_x) \
641 do { \
642 errcode_t _error = (_x); \
643 if (_error) { \
644 errno = _error; \
645 LOG(ERROR) << #_x " failed: " << _error; \
646 return false; \
647 } \
648 } while (0)
649
Gilad Arnoldcf175a02014-07-10 16:48:47 -0700650#endif // UPDATE_ENGINE_UTILS_H_