// Copyright 2020 The Chromium Authors

// Use of this source code is governed by a BSD-style license that can be

// found in the LICENSE file.

#include "base/allocator/partition_alloc_features.h"

#include "base/base_export.h"

#include "base/feature_list.h"

#include "build/build_config.h"

namespace base {

namespace features {

BASE_FEATURE(kPartitionAllocUnretainedDanglingPtr,

"PartitionAllocUnretainedDanglingPtr",

FEATURE_DISABLED_BY_DEFAULT);

constexpr FeatureParam<UnretainedDanglingPtrMode>::Option

kUnretainedDanglingPtrModeOption[] = {

{UnretainedDanglingPtrMode::kCrash, "crash"},

{UnretainedDanglingPtrMode::kDumpWithoutCrashing,

"dump_without_crashing"},

};

const base::FeatureParam<UnretainedDanglingPtrMode>

kUnretainedDanglingPtrModeParam = {

&kPartitionAllocUnretainedDanglingPtr,

"mode",

UnretainedDanglingPtrMode::kDumpWithoutCrashing,

&kUnretainedDanglingPtrModeOption,

};

BASE_FEATURE(kPartitionAllocDanglingPtr,

"PartitionAllocDanglingPtr",

FEATURE_DISABLED_BY_DEFAULT);

constexpr FeatureParam<DanglingPtrMode>::Option kDanglingPtrModeOption[] = {

{DanglingPtrMode::kCrash, "crash"},

{DanglingPtrMode::kLogSignature, "log_signature"},

};

const base::FeatureParam<DanglingPtrMode> kDanglingPtrModeParam{

&kPartitionAllocDanglingPtr,

"mode",

DanglingPtrMode::kCrash,

&kDanglingPtrModeOption,

};

#if defined(PA_ALLOW_PCSCAN)

// If enabled, PCScan is turned on by default for all partitions that don't

// disable it explicitly.

BASE_FEATURE(kPartitionAllocPCScan,

"PartitionAllocPCScan",

FEATURE_DISABLED_BY_DEFAULT);

#endif // defined(PA_ALLOW_PCSCAN)

#if BUILDFLAG(USE_PARTITION_ALLOC_AS_MALLOC)

// If enabled, PCScan is turned on only for the browser's malloc partition.

BASE_FEATURE(kPartitionAllocPCScanBrowserOnly,

"PartitionAllocPCScanBrowserOnly",

FEATURE_DISABLED_BY_DEFAULT);

// If enabled, PCScan is turned on only for the renderer's malloc partition.

BASE_FEATURE(kPartitionAllocPCScanRendererOnly,

"PartitionAllocPCScanRendererOnly",

FEATURE_DISABLED_BY_DEFAULT);

// If enabled, this instance belongs to the Control group of the BackupRefPtr

// binary experiment.

BASE_FEATURE(kPartitionAllocBackupRefPtrControl,

"PartitionAllocBackupRefPtrControl",

FEATURE_DISABLED_BY_DEFAULT);

// Use a larger maximum thread cache cacheable bucket size.

BASE_FEATURE(kPartitionAllocLargeThreadCacheSize,

"PartitionAllocLargeThreadCacheSize",

#if BUILDFLAG(IS_ANDROID) && defined(ARCH_CPU_32_BITS)

// Not unconditionally enabled on 32 bit Android, since it is a

// more memory-constrained platform.

FEATURE_DISABLED_BY_DEFAULT

#else

FEATURE_ENABLED_BY_DEFAULT

#endif

);

BASE_FEATURE(kPartitionAllocLargeEmptySlotSpanRing,

"PartitionAllocLargeEmptySlotSpanRing",

FEATURE_DISABLED_BY_DEFAULT);

#endif // BUILDFLAG(USE_PARTITION_ALLOC_AS_MALLOC)

BASE_FEATURE(kPartitionAllocBackupRefPtr,

"PartitionAllocBackupRefPtr",

#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_WIN) || \

(BUILDFLAG(USE_ASAN_BACKUP_REF_PTR) && BUILDFLAG(IS_LINUX))

FEATURE_ENABLED_BY_DEFAULT

#else

FEATURE_DISABLED_BY_DEFAULT

#endif

);

constexpr FeatureParam<BackupRefPtrEnabledProcesses>::Option

kBackupRefPtrEnabledProcessesOptions[] = {

{BackupRefPtrEnabledProcesses::kBrowserOnly, "browser-only"},

{BackupRefPtrEnabledProcesses::kBrowserAndRenderer,

"browser-and-renderer"},

{BackupRefPtrEnabledProcesses::kNonRenderer, "non-renderer"},

{BackupRefPtrEnabledProcesses::kAllProcesses, "all-processes"}};

const base::FeatureParam<BackupRefPtrEnabledProcesses>

kBackupRefPtrEnabledProcessesParam{

&kPartitionAllocBackupRefPtr, "enabled-processes",

#if BUILDFLAG(IS_ANDROID) || BUILDFLAG(IS_WIN) || \

(BUILDFLAG(USE_ASAN_BACKUP_REF_PTR) && BUILDFLAG(IS_LINUX))

BackupRefPtrEnabledProcesses::kNonRenderer,

#else

BackupRefPtrEnabledProcesses::kBrowserOnly,

#endif

&kBackupRefPtrEnabledProcessesOptions

};

constexpr FeatureParam<BackupRefPtrMode>::Option kBackupRefPtrModeOptions[] = {

{BackupRefPtrMode::kDisabled, "disabled"},

{BackupRefPtrMode::kEnabled, "enabled"},

{BackupRefPtrMode::kEnabledWithoutZapping, "enabled-without-zapping"},

{BackupRefPtrMode::kDisabledButSplitPartitions2Way,

"disabled-but-2-way-split"},

{BackupRefPtrMode::kDisabledButSplitPartitions3Way,

"disabled-but-3-way-split"},

};

const base::FeatureParam<BackupRefPtrMode> kBackupRefPtrModeParam{

&kPartitionAllocBackupRefPtr, "brp-mode", BackupRefPtrMode::kEnabled,

&kBackupRefPtrModeOptions};

const base::FeatureParam<bool> kBackupRefPtrAsanEnableDereferenceCheckParam{

&kPartitionAllocBackupRefPtr, "asan-enable-dereference-check", true};

const base::FeatureParam<bool> kBackupRefPtrAsanEnableExtractionCheckParam{

&kPartitionAllocBackupRefPtr, "asan-enable-extraction-check",

false}; // Not much noise at the moment to enable by default.

const base::FeatureParam<bool> kBackupRefPtrAsanEnableInstantiationCheckParam{

&kPartitionAllocBackupRefPtr, "asan-enable-instantiation-check", true};

// If enabled, switches the bucket distribution to an alternate one. Only one of

// these features may b e enabled at a time.

BASE_FEATURE(kPartitionAllocUseAlternateDistribution,

"PartitionAllocUseAlternateDistribution",

FEATURE_DISABLED_BY_DEFAULT);

const base::FeatureParam<AlternateBucketDistributionMode>::Option

kPartitionAllocAlternateDistributionOption[] = {

{AlternateBucketDistributionMode::kDefault, "default"},

{AlternateBucketDistributionMode::kCoarser, "coarser"},

{AlternateBucketDistributionMode::kDenser, "denser"},

};

const base::FeatureParam<AlternateBucketDistributionMode>

kPartitionAllocAlternateBucketDistributionParam{

&kPartitionAllocUseAlternateDistribution, "mode",

AlternateBucketDistributionMode::kDefault,

&kPartitionAllocAlternateDistributionOption};

// If enabled, switches PCScan scheduling to a mutator-aware scheduler. Does not

// affect whether PCScan is enabled itself.

BASE_FEATURE(kPartitionAllocPCScanMUAwareScheduler,

"PartitionAllocPCScanMUAwareScheduler",

FEATURE_ENABLED_BY_DEFAULT);

// If enabled, PCScan frees unconditionally all quarantined objects.

// This is a performance testing feature.

BASE_FEATURE(kPartitionAllocPCScanImmediateFreeing,

"PartitionAllocPCScanImmediateFreeing",

FEATURE_DISABLED_BY_DEFAULT);

// If enabled, PCScan clears eagerly (synchronously) on free().

BASE_FEATURE(kPartitionAllocPCScanEagerClearing,

"PartitionAllocPCScanEagerClearing",

FEATURE_DISABLED_BY_DEFAULT);

// In addition to heap, scan also the stack of the current mutator.

BASE_FEATURE(kPartitionAllocPCScanStackScanning,

"PartitionAllocPCScanStackScanning",

#if defined(PA_PCSCAN_STACK_SUPPORTED)

FEATURE_ENABLED_BY_DEFAULT

#else

FEATURE_DISABLED_BY_DEFAULT

#endif // defined(PA_PCSCAN_STACK_SUPPORTED)

);

BASE_FEATURE(kPartitionAllocDCScan,

"PartitionAllocDCScan",

FEATURE_DISABLED_BY_DEFAULT);

// Whether to sort the active slot spans in PurgeMemory().

BASE_FEATURE(kPartitionAllocSortActiveSlotSpans,

"PartitionAllocSortActiveSlotSpans",

FEATURE_DISABLED_BY_DEFAULT);

} // namespace features

} // namespace base