pythonnet/src/runtime/interop.cs at drop-python2 · filmor/pythonnet · GitHub

History

559 lines (482 loc) · 18.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

using System;

using System.Collections;

using System.Collections.Generic;

using System.Diagnostics;

using System.Runtime.InteropServices;

using System.Reflection;

using System.Text;

using System.Collections.Generic;

namespace Python.Runtime

{

/// <summary>

/// This file defines objects to support binary interop with the Python

/// runtime. Generally, the definitions here need to be kept up to date

/// when moving to new Python versions.

/// </summary>

[Serializable]

[AttributeUsage(AttributeTargets.All)]

public class DocStringAttribute : Attribute

{

public DocStringAttribute(string docStr)

{

DocString = docStr;

}

public string DocString

{

get { return docStr; }

set { docStr = value; }

}

private string docStr;

}

[Serializable]

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Delegate)]

internal class PythonMethodAttribute : Attribute

{

public PythonMethodAttribute()

{

}

[Serializable]

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Delegate)]

internal class ModuleFunctionAttribute : Attribute

{

public ModuleFunctionAttribute()

{

}

[Serializable]

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Delegate)]

internal class ForbidPythonThreadsAttribute : Attribute

{

public ForbidPythonThreadsAttribute()

{

}

[Serializable]

[AttributeUsage(AttributeTargets.Property)]

internal class ModulePropertyAttribute : Attribute

{

public ModulePropertyAttribute()

{

}

internal static class ManagedDataOffsets

{

static ManagedDataOffsets()

{

FieldInfo[] fi = typeof(ManagedDataOffsets).GetFields(BindingFlags.Static | BindingFlags.Public);

for (int i = 0; i < fi.Length; i++)

{

fi[i].SetValue(null, -(i * IntPtr.Size) - IntPtr.Size);

}

size = fi.Length * IntPtr.Size;

}

public static readonly int ob_data;

public static readonly int ob_dict;

private static int BaseOffset(IntPtr type)

{

Debug.Assert(type != IntPtr.Zero);

int typeSize = Marshal.ReadInt32(type, TypeOffset.tp_basicsize);

Debug.Assert(typeSize > 0 && typeSize <= ExceptionOffset.Size());

return typeSize;

}

public static int DataOffset(IntPtr type)

{

return BaseOffset(type) + ob_data;

}

public static int DictOffset(IntPtr type)

{

return BaseOffset(type) + ob_dict;

}

public static int Size { get { return size; } }

private static readonly int size;

}

internal static class OriginalObjectOffsets

{

static OriginalObjectOffsets()

{

int size = IntPtr.Size;

var n = 0; // Py_TRACE_REFS add two pointers to PyObject_HEAD

#if PYTHON_WITH_PYDEBUG

_ob_next = 0;

_ob_prev = 1 * size;

n = 2;

#endif

ob_refcnt = (n + 0) * size;

ob_type = (n + 1) * size;

}

public static int Size { get { return size; } }

private static readonly int size =

#if PYTHON_WITH_PYDEBUG

4 * IntPtr.Size;

#else

2 * IntPtr.Size;

#endif

#if PYTHON_WITH_PYDEBUG

public static int _ob_next;

public static int _ob_prev;

#endif

public static int ob_refcnt;

public static int ob_type;

}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]

internal class ObjectOffset

{

static ObjectOffset()

{

#if PYTHON_WITH_PYDEBUG

_ob_next = OriginalObjectOffsets._ob_next;

_ob_prev = OriginalObjectOffsets._ob_prev;

#endif

ob_refcnt = OriginalObjectOffsets.ob_refcnt;

ob_type = OriginalObjectOffsets.ob_type;

size = OriginalObjectOffsets.Size + ManagedDataOffsets.Size;

}

public static int magic(IntPtr type)

{

return ManagedDataOffsets.DataOffset(type);

}

public static int TypeDictOffset(IntPtr type)

{

return ManagedDataOffsets.DictOffset(type);

}

public static int Size(IntPtr pyType)

{

if (IsException(pyType))

{

return ExceptionOffset.Size();

}

return size;

}

#if PYTHON_WITH_PYDEBUG

public static int _ob_next;

public static int _ob_prev;

#endif

public static int ob_refcnt;

public static int ob_type;

private static readonly int size;

private static bool IsException(IntPtr pyObject)

{

var type = Runtime.PyObject_TYPE(pyObject);

return Runtime.PyType_IsSameAsOrSubtype(type, ofType: Exceptions.BaseException)

|| Runtime.PyType_IsSameAsOrSubtype(type, ofType: Runtime.PyTypeType)

&& Runtime.PyType_IsSubtype(pyObject, Exceptions.BaseException);

}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]

internal class ExceptionOffset

{

static ExceptionOffset()

{

Type type = typeof(ExceptionOffset);

FieldInfo[] fi = type.GetFields(BindingFlags.Static | BindingFlags.Public);

for (int i = 0; i < fi.Length; i++)

{

fi[i].SetValue(null, (i * IntPtr.Size) + OriginalObjectOffsets.Size);

}

size = fi.Length * IntPtr.Size + OriginalObjectOffsets.Size + ManagedDataOffsets.Size;

}

public static int Size() { return size; }

// PyException_HEAD

// (start after PyObject_HEAD)

public static int dict = 0;

public static int args = 0;

public static int traceback = 0;

public static int context = 0;

public static int cause = 0;

public static int suppress_context = 0;

private static readonly int size;

}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]

internal class BytesOffset

{

static BytesOffset()

{

Type type = typeof(BytesOffset);

FieldInfo[] fi = type.GetFields();

int size = IntPtr.Size;

for (int i = 0; i < fi.Length; i++)

{

fi[i].SetValue(null, i * size);

}

/* The *real* layout of a type object when allocated on the heap */

//typedef struct _heaptypeobject {

#if PYTHON_WITH_PYDEBUG

/* _PyObject_HEAD_EXTRA defines pointers to support a doubly-linked list of all live heap objects. */

public static int _ob_next = 0;

public static int _ob_prev = 0;

#endif

// PyObject_VAR_HEAD {

// PyObject_HEAD {

public static int ob_refcnt = 0;

public static int ob_type = 0;

// }

public static int ob_size = 0; /* Number of items in _VAR_iable part */

// }

public static int ob_shash = 0;

public static int ob_sval = 0; /* start of data */

/* Invariants:

* ob_sval contains space for 'ob_size+1' elements.

* ob_sval[ob_size] == 0.

* ob_shash is the hash of the string or -1 if not computed yet.

//} PyBytesObject;

}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]

internal class ModuleDefOffset

{

static ModuleDefOffset()

{

Type type = typeof(ModuleDefOffset);

FieldInfo[] fi = type.GetFields();

int size = IntPtr.Size;

for (int i = 0; i < fi.Length; i++)

{

fi[i].SetValue(null, (i * size) + TypeOffset.ob_size);

}

public static IntPtr AllocModuleDef(string modulename)

{

byte[] ascii = Encoding.ASCII.GetBytes(modulename);

int size = name + ascii.Length + 1;

IntPtr ptr = Marshal.AllocHGlobal(size);

for (int i = 0; i <= m_free; i += IntPtr.Size)

Marshal.WriteIntPtr(ptr, i, IntPtr.Zero);

Marshal.Copy(ascii, 0, (IntPtr)(ptr + name), ascii.Length);

Marshal.WriteIntPtr(ptr, m_name, (IntPtr)(ptr + name));

Marshal.WriteByte(ptr, name + ascii.Length, 0);

return ptr;

}

public static void FreeModuleDef(IntPtr ptr)

{

Marshal.FreeHGlobal(ptr);

}

// typedef struct PyModuleDef{

// typedef struct PyModuleDef_Base {

// starts after PyObject_HEAD (TypeOffset.ob_type + 1)

public static int m_init = 0;

public static int m_index = 0;

public static int m_copy = 0;

// } PyModuleDef_Base

public static int m_name = 0;

public static int m_doc = 0;

public static int m_size = 0;

public static int m_methods = 0;

public static int m_reload = 0;

public static int m_traverse = 0;

public static int m_clear = 0;

public static int m_free = 0;

// } PyModuleDef

public static int name = 0;

}

/// <summary>

/// TypeFlags(): The actual bit values for the Type Flags stored

/// in a class.

/// Note that the two values reserved for stackless have been put

/// to good use as PythonNet specific flags (Managed and Subclass)

/// </summary>

internal class TypeFlags

{

public static int HeapType = (1 << 9);

public static int BaseType = (1 << 10);

public static int Ready = (1 << 12);

public static int Readying = (1 << 13);

public static int HaveGC = (1 << 14);

// 15 and 16 are reserved for stackless

public static int HaveStacklessExtension = 0;

/* XXX Reusing reserved constants */

public static int Managed = (1 << 15); // PythonNet specific

public static int Subclass = (1 << 16); // PythonNet specific

public static int HaveIndex = (1 << 17);

/* Objects support nb_index in PyNumberMethods */

public static int HaveVersionTag = (1 << 18);

public static int ValidVersionTag = (1 << 19);

public static int IsAbstract = (1 << 20);

public static int HaveNewBuffer = (1 << 21);

// TODO: Implement FastSubclass functions

public static int IntSubclass = (1 << 23);

public static int LongSubclass = (1 << 24);

public static int ListSubclass = (1 << 25);

public static int TupleSubclass = (1 << 26);

public static int StringSubclass = (1 << 27);

public static int UnicodeSubclass = (1 << 28);

public static int DictSubclass = (1 << 29);

public static int BaseExceptionSubclass = (1 << 30);

public static int TypeSubclass = (1 << 31);

public static int Default = (

HaveStacklessExtension |

HaveVersionTag);

}

// This class defines the function prototypes (delegates) used for low

// level integration with the CPython runtime. It also provides name

// based lookup of the correct prototype for a particular Python type

// slot and utilities for generating method thunks for managed methods.

internal class Interop

{

private static List<ThunkInfo> keepAlive;

private static Hashtable pmap;

static Interop()

{

// Here we build a mapping of PyTypeObject slot names to the

// appropriate prototype (delegate) type to use for the slot.

Type[] items = typeof(Interop).GetNestedTypes();

Hashtable p = new Hashtable();

for (int i = 0; i < items.Length; i++)

{

Type item = items[i];

p[item.Name] = item;

}

keepAlive = new List<ThunkInfo>();

pmap = new Hashtable();

pmap["tp_dealloc"] = p["DestructorFunc"];

pmap["tp_print"] = p["PrintFunc"];

pmap["tp_getattr"] = p["BinaryFunc"];

pmap["tp_setattr"] = p["ObjObjArgFunc"];

pmap["tp_compare"] = p["ObjObjFunc"];

pmap["tp_repr"] = p["UnaryFunc"];

pmap["tp_hash"] = p["UnaryFunc"];

pmap["tp_call"] = p["TernaryFunc"];

pmap["tp_str"] = p["UnaryFunc"];

pmap["tp_getattro"] = p["BinaryFunc"];

pmap["tp_setattro"] = p["ObjObjArgFunc"];

pmap["tp_traverse"] = p["ObjObjArgFunc"];

pmap["tp_clear"] = p["InquiryFunc"];

pmap["tp_richcompare"] = p["RichCmpFunc"];

pmap["tp_iter"] = p["UnaryFunc"];

pmap["tp_iternext"] = p["UnaryFunc"];

pmap["tp_descr_get"] = p["TernaryFunc"];

pmap["tp_descr_set"] = p["ObjObjArgFunc"];

pmap["tp_init"] = p["ObjObjArgFunc"];

pmap["tp_alloc"] = p["IntArgFunc"];

pmap["tp_new"] = p["TernaryFunc"];

pmap["tp_free"] = p["DestructorFunc"];

pmap["tp_is_gc"] = p["InquiryFunc"];

pmap["nb_add"] = p["BinaryFunc"];

pmap["nb_subtract"] = p["BinaryFunc"];

pmap["nb_multiply"] = p["BinaryFunc"];

pmap["nb_remainder"] = p["BinaryFunc"];

pmap["nb_divmod"] = p["BinaryFunc"];

pmap["nb_power"] = p["TernaryFunc"];

pmap["nb_negative"] = p["UnaryFunc"];

pmap["nb_positive"] = p["UnaryFunc"];

pmap["nb_absolute"] = p["UnaryFunc"];

pmap["nb_nonzero"] = p["InquiryFunc"];

pmap["nb_invert"] = p["UnaryFunc"];

pmap["nb_lshift"] = p["BinaryFunc"];

pmap["nb_rshift"] = p["BinaryFunc"];

pmap["nb_and"] = p["BinaryFunc"];

pmap["nb_xor"] = p["BinaryFunc"];

pmap["nb_or"] = p["BinaryFunc"];

pmap["nb_coerce"] = p["ObjObjFunc"];

pmap["nb_int"] = p["UnaryFunc"];

pmap["nb_long"] = p["UnaryFunc"];

pmap["nb_float"] = p["UnaryFunc"];

pmap["nb_oct"] = p["UnaryFunc"];

pmap["nb_hex"] = p["UnaryFunc"];

pmap["nb_inplace_add"] = p["BinaryFunc"];

pmap["nb_inplace_subtract"] = p["BinaryFunc"];

pmap["nb_inplace_multiply"] = p["BinaryFunc"];

pmap["nb_inplace_remainder"] = p["BinaryFunc"];

pmap["nb_inplace_power"] = p["TernaryFunc"];

pmap["nb_inplace_lshift"] = p["BinaryFunc"];

pmap["nb_inplace_rshift"] = p["BinaryFunc"];

pmap["nb_inplace_and"] = p["BinaryFunc"];

pmap["nb_inplace_xor"] = p["BinaryFunc"];

pmap["nb_inplace_or"] = p["BinaryFunc"];

pmap["nb_floor_divide"] = p["BinaryFunc"];

pmap["nb_true_divide"] = p["BinaryFunc"];

pmap["nb_inplace_floor_divide"] = p["BinaryFunc"];

pmap["nb_inplace_true_divide"] = p["BinaryFunc"];

pmap["nb_index"] = p["UnaryFunc"];

pmap["sq_length"] = p["InquiryFunc"];

pmap["sq_concat"] = p["BinaryFunc"];

pmap["sq_repeat"] = p["IntArgFunc"];

pmap["sq_item"] = p["IntArgFunc"];

pmap["sq_slice"] = p["IntIntArgFunc"];

pmap["sq_ass_item"] = p["IntObjArgFunc"];

pmap["sq_ass_slice"] = p["IntIntObjArgFunc"];

pmap["sq_contains"] = p["ObjObjFunc"];

pmap["sq_inplace_concat"] = p["BinaryFunc"];

pmap["sq_inplace_repeat"] = p["IntArgFunc"];

pmap["mp_length"] = p["InquiryFunc"];

pmap["mp_subscript"] = p["BinaryFunc"];

pmap["mp_ass_subscript"] = p["ObjObjArgFunc"];

pmap["bf_getreadbuffer"] = p["IntObjArgFunc"];

pmap["bf_getwritebuffer"] = p["IntObjArgFunc"];

pmap["bf_getsegcount"] = p["ObjObjFunc"];

pmap["bf_getcharbuffer"] = p["IntObjArgFunc"];

}

internal static Type GetPrototype(string name)

{

return pmap[name] as Type;

}

internal static ThunkInfo GetThunk(MethodInfo method, string funcType = null)

{

Type dt;

if (funcType != null)

dt = typeof(Interop).GetNestedType(funcType) as Type;

else

dt = GetPrototype(method.Name);

if (dt == null)

{

return ThunkInfo.Empty;

}

Delegate d = Delegate.CreateDelegate(dt, method);

var info = new ThunkInfo(d);

// TODO: remove keepAlive when #958 merged, let the lifecycle of ThunkInfo transfer to caller.

keepAlive.Add(info);

return info;

}