mtree/metrics.h

   1 /*
   2 * Copyright (c) 2020 Apple Inc. All rights reserved.
   3 *
   4 * @APPLE_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. Please obtain a copy of the License at
  10 * http://www.opensource.apple.com/apsl/ and read it before using this
  11 * file.
  12 *
  13 * The Original Code and all software distributed under the License are
  14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18 * Please see the License for the specific language governing rights and
  19 * limitations under the License.
  20 *
  21 * @APPLE_LICENSE_HEADER_END@
  22 */
  23
  24 #ifndef _METRICS_H_
  25 #define _METRICS_H_
  26
  27 #include <sys/time.h>
  28 #include <stdio.h>
  29
  30 // mtree error logging
  31 enum mtree_result {
  32         SUCCESS = 0,
  33         WARN_TIME = -1,
  34         WARN_USAGE = -2,
  35         WARN_CHECKSUM = -3,
  36         WARN_MISMATCH = -4,
  37         WARN_UNAME = -5,
  38         /* Could also be a POSIX errno value */
  39 };
  40
  41 void set_metrics_file(FILE *file);
  42 void set_metric_start_time(time_t time);
  43 void set_metric_path(char *path);
  44 #define RECORD_FAILURE(location, error) mtree_record_failure(location, error)
  45 void mtree_record_failure(int location, int code);
  46 void print_metrics_to_file(void);
  47
  48 #endif /* _METRICS_H_ */