blob: 19bb9d6ffd3ad2baa3e2d01b67166ff74803a62e [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>
Andrew de los Reyesc7020782010-04-28 10:46:04 -070021#include <glib.h>
Jay Srinivasanf0572052012-10-23 18:12:56 -070022#include "metrics/metrics_library.h"
Darin Petkovc6c135c2010-08-11 13:36:18 -070023
adlr@google.com3defe6a2009-12-04 20:57:17 +000024#include "update_engine/action.h"
David Zeuthenb281f072014-04-02 10:20:19 -070025#include "update_engine/action_processor.h"
26#include "update_engine/connection_manager.h"
Jay Srinivasan19409b72013-04-12 19:23:36 -070027#include "update_engine/constants.h"
David Zeuthen33bae492014-02-25 16:16:18 -080028#include "update_engine/metrics.h"
adlr@google.com3defe6a2009-12-04 20:57:17 +000029
30namespace chromeos_update_engine {
31
Jay Srinivasan55f50c22013-01-10 19:24:35 -080032class SystemState;
33
adlr@google.com3defe6a2009-12-04 20:57:17 +000034namespace utils {
35
David Zeuthen27a48bc2013-08-06 12:06:29 -070036// Converts a struct timespec representing a number of seconds since
37// the Unix epoch to a base::Time. Sub-microsecond time is rounded
38// down.
39base::Time TimeFromStructTimespec(struct timespec *ts);
40
Alex Vakulenko88b591f2014-08-28 16:48:57 -070041// Converts a vector of strings to a NUL-terminated array of
David Zeuthen27a48bc2013-08-06 12:06:29 -070042// strings. The resulting array should be freed with g_strfreev()
43// when are you done with it.
Alex Deymof329b932014-10-30 01:37:48 -070044gchar** StringVectorToGStrv(const std::vector<std::string> &vec_str);
David Zeuthen27a48bc2013-08-06 12:06:29 -070045
Alex Deymof329b932014-10-30 01:37:48 -070046// Formats |vec_str| as a string of the form ["<elem1>", "<elem2>"].
David Zeuthen27a48bc2013-08-06 12:06:29 -070047// Does no escaping, only use this for presentation in error messages.
Alex Deymof329b932014-10-30 01:37:48 -070048std::string StringVectorToString(const std::vector<std::string> &vec_str);
David Zeuthen27a48bc2013-08-06 12:06:29 -070049
David Zeuthen8f191b22013-08-06 12:27:50 -070050// Calculates the p2p file id from payload hash and size
51std::string CalculateP2PFileId(const std::string& payload_hash,
52 size_t payload_size);
53
J. Richard Barnette63137e52013-10-28 10:57:29 -070054// Parse the firmware version from one line of output from the
55// "mosys" command.
56std::string ParseECVersion(std::string input_line);
57
J. Richard Barnette30842932013-10-28 15:04:23 -070058// Given the name of the block device of a boot partition, return the
59// name of the associated kernel partition (e.g. given "/dev/sda3",
60// return "/dev/sda2").
61const std::string KernelDeviceOfBootDevice(const std::string& boot_device);
62
Andrew de los Reyes970bb282009-12-09 16:34:04 -080063// Writes the data passed to path. The file at path will be overwritten if it
64// exists. Returns true on success, false otherwise.
65bool WriteFile(const char* path, const char* data, int data_len);
66
Andrew de los Reyes09e56d62010-04-23 13:45:53 -070067// Calls write() or pwrite() repeatedly until all count bytes at buf are
68// written to fd or an error occurs. Returns true on success.
69bool WriteAll(int fd, const void* buf, size_t count);
70bool PWriteAll(int fd, const void* buf, size_t count, off_t offset);
71
72// Calls pread() repeatedly until count bytes are read, or EOF is reached.
73// Returns number of bytes read in *bytes_read. Returns true on success.
74bool PReadAll(int fd, void* buf, size_t count, off_t offset,
75 ssize_t* out_bytes_read);
Andrew de los Reyesb10320d2010-03-31 16:44:44 -070076
Gilad Arnold19a45f02012-07-19 12:36:10 -070077// Opens |path| for reading and appends its entire content to the container
78// pointed to by |out_p|. Returns true upon successfully reading all of the
79// file's content, false otherwise, in which case the state of the output
Darin Petkov8e447e02013-04-16 16:23:50 +020080// container is unknown. ReadFileChunk starts reading the file from |offset|; if
81// |size| is not -1, only up to |size| bytes are read in.
Gilad Arnold19a45f02012-07-19 12:36:10 -070082bool ReadFile(const std::string& path, std::vector<char>* out_p);
83bool ReadFile(const std::string& path, std::string* out_p);
Darin Petkov8e447e02013-04-16 16:23:50 +020084bool ReadFileChunk(const std::string& path, off_t offset, off_t size,
85 std::vector<char>* out_p);
Gilad Arnold19a45f02012-07-19 12:36:10 -070086
87// Invokes |cmd| in a pipe and appends its stdout to the container pointed to by
88// |out_p|. Returns true upon successfully reading all of the output, false
89// otherwise, in which case the state of the output container is unknown.
90bool ReadPipe(const std::string& cmd, std::vector<char>* out_p);
91bool ReadPipe(const std::string& cmd, std::string* out_p);
adlr@google.com3defe6a2009-12-04 20:57:17 +000092
Gabe Blackb92cd2e2014-09-08 02:47:41 -070093// Returns the size of the block device at path, or the file descriptor fd. If
94// an error occurs, -1 is returned.
95off_t BlockDevSize(const std::string& path);
96off_t BlockDevSize(int fd);
97
98// Returns the size of the file at path, or the file desciptor fd. If the file
99// is actually a block device, this function will automatically call
100// BlockDevSize. If the file doesn't exist or some error occurrs, -1 is
101// returned.
Andrew de los Reyesf4c7ef12010-04-30 10:37:00 -0700102off_t FileSize(const std::string& path);
Gabe Blackb92cd2e2014-09-08 02:47:41 -0700103off_t FileSize(int fd);
Andrew de los Reyesf4c7ef12010-04-30 10:37:00 -0700104
adlr@google.com3defe6a2009-12-04 20:57:17 +0000105std::string ErrnoNumberAsString(int err);
106
107// Strips duplicate slashes, and optionally removes all trailing slashes.
108// Does not compact /./ or /../.
109std::string NormalizePath(const std::string& path, bool strip_trailing_slash);
110
111// Returns true if the file exists for sure. Returns false if it doesn't exist,
112// or an error occurs.
113bool FileExists(const char* path);
114
Darin Petkov30291ed2010-11-12 10:23:06 -0800115// Returns true if |path| exists and is a symbolic link.
116bool IsSymlink(const char* path);
117
Alex Deymo7dc4c502014-05-20 20:09:58 -0700118// Returns true if |path| exists and is a directory.
119bool IsDir(const char* path);
120
Gilad Arnoldd04f8e22014-01-09 13:13:40 -0800121// If |base_filename_template| is neither absolute (starts with "/") nor
122// explicitly relative to the current working directory (starts with "./" or
123// "../"), then it is prepended the value of TMPDIR, which defaults to /tmp if
124// it isn't set or is empty. It then calls mkstemp(3) with the resulting
125// template. Writes the name of a new temporary file to |filename|. If |fd| is
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700126// non-null, the file descriptor returned by mkstemp is written to it and
127// kept open; otherwise, it is closed. The template must end with "XXXXXX".
128// Returns true on success.
Gilad Arnoldd04f8e22014-01-09 13:13:40 -0800129bool MakeTempFile(const std::string& base_filename_template,
Andrew de los Reyesb10320d2010-03-31 16:44:44 -0700130 std::string* filename,
131 int* fd);
132
Gilad Arnoldd04f8e22014-01-09 13:13:40 -0800133// If |base_filename_template| is neither absolute (starts with "/") nor
134// explicitly relative to the current working directory (starts with "./" or
135// "../"), then it is prepended the value of TMPDIR, which defaults to /tmp if
136// it isn't set or is empty. It then calls mkdtemp() with the resulting
137// template. Writes the name of the new temporary directory to |dirname|.
138// The template must end with "XXXXXX". Returns true on success.
139bool MakeTempDirectory(const std::string& base_dirname_template,
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700140 std::string* dirname);
141
adlr@google.com3defe6a2009-12-04 20:57:17 +0000142// Deletes a directory and all its contents synchronously. Returns true
143// on success. This may be called with a regular file--it will just unlink it.
144// This WILL cross filesystem boundaries.
145bool RecursiveUnlinkDir(const std::string& path);
146
Alex Vakulenko4f5b1442014-02-21 12:19:44 -0800147// Returns the disk device name for a partition. For example,
148// GetDiskName("/dev/sda3") returns "/dev/sda". Returns an empty string
149// if the input device is not of the "/dev/xyz#" form.
150std::string GetDiskName(const std::string& partition_name);
Andrew de los Reyesf9714432010-05-04 10:21:23 -0700151
Alex Vakulenko4f5b1442014-02-21 12:19:44 -0800152// Returns the partition number, of partition device name. For example,
153// GetPartitionNumber("/dev/sda3") returns 3.
154// Returns 0 on failure
155int GetPartitionNumber(const std::string& partition_name);
156
157// Splits the partition device name into the block device name and partition
158// number. For example, "/dev/sda3" will be split into {"/dev/sda", 3} and
159// "/dev/mmcblk0p2" into {"/dev/mmcblk0", 2}
160// Returns false when malformed device name is passed in.
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700161// If both output parameters are omitted (null), can be used
Alex Vakulenko4f5b1442014-02-21 12:19:44 -0800162// just to test the validity of the device name. Note that the function
163// simply checks if the device name looks like a valid device, no other
164// checks are performed (i.e. it doesn't check if the device actually exists).
165bool SplitPartitionName(const std::string& partition_name,
166 std::string* out_disk_name,
167 int* out_partition_num);
168
169// Builds a partition device name from the block device name and partition
170// number. For example:
171// {"/dev/sda", 1} => "/dev/sda1"
172// {"/dev/mmcblk2", 12} => "/dev/mmcblk2p12"
173// Returns empty string when invalid parameters are passed in
174std::string MakePartitionName(const std::string& disk_name,
175 int partition_num);
Andrew de los Reyesf9714432010-05-04 10:21:23 -0700176
Darin Petkovf74eb652010-08-04 12:08:38 -0700177// Returns the sysfs block device for a root block device. For
178// example, SysfsBlockDevice("/dev/sda") returns
179// "/sys/block/sda". Returns an empty string if the input device is
180// not of the "/dev/xyz" form.
181std::string SysfsBlockDevice(const std::string& device);
182
183// Returns true if the root |device| (e.g., "/dev/sdb") is known to be
184// removable, false otherwise.
185bool IsRemovableDevice(const std::string& device);
186
adlr@google.com3defe6a2009-12-04 20:57:17 +0000187// Synchronously mount or unmount a filesystem. Return true on success.
Alex Deymo4c82df32014-11-10 22:25:57 -0800188// When mounting, it will attempt to mount the the device as "ext3", "ext2" and
189// "squashfs", with the passed |flags| options.
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700190bool MountFilesystem(const std::string& device, const std::string& mountpoint,
Alex Vakulenkod2779df2014-06-16 13:19:00 -0700191 unsigned long flags); // NOLINT(runtime/int)
Andrew de los Reyes4fe15d02009-12-10 19:01:36 -0800192bool UnmountFilesystem(const std::string& mountpoint);
adlr@google.com3defe6a2009-12-04 20:57:17 +0000193
Alex Deymo192393b2014-11-10 15:58:38 -0800194// Returns the block count and the block byte size of the file system on
Darin Petkovd3f8c892010-10-12 21:38:45 -0700195// |device| (which may be a real device or a path to a filesystem image) or on
196// an opened file descriptor |fd|. The actual file-system size is |block_count|
197// * |block_size| bytes. Returns true on success, false otherwise.
198bool GetFilesystemSize(const std::string& device,
199 int* out_block_count,
200 int* out_block_size);
201bool GetFilesystemSizeFromFD(int fd,
202 int* out_block_count,
203 int* out_block_size);
204
Alex Deymo192393b2014-11-10 15:58:38 -0800205// Determines the block count and block size of the ext3 fs. At least 2048 bytes
206// are required to parse the first superblock. Returns whether the buffer
207// contains a valid ext3 filesystem and the values were parsed.
208bool GetExt3Size(const uint8_t* buffer, size_t buffer_size,
209 int* out_block_count,
210 int* out_block_size);
211
212// Determines the block count and block size of the squashfs v4 fs. At least 96
213// bytes are required to parse the header of the filesystem. Since squashfs
214// doesn't define a physical block size, a value of 4096 is used for the block
215// size, which is the default padding when creating the filesystem.
216// Returns whether the buffer contains a valid squashfs v4 header and the size
217// was parsed. Only little endian squashfs is supported.
218bool GetSquashfs4Size(const uint8_t* buffer, size_t buffer_size,
219 int* out_block_count,
220 int* out_block_size);
221
Alex Deymo719bfff2014-07-11 12:12:32 -0700222// Returns the path of the passed |command| on the board. This uses the
223// environment variable SYSROOT to determine the path to the command on the
224// board instead of the path on the running environment.
225std::string GetPathOnBoard(const std::string& command);
Alex Deymo032e7722014-03-25 17:53:56 -0700226
227// Returns a human-readable string with the file format based on magic constants
228// on the header of the file.
229std::string GetFileFormat(const std::string& path);
230
Jay Srinivasan480ddfa2012-06-01 19:15:26 -0700231// Returns the string representation of the given UTC time.
232// such as "11/14/2011 14:05:30 GMT".
233std::string ToString(const base::Time utc_time);
234
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700235// Returns true or false depending on the value of b.
236std::string ToString(bool b);
237
Jay Srinivasan19409b72013-04-12 19:23:36 -0700238// Returns a string representation of the given enum.
239std::string ToString(DownloadSource source);
240
Alex Deymo1c656c42013-06-28 11:02:14 -0700241// Returns a string representation of the given enum.
242std::string ToString(PayloadType payload_type);
243
Andrew de los Reyes712b3ac2011-01-07 13:47:52 -0800244// Schedules a Main Loop callback to trigger the crash reporter to perform an
245// upload as if this process had crashed.
246void ScheduleCrashReporterUpload();
247
Darin Petkov5c0a8af2010-08-24 13:39:13 -0700248// Fuzzes an integer |value| randomly in the range:
249// [value - range / 2, value + range - range / 2]
250int FuzzInt(int value, unsigned int range);
251
adlr@google.com3defe6a2009-12-04 20:57:17 +0000252// Log a string in hex to LOG(INFO). Useful for debugging.
253void HexDumpArray(const unsigned char* const arr, const size_t length);
254inline void HexDumpString(const std::string& str) {
255 HexDumpArray(reinterpret_cast<const unsigned char*>(str.data()), str.size());
256}
257inline void HexDumpVector(const std::vector<char>& vect) {
258 HexDumpArray(reinterpret_cast<const unsigned char*>(&vect[0]), vect.size());
259}
260
adlr@google.com3defe6a2009-12-04 20:57:17 +0000261bool StringHasSuffix(const std::string& str, const std::string& suffix);
262bool StringHasPrefix(const std::string& str, const std::string& prefix);
263
264template<typename KeyType, typename ValueType>
265bool MapContainsKey(const std::map<KeyType, ValueType>& m, const KeyType& k) {
266 return m.find(k) != m.end();
267}
Andrew de los Reyes4fe15d02009-12-10 19:01:36 -0800268template<typename KeyType>
269bool SetContainsKey(const std::set<KeyType>& s, const KeyType& k) {
270 return s.find(k) != s.end();
271}
adlr@google.com3defe6a2009-12-04 20:57:17 +0000272
273template<typename ValueType>
274std::set<ValueType> SetWithValue(const ValueType& value) {
275 std::set<ValueType> ret;
276 ret.insert(value);
277 return ret;
278}
279
Andrew de los Reyes0ce161b2010-02-22 15:27:01 -0800280template<typename T>
281bool VectorContainsValue(const std::vector<T>& vect, const T& value) {
Darin Petkovc1a8b422010-07-19 11:34:49 -0700282 return std::find(vect.begin(), vect.end(), value) != vect.end();
Andrew de los Reyes0ce161b2010-02-22 15:27:01 -0800283}
284
Andrew de los Reyesb10320d2010-03-31 16:44:44 -0700285template<typename T>
286bool VectorIndexOf(const std::vector<T>& vect, const T& value,
287 typename std::vector<T>::size_type* out_index) {
288 typename std::vector<T>::const_iterator it = std::find(vect.begin(),
289 vect.end(),
290 value);
291 if (it == vect.end()) {
292 return false;
293 } else {
294 *out_index = it - vect.begin();
295 return true;
296 }
297}
298
Andrew de los Reyescc92cd32010-10-05 16:56:14 -0700299template<typename ValueType>
300void ApplyMap(std::vector<ValueType>* collection,
301 const std::map<ValueType, ValueType>& the_map) {
302 for (typename std::vector<ValueType>::iterator it = collection->begin();
303 it != collection->end(); ++it) {
304 typename std::map<ValueType, ValueType>::const_iterator map_it =
305 the_map.find(*it);
306 if (map_it != the_map.end()) {
307 *it = map_it->second;
308 }
309 }
310}
311
Chris Sosa4f8ee272012-11-30 13:01:54 -0800312// Cgroups cpu shares constants. 1024 is the default shares a standard process
313// gets and 2 is the minimum value. We set High as a value that gives the
314// update-engine 2x the cpu share of a standard process.
315enum CpuShares {
316 kCpuSharesHigh = 2048,
317 kCpuSharesNormal = 1024,
318 kCpuSharesLow = 2,
Darin Petkovc6c135c2010-08-11 13:36:18 -0700319};
320
Chris Sosa4f8ee272012-11-30 13:01:54 -0800321// Compares cpu shares and returns an integer that is less
322// than, equal to or greater than 0 if |shares_lhs| is,
323// respectively, lower than, same as or higher than |shares_rhs|.
324int CompareCpuShares(CpuShares shares_lhs,
325 CpuShares shares_rhs);
Darin Petkovc6c135c2010-08-11 13:36:18 -0700326
Chris Sosa4f8ee272012-11-30 13:01:54 -0800327// Sets the current process shares to |shares|. Returns true on
Darin Petkovc6c135c2010-08-11 13:36:18 -0700328// success, false otherwise.
Chris Sosa4f8ee272012-11-30 13:01:54 -0800329bool SetCpuShares(CpuShares shares);
Andrew de los Reyesf9185172010-05-03 11:07:05 -0700330
Alex Deymoc4acdf42014-05-28 21:07:10 -0700331// Assumes |data| points to a Closure. Runs it and returns FALSE;
Andrew de los Reyesf3ed8e72011-02-16 10:35:46 -0800332gboolean GlibRunClosure(gpointer data);
333
Alex Deymoc4acdf42014-05-28 21:07:10 -0700334// Destroys the Closure pointed by |data|.
335void GlibDestroyClosure(gpointer data);
336
Gilad Arnoldd7b513d2012-05-10 14:25:27 -0700337// Converts seconds into human readable notation including days, hours, minutes
338// and seconds. For example, 185 will yield 3m5s, 4300 will yield 1h11m40s, and
339// 360000 will yield 4d4h0m0s. Zero padding not applied. Seconds are always
340// shown in the result.
341std::string FormatSecs(unsigned secs);
342
343// Converts a TimeDelta into human readable notation including days, hours,
344// minutes, seconds and fractions of a second down to microsecond granularity,
345// as necessary; for example, an output of 5d2h0m15.053s means that the input
346// time was precise to the milliseconds only. Zero padding not applied, except
347// for fractions. Seconds are always shown, but fractions thereof are only shown
David Zeuthen973449e2014-08-18 16:18:23 -0400348// when applicable. If |delta| is negative, the output will have a leading '-'
349// followed by the absolute duration.
Gilad Arnoldd7b513d2012-05-10 14:25:27 -0700350std::string FormatTimeDelta(base::TimeDelta delta);
Gilad Arnold1ebd8132012-03-05 10:19:29 -0800351
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -0800352// This method transforms the given error code to be suitable for UMA and
353// for error classification purposes by removing the higher order bits and
354// aggregating error codes beyond the enum range, etc. This method is
355// idempotent, i.e. if called with a value previously returned by this method,
356// it'll return the same value again.
David Zeuthena99981f2013-04-29 13:42:47 -0700357ErrorCode GetBaseErrorCode(ErrorCode code);
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -0800358
David Zeuthen33bae492014-02-25 16:16:18 -0800359// Transforms a ErrorCode value into a metrics::DownloadErrorCode.
360// This obviously only works for errors related to downloading so if |code|
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700361// is e.g. |ErrorCode::kFilesystemCopierError| then
David Zeuthen33bae492014-02-25 16:16:18 -0800362// |kDownloadErrorCodeInputMalformed| is returned.
363metrics::DownloadErrorCode GetDownloadErrorCode(ErrorCode code);
364
365// Transforms a ErrorCode value into a metrics::AttemptResult.
366//
367// If metrics::AttemptResult::kPayloadDownloadError is returned, you
368// can use utils::GetDownloadError() to get more detail.
369metrics::AttemptResult GetAttemptResult(ErrorCode code);
370
David Zeuthenb281f072014-04-02 10:20:19 -0700371// Calculates the internet connection type given |type| and |tethering|.
372metrics::ConnectionType GetConnectionType(NetworkConnectionType type,
373 NetworkTethering tethering);
374
Jay Srinivasan55f50c22013-01-10 19:24:35 -0800375// Sends the error code to UMA using the metrics interface object in the given
376// system state. It also uses the system state to determine the right UMA
377// bucket for the error code.
David Zeuthena99981f2013-04-29 13:42:47 -0700378void SendErrorCodeToUma(SystemState* system_state, ErrorCode code);
Jay Srinivasan55f50c22013-01-10 19:24:35 -0800379
David Zeuthena99981f2013-04-29 13:42:47 -0700380// Returns a string representation of the ErrorCodes (either the base
Jay Srinivasan55f50c22013-01-10 19:24:35 -0800381// error codes or the bit flags) for logging purposes.
David Zeuthena99981f2013-04-29 13:42:47 -0700382std::string CodeToString(ErrorCode code);
Jay Srinivasan55f50c22013-01-10 19:24:35 -0800383
Gilad Arnold30dedd82013-07-03 06:19:09 -0700384// Creates the powerwash marker file with the appropriate commands in it. 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 created. False otherwise.
387bool CreatePowerwashMarkerFile(const char* file_path);
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700388
Gilad Arnold30dedd82013-07-03 06:19:09 -0700389// Deletes the marker file used to trigger Powerwash using clobber-state. Uses
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700390// |file_path| as the path to the marker file if non-null, otherwise uses the
Gilad Arnold30dedd82013-07-03 06:19:09 -0700391// global default. Returns true if successfully deleted. False otherwise.
392bool DeletePowerwashMarkerFile(const char* file_path);
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700393
Chris Sosad317e402013-06-12 13:47:09 -0700394// Assumes you want to install on the "other" device, where the other
395// device is what you get if you swap 1 for 2 or 3 for 4 or vice versa
396// for the number at the end of the boot device. E.g., /dev/sda1 -> /dev/sda2
397// or /dev/sda4 -> /dev/sda3. See
398// http://www.chromium.org/chromium-os/chromiumos-design-docs/disk-format
399bool GetInstallDev(const std::string& boot_dev, std::string* install_dev);
400
David Zeuthen910ec5b2013-09-26 12:10:58 -0700401// Checks if xattr is supported in the directory specified by
402// |dir_path| which must be writable. Returns true if the feature is
403// supported, false if not or if an error occured.
404bool IsXAttrSupported(const base::FilePath& dir_path);
405
David Zeuthene7f89172013-10-31 10:21:04 -0700406// Decodes the data in |base64_encoded| and stores it in a temporary
407// file. Returns false if the given data is empty, not well-formed
408// base64 or if an error occurred. If true is returned, the decoded
409// data is stored in the file returned in |out_path|. The file should
410// be deleted when no longer needed.
411bool DecodeAndStoreBase64String(const std::string& base64_encoded,
412 base::FilePath *out_path);
413
David Zeuthen639aa362014-02-03 16:23:44 -0800414// Converts |time| to an Omaha InstallDate which is defined as "the
415// number of PST8PDT calendar weeks since Jan 1st 2007 0:00 PST, times
416// seven" with PST8PDT defined as "Pacific Time" (e.g. UTC-07:00 if
417// daylight savings is observed and UTC-08:00 otherwise.)
418//
419// If the passed in |time| variable is before Monday January 1st 2007
420// 0:00 PST, False is returned and the value returned in
421// |out_num_days| is undefined. Otherwise the number of PST8PDT
422// calendar weeks since that date times seven is returned in
423// |out_num_days| and the function returns True.
424//
425// (NOTE: This function does not currently take daylight savings time
426// into account so the result may up to one hour off. This is because
427// the glibc date and timezone routines depend on the TZ environment
428// variable and changing environment variables is not thread-safe. An
429// alternative, thread-safe API to use would be GDateTime/GTimeZone
430// available in GLib 2.26 or later.)
431bool ConvertToOmahaInstallDate(base::Time time, int *out_num_days);
432
David Zeuthen33bae492014-02-25 16:16:18 -0800433// This function returns the duration on the wallclock since the last
434// time it was called for the same |state_variable_key| value.
435//
436// If the function returns |true|, the duration (always non-negative)
437// is returned in |out_duration|. If the function returns |false|
438// something went wrong or there was no previous measurement.
439bool WallclockDurationHelper(SystemState* system_state,
440 const std::string& state_variable_key,
441 base::TimeDelta* out_duration);
442
443// This function returns the duration on the monotonic clock since the
444// last time it was called for the same |storage| pointer.
445//
446// You should pass a pointer to a 64-bit integer in |storage| which
447// should be initialized to 0.
448//
449// If the function returns |true|, the duration (always non-negative)
450// is returned in |out_duration|. If the function returns |false|
451// something went wrong or there was no previous measurement.
452bool MonotonicDurationHelper(SystemState* system_state,
453 int64_t* storage,
454 base::TimeDelta* out_duration);
455
adlr@google.com3defe6a2009-12-04 20:57:17 +0000456} // namespace utils
457
Jay Srinivasan08fce042012-06-07 16:31:01 -0700458
adlr@google.com3defe6a2009-12-04 20:57:17 +0000459// Class to unmount FS when object goes out of scope
460class ScopedFilesystemUnmounter {
461 public:
462 explicit ScopedFilesystemUnmounter(const std::string& mountpoint)
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800463 : mountpoint_(mountpoint),
464 should_unmount_(true) {}
adlr@google.com3defe6a2009-12-04 20:57:17 +0000465 ~ScopedFilesystemUnmounter() {
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800466 if (should_unmount_) {
467 utils::UnmountFilesystem(mountpoint_);
468 }
adlr@google.com3defe6a2009-12-04 20:57:17 +0000469 }
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800470 void set_should_unmount(bool unmount) { should_unmount_ = unmount; }
adlr@google.com3defe6a2009-12-04 20:57:17 +0000471 private:
472 const std::string mountpoint_;
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800473 bool should_unmount_;
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700474 DISALLOW_COPY_AND_ASSIGN(ScopedFilesystemUnmounter);
adlr@google.com3defe6a2009-12-04 20:57:17 +0000475};
476
477// Utility class to close a file descriptor
478class ScopedFdCloser {
479 public:
480 explicit ScopedFdCloser(int* fd) : fd_(fd), should_close_(true) {}
adlr@google.com3defe6a2009-12-04 20:57:17 +0000481 ~ScopedFdCloser() {
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800482 if (should_close_ && fd_ && (*fd_ >= 0)) {
Gilad Arnoldf9609112012-02-29 11:38:47 -0800483 if (!close(*fd_))
484 *fd_ = -1;
adlr@google.com3defe6a2009-12-04 20:57:17 +0000485 }
486 }
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800487 void set_should_close(bool should_close) { should_close_ = should_close; }
adlr@google.com3defe6a2009-12-04 20:57:17 +0000488 private:
489 int* fd_;
490 bool should_close_;
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700491 DISALLOW_COPY_AND_ASSIGN(ScopedFdCloser);
492};
493
Gilad Arnoldf9609112012-02-29 11:38:47 -0800494// An EINTR-immune file descriptor closer.
495class ScopedEintrSafeFdCloser {
496 public:
497 explicit ScopedEintrSafeFdCloser(int* fd) : fd_(fd), should_close_(true) {}
498 ~ScopedEintrSafeFdCloser() {
499 if (should_close_ && fd_ && (*fd_ >= 0)) {
Mike Frysingerbcee2ca2014-05-14 16:28:23 -0400500 if (!IGNORE_EINTR(close(*fd_)))
Gilad Arnoldf9609112012-02-29 11:38:47 -0800501 *fd_ = -1;
502 }
503 }
504 void set_should_close(bool should_close) { should_close_ = should_close; }
505 private:
506 int* fd_;
507 bool should_close_;
508 DISALLOW_COPY_AND_ASSIGN(ScopedEintrSafeFdCloser);
509};
510
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700511// Utility class to delete a file when it goes out of scope.
512class ScopedPathUnlinker {
513 public:
Darin Petkov52dcaeb2011-01-14 15:33:06 -0800514 explicit ScopedPathUnlinker(const std::string& path)
515 : path_(path),
516 should_remove_(true) {}
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700517 ~ScopedPathUnlinker() {
Darin Petkov52dcaeb2011-01-14 15:33:06 -0800518 if (should_remove_ && unlink(path_.c_str()) < 0) {
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700519 std::string err_message = strerror(errno);
520 LOG(ERROR) << "Unable to unlink path " << path_ << ": " << err_message;
521 }
522 }
Darin Petkov52dcaeb2011-01-14 15:33:06 -0800523 void set_should_remove(bool should_remove) { should_remove_ = should_remove; }
524
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700525 private:
526 const std::string path_;
Darin Petkov52dcaeb2011-01-14 15:33:06 -0800527 bool should_remove_;
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700528 DISALLOW_COPY_AND_ASSIGN(ScopedPathUnlinker);
529};
530
531// Utility class to delete an empty directory when it goes out of scope.
532class ScopedDirRemover {
533 public:
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800534 explicit ScopedDirRemover(const std::string& path)
535 : path_(path),
536 should_remove_(true) {}
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700537 ~ScopedDirRemover() {
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800538 if (should_remove_ && (rmdir(path_.c_str()) < 0)) {
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700539 PLOG(ERROR) << "Unable to remove dir " << path_;
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800540 }
541 }
542 void set_should_remove(bool should_remove) { should_remove_ = should_remove; }
543
544 protected:
545 const std::string path_;
546
547 private:
548 bool should_remove_;
549 DISALLOW_COPY_AND_ASSIGN(ScopedDirRemover);
550};
551
552// Utility class to unmount a filesystem mounted on a temporary directory and
553// delete the temporary directory when it goes out of scope.
554class ScopedTempUnmounter : public ScopedDirRemover {
555 public:
556 explicit ScopedTempUnmounter(const std::string& path) :
557 ScopedDirRemover(path) {}
558 ~ScopedTempUnmounter() {
559 utils::UnmountFilesystem(path_);
Andrew de los Reyes09e56d62010-04-23 13:45:53 -0700560 }
561 private:
Darin Petkov6f03a3b2010-11-10 14:27:14 -0800562 DISALLOW_COPY_AND_ASSIGN(ScopedTempUnmounter);
adlr@google.com3defe6a2009-12-04 20:57:17 +0000563};
564
565// A little object to call ActionComplete on the ActionProcessor when
566// it's destructed.
567class ScopedActionCompleter {
568 public:
569 explicit ScopedActionCompleter(ActionProcessor* processor,
570 AbstractAction* action)
571 : processor_(processor),
572 action_(action),
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700573 code_(ErrorCode::kError),
adlr@google.com3defe6a2009-12-04 20:57:17 +0000574 should_complete_(true) {}
575 ~ScopedActionCompleter() {
576 if (should_complete_)
Darin Petkovc1a8b422010-07-19 11:34:49 -0700577 processor_->ActionComplete(action_, code_);
adlr@google.com3defe6a2009-12-04 20:57:17 +0000578 }
David Zeuthena99981f2013-04-29 13:42:47 -0700579 void set_code(ErrorCode code) { code_ = code; }
adlr@google.com3defe6a2009-12-04 20:57:17 +0000580 void set_should_complete(bool should_complete) {
581 should_complete_ = should_complete;
582 }
David Zeuthen33bae492014-02-25 16:16:18 -0800583 ErrorCode get_code() const { return code_; }
Darin Petkovc1a8b422010-07-19 11:34:49 -0700584
adlr@google.com3defe6a2009-12-04 20:57:17 +0000585 private:
586 ActionProcessor* processor_;
587 AbstractAction* action_;
David Zeuthena99981f2013-04-29 13:42:47 -0700588 ErrorCode code_;
adlr@google.com3defe6a2009-12-04 20:57:17 +0000589 bool should_complete_;
590 DISALLOW_COPY_AND_ASSIGN(ScopedActionCompleter);
591};
592
David Zeuthen27a48bc2013-08-06 12:06:29 -0700593// A base::FreeDeleter that frees memory using g_free(). Useful when
Ben Chan02f7c1d2014-10-18 15:18:02 -0700594// integrating with GLib since it can be used with std::unique_ptr to
David Zeuthen27a48bc2013-08-06 12:06:29 -0700595// automatically free memory when going out of scope.
596struct GLibFreeDeleter : public base::FreeDeleter {
597 inline void operator()(void *ptr) const {
598 g_free(reinterpret_cast<gpointer>(ptr));
599 }
600};
601
602// A base::FreeDeleter that frees memory using g_strfreev(). Useful
Ben Chan02f7c1d2014-10-18 15:18:02 -0700603// when integrating with GLib since it can be used with std::unique_ptr to
David Zeuthen27a48bc2013-08-06 12:06:29 -0700604// automatically free memory when going out of scope.
605struct GLibStrvFreeDeleter : public base::FreeDeleter {
606 inline void operator()(void *ptr) const {
607 g_strfreev(reinterpret_cast<gchar**>(ptr));
608 }
609};
610
adlr@google.com3defe6a2009-12-04 20:57:17 +0000611} // namespace chromeos_update_engine
612
613#define TEST_AND_RETURN_FALSE_ERRNO(_x) \
614 do { \
615 bool _success = (_x); \
616 if (!_success) { \
617 std::string _msg = \
618 chromeos_update_engine::utils::ErrnoNumberAsString(errno); \
619 LOG(ERROR) << #_x " failed: " << _msg; \
620 return false; \
621 } \
622 } while (0)
623
624#define TEST_AND_RETURN_FALSE(_x) \
625 do { \
626 bool _success = (_x); \
627 if (!_success) { \
628 LOG(ERROR) << #_x " failed."; \
629 return false; \
630 } \
631 } while (0)
632
633#define TEST_AND_RETURN_ERRNO(_x) \
634 do { \
635 bool _success = (_x); \
636 if (!_success) { \
637 std::string _msg = \
638 chromeos_update_engine::utils::ErrnoNumberAsString(errno); \
639 LOG(ERROR) << #_x " failed: " << _msg; \
640 return; \
641 } \
642 } while (0)
643
644#define TEST_AND_RETURN(_x) \
645 do { \
646 bool _success = (_x); \
647 if (!_success) { \
648 LOG(ERROR) << #_x " failed."; \
649 return; \
650 } \
651 } while (0)
652
Thieu Le5c7d9752010-12-15 16:09:28 -0800653#define TEST_AND_RETURN_FALSE_ERRCODE(_x) \
654 do { \
655 errcode_t _error = (_x); \
656 if (_error) { \
657 errno = _error; \
658 LOG(ERROR) << #_x " failed: " << _error; \
659 return false; \
660 } \
661 } while (0)
662
Gilad Arnoldcf175a02014-07-10 16:48:47 -0700663#endif // UPDATE_ENGINE_UTILS_H_