pythonnet/src/runtime/runtime_data.cs at precise-API-references · ra2003/pythonnet · GitHub

Repository navigation

History

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

using System;

using System.Collections;

using System.Collections.Generic;

using System.Collections.ObjectModel;

using System.Diagnostics;

using System.IO;

using System.Linq;

using System.Runtime.InteropServices;

using System.Runtime.Serialization;

using System.Runtime.Serialization.Formatters.Binary;

using Python.Runtime.StateSerialization;

using static Python.Runtime.Runtime;

namespace Python.Runtime

{

public static class RuntimeData

{

private static Type _formatterType;

public static Type FormatterType

{

get => _formatterType;

set

{

if (!typeof(IFormatter).IsAssignableFrom(value))

{

throw new ArgumentException("Not a type implemented IFormatter");

}

_formatterType = value;

}

public static ICLRObjectStorer WrappersStorer { get; set; }

/// <summary>

/// Clears the old "clr_data" entry if a previous one is present.

/// </summary>

static void ClearCLRData ()

{

BorrowedReference capsule = PySys_GetObject("clr_data");

if (!capsule.IsNull)

{

IntPtr oldData = PyCapsule_GetPointer(capsule, IntPtr.Zero);

PyMem_Free(oldData);

PyCapsule_SetPointer(capsule, IntPtr.Zero);

}

internal static void Stash()

{

var runtimeStorage = new PythonNetState

{

Metatype = MetaType.SaveRuntimeData(),

ImportHookState = ImportHook.SaveRuntimeData(),

Types = TypeManager.SaveRuntimeData(),

Classes = ClassManager.SaveRuntimeData(),

SharedObjects = SaveRuntimeDataObjects(),

};

IFormatter formatter = CreateFormatter();

var ms = new MemoryStream();

formatter.Serialize(ms, runtimeStorage);

Debug.Assert(ms.Length <= int.MaxValue);

byte[] data = ms.GetBuffer();

// TODO: use buffer api instead

IntPtr mem = PyMem_Malloc(ms.Length + IntPtr.Size);

Marshal.WriteIntPtr(mem, (IntPtr)ms.Length);

Marshal.Copy(data, 0, mem + IntPtr.Size, (int)ms.Length);

ClearCLRData();

using NewReference capsule = PyCapsule_New(mem, IntPtr.Zero, IntPtr.Zero);

int res = PySys_SetObject("clr_data", capsule.BorrowOrThrow());

PythonException.ThrowIfIsNotZero(res);

}

internal static void RestoreRuntimeData()

{

try

{

RestoreRuntimeDataImpl();

}

finally

{

ClearStash();

}

private static void RestoreRuntimeDataImpl()

{

BorrowedReference capsule = PySys_GetObject("clr_data");

if (capsule.IsNull)

{

return;

}

IntPtr mem = PyCapsule_GetPointer(capsule, IntPtr.Zero);

int length = (int)Marshal.ReadIntPtr(mem);

byte[] data = new byte[length];

Marshal.Copy(mem + IntPtr.Size, data, 0, length);

var ms = new MemoryStream(data);

var formatter = CreateFormatter();

var storage = (PythonNetState)formatter.Deserialize(ms);

PyCLRMetaType = MetaType.RestoreRuntimeData(storage.Metatype);

var objs = RestoreRuntimeDataObjects(storage.SharedObjects);

// RestoreRuntimeDataModules(storage.Assmeblies);

TypeManager.RestoreRuntimeData(storage.Types);

var clsObjs = ClassManager.RestoreRuntimeData(storage.Classes);

ImportHook.RestoreRuntimeData(storage.ImportHookState);

foreach (var item in objs)

{

item.Value.ExecutePostActions();

#warning XDecref(item.Key.pyHandle);

}

foreach (var item in clsObjs)

{

item.Value.ExecutePostActions();

}

public static bool HasStashData()

{

return !PySys_GetObject("clr_data").IsNull;

}

public static void ClearStash()

{

PySys_SetObject("clr_data", default);

}

static bool CheckSerializable (object o)

{

Type type = o.GetType();

{

if (!type.IsSerializable)

{

return false;

}

} while ((type = type.BaseType) != null);

return true;

}

private static SharedObjectsState SaveRuntimeDataObjects()

{

var objs = ManagedType.GetManagedObjects();

var extensionObjs = new List<ManagedType>();

var wrappers = new Dictionary<object, List<CLRObject>>();

var userObjects = new CLRWrapperCollection();

var contexts = new Dictionary<PyObject, InterDomainContext>(PythonReferenceComparer.Instance);

foreach (var entry in objs)

{

var obj = entry.Key;

XIncref(obj.pyHandle);

switch (entry.Value)

{

case ManagedType.TrackTypes.Extension:

Debug.Assert(CheckSerializable(obj));

var context = new InterDomainContext();

contexts[obj.pyHandle] = context;

obj.Save(context);

extensionObjs.Add(obj);

break;

case ManagedType.TrackTypes.Wrapper:

// Wrapper must be the CLRObject

var clrObj = (CLRObject)obj;

object inst = clrObj.inst;

CLRMappedItem item;

List<CLRObject> mappedObjs;

if (!userObjects.TryGetValue(inst, out item))

{

item = new CLRMappedItem(inst);

userObjects.Add(item);

Debug.Assert(!wrappers.ContainsKey(inst));

mappedObjs = new List<CLRObject>();

wrappers.Add(inst, mappedObjs);

}

else

{

mappedObjs = wrappers[inst];

}

item.AddRef(clrObj.pyHandle);

mappedObjs.Add(clrObj);

break;

default:

break;

}

var wrapperStorage = new RuntimeDataStorage();

WrappersStorer?.Store(userObjects, wrapperStorage);

var internalStores = new List<CLRObject>();

foreach (var item in userObjects)

{

if (!CheckSerializable(item.Instance))

{

continue;

}

internalStores.AddRange(wrappers[item.Instance]);

foreach (var clrObj in wrappers[item.Instance])

{

XIncref(clrObj.pyHandle);

var context = new InterDomainContext();

contexts[clrObj.pyHandle] = context;

clrObj.Save(context);

}

return new()

{

InternalStores = internalStores,

Extensions = extensionObjs,

Wrappers = wrapperStorage,

Contexts = contexts,

};

}

private static Dictionary<ManagedType, InterDomainContext> RestoreRuntimeDataObjects(SharedObjectsState storage)

{

var extensions = storage.Extensions;

var internalStores = storage.InternalStores;

var contexts = storage.Contexts;

var storedObjs = new Dictionary<ManagedType, InterDomainContext>();

foreach (var obj in Enumerable.Union(extensions, internalStores))

{

var context = contexts[obj.pyHandle];

obj.Load(context);

storedObjs.Add(obj, context);

}

if (WrappersStorer != null)

{

var wrapperStorage = storage.Wrappers;

var handle2Obj = WrappersStorer.Restore(wrapperStorage);

foreach (var item in handle2Obj)

{

object obj = item.Instance;

foreach (var pyRef in item.PyRefs ?? new List<PyObject>())

{

var context = contexts[pyRef];

var co = CLRObject.Restore(obj, pyRef, context);

storedObjs.Add(co, context);

}

return storedObjs;

}

private static IFormatter CreateFormatter()

{

return FormatterType != null ?

(IFormatter)Activator.CreateInstance(FormatterType)

: new BinaryFormatter();

}

[Serializable]

public class RuntimeDataStorage

{

private Stack _stack;

private Dictionary<string, object> _namedValues;

public T AddValue<T>(string name, T value)

{

if (_namedValues == null)

{

_namedValues = new Dictionary<string, object>();

}

_namedValues.Add(name, value);

return value;

}

public object GetValue(string name)

{

return _namedValues[name];

}

public T GetValue<T>(string name)

{

return (T)GetValue(name);

}

public T GetValue<T>(string name, out T value)

{

value = GetValue<T>(name);

return value;

}

public RuntimeDataStorage GetStorage(string name)

{

return GetValue<RuntimeDataStorage>(name);

}

public T PushValue<T>(T value)

{

if (_stack == null)

{

_stack = new Stack();

}

_stack.Push(value);

return value;

}

public object PopValue()

{

return _stack.Pop();

}

public T PopValue<T>()

{

return (T)PopValue();

}

public T PopValue<T>(out T value)

{

return value = (T)PopValue();

}

[Serializable]

class InterDomainContext

{

private RuntimeDataStorage _storage;

public RuntimeDataStorage Storage => _storage ?? (_storage = new RuntimeDataStorage());

/// <summary>

/// Actions after loaded.

/// </summary>

[NonSerialized]

private List<Action> _postActions;

public List<Action> PostActions => _postActions ?? (_postActions = new List<Action>());

public void AddPostAction(Action action)

{

PostActions.Add(action);

}

public void ExecutePostActions()

{

if (_postActions == null)

{

return;

}

foreach (var action in _postActions)

{

action();

}

public class CLRMappedItem

{

public object Instance { get; private set; }

public List<PyObject>? PyRefs { get; set; }

public CLRMappedItem(object instance)

{

Instance = instance;

}

internal void AddRef(PyObject pyRef)

{

this.PyRefs ??= new List<PyObject>();

this.PyRefs.Add(pyRef);

}

public interface ICLRObjectStorer

{

ICollection<CLRMappedItem> Store(CLRWrapperCollection wrappers, RuntimeDataStorage storage);

CLRWrapperCollection Restore(RuntimeDataStorage storage);

}

public class CLRWrapperCollection : KeyedCollection<object, CLRMappedItem>

{

public bool TryGetValue(object key, out CLRMappedItem value)

{

if (Dictionary == null)

{

value = null;

return false;

}

return Dictionary.TryGetValue(key, out value);

}

protected override object GetKeyForItem(CLRMappedItem item)

{

return item.Instance;

}

pythonnet/src/runtime/runtime_data.cs at precise-API-references · ra2003/pythonnet · GitHub

Repository navigation

Expand file tree

Breadcrumbs

runtime_data.cs

Latest commit

History

Breadcrumbs

runtime_data.cs

File metadata and controls