Files
swift-mirror/lib/SILOptimizer/FunctionSignatureTransforms/ExistentialTransform.h
Andrew Trick bddc69c8a6 Organize SILOptimizer/Utils headers. Remove Local.h.
The XXOptUtils.h convention is already established and parallels
the SIL/XXUtils convention.

New:
- InstOptUtils.h
- CFGOptUtils.h
- BasicBlockOptUtils.h
- ValueLifetime.h

Removed:
- Local.h
- Two conflicting CFG.h files

This reorganization is helpful before I introduce more
utilities for block cloning similar to SinkAddressProjections.

Move the control flow utilies out of Local.h, which was an
unreadable, unprincipled mess. Rename it to InstOptUtils.h, and
confine it to small APIs for working with individual instructions.
These are the optimizer's additions to /SIL/InstUtils.h.

Rename CFG.h to CFGOptUtils.h and remove the one in /Analysis. Now
there is only SIL/CFG.h, resolving the naming conflict within the
swift project (this has always been a problem for source tools). Limit
this header to low-level APIs for working with branches and CFG edges.

Add BasicBlockOptUtils.h for block level transforms (it makes me sad
that I can't use BBOptUtils.h, but SIL already has
BasicBlockUtils.h). These are larger APIs for cloning or removing
whole blocks.
2019-10-02 11:34:54 -07:00

106 lines
3.6 KiB
C++

//===---- ExistentialSpecializerTransform.h - Existential Specializer -----===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// This contains utilities for transforming existential args to generics.
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_SIL_EXISTENTIALTRANSFORM_H
#define SWIFT_SIL_EXISTENTIALTRANSFORM_H
#include "FunctionSignatureOpts.h"
#include "swift/SIL/SILFunction.h"
#include "swift/SIL/SILInstruction.h"
#include "swift/SILOptimizer/Utils/Existential.h"
#include "swift/SILOptimizer/Utils/InstOptUtils.h"
#include "swift/SILOptimizer/Utils/SILOptFunctionBuilder.h"
#include "swift/SILOptimizer/Utils/SpecializationMangler.h"
#include "llvm/ADT/SmallBitVector.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Debug.h"
namespace swift {
/// A descriptor to carry information from ExistentialTransform analysis
/// to transformation.
struct ExistentialTransformArgumentDescriptor {
OpenedExistentialAccess AccessType;
bool isConsumed;
};
/// ExistentialTransform creates a protocol constrained generic and a thunk.
class ExistentialTransform {
/// Function Builder to create a new thunk.
SILOptFunctionBuilder &FunctionBuilder;
/// The original function to analyze and transform.
SILFunction *F;
/// The newly created inner function.
SILFunction *NewF;
/// The function signature mangler we are using.
Mangle::FunctionSignatureSpecializationMangler &Mangler;
/// List of arguments and their descriptors to specialize
llvm::SmallDenseMap<int, ExistentialTransformArgumentDescriptor>
&ExistentialArgDescriptor;
/// Argument to Generic Type Map for NewF.
llvm::SmallDenseMap<int, GenericTypeParamType *> ArgToGenericTypeMap;
/// Allocate the argument descriptors.
llvm::SmallVector<ArgumentDescriptor, 4> &ArgumentDescList;
/// Create the Devirtualized Inner Function.
void createExistentialSpecializedFunction();
/// Create new generic arguments from existential arguments.
void
convertExistentialArgTypesToGenericArgTypes(
SmallVectorImpl<GenericTypeParamType *> &genericParams,
SmallVectorImpl<Requirement> &requirements);
/// Create a name for the inner function.
std::string createExistentialSpecializedFunctionName();
/// Create the new devirtualized protocol function signature.
CanSILFunctionType createExistentialSpecializedFunctionType();
/// Create the thunk.
void populateThunkBody();
public:
/// Constructor.
ExistentialTransform(
SILOptFunctionBuilder &FunctionBuilder, SILFunction *F,
Mangle::FunctionSignatureSpecializationMangler &Mangler,
llvm::SmallVector<ArgumentDescriptor, 4> &ADL,
llvm::SmallDenseMap<int, ExistentialTransformArgumentDescriptor>
&ExistentialArgDescriptor)
: FunctionBuilder(FunctionBuilder), F(F), NewF(nullptr), Mangler(Mangler),
ExistentialArgDescriptor(ExistentialArgDescriptor),
ArgumentDescList(ADL) {}
/// Return the optimized iner function.
SILFunction *getExistentialSpecializedFunction() { return NewF; }
/// External function for the optimization.
bool run() {
createExistentialSpecializedFunction();
return true;
}
};
} // end namespace swift
#endif