openethereum/ipc/codegen/src/codegen.rs

896 lines
30 KiB
Rust
Raw Normal View History

2016-12-11 19:31:31 +01:00
// Copyright 2015, 2016 Parity Technologies (UK) Ltd.
2016-03-24 22:07:01 +01:00
// This file is part of Parity.
// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
use aster;
use syntax::ast::{
MetaItem,
Item,
ImplItemKind,
MethodSig,
Arg,
PatKind,
FunctionRetTy,
2016-03-29 00:55:04 +02:00
Ty,
2016-04-15 15:16:58 +02:00
TraitRef,
Ident,
Generics,
2016-07-12 17:45:35 +02:00
TraitItemKind,
2016-03-24 22:07:01 +01:00
};
use syntax::ast;
use syntax::codemap::Span;
use syntax::ext::base::{Annotatable, ExtCtxt};
use syntax::ptr::P;
pub struct Error;
2016-04-07 22:18:48 +02:00
const RESERVED_MESSAGE_IDS: u16 = 16;
2016-03-24 22:07:01 +01:00
pub fn expand_ipc_implementation(
2016-03-24 22:42:09 +01:00
cx: &mut ExtCtxt,
span: Span,
meta_item: &MetaItem,
annotatable: &Annotatable,
push: &mut FnMut(Annotatable)
2016-03-24 22:07:01 +01:00
) {
2016-03-24 22:39:20 +01:00
let item = match *annotatable {
Annotatable::Item(ref item) => item,
_ => {
2016-10-05 09:36:09 +02:00
cx.span_err(meta_item.span, "`#[ipc]` may only be applied to implementations and traits");
2016-03-24 22:39:20 +01:00
return;
2016-04-25 01:43:21 +02:00
},
2016-03-24 22:39:20 +01:00
};
2016-03-24 22:07:01 +01:00
2016-03-24 22:39:20 +01:00
let builder = aster::AstBuilder::new().span(span);
2016-03-24 22:07:01 +01:00
2016-04-15 15:16:58 +02:00
let interface_map = match implement_interface(cx, &builder, &item, push) {
Ok(interface_map) => interface_map,
2016-04-25 01:43:21 +02:00
Err(Error) => { return; },
2016-03-24 22:39:20 +01:00
};
2016-03-24 22:07:01 +01:00
2016-04-15 15:16:58 +02:00
push_client(cx, &builder, &interface_map, push);
2016-04-15 15:16:58 +02:00
push(Annotatable::Item(interface_map.item));
2016-03-24 22:07:01 +01:00
}
macro_rules! literal {
($builder:ident, $($arg:tt)*) => {
$builder.expr().lit().str::<&str>(&format!($($arg)*))
}
}
2016-03-24 22:07:01 +01:00
fn field_name(builder: &aster::AstBuilder, arg: &Arg) -> ast::Ident {
match arg.pat.node {
2016-03-24 22:41:15 +01:00
PatKind::Ident(_, ref ident, _) => builder.id(ident.node),
2016-03-24 22:07:01 +01:00
_ => { panic!("unexpected param in interface: {:?}", arg.pat.node) }
}
}
pub fn replace_slice_u8(builder: &aster::AstBuilder, ty: &P<ast::Ty>) -> P<ast::Ty> {
if ::syntax::print::pprust::ty_to_string(&strip_ptr(ty)) == "[u8]" {
return builder.ty().id("Vec<u8>")
}
ty.clone()
}
2016-07-12 17:45:35 +02:00
struct NamedSignature<'a> {
sig: &'a MethodSig,
ident: &'a Ident,
}
2016-03-24 22:44:02 +01:00
fn push_invoke_signature_aster(
2016-03-24 22:42:09 +01:00
builder: &aster::AstBuilder,
2016-07-12 17:45:35 +02:00
named_signature: &NamedSignature,
2016-03-24 22:42:09 +01:00
push: &mut FnMut(Annotatable),
2016-03-24 22:07:01 +01:00
) -> Dispatch {
2016-07-12 17:45:35 +02:00
let inputs = &named_signature.sig.decl.inputs;
2016-03-29 00:55:04 +02:00
let (input_type_name, input_arg_names, input_arg_tys) = if inputs.len() > 0 {
2016-03-24 22:07:01 +01:00
let first_field_name = field_name(builder, &inputs[0]).name.as_str();
2016-03-29 00:55:04 +02:00
if first_field_name == "self" && inputs.len() == 1 { (None, vec![], vec![]) }
2016-03-24 22:07:01 +01:00
else {
let skip = if first_field_name == "self" { 2 } else { 1 };
2016-07-12 17:45:35 +02:00
let name_str = format!("{}_input", named_signature.ident.name.as_str());
2016-03-24 22:07:01 +01:00
let mut arg_names = Vec::new();
2016-03-29 00:55:04 +02:00
let mut arg_tys = Vec::new();
2016-04-13 08:57:35 +02:00
let arg_name = format!("{}", field_name(builder, &inputs[skip-1]).name);
2016-04-17 18:30:23 +02:00
let arg_ty = &inputs[skip-1].ty;
2016-04-13 08:57:35 +02:00
2016-03-24 22:07:01 +01:00
let mut tree = builder.item()
2016-04-22 18:45:09 +02:00
.attr().word("derive(Binary)")
2016-03-24 22:07:01 +01:00
.attr().word("allow(non_camel_case_types)")
.struct_(name_str.as_str())
.field(arg_name.as_str())
.ty().build(replace_slice_u8(builder, &strip_ptr(arg_ty)));
2016-04-13 08:57:35 +02:00
2016-03-24 22:07:01 +01:00
arg_names.push(arg_name);
2016-04-17 18:30:23 +02:00
arg_tys.push(arg_ty.clone());
2016-03-24 22:07:01 +01:00
for arg in inputs.iter().skip(skip) {
let arg_name = format!("{}", field_name(builder, &arg));
2016-04-17 18:30:23 +02:00
let arg_ty = &arg.ty;
2016-04-13 08:57:35 +02:00
tree = tree.field(arg_name.as_str()).ty().build(replace_slice_u8(builder, &strip_ptr(arg_ty)));
2016-03-24 22:07:01 +01:00
arg_names.push(arg_name);
2016-04-17 18:30:23 +02:00
arg_tys.push(arg_ty.clone());
2016-03-24 22:07:01 +01:00
}
push(Annotatable::Item(tree.build()));
2016-03-29 00:55:04 +02:00
(Some(name_str.to_owned()), arg_names, arg_tys)
2016-03-24 22:07:01 +01:00
}
}
else {
2016-03-29 00:55:04 +02:00
(None, vec![], vec![])
2016-03-24 22:07:01 +01:00
};
2016-07-12 17:45:35 +02:00
let return_type_ty = match named_signature.sig.decl.output {
2016-03-24 22:07:01 +01:00
FunctionRetTy::Ty(ref ty) => {
2016-07-12 17:45:35 +02:00
let name_str = format!("{}_output", named_signature.ident.name.as_str());
2016-03-24 22:07:01 +01:00
let tree = builder.item()
2016-04-22 18:45:09 +02:00
.attr().word("derive(Binary)")
2016-03-24 22:07:01 +01:00
.attr().word("allow(non_camel_case_types)")
.struct_(name_str.as_str())
.field(format!("payload")).ty().build(ty.clone());
push(Annotatable::Item(tree.build()));
2016-04-15 15:33:42 +02:00
Some(ty.clone())
2016-03-24 22:07:01 +01:00
}
2016-04-15 15:33:42 +02:00
_ => None
2016-03-24 22:07:01 +01:00
};
Dispatch {
2016-07-12 17:45:35 +02:00
function_name: format!("{}", named_signature.ident.name.as_str()),
2016-03-24 22:07:01 +01:00
input_type_name: input_type_name,
input_arg_names: input_arg_names,
2016-03-29 00:55:04 +02:00
input_arg_tys: input_arg_tys,
2016-03-29 21:15:45 +02:00
return_type_ty: return_type_ty,
2016-03-24 22:07:01 +01:00
}
}
struct Dispatch {
function_name: String,
input_type_name: Option<String>,
input_arg_names: Vec<String>,
2016-03-29 00:55:04 +02:00
input_arg_tys: Vec<P<Ty>>,
2016-03-29 21:15:45 +02:00
return_type_ty: Option<P<Ty>>,
2016-03-24 22:07:01 +01:00
}
2016-04-05 11:08:42 +02:00
// This is the expanded version of this:
//
// let invoke_serialize_stmt = quote_stmt!(cx, {
// ::bincode::serde::serialize(& $output_type_id { payload: self. $function_name ($hand_param_a, $hand_param_b) }, ::bincode::SizeLimit::Infinite).unwrap()
// });
//
// But the above does not allow comma-separated expressions for arbitrary number
// of parameters ...$hand_param_a, $hand_param_b, ... $hand_param_n
fn implement_dispatch_arm_invoke_stmt(
2016-03-24 22:07:01 +01:00
cx: &ExtCtxt,
2016-03-24 22:42:09 +01:00
builder: &aster::AstBuilder,
2016-03-24 22:07:01 +01:00
dispatch: &Dispatch,
2016-04-05 11:08:42 +02:00
) -> ast::Stmt
2016-03-24 22:07:01 +01:00
{
let function_name = builder.id(dispatch.function_name.as_str());
let input_args_exprs = dispatch.input_arg_names.iter().enumerate().map(|(arg_index, arg_name)| {
2016-03-24 22:07:01 +01:00
let arg_ident = builder.id(arg_name);
2016-04-22 18:45:09 +02:00
let expr = quote_expr!(cx, input. $arg_ident);
2016-04-17 18:30:23 +02:00
if has_ptr(&dispatch.input_arg_tys[arg_index]) { quote_expr!(cx, & $expr) }
else { expr }
2016-03-24 22:07:01 +01:00
}).collect::<Vec<P<ast::Expr>>>();
2016-04-05 11:08:42 +02:00
let ext_cx = &*cx;
::quasi::parse_stmt_panic(&mut ::syntax::parse::new_parser_from_tts(
ext_cx.parse_sess(),
ext_cx.cfg(),
{
let _sp = ext_cx.call_site();
let mut tt = ::std::vec::Vec::new();
2016-07-05 10:11:09 +02:00
2016-04-05 11:08:42 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::OpenDelim(::syntax::parse::token::Brace)));
2016-07-05 10:11:09 +02:00
if dispatch.return_type_ty.is_some() {
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::ModSep));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("ipc"))));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::ModSep));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("binary"))));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::ModSep));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("serialize"))));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::OpenDelim(::syntax::parse::token::Paren)));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::BinOp(::syntax::parse::token::And)));
}
2016-05-06 00:25:58 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("self"))));
2016-04-05 11:08:42 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Dot));
tt.extend(::quasi::ToTokens::to_tokens(&function_name, ext_cx).into_iter());
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::OpenDelim(::syntax::parse::token::Paren)));
for arg_expr in input_args_exprs {
tt.extend(::quasi::ToTokens::to_tokens(&arg_expr, ext_cx).into_iter());
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Comma));
}
2016-03-24 22:07:01 +01:00
2016-04-05 11:08:42 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::CloseDelim(::syntax::parse::token::Paren)));
2016-07-05 10:11:09 +02:00
if dispatch.return_type_ty.is_some() {
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::CloseDelim(::syntax::parse::token::Paren)));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Dot));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("unwrap"))));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::OpenDelim(::syntax::parse::token::Paren)));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::CloseDelim(::syntax::parse::token::Paren)));
}
else {
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Semi));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("Vec"))));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::ModSep));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("new"))));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::OpenDelim(::syntax::parse::token::Paren)));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::CloseDelim(::syntax::parse::token::Paren)));
}
2016-04-05 11:08:42 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::CloseDelim(::syntax::parse::token::Brace)));
2016-07-05 10:11:09 +02:00
2016-04-05 11:08:42 +02:00
tt
})).unwrap()
}
2016-03-24 22:07:01 +01:00
2016-04-05 11:08:42 +02:00
fn implement_dispatch_arm_invoke(
cx: &ExtCtxt,
builder: &aster::AstBuilder,
dispatch: &Dispatch,
buffer: bool,
) -> P<ast::Expr>
{
let deserialize_expr = if buffer {
quote_expr!(cx,
::ipc::binary::deserialize(buf)
.unwrap_or_else(|e| { panic!("ipc error while deserializing payload, aborting \n payload: {:?}, \n error: {:?}", buf, e); } )
)
2016-04-05 11:08:42 +02:00
} else {
quote_expr!(cx,
::ipc::binary::deserialize_from(r)
.unwrap_or_else(|e| { panic!("ipc error while deserializing payload, aborting \n error: {:?}", e); } )
)
2016-03-24 22:07:01 +01:00
};
2016-04-05 11:08:42 +02:00
2016-04-22 18:45:09 +02:00
let invoke_serialize_stmt = implement_dispatch_arm_invoke_stmt(cx, builder, dispatch);
2016-04-17 18:30:23 +02:00
dispatch.input_type_name.as_ref().map(|val| {
let input_type_id = builder.id(val.clone().as_str());
quote_expr!(cx, {
let input: $input_type_id = $deserialize_expr;
$invoke_serialize_stmt
})
}).unwrap_or(quote_expr!(cx, { $invoke_serialize_stmt }))
2016-03-24 22:07:01 +01:00
}
2016-03-30 18:27:39 +02:00
/// generates dispatch match for method id
2016-04-05 11:08:42 +02:00
fn implement_dispatch_arm(
cx: &ExtCtxt,
builder: &aster::AstBuilder,
index: u32,
dispatch: &Dispatch,
buffer: bool,
) -> ast::Arm
2016-03-24 22:07:01 +01:00
{
let index_ident = builder.id(format!("{}", index + (RESERVED_MESSAGE_IDS as u32)).as_str());
2016-04-22 18:45:09 +02:00
let invoke_expr = implement_dispatch_arm_invoke(cx, builder, dispatch, buffer);
let trace = literal!(builder, "Dispatching: {}", &dispatch.function_name);
quote_arm!(cx, $index_ident => {
trace!(target: "ipc", $trace);
$invoke_expr
})
2016-03-24 22:07:01 +01:00
}
2016-04-05 11:08:42 +02:00
fn implement_dispatch_arms(
cx: &ExtCtxt,
builder: &aster::AstBuilder,
dispatches: &[Dispatch],
buffer: bool,
) -> Vec<ast::Arm>
{
let mut index = -1;
dispatches.iter()
2016-04-22 18:45:09 +02:00
.map(|dispatch| { index = index + 1; implement_dispatch_arm(cx, builder, index as u32, dispatch, buffer) }).collect()
2016-04-05 11:08:42 +02:00
}
2016-04-22 15:37:22 +02:00
pub fn strip_ptr(ty: &P<ast::Ty>) -> P<ast::Ty> {
2016-04-17 18:30:23 +02:00
if let ast::TyKind::Rptr(_, ref ptr_mut) = ty.node {
ptr_mut.ty.clone()
}
else { ty.clone() }
}
2016-04-22 15:46:09 +02:00
pub fn has_ptr(ty: &P<ast::Ty>) -> bool {
2016-04-21 15:56:35 +02:00
if let ast::TyKind::Rptr(_, ref _ptr_mut) = ty.node {
2016-04-17 18:30:23 +02:00
true
}
else { false }
}
2016-03-30 18:27:39 +02:00
/// returns an expression with the body for single operation that is being sent to server
/// operation itself serializes input, writes to socket and waits for socket to respond
/// (the latter only if original method signature returns anyting)
2016-03-30 18:20:39 +02:00
///
/// assuming expanded class contains method
/// fn commit(&self, f: u32) -> u32
///
/// the expanded implementation will generate method for the client like that
2016-03-30 18:27:39 +02:00
/// #[derive(Serialize)]
/// struct Request<'a> {
/// f: &'a u32,
2016-03-30 18:20:39 +02:00
/// }
2016-03-30 18:27:39 +02:00
/// let payload = Request{f: &f,};
/// let mut socket_ref = self.socket.borrow_mut();
/// let mut socket = socket_ref.deref_mut();
/// let serialized_payload = ::bincode::serde::serialize(&payload, ::bincode::SizeLimit::Infinite).unwrap();
/// ::ipc::invoke(0, &Some(serialized_payload), &mut socket);
/// while !socket.ready().load(::std::sync::atomic::Ordering::Relaxed) { }
/// ::bincode::serde::deserialize_from::<_, u32>(&mut socket, ::bincode::SizeLimit::Infinite).unwrap()
2016-03-30 17:27:31 +02:00
fn implement_client_method_body(
2016-03-29 21:00:23 +02:00
cx: &ExtCtxt,
builder: &aster::AstBuilder,
2016-03-30 01:21:47 +02:00
index: u16,
2016-04-15 15:16:58 +02:00
interface_map: &InterfaceMap,
) -> P<ast::Expr>
2016-03-29 21:00:23 +02:00
{
2016-04-15 15:16:58 +02:00
let dispatch = &interface_map.dispatches[index as usize];
2016-04-17 18:30:23 +02:00
let index_ident = builder.id(format!("{}", index + RESERVED_MESSAGE_IDS).as_str());
2016-03-29 21:00:23 +02:00
let request = if dispatch.input_arg_names.len() > 0 {
2016-04-13 02:46:36 +02:00
2016-03-29 21:00:23 +02:00
let arg_name = dispatch.input_arg_names[0].as_str();
2016-04-17 18:30:23 +02:00
let static_ty = strip_ptr(&dispatch.input_arg_tys[0]);
2016-03-29 21:00:23 +02:00
let arg_ty = builder
.ty().ref_()
.lifetime("'a")
.ty()
2016-04-22 18:45:09 +02:00
.build(static_ty.clone());
2016-03-29 21:00:23 +02:00
let mut tree = builder.item()
2016-04-22 18:45:09 +02:00
.attr().word("derive(Binary)")
2016-03-29 21:00:23 +02:00
.struct_("Request")
.generics()
.lifetime_name("'a")
.build()
.field(arg_name).ty()
.build(arg_ty);
2016-03-29 21:00:23 +02:00
for arg_idx in 1..dispatch.input_arg_names.len() {
let arg_name = dispatch.input_arg_names[arg_idx].as_str();
2016-04-17 18:30:23 +02:00
let static_ty = strip_ptr(&dispatch.input_arg_tys[arg_idx]);
2016-03-29 21:00:23 +02:00
let arg_ty = builder
.ty().ref_()
.lifetime("'a")
.ty()
2016-04-22 18:45:09 +02:00
.build(static_ty);
2016-03-29 21:00:23 +02:00
tree = tree.field(arg_name).ty().build(arg_ty);
2016-03-29 21:00:23 +02:00
}
let mut request_serialization_statements = Vec::new();
let struct_tree = tree.build();
let struct_stmt = quote_stmt!(cx, $struct_tree);
request_serialization_statements.push(struct_stmt);
// actually this is just expanded version of this:
// request_serialization_statements.push(quote_stmt!(cx, let payload = Request { p1: &p1, p2: &p2, ... pn: &pn, }));
// again, cannot dynamically create expression with arbitrary number of comma-separated members
request_serialization_statements.push({
let ext_cx = &*cx;
::quasi::parse_stmt_panic(&mut ::syntax::parse::new_parser_from_tts(
ext_cx.parse_sess(),
ext_cx.cfg(),
{
let _sp = ext_cx.call_site();
let mut tt = ::std::vec::Vec::new();
2016-05-06 00:25:58 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("let"))));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("payload"))));
2016-03-29 21:00:23 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Eq));
2016-05-06 00:25:58 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("Request"))));
2016-03-29 21:00:23 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::OpenDelim(::syntax::parse::token::Brace)));
2016-04-22 18:45:09 +02:00
for arg in dispatch.input_arg_names.iter() {
2016-05-06 00:25:58 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of(arg.as_str()))));
2016-03-29 21:00:23 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Colon));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::BinOp(::syntax::parse::token::And)));
2016-05-06 00:25:58 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of(arg.as_str()))));
2016-03-29 21:00:23 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Comma));
}
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::CloseDelim(::syntax::parse::token::Brace)));
tt
}))
});
request_serialization_statements.push(
quote_stmt!(cx, let mut socket = self.socket.write().unwrap(); ));
2016-03-29 21:00:23 +02:00
request_serialization_statements.push(
2016-04-22 18:45:09 +02:00
quote_stmt!(cx, let serialized_payload = ::ipc::binary::serialize(&payload).unwrap()));
2016-03-29 21:00:23 +02:00
request_serialization_statements.push(
quote_stmt!(cx, ::ipc::invoke($index_ident, &Some(serialized_payload), &mut *socket)));
2016-03-29 21:00:23 +02:00
request_serialization_statements
}
else {
2016-04-17 18:30:23 +02:00
let mut request_serialization_statements = Vec::new();
request_serialization_statements.push(
quote_stmt!(cx, let mut socket = self.socket.write().unwrap(); ));
2016-04-17 18:30:23 +02:00
request_serialization_statements.push(
quote_stmt!(cx, ::ipc::invoke($index_ident, &None, &mut *socket)));
2016-04-17 18:30:23 +02:00
request_serialization_statements
2016-03-29 21:00:23 +02:00
};
2016-03-29 00:55:04 +02:00
let trace = literal!(builder, "Invoking: {}", &dispatch.function_name);
2016-03-29 21:15:45 +02:00
if let Some(ref return_ty) = dispatch.return_type_ty {
let return_expr = quote_expr!(cx,
::ipc::binary::deserialize_from::<$return_ty, _>(&mut *socket).unwrap()
2016-03-29 21:15:45 +02:00
);
quote_expr!(cx, {
trace!(target: "ipc", $trace);
$request;
2016-03-29 21:15:45 +02:00
$return_expr
})
}
else {
quote_expr!(cx, {
trace!(target: "ipc", $trace);
2016-03-29 21:15:45 +02:00
$request
})
}
2016-03-29 21:00:23 +02:00
}
2016-03-30 18:31:09 +02:00
/// Generates signature and body (see `implement_client_method_body`)
/// for the client (signature is identical to the original method)
2016-03-30 17:27:31 +02:00
fn implement_client_method(
2016-03-29 21:00:23 +02:00
cx: &ExtCtxt,
builder: &aster::AstBuilder,
2016-03-30 01:21:47 +02:00
index: u16,
2016-04-15 15:16:58 +02:00
interface_map: &InterfaceMap,
)
2016-03-29 21:00:23 +02:00
-> ast::ImplItem
{
2016-04-15 15:16:58 +02:00
let dispatch = &interface_map.dispatches[index as usize];
2016-03-29 21:00:23 +02:00
let method_name = builder.id(dispatch.function_name.as_str());
2016-04-15 15:16:58 +02:00
let body = implement_client_method_body(cx, builder, index, interface_map);
2016-03-29 21:00:23 +02:00
let ext_cx = &*cx;
// expanded version of this
// pub fn $method_name(&self, p1: p1_ty, p2: p2_ty ... pn: pn_ty, ) [-> return_ty] { $body }
// looks like it's tricky to build function declaration with aster if body already generated
let signature = ::syntax::parse::parser::Parser::parse_impl_item(
&mut ::syntax::parse::new_parser_from_tts(
ext_cx.parse_sess(),
ext_cx.cfg(),
{
let _sp = ext_cx.call_site();
let mut tt = ::std::vec::Vec::new();
2016-05-06 00:25:58 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("fn"))));
2016-03-29 21:00:23 +02:00
tt.extend(::quasi::ToTokens::to_tokens(&method_name, ext_cx).into_iter());
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::OpenDelim(::syntax::parse::token::Paren)));
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::BinOp(::syntax::parse::token::And)));
2016-05-06 00:25:58 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of("self"))));
2016-03-29 21:00:23 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Comma));
2016-03-29 21:15:45 +02:00
2016-03-29 21:00:23 +02:00
for arg_idx in 0..dispatch.input_arg_names.len() {
let arg_name = dispatch.input_arg_names[arg_idx].as_str();
let arg_ty = dispatch.input_arg_tys[arg_idx].clone();
2016-05-06 00:25:58 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Ident(ext_cx.ident_of(arg_name))));
2016-03-29 21:00:23 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Colon));
tt.extend(::quasi::ToTokens::to_tokens(&arg_ty, ext_cx).into_iter());
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::Comma));
}
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::CloseDelim(::syntax::parse::token::Paren)));
2016-03-29 21:15:45 +02:00
if let Some(ref return_ty) = dispatch.return_type_ty {
2016-03-29 21:00:23 +02:00
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::RArrow));
2016-03-29 21:15:45 +02:00
tt.extend(::quasi::ToTokens::to_tokens(return_ty, ext_cx).into_iter());
2016-03-29 21:00:23 +02:00
}
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::OpenDelim(::syntax::parse::token::Brace)));
tt.extend(::quasi::ToTokens::to_tokens(&body, ext_cx).into_iter());
tt.push(::syntax::ast::TokenTree::Token(_sp, ::syntax::parse::token::CloseDelim(::syntax::parse::token::Brace)));
tt
}));
signature.unwrap()
2016-03-29 00:55:04 +02:00
}
2016-04-15 15:16:58 +02:00
fn client_generics(builder: &aster::AstBuilder, interface_map: &InterfaceMap) -> Generics {
let ty_param = aster::ty_param::TyParamBuilder::new(
builder.id("S")).trait_bound(
builder.path().global().ids(&["ipc", "IpcSocket"]).build()
).build().build();
builder.from_generics(interface_map.generics.clone())
.with_ty_param(ty_param)
.build()
}
2016-06-30 14:33:34 +02:00
fn client_qualified_ident(cx: &ExtCtxt, builder: &aster::AstBuilder, interface_map: &InterfaceMap) -> P<Ty> {
2016-04-15 15:16:58 +02:00
let generics = client_generics(builder, interface_map);
2016-06-30 14:33:34 +02:00
aster::ty::TyBuilder::new().path().segment(interface_map.ident_map.client_ident(cx, builder, &interface_map.original_item))
2016-04-15 15:16:58 +02:00
.with_generics(generics).build()
.build()
}
fn client_phantom_ident(builder: &aster::AstBuilder, interface_map: &InterfaceMap) -> P<Ty> {
let generics = client_generics(builder, interface_map);
aster::ty::TyBuilder::new().phantom_data()
.tuple().with_tys(generics.ty_params.iter().map(|x| aster::ty::TyBuilder::new().id(x.ident)))
.build()
}
/// generates client type for specified server type
/// for say `Service` it generates `ServiceClient`
fn push_client_struct(cx: &ExtCtxt, builder: &aster::AstBuilder, interface_map: &InterfaceMap, push: &mut FnMut(Annotatable)) {
let generics = client_generics(builder, interface_map);
2016-06-30 14:33:34 +02:00
let client_short_ident = interface_map.ident_map.client_ident(cx, builder, &interface_map.original_item);
2016-04-15 15:16:58 +02:00
let phantom = client_phantom_ident(builder, interface_map);
let client_struct_item = quote_item!(cx,
pub struct $client_short_ident $generics {
socket: ::std::sync::RwLock<S>,
2016-04-15 15:16:58 +02:00
phantom: $phantom,
});
push(Annotatable::Item(client_struct_item.expect(&format!("could not generate client struct for {:?}", client_short_ident.name))));
}
/// pushes generated code for the client class (type declaration and method invocation implementations)
fn push_client(
cx: &ExtCtxt,
builder: &aster::AstBuilder,
interface_map: &InterfaceMap,
push: &mut FnMut(Annotatable),
) {
push_client_struct(cx, builder, interface_map, push);
push_client_implementation(cx, builder, interface_map, push);
push_with_socket_client_implementation(cx, builder, interface_map, push);
}
2016-04-12 09:18:39 +02:00
fn push_with_socket_client_implementation(
cx: &ExtCtxt,
builder: &aster::AstBuilder,
2016-04-15 15:16:58 +02:00
interface_map: &InterfaceMap,
2016-04-12 09:18:39 +02:00
push: &mut FnMut(Annotatable))
{
2016-04-15 15:16:58 +02:00
let generics = client_generics(builder, interface_map);
2016-06-30 14:33:34 +02:00
let client_ident = client_qualified_ident(cx, builder, interface_map);
2016-04-15 15:16:58 +02:00
let where_clause = &generics.where_clause;
2016-06-30 14:33:34 +02:00
let client_short_ident = interface_map.ident_map.client_ident(cx, builder, &interface_map.original_item);
2016-04-12 17:03:58 +02:00
2016-04-12 09:18:39 +02:00
let implement = quote_item!(cx,
2016-04-15 15:16:58 +02:00
impl $generics ::ipc::WithSocket<S> for $client_ident $where_clause {
fn init(socket: S) -> $client_ident {
$client_short_ident {
socket: ::std::sync::RwLock::new(socket),
2016-04-12 09:18:39 +02:00
phantom: ::std::marker::PhantomData,
}
}
}).unwrap();
push(Annotatable::Item(implement));
}
2016-03-30 18:31:09 +02:00
/// pushes full client side code for the original class exposed via ipc
2016-03-30 17:27:31 +02:00
fn push_client_implementation(
2016-03-29 00:55:04 +02:00
cx: &ExtCtxt,
2016-03-29 21:00:23 +02:00
builder: &aster::AstBuilder,
2016-04-15 15:16:58 +02:00
interface_map: &InterfaceMap,
push: &mut FnMut(Annotatable),
) {
2016-03-30 01:21:47 +02:00
let mut index = -1i32;
2016-04-15 15:16:58 +02:00
let items = interface_map.dispatches.iter()
2016-04-15 15:33:42 +02:00
.map(|_| { index = index + 1; P(implement_client_method(cx, builder, index as u16, interface_map)) })
2016-03-29 21:00:23 +02:00
.collect::<Vec<P<ast::ImplItem>>>();
2016-04-15 15:16:58 +02:00
let generics = client_generics(builder, interface_map);
2016-06-30 14:33:34 +02:00
let client_ident = client_qualified_ident(cx, builder, interface_map);
2016-04-15 15:16:58 +02:00
let where_clause = &generics.where_clause;
let endpoint = interface_map.endpoint;
2016-04-15 15:16:58 +02:00
2016-04-15 16:50:10 +02:00
let handshake_item = quote_impl_item!(cx,
pub fn handshake(&self) -> Result<(), ::ipc::Error> {
2016-07-12 10:33:20 +02:00
let payload = ::ipc::Handshake {
2016-07-16 19:09:14 +02:00
protocol_version: $endpoint::protocol_version(),
api_version: $endpoint::api_version(),
2016-04-15 16:50:10 +02:00
};
::ipc::invoke(
0,
2016-07-12 10:33:20 +02:00
&Some(::ipc::binary::serialize(&::ipc::BinHandshake::from(payload)).unwrap()),
&mut *self.socket.write().unwrap());
2016-04-15 16:50:10 +02:00
let mut result = vec![0u8; 1];
if try!(self.socket.write().unwrap().read(&mut result).map_err(|_| ::ipc::Error::HandshakeFailed)) == 1 {
2016-04-15 16:50:10 +02:00
match result[0] {
1 => Ok(()),
_ => Err(::ipc::Error::RemoteServiceUnsupported),
2016-04-12 06:07:12 +02:00
}
2016-03-29 21:29:43 +02:00
}
2016-04-15 16:50:10 +02:00
else { Err(::ipc::Error::HandshakeFailed) }
}).unwrap();
2016-03-29 21:29:43 +02:00
2016-04-15 16:50:10 +02:00
let socket_item = quote_impl_item!(cx,
#[cfg(test)]
pub fn socket(&self) -> &::std::sync::RwLock<S> {
2016-04-15 16:50:10 +02:00
&self.socket
2016-03-29 21:00:23 +02:00
}).unwrap();
2016-04-15 16:50:10 +02:00
let generic_items = vec![P(handshake_item), P(socket_item)];
if interface_map.impl_trait.is_some() {
let trait_ty = builder.id(
::syntax::print::pprust::path_to_string(
&interface_map.impl_trait.as_ref().unwrap().path));
let implement_trait =
quote_item!(cx,
impl $generics $trait_ty for $client_ident $where_clause {
$items
}
).unwrap();
push(Annotatable::Item(implement_trait));
let implement =
quote_item!(cx,
impl $generics $client_ident $where_clause {
$generic_items
}
).unwrap();
push(Annotatable::Item(implement));
}
else {
let pub_items = items.iter().map(|item| {
let pub_item = item.clone();
pub_item.map(|mut val| { val.vis = ast::Visibility::Public; val })
}).collect::<Vec<P<ast::ImplItem>>>();
let implement = quote_item!(cx,
impl $generics $client_ident $where_clause {
$pub_items
$generic_items
}).unwrap();
push(Annotatable::Item(implement));
}
2016-03-29 00:55:04 +02:00
}
2016-04-12 06:07:12 +02:00
/// implements dispatching of system handshake invocation (method_num 0)
fn implement_handshake_arm(
cx: &ExtCtxt,
) -> (ast::Arm, ast::Arm)
{
let handshake_deserialize = quote_stmt!(&cx,
2016-07-12 10:33:20 +02:00
let handshake_payload = ::ipc::binary::deserialize_from::<::ipc::BinHandshake, _>(r).unwrap();
2016-04-12 06:07:12 +02:00
);
let handshake_deserialize_buf = quote_stmt!(&cx,
2016-07-12 10:33:20 +02:00
let handshake_payload = ::ipc::binary::deserialize::<::ipc::BinHandshake>(buf).unwrap();
2016-04-12 06:07:12 +02:00
);
let handshake_serialize = quote_expr!(&cx,
2016-07-12 10:33:20 +02:00
::ipc::binary::serialize::<bool>(&Self::handshake(&handshake_payload.to_semver())).unwrap()
2016-04-12 06:07:12 +02:00
);
(
quote_arm!(&cx, 0 => {
$handshake_deserialize
$handshake_serialize
}),
quote_arm!(&cx, 0 => {
$handshake_deserialize_buf
$handshake_serialize
}),
)
}
2016-06-30 14:33:34 +02:00
fn get_str_from_lit(cx: &ExtCtxt, name: &str, lit: &ast::Lit) -> Result<String, ()> {
match lit.node {
ast::LitKind::Str(ref s, _) => Ok(format!("{}", s)),
_ => {
cx.span_err(
lit.span,
&format!("ipc client_ident annotation `{}` must be a string, not `{}`",
name,
::syntax::print::pprust::lit_to_string(lit)));
return Err(());
}
}
}
pub fn get_ipc_meta_items(attr: &ast::Attribute) -> Option<&[P<ast::MetaItem>]> {
match attr.node.value.node {
ast::MetaItemKind::List(ref name, ref items) if name == &"ipc" => {
Some(items)
}
_ => None
}
}
fn client_ident_renamed(cx: &ExtCtxt, item: &ast::Item) -> Option<String> {
for meta_items in item.attrs().iter().filter_map(get_ipc_meta_items) {
for meta_item in meta_items {
match meta_item.node {
ast::MetaItemKind::NameValue(ref name, ref lit) if name == &"client_ident" => {
if let Ok(s) = get_str_from_lit(cx, name, lit) {
return Some(s);
}
}
_ => {
cx.span_err(
meta_item.span,
&format!("unknown client_ident container attribute `{}`",
::syntax::print::pprust::meta_item_to_string(meta_item)));
}
}
}
}
None
}
2016-04-15 15:16:58 +02:00
struct InterfaceMap {
pub original_item: Item,
pub item: P<ast::Item>,
pub dispatches: Vec<Dispatch>,
pub generics: Generics,
pub impl_trait: Option<TraitRef>,
pub ident_map: IdentMap,
pub endpoint: Ident,
2016-04-15 15:16:58 +02:00
}
struct IdentMap {
original_path: ast::Path,
}
impl IdentMap {
fn ident(&self, builder: &aster::AstBuilder) -> Ident {
builder.id(format!("{}", ::syntax::print::pprust::path_to_string(&self.original_path)))
}
2016-06-30 14:33:34 +02:00
fn client_ident(&self, cx: &ExtCtxt, builder: &aster::AstBuilder, item: &ast::Item) -> Ident {
if let Some(new_name) = client_ident_renamed(cx, item) {
builder.id(new_name)
}
else {
builder.id(format!("{}Client", self.original_path.segments[0].identifier))
}
2016-04-15 15:16:58 +02:00
}
}
fn ty_ident_map(original_ty: &P<Ty>) -> IdentMap {
let original_path = match original_ty.node {
::syntax::ast::TyKind::Path(_, ref path) => path.clone(),
_ => { panic!("incompatible implementation"); }
};
let ident_map = IdentMap { original_path: original_path };
ident_map
}
/// implements `IpcInterface` for the given class `C`
2016-03-24 22:07:01 +01:00
fn implement_interface(
2016-03-24 22:42:09 +01:00
cx: &ExtCtxt,
builder: &aster::AstBuilder,
item: &Item,
push: &mut FnMut(Annotatable),
2016-04-15 15:16:58 +02:00
) -> Result<InterfaceMap, Error> {
2016-07-12 17:45:35 +02:00
let (generics, impl_trait, original_ty, dispatch_table) = match item.node {
ast::ItemKind::Impl(_, _, ref generics, ref impl_trait, ref ty, ref impl_items) => {
let mut method_signatures = Vec::new();
for impl_item in impl_items {
if let ImplItemKind::Method(ref signature, _) = impl_item.node {
method_signatures.push(NamedSignature { ident: &impl_item.ident, sig: signature });
}
}
let dispatch_table = method_signatures.iter().map(|named_signature|
push_invoke_signature_aster(builder, named_signature, push))
.collect::<Vec<Dispatch>>();
(generics, impl_trait.clone(), ty.clone(), dispatch_table)
},
ast::ItemKind::Trait(_, ref generics, _, ref trait_items) => {
let mut method_signatures = Vec::new();
for trait_item in trait_items {
if let TraitItemKind::Method(ref signature, _) = trait_item.node {
method_signatures.push(NamedSignature { ident: &trait_item.ident, sig: signature });
}
}
let dispatch_table = method_signatures.iter().map(|named_signature|
push_invoke_signature_aster(builder, named_signature, push))
.collect::<Vec<Dispatch>>();
(
generics,
Some(ast::TraitRef {
path: builder.path().ids(&[item.ident.name]).build(),
ref_id: item.id,
}),
builder.ty().id(item.ident),
dispatch_table
)
},
2016-03-24 22:07:01 +01:00
_ => {
cx.span_err(
item.span,
2016-10-04 18:20:16 +02:00
"`#[ipc]` may only be applied to implementations and traits");
2016-03-24 22:07:01 +01:00
return Err(Error);
2016-04-25 01:43:21 +02:00
},
2016-03-24 22:07:01 +01:00
};
2016-04-15 15:16:58 +02:00
let impl_generics = builder.from_generics(generics.clone()).build();
2016-03-24 22:07:01 +01:00
let where_clause = &impl_generics.where_clause;
2016-04-22 18:45:09 +02:00
let dispatch_arms = implement_dispatch_arms(cx, builder, &dispatch_table, false);
let dispatch_arms_buffered = implement_dispatch_arms(cx, builder, &dispatch_table, true);
2016-03-24 22:07:01 +01:00
2016-04-12 06:07:12 +02:00
let (handshake_arm, handshake_arm_buf) = implement_handshake_arm(cx);
2016-04-08 13:07:25 +02:00
2016-04-15 15:16:58 +02:00
let ty = ty_ident_map(&original_ty).ident(builder);
2016-07-12 17:45:35 +02:00
let (interface_endpoint, host_generics) = match impl_trait {
Some(ref trait_) => (builder.id(::syntax::print::pprust::path_to_string(&trait_.path)), None),
None => (ty, Some(&impl_generics)),
};
2016-04-15 15:16:58 +02:00
let ipc_item = quote_item!(cx,
impl $host_generics ::ipc::IpcInterface for $interface_endpoint $where_clause {
2016-03-24 22:07:01 +01:00
fn dispatch<R>(&self, r: &mut R) -> Vec<u8>
where R: ::std::io::Read
{
let mut method_num = vec![0u8;2];
match r.read(&mut method_num) {
Ok(size) if size == 0 => { panic!("method id not supplied" ); }
Err(e) => { panic!("ipc read error: {:?}, aborting", e); }
_ => { }
}
2016-04-14 19:43:14 +02:00
// method_num is a 16-bit little-endian unsigned number
match method_num[1] as u16 + (method_num[0] as u16)*256 {
2016-04-08 13:07:25 +02:00
// handshake
$handshake_arm
// user methods
2016-03-24 22:07:01 +01:00
$dispatch_arms
_ => vec![]
}
}
2016-04-03 22:39:49 +02:00
2016-04-05 11:08:42 +02:00
fn dispatch_buf(&self, method_num: u16, buf: &[u8]) -> Vec<u8>
2016-04-03 22:39:49 +02:00
{
match method_num {
2016-04-12 06:07:12 +02:00
$handshake_arm_buf
2016-04-05 11:08:42 +02:00
$dispatch_arms_buffered
2016-04-03 22:39:49 +02:00
_ => vec![]
}
}
2016-03-24 22:07:01 +01:00
}
2016-04-15 15:16:58 +02:00
).unwrap();
Ok(InterfaceMap {
ident_map: ty_ident_map(&original_ty),
original_item: item.clone(),
item: ipc_item,
dispatches: dispatch_table,
generics: generics.clone(),
impl_trait: impl_trait.clone(),
endpoint: interface_endpoint,
2016-04-15 15:16:58 +02:00
})
2016-03-24 22:07:01 +01:00
}