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 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 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
use super::{
safe::SchemaNode as SafeSchemaNode,
union_variants_per_type_lookup::PerTypeLookup as UnionVariantsPerTypeLookup, Decimal, Fixed,
Name,
};
use std::collections::HashMap;
/// The most performant and easiest to navigate version of an Avro schema
///
/// Navigated through [`SchemaNode`] via [`.root`](Schema::root).
///
/// To achieve the ideal performance and ease of use via self-referencing
/// [`SchemaNode`]s all held in the [`Schema`], it is built using `unsafe`, so
/// it can only be built through
/// [its safe counterpart](crate::schema::safe::Schema) (via [`From`]) because
/// it makes the conversion code simple enough that we can reasonably guarantee
/// its correctness despite the usage of `unsafe`.
///
/// It is useful to implement it this way because, due to how referencing via
/// [Names](https://avro.apache.org/docs/current/specification/#names) works in Avro,
/// the most performant representation of an Avro schema is not a tree but a
/// possibly-cyclic general directed graph.
pub struct Schema {
// First node in the array is considered to be the root
//
// This lifetime is fake, but since all elements have to be accessed by the `root` function
// which will downcast it and we never push anything more in there (which would cause
// reallocation and invalidate all nodes) this is correct.
nodes: Vec<SchemaNode<'static>>,
parsing_canonical_form: String,
fingerprint: [u8; 8],
}
impl Schema {
/// The Avro schema is represented internally as a directed graph of nodes,
/// all stored in [`Schema`].
///
/// The root node represents the whole schema.
pub fn root<'a>(&'a self) -> &'a SchemaNode<'a> {
// the signature of this function downgrades the fake 'static lifetime in a way
// that makes it correct
&self.nodes[0]
}
/// Obtain the
/// [Parsing Canonical Form](https://avro.apache.org/docs/current/specification/#parsing-canonical-form-for-schemas)
/// of the schema
pub fn parsing_canonical_form(&self) -> &str {
self.parsing_canonical_form.as_str()
}
/// Obtain the Rabin fingerprint of the schema
pub fn rabin_fingerprint(&self) -> &[u8; 8] {
&self.fingerprint
}
}
/// A node of an avro schema, borrowed from a [`Schema`].
///
/// More information about Avro schemas can be found in the
/// [Avro Specification](https://avro.apache.org/docs/current/specification/).
///
/// This enum is borrowed from a [`Schema`] and is used to navigate it.
pub enum SchemaNode<'a> {
/// A `null` Avro schema.
Null,
/// A `boolean` Avro schema.
Boolean,
/// An `int` Avro schema.
Int,
/// A `long` Avro schema.
Long,
/// A `float` Avro schema.
Float,
/// A `double` Avro schema.
Double,
/// A `bytes` Avro schema.
/// `Bytes` represents a sequence of 8-bit unsigned bytes.
Bytes,
/// A `string` Avro schema.
/// `String` represents a unicode character sequence.
String,
/// A `array` Avro schema. Avro arrays are required to have the same type
/// for each element. This variant holds the `Schema` for the array element
/// type.
Array(&'a SchemaNode<'a>),
/// A `map` Avro schema.
/// `Map` holds a pointer to the `Schema` of its values, which must all be
/// the same schema. `Map` keys are assumed to be `string`.
Map(&'a SchemaNode<'a>),
/// A `union` Avro schema.
///
/// These can be deserialized into rust enums, where the variant name
/// should match:
/// - If it's not a named type, the PascalCase of the type (e.g. `String`,
/// `Uuid`...)
/// - If it's a named type, the fully qualified name of the type (e.g for a
/// record `{"namespace": "foo", "name": "bar"}`, `foo.bar`)
///
/// See the `tests/unions.rs` file for more examples.
Union(Union<'a>),
/// A `record` Avro schema.
Record(Record<'a>),
/// An `enum` Avro schema.
///
/// These can be deserialized into rust enums, matching on the name
/// as defined in the schema.
Enum(Enum),
/// A `fixed` Avro schema.
Fixed(Fixed),
/// Logical type which represents `Decimal` values. The underlying type is
/// serialized and deserialized as `Schema::Bytes` or `Schema::Fixed`.
///
/// `scale` defaults to 0 and is an integer greater than or equal to 0 and
/// `precision` is an integer greater than 0.
///
/// <https://avro.apache.org/docs/current/specification/#decimal>
Decimal(Decimal),
/// A universally unique identifier, annotating a string.
Uuid,
/// Logical type which represents the number of days since the unix epoch.
/// Serialization format is `Schema::Int`.
Date,
/// The time of day in number of milliseconds after midnight with no
/// reference any calendar, time zone or date in particular.
TimeMillis,
/// The time of day in number of microseconds after midnight with no
/// reference any calendar, time zone or date in particular.
TimeMicros,
/// An instant in time represented as the number of milliseconds after the
/// UNIX epoch.
///
/// You probably want to use
/// [`TimestampMilliSeconds`](https://docs.rs/serde_with/latest/serde_with/struct.TimestampMilliSeconds.html)
/// from [`serde_with`](https://docs.rs/serde_with/latest/serde_with/index.html#examples) when deserializing this.
TimestampMillis,
/// An instant in time represented as the number of microseconds after the
/// UNIX epoch.
///
/// You probably want to use
/// [`TimestampMicroSeconds`](https://docs.rs/serde_with/latest/serde_with/struct.TimestampMicroSeconds.html)
/// from [`serde_with`](https://docs.rs/serde_with/latest/serde_with/index.html#examples) when deserializing this.
TimestampMicros,
/// An amount of time defined by a number of months, days and milliseconds.
///
/// This deserializes to a struct that has the `months`, `days`, and
/// `milliseconds` fields declared as `u32`s, or to a `(u32, u32, u32)`
/// tuple, or to its raw representation [as defined by the specification](https://avro.apache.org/docs/current/specification/#duration)
/// if the deserializer is hinted this way ([`serde_bytes`](https://docs.rs/serde_bytes/latest/serde_bytes/)).
Duration,
}
/// Component of a [`SchemaNode`]
pub struct Union<'a> {
pub variants: Vec<&'a SchemaNode<'a>>,
pub(crate) per_type_lookup: UnionVariantsPerTypeLookup<'a>,
}
impl std::fmt::Debug for Union<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
// Skip per_type_lookup for readability
f.debug_struct("Union")
.field("variants", &self.variants)
.finish()
}
}
/// Component of a [`SchemaNode`]
pub struct Record<'a> {
pub fields: Vec<RecordField<'a>>,
pub name: Name,
pub per_name_lookup: HashMap<String, usize>,
}
impl<'a> std::fmt::Debug for Record<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
// Skip per_type_lookup for readability
f.debug_struct("Record")
.field("fields", &self.fields)
.field("name", &self.name)
.finish()
}
}
/// Component of a [`SchemaNode`]
#[derive(Debug)]
pub struct RecordField<'a> {
pub name: String,
pub schema: &'a SchemaNode<'a>,
}
/// Component of a [`SchemaNode`]
#[derive(Clone)]
pub struct Enum {
pub symbols: Vec<String>,
pub name: Name,
pub per_name_lookup: HashMap<String, usize>,
}
impl std::fmt::Debug for Enum {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
// Skip per_type_lookup for readability
f.debug_struct("Enum")
.field("name", &self.name)
.field("symbols", &self.symbols)
.finish()
}
}
impl From<super::safe::Schema> for Schema {
fn from(safe: super::safe::Schema) -> Self {
// This allocation should never be moved otherwise references will become
// invalid
let mut ret = Self {
nodes: (0..safe.nodes.len()).map(|_| SchemaNode::Null).collect(),
parsing_canonical_form: safe.parsing_canonical_form,
fingerprint: safe.fingerprint,
};
let len = ret.nodes.len();
// Let's be extra-sure (second condition is for calls to add)
assert!(len > 0 && len == safe.nodes.len() && len <= (isize::MAX as usize));
let storage_start_ptr = ret.nodes.as_mut_ptr();
// unsafe closure used below in unsafe block
let key_to_node = |schema_key: super::safe::SchemaKey| -> &'static SchemaNode {
let idx = schema_key.idx;
assert!(idx < len);
unsafe { &*(storage_start_ptr.add(schema_key.idx)) }
};
let mut curr_storage_node_ptr = storage_start_ptr;
for safe_node in safe.nodes {
// Safety:
// - The nodes we create here are never moving in memory since the entire vec is
// preallocated, and even when moving a vec, the pointed space doesn't move.
// - The fake `'static` lifetimes are always downgraded before being made
// available.
// - We only use pointers from the point at which we call `as_mut_ptr` so the
// compiler will not have aliasing constraints.
// - We don't dereference the references we create in key_to_node until they
// they are all initialized.
unsafe {
*curr_storage_node_ptr = match safe_node {
SafeSchemaNode::Null => SchemaNode::Null,
SafeSchemaNode::Boolean => SchemaNode::Boolean,
SafeSchemaNode::Int => SchemaNode::Int,
SafeSchemaNode::Long => SchemaNode::Long,
SafeSchemaNode::Float => SchemaNode::Float,
SafeSchemaNode::Double => SchemaNode::Double,
SafeSchemaNode::Bytes => SchemaNode::Bytes,
SafeSchemaNode::String => SchemaNode::String,
SafeSchemaNode::Array(schema_key) => SchemaNode::Array(key_to_node(schema_key)),
SafeSchemaNode::Map(schema_key) => SchemaNode::Map(key_to_node(schema_key)),
SafeSchemaNode::Union(union) => SchemaNode::Union({
Union {
variants: union
.variants
.into_iter()
.map(|schema_key| key_to_node(schema_key))
.collect(),
per_type_lookup: {
// Can't be initialized just yet because other nodes
// may not have been initialized
UnionVariantsPerTypeLookup::placeholder()
},
}
}),
SafeSchemaNode::Record(record) => SchemaNode::Record(Record {
per_name_lookup: record
.fields
.iter()
.enumerate()
.map(|(i, v)| (v.name.clone(), i))
.collect(),
fields: record
.fields
.into_iter()
.map(|f| RecordField {
name: f.name,
schema: key_to_node(f.schema),
})
.collect(),
name: record.name,
}),
SafeSchemaNode::Enum(enum_) => SchemaNode::Enum(Enum {
per_name_lookup: enum_
.symbols
.iter()
.enumerate()
.map(|(i, v)| (v.clone(), i))
.collect(),
symbols: enum_.symbols,
name: enum_.name,
}),
SafeSchemaNode::Fixed(fixed) => SchemaNode::Fixed(fixed),
SafeSchemaNode::Decimal(decimal) => SchemaNode::Decimal(decimal),
SafeSchemaNode::Uuid => SchemaNode::Uuid,
SafeSchemaNode::Date => SchemaNode::Date,
SafeSchemaNode::TimeMillis => SchemaNode::TimeMillis,
SafeSchemaNode::TimeMicros => SchemaNode::TimeMicros,
SafeSchemaNode::TimestampMillis => SchemaNode::TimestampMillis,
SafeSchemaNode::TimestampMicros => SchemaNode::TimestampMicros,
SafeSchemaNode::Duration => SchemaNode::Duration,
};
curr_storage_node_ptr = curr_storage_node_ptr.add(1);
};
}
// Now that all the nodes have been initialized (except their `per_type_lookup`
// tables) we can initialize the `per_type_lookup` tables
curr_storage_node_ptr = storage_start_ptr;
for _ in 0..len {
// Safety:
// - UnionVariantsPerTypeLookup won't ever read `per_type_lookup` of the other
// nodes, so there are no aliasing issues. (Tbh I'm not even sure that would
// really be an issue because we'd have `& &mut` anyway but with that I'm sure
// there isn't an issue)
unsafe {
match *curr_storage_node_ptr {
SchemaNode::Union(Union {
ref variants,
ref mut per_type_lookup,
}) => {
*per_type_lookup = UnionVariantsPerTypeLookup::new(variants);
}
_ => {}
}
curr_storage_node_ptr = curr_storage_node_ptr.add(1);
}
}
ret
}
}
impl std::fmt::Debug for Schema {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
<SchemaNode<'_> as std::fmt::Debug>::fmt(self.root(), f)
}
}
impl<'a> std::fmt::Debug for SchemaNode<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> ::std::fmt::Result {
// Avoid going into stack overflow when rendering SchemaNode's debug impl, in
// case there are loops
use std::cell::Cell;
struct SchemaNodeRenderingDepthGuard;
thread_local! {
static DEPTH: Cell<u32> = Cell::new(0);
}
impl Drop for SchemaNodeRenderingDepthGuard {
fn drop(&mut self) {
DEPTH.with(|cell| cell.set(cell.get().checked_sub(1).unwrap()));
}
}
const MAX_DEPTH: u32 = 2;
let depth = DEPTH.with(|cell| {
let val = cell.get();
cell.set(val + 1);
val
});
let _decrement_depth_guard = SchemaNodeRenderingDepthGuard;
match *self {
SchemaNode::Null => f.debug_tuple("Null").finish(),
SchemaNode::Boolean => f.debug_tuple("Boolean").finish(),
SchemaNode::Int => f.debug_tuple("Int").finish(),
SchemaNode::Long => f.debug_tuple("Long").finish(),
SchemaNode::Float => f.debug_tuple("Float").finish(),
SchemaNode::Double => f.debug_tuple("Double").finish(),
SchemaNode::Bytes => f.debug_tuple("Bytes").finish(),
SchemaNode::String => f.debug_tuple("String").finish(),
SchemaNode::Array(inner) => {
let mut d = f.debug_tuple("Array");
if depth < MAX_DEPTH {
d.field(inner);
}
d.finish()
}
SchemaNode::Map(inner) => {
let mut d = f.debug_tuple("Map");
if depth < MAX_DEPTH {
d.field(inner);
}
d.finish()
}
SchemaNode::Union(ref inner) => {
let mut d = f.debug_tuple("Union");
if depth < MAX_DEPTH {
d.field(inner);
}
d.finish()
}
SchemaNode::Record(ref inner) => {
let mut d = f.debug_tuple("Record");
if depth < MAX_DEPTH {
d.field(inner);
}
d.finish()
}
SchemaNode::Enum(ref inner) => {
let mut d = f.debug_tuple("Enum");
if depth < MAX_DEPTH {
d.field(inner);
}
d.finish()
}
SchemaNode::Fixed(ref inner) => {
let mut d = f.debug_tuple("Fixed");
if depth < MAX_DEPTH {
d.field(inner);
}
d.finish()
}
SchemaNode::Decimal(ref inner) => {
let mut d = f.debug_tuple("Decimal");
if depth < MAX_DEPTH {
d.field(inner);
}
d.finish()
}
SchemaNode::Uuid => f.debug_tuple("Uuid").finish(),
SchemaNode::Date => f.debug_tuple("Date").finish(),
SchemaNode::TimeMillis => f.debug_tuple("TimeMillis").finish(),
SchemaNode::TimeMicros => f.debug_tuple("TimeMicros").finish(),
SchemaNode::TimestampMillis => f.debug_tuple("TimestampMillis").finish(),
SchemaNode::TimestampMicros => f.debug_tuple("TimestampMicros").finish(),
SchemaNode::Duration => f.debug_tuple("Duration").finish(),
}
}
}