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
use crate::errors::*; use crate::functions_ids::*; use crate::functions_names::*; use crate::map::*; use crate::sections::*; use crate::symbols::{self, ExtractedSymbols}; use parity_wasm; use parity_wasm::elements::{ self, External, FunctionNameSubsection, ImportEntry, ImportSection, Internal, Module, NameSection, Section, }; use std::collections::HashMap; use std::path::{Path, PathBuf}; pub const BUILTIN_PREFIX: &str = "builtin_"; #[derive(Default, Clone, Debug)] pub struct PatcherConfig { pub builtins_path: Option<PathBuf>, pub builtins_map_path: Option<PathBuf>, pub builtins_map_original_names: bool, pub builtins_additional: Vec<String>, } pub struct Patcher { pub config: PatcherConfig, patched_module: Module, patched_builtins_map: PatchedBuiltinsMap, } impl Patcher { pub fn new(config: PatcherConfig, module: Module) -> Result<Self, WError> { let symbols = match &config.builtins_path { None => ExtractedSymbols::from(vec![]), Some(builtins_path) => symbols::extract_symbols(&builtins_path)?, } .merge_additional(&config.builtins_additional); let builtins_names = symbols.builtins_names(); let (patched_module, patched_builtins_map) = patch_module(module, &builtins_names)?; let patcher = Patcher { config, patched_module, patched_builtins_map, }; Ok(patcher) } pub fn from_bytes(config: PatcherConfig, bytes: &[u8]) -> Result<Self, WError> { let module = parity_wasm::deserialize_buffer(bytes)?; Self::new(config, module) } pub fn from_file<P: AsRef<Path>>(config: PatcherConfig, path_in: P) -> Result<Self, WError> { let module = parity_wasm::deserialize_file(path_in)?; Self::new(config, module) } pub fn into_bytes(self) -> Result<Vec<u8>, WError> { let bytes = elements::serialize(self.patched_module)?; Ok(bytes) } pub fn store_to_file<P: AsRef<Path>>(self, path_out: P) -> Result<(), WError> { elements::serialize_to_file(path_out, self.patched_module)?; if let Some(builtins_map_path) = self.config.builtins_map_path { self.patched_builtins_map .write_to_file(builtins_map_path, self.config.builtins_map_original_names)?; } Ok(()) } pub fn patched_builtins_map(&self, module: &str) -> Result<HashMap<String, String>, WError> { self.patched_builtins_map .builtins_map(module, self.config.builtins_map_original_names) } pub fn patched_module(self) -> Module { self.patched_module } } #[derive(Debug)] pub struct Builtin { pub name: String, pub original_function_id: Option<u32>, pub function_type_id: Option<u32>, } impl Builtin { pub fn new(name: String) -> Self { Builtin { name, original_function_id: None, function_type_id: None, } } pub fn import_name(&self) -> String { format!("{}{}", BUILTIN_PREFIX, self.name) } } fn function_type_id_for_function_id(module: &Module, function_id: u32) -> Option<u32> { let offset = module .import_section() .map(|import_section| import_section.entries().len() as u32) .unwrap_or(0); if function_id < offset { return None; } let functions_section_type_ids = module.function_section().unwrap().entries(); Some(functions_section_type_ids[(function_id - offset) as usize].type_ref()) } fn add_function_type_id_to_builtins( module: &Module, builtins: &mut Vec<Builtin>, ) -> Result<(), WError> { for builtin in builtins.iter_mut() { let function_type_id = function_type_id_for_function_id(module, builtin.original_function_id.unwrap()) .expect("Function ID not found"); builtin.function_type_id = Some(function_type_id); } Ok(()) } fn retain_only_used_builtins(module: &Module, builtins: &mut Vec<Builtin>) -> Result<(), WError> { let export_section = module.export_section().expect("No export section"); for entry in export_section.entries() { let internal = entry.internal(); let function_id = match internal { Internal::Function(function_id) => *function_id, _ => continue, }; let field = entry.field(); for builtin in builtins.iter_mut() { if field == builtin.name { assert!(builtin.original_function_id.is_none()); builtin.original_function_id = Some(function_id); break; } } } builtins.retain(|builtin| builtin.original_function_id.is_some()); Ok(()) } fn add_import_section_if_missing(module: &mut Module) -> Result<(), WError> { if module.import_section().is_some() { return Ok(()); } let import_section = ImportSection::with_entries(vec![]); let import_section_idx = find_type_section_idx(&module).unwrap() + 1; module .sections_mut() .insert(import_section_idx, Section::Import(import_section)); Ok(()) } fn prepend_builtin_to_import_section(module: &mut Module, builtin: &Builtin) -> Result<(), WError> { let import_name = builtin.import_name(); let external = External::Function(builtin.function_type_id.unwrap()); let import_entry = ImportEntry::new("env".to_string(), import_name, external); module .import_section_mut() .unwrap() .entries_mut() .insert(0, import_entry); Ok(()) } fn prepend_builtin_to_names_section(module: &mut Module, builtin: &Builtin) -> Result<(), WError> { let import_name = builtin.import_name(); if module.names_section().is_none() { let sections = module.sections_mut(); let function_names_subsection = FunctionNameSubsection::default(); let name_section = NameSection::new(None, Some(function_names_subsection), None); sections.push(Section::Name(name_section)); } let names_section = module .names_section_mut() .expect("Names section not present"); let function_names_subsection = match names_section.functions_mut() { Some(function_names_subsection) => function_names_subsection, _ => xbail!(WError::InternalError("Unexpected names section")), }; prepend_function_name(function_names_subsection, import_name)?; Ok(()) } fn patch_module( module: Module, builtins_names: &[&str], ) -> Result<(Module, PatchedBuiltinsMap), WError> { let mut module = module .parse_names() .map_err(|_| WError::InternalError("Unable to parse names"))?; let mut builtins: Vec<_> = builtins_names .iter() .map(|x| Builtin::new(x.to_string())) .collect(); retain_only_used_builtins(&module, &mut builtins)?; add_function_type_id_to_builtins(&module, &mut builtins)?; add_import_section_if_missing(&mut module)?; for (builtin_idx, builtin) in builtins.iter_mut().enumerate() { prepend_builtin_to_import_section(&mut module, &builtin)?; prepend_builtin_to_names_section(&mut module, &builtin)?; shift_function_ids(&mut module, 1)?; let original_function_id = builtin.original_function_id.unwrap() + builtin_idx as u32 + 1; let new_function_id = 0; replace_function_id(&mut module, original_function_id, new_function_id)?; } let mut patched_builtins_map = PatchedBuiltinsMap::with_capacity(builtins.len()); for builtin in builtins { patched_builtins_map.insert(builtin.name.clone(), builtin.import_name()); } Ok((module, patched_builtins_map)) }