dart::compiler::ffi::BaseMarshaller Class Reference

#include <marshaller.h>

Inheritance diagram for dart::compiler::ffi::BaseMarshaller:

Public Member Functions
intptr_t	num_args () const
intptr_t	NumArgumentDefinitions () const
virtual intptr_t	NumDefinitions (intptr_t arg_index) const
virtual intptr_t	NumReturnDefinitions () const =0
bool	ArgumentIndexIsReturn (intptr_t arg_index) const
bool	DefinitionIndexIsReturn (intptr_t def_index_global) const
intptr_t	ArgumentIndex (intptr_t def_index_global) const
intptr_t	FirstDefinitionIndex (intptr_t arg_index) const
intptr_t	DefinitionInArgument (intptr_t def_index_global, intptr_t arg_index) const
intptr_t	DefinitionIndex (intptr_t def_index_in_arg, intptr_t arg_index) const
const NativeLocation &	Location (intptr_t arg_index) const
Representation	RepInDart (intptr_t arg_index) const
virtual Representation	RepInFfiCall (intptr_t def_index_global) const
void	RepsInFfiCall (intptr_t arg_index, GrowableArray< Representation > *out) const
bool	RequiresBitCast (intptr_t index) const
const NativeType &	SignExtendFrom (intptr_t arg_index) const
AbstractTypePtr	CType (intptr_t arg_index) const
AbstractTypePtr	DartType (intptr_t arg_index) const
bool	IsPointerPointer (intptr_t arg_index) const
bool	IsTypedDataPointer (intptr_t arg_index) const
bool	IsCompoundPointer (intptr_t arg_index) const
bool	IsHandleCType (intptr_t arg_index) const
bool	IsBool (intptr_t arg_index) const
bool	IsCompoundCType (intptr_t arg_index) const
bool	IsVoid (intptr_t arg_index) const
bool	ContainsHandles () const
bool	contains_varargs () const
const Function &	dart_signature () const
intptr_t	dart_signature_params_start_at () const
const FunctionType &	c_signature () const
StringPtr	function_name () const
Public Member Functions inherited from dart::ZoneAllocated
	ZoneAllocated ()
void *	operator new (size_t size)
void *	operator new (size_t size, Zone *zone)
void	operator delete (void *pointer)

Protected Member Functions
bool	IsPointerDartType (intptr_t arg_index) const
bool	IsPointerCType (intptr_t arg_index) const
	BaseMarshaller (Zone *zone, const Function &dart_signature, intptr_t dart_signature_params_start_at, const FunctionType &c_signature, const NativeCallingConvention &native_calling_convention)
	~BaseMarshaller ()

Protected Attributes
Zone *	zone_
const Function &	dart_signature_
const intptr_t	dart_signature_params_start_at_
const FunctionType &	c_signature_
const NativeCallingConvention &	native_calling_convention_

Detailed Description

Definition at line 42 of file marshaller.h.

Constructor & Destructor Documentation

BaseMarshaller()

dart::compiler::ffi::BaseMarshaller::BaseMarshaller ( Zone *  zone, const Function &  dart_signature, intptr_t  dart_signature_params_start_at, const FunctionType &  c_signature, const NativeCallingConvention &  native_calling_convention  )

inlineprotected

Definition at line 176 of file marshaller.h.

      : zone_(zone),
        dart_signature_(dart_signature),
        dart_signature_params_start_at_(dart_signature_params_start_at),
        c_signature_(c_signature),
        native_calling_convention_(native_calling_convention) {}

~BaseMarshaller()

dart::compiler::ffi::BaseMarshaller::~BaseMarshaller ( )

inlineprotected

Definition at line 187 of file marshaller.h.

{}

Member Function Documentation

ArgumentIndex()

intptr_t dart::compiler::ffi::BaseMarshaller::ArgumentIndex

(

intptr_t

def_index_global

)

const

Definition at line 367 of file marshaller.cc.

                                                                      {
  if (DefinitionIndexIsReturn(def_index_global)) {
    const intptr_t def = DefinitionInArgument(def_index_global, kResultIndex);
    ASSERT(def < NumReturnDefinitions());
    return kResultIndex;
  }
  ASSERT(def_index_global < NumArgumentDefinitions());
  intptr_t defs = 0;
  intptr_t arg_index = 0;
  for (; arg_index < num_args(); arg_index++) {
    defs += NumDefinitions(arg_index);
    if (defs > def_index_global) {
      return arg_index;
    }
  }
  UNREACHABLE();
}

ArgumentIndexIsReturn()

bool dart::compiler::ffi::BaseMarshaller::ArgumentIndexIsReturn

(

intptr_t

arg_index

)

const

Definition at line 357 of file marshaller.cc.

                                                                   {
  ASSERT(arg_index == kResultIndex || arg_index >= 0);
  return arg_index == kResultIndex;
}

c_signature()

const FunctionType & dart::compiler::ffi::BaseMarshaller::c_signature ( ) const

inline

Definition at line 172 of file marshaller.h.

{ return c_signature_; }

contains_varargs()

bool dart::compiler::ffi::BaseMarshaller::contains_varargs ( ) const

inline

Definition at line 159 of file marshaller.h.

                                {
    return native_calling_convention_.contains_varargs();
  }

ContainsHandles()

bool dart::compiler::ffi::BaseMarshaller::ContainsHandles

(

)

const

Definition at line 245 of file marshaller.cc.

                                           {
  return c_signature_.ContainsHandles();
}

CType()

AbstractTypePtr dart::compiler::ffi::BaseMarshaller::CType

(

intptr_t

arg_index

)

const

Definition at line 108 of file marshaller.cc.

                                                              {
  if (arg_index == kResultIndex) {
    return c_signature_.result_type();
  }
 
  Zone* zone = Thread::Current()->zone();
  const auto& parameter_types =
      Array::Handle(zone, c_signature_.parameter_types());
  const intptr_t parameter_type_length = parameter_types.Length();
  const intptr_t last_param_index = parameter_type_length - 1;
  const auto& last_arg_type = AbstractType::Handle(
      zone, c_signature_.ParameterTypeAt(last_param_index));
  ObjectStore* object_store = IsolateGroup::Current()->object_store();
  const bool has_varargs =
      last_arg_type.type_class() == object_store->varargs_class();
 
  // Skip #0 argument, the function pointer.
  const intptr_t real_arg_index = arg_index + kNativeParamsStartAt;
 
  if (has_varargs && real_arg_index >= last_param_index) {
    // The C-type is nested in a VarArgs.
    const auto& var_args_type_arg = AbstractType::Handle(
        zone, TypeArguments::Handle(zone, Type::Cast(last_arg_type).arguments())
                  .TypeAt(0));
    if (var_args_type_arg.IsRecordType()) {
      const intptr_t index_in_record = real_arg_index - last_param_index;
      const auto& record_type = RecordType::Cast(var_args_type_arg);
      ASSERT(index_in_record < record_type.NumFields());
      return record_type.FieldTypeAt(index_in_record);
    } else {
      ASSERT(!var_args_type_arg.IsNull());
      return var_args_type_arg.ptr();
    }
  }
 
  ASSERT(!AbstractType::Handle(c_signature_.ParameterTypeAt(real_arg_index))
              .IsNull());
  return c_signature_.ParameterTypeAt(real_arg_index);
}

dart_signature()

const Function & dart::compiler::ffi::BaseMarshaller::dart_signature ( ) const

inline

Definition at line 168 of file marshaller.h.

{ return dart_signature_; }

dart_signature_params_start_at()

intptr_t dart::compiler::ffi::BaseMarshaller::dart_signature_params_start_at ( ) const

inline

Definition at line 169 of file marshaller.h.

                                                  {
    return dart_signature_params_start_at_;
  }

DartType()

AbstractTypePtr dart::compiler::ffi::BaseMarshaller::DartType

(

intptr_t

arg_index

)

const

Definition at line 148 of file marshaller.cc.

                                                                 {
  if (arg_index == kResultIndex) {
    return dart_signature_.result_type();
  }
  const intptr_t real_arg_index = arg_index + dart_signature_params_start_at_;
  ASSERT(!Array::Handle(dart_signature_.parameter_types()).IsNull());
  ASSERT(real_arg_index <
         Array::Handle(dart_signature_.parameter_types()).Length());
  ASSERT(!AbstractType::Handle(dart_signature_.ParameterTypeAt(real_arg_index))
              .IsNull());
  return dart_signature_.ParameterTypeAt(real_arg_index);
}

DefinitionInArgument()

intptr_t dart::compiler::ffi::BaseMarshaller::DefinitionInArgument	(	intptr_t	def_index_global,
		intptr_t	arg_index
	)		const

Definition at line 397 of file marshaller.cc.

                                                                        {
  if (ArgumentIndexIsReturn(arg_index)) {
    // Counting down for return definitions.
    const intptr_t def = kResultIndex - def_index_global;
    ASSERT(def < NumReturnDefinitions());
    return def;
  } else {
    // Counting up for arguments in consecutive order.
    const intptr_t def = def_index_global - FirstDefinitionIndex(arg_index);
    ASSERT(def < NumArgumentDefinitions());
    return def;
  }
}

DefinitionIndex()

intptr_t dart::compiler::ffi::BaseMarshaller::DefinitionIndex	(	intptr_t	def_index_in_arg,
		intptr_t	arg_index
	)		const

Definition at line 412 of file marshaller.cc.

                                                                   {
  ASSERT(def_index_in_arg < NumDefinitions(arg_index));
  if (ArgumentIndexIsReturn(arg_index)) {
    return kResultIndex - def_index_in_arg;
  } else {
    return FirstDefinitionIndex(arg_index) + def_index_in_arg;
  }
}

DefinitionIndexIsReturn()

bool dart::compiler::ffi::BaseMarshaller::DefinitionIndexIsReturn

(

intptr_t

def_index_global

)

const

Definition at line 363 of file marshaller.cc.

                                                                            {
  return def_index_global <= kResultIndex;
}

FirstDefinitionIndex()

intptr_t dart::compiler::ffi::BaseMarshaller::FirstDefinitionIndex

(

intptr_t

arg_index

)

const

Definition at line 385 of file marshaller.cc.

                                                                      {
  if (arg_index <= kResultIndex) {
    return kResultIndex;
  }
  ASSERT(arg_index < num_args());
  intptr_t num_defs = 0;
  for (intptr_t i = 0; i < arg_index; i++) {
    num_defs += NumDefinitions(i);
  }
  return num_defs;
}

function_name()

StringPtr dart::compiler::ffi::BaseMarshaller::function_name ( ) const

inline

Definition at line 173 of file marshaller.h.

{ return dart_signature_.name(); }

IsBool()

bool dart::compiler::ffi::BaseMarshaller::IsBool

(

intptr_t

arg_index

)

const

Definition at line 234 of file marshaller.cc.

                                                    {
  return AbstractType::Handle(zone_, CType(arg_index)).type_class_id() ==
         kFfiBoolCid;
}

IsCompoundCType()

bool dart::compiler::ffi::BaseMarshaller::IsCompoundCType

(

intptr_t

arg_index

)

const

Definition at line 240 of file marshaller.cc.

                                                             {
  const auto& c_type = AbstractType::Handle(zone_, CType(arg_index));
  return IsCompound(this->zone_, c_type);
}

IsCompoundPointer()

bool dart::compiler::ffi::BaseMarshaller::IsCompoundPointer

(

intptr_t

arg_index

)

const

Definition at line 215 of file marshaller.cc.

                                                               {
  if (!IsPointerCType(arg_index)) {
    return false;
  }
  if (dart_signature_.parameter_types() == Array::null()) {
    // TODO(https://dartbug.com/54173): BuildGraphOfSyncFfiCallback provides a
    // function object with its type arguments not initialized.
    return false;
  }
 
  const auto& dart_type = AbstractType::Handle(zone_, DartType(arg_index));
  return IsCompound(this->zone_, dart_type);
}

IsHandleCType()

bool dart::compiler::ffi::BaseMarshaller::IsHandleCType

(

intptr_t

arg_index

)

const

Definition at line 229 of file marshaller.cc.

                                                           {
  return AbstractType::Handle(zone_, CType(arg_index)).type_class_id() ==
         kFfiHandleCid;
}

IsPointerCType()

bool dart::compiler::ffi::BaseMarshaller::IsPointerCType ( intptr_t  arg_index ) const

protected

Definition at line 161 of file marshaller.cc.

                                                            {
  return AbstractType::Handle(zone_, CType(arg_index)).type_class_id() ==
         kPointerCid;
}

IsPointerDartType()

bool dart::compiler::ffi::BaseMarshaller::IsPointerDartType ( intptr_t  arg_index ) const

protected

Definition at line 166 of file marshaller.cc.

                                                               {
  return AbstractType::Handle(zone_, DartType(arg_index)).type_class_id() ==
         kPointerCid;
}

IsPointerPointer()

bool dart::compiler::ffi::BaseMarshaller::IsPointerPointer

(

intptr_t

arg_index

)

const

Definition at line 171 of file marshaller.cc.

                                                              {
  if (dart_signature_.parameter_types() == Array::null()) {
    // TODO(https://dartbug.com/54173): BuildGraphOfSyncFfiCallback provides a
    // function object with its type arguments not initialized.
    return IsPointerCType(arg_index);
  }
  return IsPointerDartType(arg_index) && IsPointerCType(arg_index);
}

IsTypedDataPointer()

bool dart::compiler::ffi::BaseMarshaller::IsTypedDataPointer

(

intptr_t

arg_index

)

const

Definition at line 180 of file marshaller.cc.

                                                                {
  if (!IsPointerCType(arg_index)) {
    return false;
  }
  if (IsHandleCType(arg_index)) {
    return false;
  }
 
  if (dart_signature_.parameter_types() == Array::null()) {
    // TODO(https://dartbug.com/54173): BuildGraphOfSyncFfiCallback provides a
    // function object with its type arguments not initialized. Change this
    // to an assert when addressing that issue.
    return false;
  }
 
  const auto& type = AbstractType::Handle(zone_, DartType(arg_index));
  return type.type_class() ==
         Thread::Current()->compiler_state().TypedDataClass().ptr();
}

IsVoid()

bool dart::compiler::ffi::BaseMarshaller::IsVoid ( intptr_t  arg_index ) const

inline

Definition at line 152 of file marshaller.h.

                                        {
    return AbstractType::Handle(zone_, CType(arg_index)).type_class_id() ==
           kFfiVoidCid;
  }

Location()

const NativeLocation & dart::compiler::ffi::BaseMarshaller::Location ( intptr_t  arg_index ) const

inline

Definition at line 71 of file marshaller.h.

                                                           {
    if (arg_index == kResultIndex) {
      return native_calling_convention_.return_location();
    }
    return *native_calling_convention_.argument_locations().At(arg_index);
  }

num_args()

intptr_t dart::compiler::ffi::BaseMarshaller::num_args ( ) const

inline

Definition at line 44 of file marshaller.h.

                            {
    return native_calling_convention_.argument_locations().length();
  }

NumArgumentDefinitions()

intptr_t dart::compiler::ffi::BaseMarshaller::NumArgumentDefinitions

(

)

const

Definition at line 249 of file marshaller.cc.

                                                      {
  intptr_t total = 0;
  for (intptr_t i = 0; i < num_args(); i++) {
    total += NumDefinitions(i);
  }
  return total;
}

NumDefinitions()

intptr_t dart::compiler::ffi::BaseMarshaller::NumDefinitions ( intptr_t  arg_index ) const

virtual

Reimplemented in dart::compiler::ffi::CallMarshaller, and dart::compiler::ffi::CallbackMarshaller.

Definition at line 257 of file marshaller.cc.

                                                                {
  if (ArgumentIndexIsReturn(arg_index)) {
    return NumReturnDefinitions();
  }
 
  const auto& loc = Location(arg_index);
  const auto& type = loc.payload_type();
 
  if (IsCompoundPointer(arg_index)) {
    // typed data base and offset.
    return 2;
  }
  if (type.IsPrimitive()) {
    // All non-struct arguments are 1 definition in IL. Even 64 bit values
    // on 32 bit architectures.
    return 1;
  }
 
  ASSERT(type.IsCompound());
  ASSERT(!loc.IsPointerToMemory());  // Handled in overrides.
  if (loc.IsMultiple()) {
    // One IL definition for every nested location.
    const auto& multiple = loc.AsMultiple();
    return multiple.locations().length();
  }
 
  ASSERT(loc.IsStack());
  // For stack, word size definitions in IL. In FFI calls passed into the
  // native call, in FFI callbacks read in separate NativeParams.
  const intptr_t size_in_bytes = type.SizeInBytes();
  const intptr_t num_defs =
      Utils::RoundUp(size_in_bytes, compiler::target::kWordSize) /
      compiler::target::kWordSize;
  return num_defs;
}

NumReturnDefinitions()

virtual intptr_t dart::compiler::ffi::BaseMarshaller::NumReturnDefinitions ( ) const

pure virtual

Implemented in dart::compiler::ffi::CallMarshaller, and dart::compiler::ffi::CallbackMarshaller.

RepInDart()

Representation dart::compiler::ffi::BaseMarshaller::RepInDart

(

intptr_t

arg_index

)

const

Definition at line 434 of file marshaller.cc.

                                                                 {
  // This should never be called on Pointers or Handles, which are specially
  // handled during marshalling/unmarshalling.
  ASSERT(!IsHandleCType(arg_index));
  ASSERT(!IsPointerPointer(arg_index));
  return Location(arg_index).payload_type().AsRepresentationOverApprox(zone_);
}

RepInFfiCall()

Representation dart::compiler::ffi::BaseMarshaller::RepInFfiCall ( intptr_t  def_index_global ) const

virtual

Reimplemented in dart::compiler::ffi::CallMarshaller, and dart::compiler::ffi::CallbackMarshaller.

Definition at line 444 of file marshaller.cc.

                                                                           {
  intptr_t arg_index = ArgumentIndex(def_index_global);
 
  // Handled appropriately in the subclasses.
  ASSERT(!IsHandleCType(arg_index));
 
  // The IL extracts the address stored in the Pointer object as an untagged
  // pointer before passing it to C, and creates a new Pointer object to store
  // the received untagged pointer when receiving a pointer from C.
  if (IsPointerPointer(arg_index)) return kUntagged;
 
  const auto& location = Location(arg_index);
  if (location.container_type().IsPrimitive()) {
    return SelectRepresentationInIL(zone_, location);
  }
  ASSERT(location.container_type().IsCompound());
 
  if (location.IsStack()) {
    // Split the struct in architecture size chunks.
    return kUnboxedWord;
  }
 
  if (location.IsMultiple()) {
    const intptr_t def_index_in_arg =
        DefinitionInArgument(def_index_global, arg_index);
    const auto& def_loc =
        *(location.AsMultiple().locations()[def_index_in_arg]);
    return SelectRepresentationInIL(zone_, def_loc);
  }
 
  UNREACHABLE();  // Implemented in subclasses.
}

RepsInFfiCall()

void dart::compiler::ffi::BaseMarshaller::RepsInFfiCall	(	intptr_t	arg_index,
		GrowableArray< Representation > *	out
	)		const

Definition at line 551 of file marshaller.cc.

                                                                             {
  const intptr_t num_definitions = NumDefinitions(arg_index);
  const intptr_t first_def = FirstDefinitionIndex(arg_index);
  for (int i = 0; i < num_definitions; i++) {
    out->Add(RepInFfiCall(first_def + i));
  }
}

RequiresBitCast()

bool dart::compiler::ffi::BaseMarshaller::RequiresBitCast ( intptr_t  index ) const

inline

Definition at line 92 of file marshaller.h.

                                             {
    return Location(index).payload_type().IsFloat() &&
           Location(index).container_type().IsInt();
  }

SignExtendFrom()

const NativeType & dart::compiler::ffi::BaseMarshaller::SignExtendFrom ( intptr_t  arg_index ) const

inline

Definition at line 98 of file marshaller.h.

                                                             {
    return Location(arg_index).payload_type();
  }

Member Data Documentation

c_signature_

const FunctionType& dart::compiler::ffi::BaseMarshaller::c_signature_

protected

Definition at line 194 of file marshaller.h.

dart_signature_

const Function& dart::compiler::ffi::BaseMarshaller::dart_signature_

protected

Definition at line 192 of file marshaller.h.

dart_signature_params_start_at_

const intptr_t dart::compiler::ffi::BaseMarshaller::dart_signature_params_start_at_

protected

Definition at line 193 of file marshaller.h.

native_calling_convention_

const NativeCallingConvention& dart::compiler::ffi::BaseMarshaller::native_calling_convention_

protected

Definition at line 195 of file marshaller.h.

zone_

Zone* dart::compiler::ffi::BaseMarshaller::zone_

protected

Definition at line 189 of file marshaller.h.

---

The documentation for this class was generated from the following files:

• third_party/dart-lang/sdk/runtime/vm/compiler/ffi/marshaller.h
• third_party/dart-lang/sdk/runtime/vm/compiler/ffi/marshaller.cc