5 macro_rules! define_handles {
7 'owned: $($oty:ident,)*
8 'interned: $($ity:ident,)*
11 #[allow(non_snake_case)]
12 pub struct HandleCounters {
13 $($oty: AtomicUsize,)*
14 $($ity: AtomicUsize,)*
18 // FIXME(eddyb) use a reference to the `static COUNTERS`, intead of
19 // a wrapper `fn` pointer, once `const fn` can reference `static`s.
20 extern "C" fn get() -> &'static Self {
21 static COUNTERS: HandleCounters = HandleCounters {
22 $($oty: AtomicUsize::new(1),)*
23 $($ity: AtomicUsize::new(1),)*
29 // FIXME(eddyb) generate the definition of `HandleStore` in `server.rs`.
31 #[allow(non_snake_case)]
32 pub(super) struct HandleStore<S: server::Types> {
33 $($oty: handle::OwnedStore<S::$oty>,)*
34 $($ity: handle::InternedStore<S::$ity>,)*
37 impl<S: server::Types> HandleStore<S> {
38 pub(super) fn new(handle_counters: &'static HandleCounters) -> Self {
40 $($oty: handle::OwnedStore::new(&handle_counters.$oty),)*
41 $($ity: handle::InternedStore::new(&handle_counters.$ity),)*
48 pub(crate) struct $oty(handle::Handle);
49 impl !Send for $oty {}
50 impl !Sync for $oty {}
52 // Forward `Drop::drop` to the inherent `drop` method.
59 impl<S> Encode<S> for $oty {
60 fn encode(self, w: &mut Writer, s: &mut S) {
67 impl<S: server::Types> DecodeMut<'_, '_, HandleStore<server::MarkedTypes<S>>>
68 for Marked<S::$oty, $oty>
70 fn decode(r: &mut Reader<'_>, s: &mut HandleStore<server::MarkedTypes<S>>) -> Self {
71 s.$oty.take(handle::Handle::decode(r, &mut ()))
75 impl<S> Encode<S> for &$oty {
76 fn encode(self, w: &mut Writer, s: &mut S) {
81 impl<S: server::Types> Decode<'_, 's, HandleStore<server::MarkedTypes<S>>>
82 for &'s Marked<S::$oty, $oty>
84 fn decode(r: &mut Reader<'_>, s: &'s HandleStore<server::MarkedTypes<S>>) -> Self {
85 &s.$oty[handle::Handle::decode(r, &mut ())]
89 impl<S> Encode<S> for &mut $oty {
90 fn encode(self, w: &mut Writer, s: &mut S) {
95 impl<S: server::Types> DecodeMut<'_, 's, HandleStore<server::MarkedTypes<S>>>
96 for &'s mut Marked<S::$oty, $oty>
100 s: &'s mut HandleStore<server::MarkedTypes<S>>
102 &mut s.$oty[handle::Handle::decode(r, &mut ())]
106 impl<S: server::Types> Encode<HandleStore<server::MarkedTypes<S>>>
107 for Marked<S::$oty, $oty>
109 fn encode(self, w: &mut Writer, s: &mut HandleStore<server::MarkedTypes<S>>) {
110 s.$oty.alloc(self).encode(w, s);
114 impl<S> DecodeMut<'_, '_, S> for $oty {
115 fn decode(r: &mut Reader<'_>, s: &mut S) -> Self {
116 $oty(handle::Handle::decode(r, s))
123 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
124 pub(crate) struct $ity(handle::Handle);
125 impl !Send for $ity {}
126 impl !Sync for $ity {}
128 impl<S> Encode<S> for $ity {
129 fn encode(self, w: &mut Writer, s: &mut S) {
134 impl<S: server::Types> DecodeMut<'_, '_, HandleStore<server::MarkedTypes<S>>>
135 for Marked<S::$ity, $ity>
137 fn decode(r: &mut Reader<'_>, s: &mut HandleStore<server::MarkedTypes<S>>) -> Self {
138 s.$ity.copy(handle::Handle::decode(r, &mut ()))
142 impl<S: server::Types> Encode<HandleStore<server::MarkedTypes<S>>>
143 for Marked<S::$ity, $ity>
145 fn encode(self, w: &mut Writer, s: &mut HandleStore<server::MarkedTypes<S>>) {
146 s.$ity.alloc(self).encode(w, s);
150 impl<S> DecodeMut<'_, '_, S> for $ity {
151 fn decode(r: &mut Reader<'_>, s: &mut S) -> Self {
152 $ity(handle::Handle::decode(r, s))
175 // FIXME(eddyb) generate these impls by pattern-matching on the
176 // names of methods - also could use the presence of `fn drop`
177 // to distinguish between 'owned and 'interned, above.
178 // Alternatively, special 'modes" could be listed of types in with_api
179 // instead of pattern matching on methods, here and in server decl.
181 impl Clone for TokenStream {
182 fn clone(&self) -> Self {
187 impl Clone for TokenStreamIter {
188 fn clone(&self) -> Self {
193 impl Clone for Group {
194 fn clone(&self) -> Self {
199 impl Clone for Literal {
200 fn clone(&self) -> Self {
205 // FIXME(eddyb) `Literal` should not expose internal `Debug` impls.
206 impl fmt::Debug for Literal {
207 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
208 f.write_str(&self.debug())
212 impl Clone for SourceFile {
213 fn clone(&self) -> Self {
218 impl fmt::Debug for Span {
219 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
220 f.write_str(&self.debug())
224 macro_rules! define_client_side {
226 $(fn $method:ident($($arg:ident: $arg_ty:ty),* $(,)?) $(-> $ret_ty:ty)*;)*
229 $(pub(crate) fn $method($($arg: $arg_ty),*) $(-> $ret_ty)* {
230 Bridge::with(|bridge| {
231 let mut b = bridge.cached_buffer.take();
234 api_tags::Method::$name(api_tags::$name::$method).encode(&mut b, &mut ());
235 reverse_encode!(b; $($arg),*);
237 b = bridge.dispatch.call(b);
239 let r = Result::<_, PanicMessage>::decode(&mut &b[..], &mut ());
241 bridge.cached_buffer = b;
243 r.unwrap_or_else(|e| panic::resume_unwind(e.into()))
249 with_api!(self, self, define_client_side);
251 enum BridgeState<'a> {
252 /// No server is currently connected to this client.
255 /// A server is connected and available for requests.
256 Connected(Bridge<'a>),
258 /// Access to the bridge is being exclusively acquired
259 /// (e.g., during `BridgeState::with`).
265 impl<'a> scoped_cell::ApplyL<'a> for BridgeStateL {
266 type Out = BridgeState<'a>;
270 static BRIDGE_STATE: scoped_cell::ScopedCell<BridgeStateL> =
271 scoped_cell::ScopedCell::new(BridgeState::NotConnected);
274 impl BridgeState<'_> {
275 /// Take exclusive control of the thread-local
276 /// `BridgeState`, and pass it to `f`, mutably.
277 /// The state will be restored after `f` exits, even
278 /// by panic, including modifications made to it by `f`.
280 /// N.B., while `f` is running, the thread-local state
281 /// is `BridgeState::InUse`.
282 fn with<R>(f: impl FnOnce(&mut BridgeState<'_>) -> R) -> R {
283 BRIDGE_STATE.with(|state| {
284 state.replace(BridgeState::InUse, |mut state| {
285 // FIXME(#52812) pass `f` directly to `replace` when `RefMutL` is gone
293 fn enter<R>(self, f: impl FnOnce() -> R) -> R {
294 // Hide the default panic output within `proc_macro` expansions.
295 // NB. the server can't do this because it may use a different libstd.
296 static HIDE_PANICS_DURING_EXPANSION: Once = Once::new();
297 HIDE_PANICS_DURING_EXPANSION.call_once(|| {
298 let prev = panic::take_hook();
299 panic::set_hook(Box::new(move |info| {
300 let hide = BridgeState::with(|state| match state {
301 BridgeState::NotConnected => false,
302 BridgeState::Connected(_) | BridgeState::InUse => true,
310 BRIDGE_STATE.with(|state| state.set(BridgeState::Connected(self), f))
313 fn with<R>(f: impl FnOnce(&mut Bridge<'_>) -> R) -> R {
314 BridgeState::with(|state| match state {
315 BridgeState::NotConnected => {
316 panic!("procedural macro API is used outside of a procedural macro");
318 BridgeState::InUse => {
319 panic!("procedural macro API is used while it's already in use");
321 BridgeState::Connected(bridge) => f(bridge),
326 /// A client-side "global object" (usually a function pointer),
327 /// which may be using a different `proc_macro` from the one
328 /// used by the server, but can be interacted with compatibly.
330 /// N.B., `F` must have FFI-friendly memory layout (e.g., a pointer).
331 /// The call ABI of function pointers used for `F` doesn't
332 /// need to match between server and client, since it's only
333 /// passed between them and (eventually) called by the client.
335 #[derive(Copy, Clone)]
336 pub struct Client<F> {
337 // FIXME(eddyb) use a reference to the `static COUNTERS`, intead of
338 // a wrapper `fn` pointer, once `const fn` can reference `static`s.
339 pub(super) get_handle_counters: extern "C" fn() -> &'static HandleCounters,
340 pub(super) run: extern "C" fn(Bridge<'_>, F) -> Buffer<u8>,
344 extern "C" fn run_expand1(
345 mut bridge: Bridge<'_>,
346 f: fn(crate::TokenStream) -> crate::TokenStream,
348 // The initial `cached_buffer` contains the input.
349 let mut b = bridge.cached_buffer.take();
351 panic::catch_unwind(panic::AssertUnwindSafe(|| {
353 let reader = &mut &b[..];
354 let input = TokenStream::decode(reader, &mut ());
356 // Put the `cached_buffer` back in the `Bridge`, for requests.
357 Bridge::with(|bridge| bridge.cached_buffer = b.take());
359 let output = f(crate::TokenStream(input)).0;
361 // Take the `cached_buffer` back out, for the output value.
362 b = Bridge::with(|bridge| bridge.cached_buffer.take());
364 // HACK(eddyb) Separate encoding a success value (`Ok(output)`)
365 // from encoding a panic (`Err(e: PanicMessage)`) to avoid
366 // having handles outside the `bridge.enter(|| ...)` scope, and
367 // to catch panics that could happen while encoding the success.
369 // Note that panics should be impossible beyond this point, but
370 // this is defensively trying to avoid any accidental panicking
371 // reaching the `extern "C"` (which should `abort` but may not
372 // at the moment, so this is also potentially preventing UB).
374 Ok::<_, ()>(output).encode(&mut b, &mut ());
377 .map_err(PanicMessage::from)
378 .unwrap_or_else(|e| {
380 Err::<(), _>(e).encode(&mut b, &mut ());
385 impl Client<fn(crate::TokenStream) -> crate::TokenStream> {
386 pub const fn expand1(f: fn(crate::TokenStream) -> crate::TokenStream) -> Self {
388 get_handle_counters: HandleCounters::get,
395 extern "C" fn run_expand2(
396 mut bridge: Bridge<'_>,
397 f: fn(crate::TokenStream, crate::TokenStream) -> crate::TokenStream,
399 // The initial `cached_buffer` contains the input.
400 let mut b = bridge.cached_buffer.take();
402 panic::catch_unwind(panic::AssertUnwindSafe(|| {
404 let reader = &mut &b[..];
405 let input = TokenStream::decode(reader, &mut ());
406 let input2 = TokenStream::decode(reader, &mut ());
408 // Put the `cached_buffer` back in the `Bridge`, for requests.
409 Bridge::with(|bridge| bridge.cached_buffer = b.take());
411 let output = f(crate::TokenStream(input), crate::TokenStream(input2)).0;
413 // Take the `cached_buffer` back out, for the output value.
414 b = Bridge::with(|bridge| bridge.cached_buffer.take());
416 // HACK(eddyb) Separate encoding a success value (`Ok(output)`)
417 // from encoding a panic (`Err(e: PanicMessage)`) to avoid
418 // having handles outside the `bridge.enter(|| ...)` scope, and
419 // to catch panics that could happen while encoding the success.
421 // Note that panics should be impossible beyond this point, but
422 // this is defensively trying to avoid any accidental panicking
423 // reaching the `extern "C"` (which should `abort` but may not
424 // at the moment, so this is also potentially preventing UB).
426 Ok::<_, ()>(output).encode(&mut b, &mut ());
429 .map_err(PanicMessage::from)
430 .unwrap_or_else(|e| {
432 Err::<(), _>(e).encode(&mut b, &mut ());
437 impl Client<fn(crate::TokenStream, crate::TokenStream) -> crate::TokenStream> {
438 pub const fn expand2(
439 f: fn(crate::TokenStream, crate::TokenStream) -> crate::TokenStream
442 get_handle_counters: HandleCounters::get,
450 #[derive(Copy, Clone)]
453 trait_name: &'static str,
454 attributes: &'static [&'static str],
455 client: Client<fn(crate::TokenStream) -> crate::TokenStream>,
460 client: Client<fn(crate::TokenStream, crate::TokenStream) -> crate::TokenStream>,
465 client: Client<fn(crate::TokenStream) -> crate::TokenStream>,
470 pub fn name(&self) -> &'static str {
472 ProcMacro::CustomDerive { trait_name, .. } => trait_name,
473 ProcMacro::Attr { name, .. } => name,
474 ProcMacro::Bang { name, ..} => name
478 pub const fn custom_derive(
479 trait_name: &'static str,
480 attributes: &'static [&'static str],
481 expand: fn(crate::TokenStream) -> crate::TokenStream,
483 ProcMacro::CustomDerive {
486 client: Client::expand1(expand),
492 expand: fn(crate::TokenStream, crate::TokenStream) -> crate::TokenStream,
496 client: Client::expand2(expand),
502 expand: fn(crate::TokenStream) -> crate::TokenStream
506 client: Client::expand1(expand),