osfmk/vm/vm_compressor_algorithms.h

   1 /*
   2  * Copyright (c) 2000-2016 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 #pragma once
  30
  31 #if XNU_KERNEL_PRIVATE
  32 //DRKTODO: the decompression side stats should be either made optional or
  33 //per-CPU to avoid cacheline contention
  34
  35 typedef struct {
  36         uint64_t lz4_compressions;
  37         uint64_t lz4_compression_failures;
  38         uint64_t lz4_compressed_bytes;
  39         uint64_t lz4_wk_compression_delta;
  40         uint64_t lz4_wk_compression_negative_delta;
  41         uint64_t lz4_post_wk_compressions;
  42
  43         uint64_t wk_compressions;
  44         uint64_t wk_sv_compressions;
  45         uint64_t wk_mzv_compressions;
  46         uint64_t wk_compression_failures;
  47         uint64_t wk_compressed_bytes_total;
  48         uint64_t wk_compressions_exclusive;
  49         uint64_t wk_compressed_bytes_exclusive;
  50
  51         uint64_t lz4_decompressions;
  52         uint64_t lz4_decompressed_bytes;
  53         uint64_t uc_decompressions;
  54
  55         uint64_t wk_decompressions;
  56         uint64_t wk_decompressed_bytes;
  57         uint64_t wk_sv_decompressions;
  58 } compressor_stats_t;
  59
  60 extern compressor_stats_t compressor_stats;
  61
  62 typedef struct {
  63         uint32_t lz4_selection_max;
  64         int32_t wkdm_reeval_threshold;
  65         int32_t lz4_threshold;
  66         uint32_t lz4_max_failure_skips;
  67         uint32_t lz4_max_failure_run_length;
  68         uint32_t lz4_max_preselects;
  69         uint32_t lz4_run_preselection_threshold;
  70         uint32_t lz4_run_continue_bytes;
  71         uint32_t lz4_profitable_bytes;
  72 } compressor_tuneables_t;
  73
  74 extern compressor_tuneables_t vmctune;
  75
  76 int metacompressor(const uint8_t *in, uint8_t *cdst, int32_t outbufsz, uint16_t *codec, void *cscratch);
  77 void metadecompressor(const uint8_t *source, uint8_t *dest, uint32_t csize, uint16_t ccodec, void *compressor_dscratch);
  78
  79 typedef enum {
  80         CCWK = 0, // must be 0 or 1
  81         CCLZ4 = 1, //must be 0 or 1
  82         CINVALID = 0xFFFF
  83 } vm_compressor_codec_t;
  84
  85 typedef enum {
  86         CMODE_WK = 0,
  87         CMODE_LZ4 = 1,
  88         CMODE_HYB = 2,
  89         VM_COMPRESSOR_DEFAULT_CODEC = 3,
  90         CMODE_INVALID = 4
  91 } vm_compressor_mode_t;
  92
  93 void vm_compressor_algorithm_init(void);
  94 int vm_compressor_algorithm(void);
  95 #endif /* XNU_KERNEL_PRIVATE */