forked from RustPython/RustPython
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_imp.rs
More file actions
364 lines (315 loc) · 11.8 KB
/
_imp.rs
File metadata and controls
364 lines (315 loc) · 11.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
use crate::builtins::{PyCode, PyStrInterned};
use crate::frozen::FrozenModule;
use crate::{VirtualMachine, builtins::PyBaseExceptionRef};
use core::borrow::Borrow;
pub(crate) use _imp::module_def;
pub use crate::vm::resolve_frozen_alias;
#[cfg(feature = "threading")]
#[pymodule(sub)]
mod lock {
use crate::{PyResult, VirtualMachine, stdlib::_thread::RawRMutex};
static IMP_LOCK: RawRMutex = RawRMutex::INIT;
#[pyfunction]
fn acquire_lock(_vm: &VirtualMachine) {
acquire_lock_for_fork()
}
#[pyfunction]
fn release_lock(vm: &VirtualMachine) -> PyResult<()> {
if !IMP_LOCK.is_locked() {
Err(vm.new_runtime_error("Global import lock not held"))
} else {
unsafe { IMP_LOCK.unlock() };
Ok(())
}
}
#[pyfunction]
fn lock_held(_vm: &VirtualMachine) -> bool {
IMP_LOCK.is_locked()
}
pub(super) fn acquire_lock_for_fork() {
IMP_LOCK.lock();
}
pub(super) fn release_lock_after_fork_parent() {
if IMP_LOCK.is_locked() && IMP_LOCK.is_owned_by_current_thread() {
unsafe { IMP_LOCK.unlock() };
}
}
/// Reset import lock after fork() — only if held by a dead thread.
///
/// `IMP_LOCK` is a reentrant mutex. If the *current* (surviving) thread
/// held it at fork time, the child must be able to release it normally.
/// Only reset if a now-dead thread was the owner.
///
/// # Safety
///
/// Must only be called from single-threaded child after fork().
#[cfg(unix)]
pub(crate) unsafe fn reinit_after_fork() {
if IMP_LOCK.is_locked() && !IMP_LOCK.is_owned_by_current_thread() {
// Held by a dead thread — reset to unlocked.
unsafe { rustpython_common::lock::zero_reinit_after_fork(&IMP_LOCK) };
}
}
/// Match CPython's `_PyImport_ReInitLock()` + `_PyImport_ReleaseLock()`
/// behavior in the post-fork child:
/// 1) if ownership metadata is stale (dead owner / changed tid), reset;
/// 2) if current thread owns the lock, release it.
#[cfg(unix)]
pub(super) unsafe fn after_fork_child_reinit_and_release() {
unsafe { reinit_after_fork() };
if IMP_LOCK.is_locked() && IMP_LOCK.is_owned_by_current_thread() {
unsafe { IMP_LOCK.unlock() };
}
}
}
/// Re-export for fork safety code in posix.rs
#[cfg(feature = "threading")]
pub(crate) fn acquire_imp_lock_for_fork() {
lock::acquire_lock_for_fork();
}
#[cfg(feature = "threading")]
pub(crate) fn release_imp_lock_after_fork_parent() {
lock::release_lock_after_fork_parent();
}
#[cfg(all(unix, feature = "threading"))]
pub(crate) unsafe fn reinit_imp_lock_after_fork() {
unsafe { lock::reinit_after_fork() }
}
#[cfg(all(unix, feature = "threading"))]
pub(crate) unsafe fn after_fork_child_imp_lock_release() {
unsafe { lock::after_fork_child_reinit_and_release() }
}
#[cfg(not(feature = "threading"))]
#[pymodule(sub)]
mod lock {
use crate::vm::VirtualMachine;
#[pyfunction]
pub(super) const fn acquire_lock(_vm: &VirtualMachine) {}
#[pyfunction]
pub(super) const fn release_lock(_vm: &VirtualMachine) {}
#[pyfunction]
pub(super) const fn lock_held(_vm: &VirtualMachine) -> bool {
false
}
}
#[allow(dead_code)]
enum FrozenError {
BadName, // The given module name wasn't valid.
NotFound, // It wasn't in PyImport_FrozenModules.
Disabled, // -X frozen_modules=off (and not essential)
Excluded, // The PyImport_FrozenModules entry has NULL "code"
// (module is present but marked as unimportable, stops search).
Invalid, // The PyImport_FrozenModules entry is bogus
// (eg. does not contain executable code).
}
impl FrozenError {
fn to_pyexception(&self, mod_name: &str, vm: &VirtualMachine) -> PyBaseExceptionRef {
use FrozenError::*;
let msg = match self {
BadName | NotFound => format!("No such frozen object named {mod_name}"),
Disabled => format!(
"Frozen modules are disabled and the frozen object named {mod_name} is not essential"
),
Excluded => format!("Excluded frozen object named {mod_name}"),
Invalid => format!("Frozen object named {mod_name} is invalid"),
};
vm.new_import_error(msg, vm.ctx.new_utf8_str(mod_name))
}
}
// look_up_frozen + use_frozen in import.c
fn find_frozen(name: &str, vm: &VirtualMachine) -> Result<FrozenModule, FrozenError> {
let frozen = vm
.state
.frozen
.get(name)
.copied()
.ok_or(FrozenError::NotFound)?;
// Bootstrap modules are always available regardless of override flag
if matches!(
name,
"_frozen_importlib" | "_frozen_importlib_external" | "zipimport"
) {
return Ok(frozen);
}
// use_frozen(): override > 0 → true, override < 0 → false, 0 → default (true)
// When disabled, non-bootstrap modules are simply not found (same as look_up_frozen)
let override_val = vm.state.override_frozen_modules.load();
if override_val < 0 {
return Err(FrozenError::NotFound);
}
Ok(frozen)
}
#[pymodule(with(lock))]
mod _imp {
use crate::{
PyObjectRef, PyPayload, PyRef, PyResult, VirtualMachine,
builtins::{PyBytesRef, PyCode, PyMemoryView, PyModule, PyStrRef, PyUtf8StrRef},
convert::TryFromBorrowedObject,
function::OptionalArg,
import, version,
};
#[pyattr]
fn check_hash_based_pycs(vm: &VirtualMachine) -> PyStrRef {
vm.ctx
.new_str(vm.state.config.settings.check_hash_pycs_mode.to_string())
}
#[pyattr(name = "pyc_magic_number_token")]
use version::PYC_MAGIC_NUMBER_TOKEN;
#[pyfunction]
const fn extension_suffixes() -> PyResult<Vec<PyObjectRef>> {
Ok(Vec::new())
}
#[pyfunction]
fn is_builtin(name: PyUtf8StrRef, vm: &VirtualMachine) -> bool {
vm.state.module_defs.contains_key(name.as_str())
}
#[pyfunction]
fn is_frozen(name: PyUtf8StrRef, vm: &VirtualMachine) -> bool {
super::find_frozen(name.as_str(), vm).is_ok()
}
#[pyfunction]
fn create_builtin(spec: PyObjectRef, vm: &VirtualMachine) -> PyResult {
let sys_modules = vm.sys_module.get_attr("modules", vm).unwrap();
let name: PyUtf8StrRef = spec.get_attr("name", vm)?.try_into_value(vm)?;
// Check sys.modules first
if let Ok(module) = sys_modules.get_item(&*name, vm) {
return Ok(module);
}
let name_str = name.as_str();
if let Some(&def) = vm.state.module_defs.get(name_str) {
// Phase 1: Create module (use create slot if provided, else default creation)
let module = if let Some(create) = def.slots.create {
// Custom module creation
create(vm, &spec, def)?
} else {
// Default module creation
PyModule::from_def(def).into_ref(&vm.ctx)
};
// Initialize module dict and methods
// Corresponds to PyModule_FromDefAndSpec: md_def, _add_methods_to_object, PyModule_SetDocString
PyModule::__init_dict_from_def(vm, &module);
module.__init_methods(vm)?;
// Add to sys.modules BEFORE exec (critical for circular import handling)
sys_modules.set_item(name.as_pystr(), module.clone().into(), vm)?;
// Phase 2: Call exec slot (can safely import other modules now)
if let Some(exec) = def.slots.exec {
exec(vm, &module)?;
}
return Ok(module.into());
}
Ok(vm.ctx.none())
}
#[pyfunction]
fn exec_builtin(_mod: PyRef<PyModule>) -> i32 {
// For multi-phase init modules, exec is already called in create_builtin
0
}
#[pyfunction]
fn get_frozen_object(
name: PyUtf8StrRef,
data: OptionalArg<PyObjectRef>,
vm: &VirtualMachine,
) -> PyResult<PyRef<PyCode>> {
if let OptionalArg::Present(data) = data
&& !vm.is_none(&data)
{
let buf = crate::protocol::PyBuffer::try_from_borrowed_object(vm, &data)?;
let contiguous = buf.as_contiguous().ok_or_else(|| {
vm.new_buffer_error("get_frozen_object() requires a contiguous buffer")
})?;
let invalid_err = || {
vm.new_import_error(
format!("Frozen object named '{}' is invalid", name.as_str()),
name.clone().into_wtf8(),
)
};
let bag = crate::builtins::code::PyObjBag(&vm.ctx);
let code =
rustpython_compiler_core::marshal::deserialize_code(&mut &contiguous[..], bag)
.map_err(|_| invalid_err())?;
return Ok(vm.ctx.new_code(code));
}
import::make_frozen(vm, name.as_str())
}
#[pyfunction]
fn init_frozen(name: PyUtf8StrRef, vm: &VirtualMachine) -> PyResult {
import::import_frozen(vm, name.as_str())
}
#[pyfunction]
fn is_frozen_package(name: PyUtf8StrRef, vm: &VirtualMachine) -> PyResult<bool> {
let name_str = name.as_str();
super::find_frozen(name_str, vm)
.map(|frozen| frozen.package)
.map_err(|e| e.to_pyexception(name_str, vm))
}
#[pyfunction]
fn _override_frozen_modules_for_tests(value: isize, vm: &VirtualMachine) {
vm.state.override_frozen_modules.store(value);
}
#[pyfunction]
fn _fix_co_filename(code: PyRef<PyCode>, path: PyStrRef, vm: &VirtualMachine) {
let old_name = code.source_path();
let new_name = vm.ctx.intern_str(path.as_wtf8());
super::update_code_filenames(&code, old_name, new_name);
}
#[pyfunction]
fn _frozen_module_names(vm: &VirtualMachine) -> PyResult<Vec<PyObjectRef>> {
let names = vm
.state
.frozen
.keys()
.map(|&name| vm.ctx.new_utf8_str(name).into())
.collect();
Ok(names)
}
#[allow(clippy::type_complexity)]
#[pyfunction]
fn find_frozen(
name: PyUtf8StrRef,
withdata: OptionalArg<bool>,
vm: &VirtualMachine,
) -> PyResult<Option<(Option<PyRef<PyMemoryView>>, bool, Option<PyStrRef>)>> {
use super::FrozenError::*;
if withdata.into_option().is_some() {
// this is keyword-only argument in CPython
unimplemented!();
}
let name_str = name.as_str();
let info = match super::find_frozen(name_str, vm) {
Ok(info) => info,
Err(NotFound | Disabled | BadName) => return Ok(None),
Err(e) => return Err(e.to_pyexception(name_str, vm)),
};
// When origname is empty (e.g. __hello_only__), return None.
// Otherwise return the resolved alias name.
let origname_str = super::resolve_frozen_alias(name_str);
let origname = if origname_str.is_empty() {
None
} else {
Some(vm.ctx.new_utf8_str(origname_str).into())
};
Ok(Some((None, info.package, origname)))
}
#[pyfunction]
fn source_hash(key: u64, source: PyBytesRef) -> Vec<u8> {
let hash: u64 = crate::common::hash::keyed_hash(key, source.as_bytes());
hash.to_le_bytes().to_vec()
}
}
fn update_code_filenames(
code: &PyCode,
old_name: &'static PyStrInterned,
new_name: &'static PyStrInterned,
) {
let current = code.source_path();
if !core::ptr::eq(current, old_name) && current.as_str() != old_name.as_str() {
return;
}
code.set_source_path(new_name);
for constant in code.code.constants.iter() {
let obj: &crate::PyObject = constant.borrow();
if let Some(inner_code) = obj.downcast_ref::<PyCode>() {
update_code_filenames(inner_code, old_name, new_name);
}
}
}