Mike Gerwitz

Activist for User Freedom

aboutsummaryrefslogtreecommitdiffstats
blob: 7dd764b193c62e83e9e4e35f69828afd008142f5 (plain)
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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
// Proof-of-concept TAME linker
//
//  Copyright (C) 2014-2019 Ryan Specialty Group, LLC.
//
//  This program 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.
//
//  This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

//! **This is a poorly-written proof of concept; do not use!**  It has been
//! banished to its own file to try to make that more clear.

use crate::global;
use crate::ir::asg::IdentKind;
use crate::ir::asg::{Asg, DefaultAsg, Object, ObjectRef, Source};
use crate::obj::xmlo::reader::{XmloError, XmloEvent, XmloReader};
use crate::sym::{DefaultInterner, Interner, Symbol};
use fxhash::{FxHashMap, FxHashSet};
use petgraph::visit::DfsPostOrder;
use quick_xml::events::{BytesEnd, BytesStart, BytesText, Event};
use quick_xml::Writer;
use std::convert::TryInto;
use std::error::Error;
use std::fs;
use std::io::{BufReader, Write};

type LinkerAsg<'i> = DefaultAsg<'i, global::ProgIdentSize>;
type LinkerObjectRef = ObjectRef<global::ProgIdentSize>;

pub fn main() -> Result<(), Box<dyn Error>> {
    let mut pkgs_seen: FxHashSet<String> = Default::default();
    let mut fragments: FxHashMap<&str, String> = Default::default();
    let mut depgraph = LinkerAsg::with_capacity(65536, 65536);
    let mut roots = Vec::new();
    let interner = DefaultInterner::new();

    let package_path = std::env::args().nth(1).expect("Missing argument");
    let abs_path = fs::canonicalize(package_path).unwrap();

    println!("WARNING: This is proof-of-concept; do not use!");

    let (name, relroot) = load_xmlo(
        &abs_path.to_str().unwrap().to_string(),
        &mut pkgs_seen,
        &mut fragments,
        &mut depgraph,
        &interner,
        &mut roots,
    )?
    .expect("missing root package information");

    //    println!(
    //        "Graph {:?}",
    //        depgraph
    //            .graph
    //            .raw_nodes()
    //            .iter()
    //            .map(|node| &node.weight)
    //            .collect::<Vec<_>>()
    //    );

    roots.extend(
        vec!["___yield", "___worksheet"]
            .iter()
            .map(|name| interner.intern(name))
            .filter_map(|sym| depgraph.lookup(sym)),
    );

    let sorted = sort_deps(&depgraph, &roots);

    //println!("Sorted ({}): {:?}", sorted.len(), sorted);

    output_xmle(
        &depgraph,
        &interner,
        sorted,
        name.expect("missing root package name"),
        relroot.expect("missing root package relroot"),
    )?;

    Ok(())
}

fn load_xmlo<'a, 'i, I: Interner<'i>>(
    path_str: &'a str,
    pkgs_seen: &mut FxHashSet<String>,
    fragments: &mut FxHashMap<&'i str, String>,
    depgraph: &mut LinkerAsg<'i>,
    interner: &'i I,
    roots: &mut Vec<LinkerObjectRef>,
) -> Result<Option<(Option<&'i Symbol<'i>>, Option<String>)>, Box<dyn Error>> {
    let path = fs::canonicalize(path_str)?;
    let path_str = path.to_str().unwrap();

    let first = pkgs_seen.len() == 0;

    if !pkgs_seen.insert(path_str.to_string()) {
        return Ok(None);
    }

    //println!("processing {}", path_str);

    let mut found: FxHashSet<&str> = Default::default();

    let file = fs::File::open(&path)?;
    let reader = BufReader::new(file);
    let mut xmlo = XmloReader::new(reader, interner);
    let mut elig = None;

    let mut name: Option<&'i Symbol<'i>> = None;
    let mut relroot: Option<String> = None;

    loop {
        match xmlo.read_event() {
            Ok(XmloEvent::Package(attrs)) => {
                if first {
                    name = attrs.name;
                    relroot = attrs.relroot;
                }
                elig = attrs.elig;
            }

            Ok(XmloEvent::SymDeps(sym, deps)) => {
                // TODO: API needs to expose whether a symbol is already
                // known so that we can warn on them

                // Maps should not pull in symbols since we may end up
                // mapping to params that are never actually used
                if !sym.starts_with(":map:") {
                    for dep_sym in deps {
                        depgraph.add_dep_lookup(sym, dep_sym);
                    }
                }
            }

            Ok(XmloEvent::SymDecl(sym, attrs)) => {
                if let Some(sym_src) = attrs.src {
                    found.insert(sym_src);
                } else if attrs.extern_ {
                    // TODO: externs (they're implicitly handled, without
                    // checks, by Missing)
                    // depgraph.declare_extern(sym, kind);
                } else {
                    let owned = attrs.src.is_none();

                    let kind = (&attrs).try_into().map_err(|err| {
                        format!("sym `{}` attrs error: {}", sym, err)
                    });

                    let mut src: Source = attrs.into();

                    // Existing convention is to omit @src of local package
                    // (in this case, the program being linked)
                    if first {
                        src.pkg_name = None;
                    }

                    // TODO: should probably track these down in the XSLT linker...
                    match kind {
                        Ok(kindval) => {
                            // TODO: inefficient
                            let link_root = owned
                                && (kindval == IdentKind::Meta
                                    || kindval == IdentKind::Map
                                    || kindval == IdentKind::RetMap);

                            let node = depgraph.declare(sym, kindval, src)?;

                            if link_root {
                                roots.push(node);
                            }
                        }
                        Err(e) => println!("{:?}; skipping...", e),
                    };
                }
            }

            Ok(XmloEvent::Fragment(sym, text)) => {
                let result = depgraph.set_fragment(
                    depgraph.lookup(sym).expect(&format!(
                        "missing symbol for fragment: {}",
                        sym
                    )),
                    text,
                );

                match result {
                    Ok(_) => (),
                    Err(e) => println!("{:?}; skipping...", e),
                };
            }

            // We don't need to read any further than the end of the
            // header (symtable, sym-deps, fragments)
            Ok(XmloEvent::Eoh) => break,

            Err(err @ XmloError::UnassociatedFragment) => {
                println!("{:?}; skipping...", err);
            }

            err @ Err(_) => err.map(|_| ())?,
        }
    }

    if let Some(elig_sym) = elig {
        roots.push(depgraph.lookup(elig_sym).expect(
            "internal error: package elig references nonexistant symbol",
        ));
    }

    let mut dir = path.clone();
    dir.pop();

    for relpath in found.iter() {
        let mut path_buf = dir.clone();
        path_buf.push(relpath);
        path_buf.set_extension("xmlo");

        // println!("Trying {:?}", path_buf);
        let path_abs = path_buf.canonicalize().unwrap();
        let path = path_abs.to_str().unwrap();

        load_xmlo(path, pkgs_seen, fragments, depgraph, interner, roots)?;
    }

    if first {
        Ok(Some((name, relroot)))
    } else {
        Ok(None)
    }
}

type ObjectVec<'a, 'i> = Vec<&'a Object<'i>>;

// Note that the classifier has nothing in it anymore; it's only there for
// API compability, so we don't include it here.
#[derive(Default)]
struct SortedDeps<'a, 'i> {
    map: ObjectVec<'a, 'i>,
    retmap: ObjectVec<'a, 'i>,
    meta: ObjectVec<'a, 'i>,
    worksheet: ObjectVec<'a, 'i>,
    params: ObjectVec<'a, 'i>,
    types: ObjectVec<'a, 'i>,
    funcs: ObjectVec<'a, 'i>,
    rater: ObjectVec<'a, 'i>,
}

fn sort_deps<'a, 'i>(
    depgraph: &'a LinkerAsg<'i>,
    roots: &Vec<LinkerObjectRef>,
) -> SortedDeps<'a, 'i> {
    // @type=meta, @preproc:elig-class-yields
    // @type={ret}map{,:head,:tail}

    let mut deps: SortedDeps = Default::default();

    // This is technically a topological sort, but functions have
    // cycles.  Once we have more symbol metadata, we can filter them out
    // and actually invoke toposort.
    let mut dfs = DfsPostOrder::empty(&depgraph);

    //println!("discovered roots: {:?}", roots);

    // TODO: we'll be processing various roots separately
    for index in roots {
        dfs.stack.push((*index).into());
    }

    // TODO: can we encapsulate NodeIndex?
    while let Some(index) = dfs.next(&depgraph) {
        let ident = depgraph.get(index).unwrap();

        match ident {
            Object::Ident(_, kind, _)
            | Object::IdentFragment(_, kind, _, _) => match kind {
                IdentKind::Meta => deps.meta.push(ident),
                IdentKind::Worksheet => deps.worksheet.push(ident),
                IdentKind::Param(_, _) => deps.params.push(ident),
                IdentKind::Type(_) => deps.types.push(ident),
                IdentKind::Func(_, _) => deps.funcs.push(ident),
                IdentKind::MapHead | IdentKind::Map | IdentKind::MapTail => {
                    deps.map.push(ident)
                }
                IdentKind::RetMapHead
                | IdentKind::RetMap
                | IdentKind::RetMapTail => deps.retmap.push(ident),
                _ => deps.rater.push(ident),
            },
            _ => panic!("unexpected node: {:?}", ident),
        }
    }

    deps
}

fn output_xmle<'a, 'i, I: Interner<'i>>(
    depgraph: &'a LinkerAsg<'i>,
    interner: &'i I,
    sorted: SortedDeps<'a, 'i>,
    name: &'i Symbol<'i>,
    relroot: String,
) -> Result<(), Box<dyn Error>> {
    use std::io::Cursor;

    let mut writer =
        Writer::new_with_indent(Cursor::new(Vec::new()), ' ' as u8, 2);

    let root =
        BytesStart::owned_name(b"package".to_vec()).with_attributes(vec![
            ("xmlns", "http://www.lovullo.com/rater"),
            ("xmlns:preproc", "http://www.lovullo.com/rater/preproc"),
            ("xmlns:l", "http://www.lovullo.com/rater/linker"),
            ("title", &name), // TODO
            ("program", "true"),
            ("name", &name),
            ("__rootpath", &relroot),
        ]);

    writer.write_event(Event::Start(root))?;

    // All of the other namespaces output in the existing xmle files are
    // unneeded.
    writer.write_event(Event::Start(BytesStart::borrowed_name(b"l:dep")))?;

    let all = sorted
        .meta
        .iter()
        .chain(sorted.map.iter())
        .chain(sorted.retmap.iter())
        .chain(sorted.worksheet.iter())
        .chain(sorted.params.iter())
        .chain(sorted.types.iter())
        .chain(sorted.funcs.iter())
        .chain(sorted.rater.iter());

    for ident in all {
        // TODO: we're doing this in two places!
        match ident {
            Object::Ident(sym, kind, src)
            | Object::IdentFragment(sym, kind, src, _) => {
                let name: &str = sym;

                // this'll be formalized more sanely
                let mut attrs = match kind {
                    IdentKind::Cgen(dim) => {
                        vec![("type", "cgen"), ("dim", dim.as_ref())]
                    }
                    IdentKind::Class(dim) => {
                        vec![("type", "class"), ("dim", dim.as_ref())]
                    }
                    IdentKind::Const(dim, dtype) => vec![
                        ("type", "const"),
                        ("dim", dim.as_ref()),
                        ("dtype", dtype.as_ref()),
                    ],
                    IdentKind::Func(dim, dtype) => vec![
                        ("type", "func"),
                        ("dim", dim.as_ref()),
                        ("dtype", dtype.as_ref()),
                    ],
                    IdentKind::Gen(dim, dtype) => vec![
                        ("type", "gen"),
                        ("dim", dim.as_ref()),
                        ("dtype", dtype.as_ref()),
                    ],
                    IdentKind::Lparam(dim, dtype) => vec![
                        ("type", "lparam"),
                        ("dim", dim.as_ref()),
                        ("dtype", dtype.as_ref()),
                    ],
                    IdentKind::Param(dim, dtype) => vec![
                        ("type", "param"),
                        ("dim", dim.as_ref()),
                        ("dtype", dtype.as_ref()),
                    ],
                    IdentKind::Rate(dtype) => {
                        vec![("type", "rate"), ("dtype", dtype.as_ref())]
                    }
                    IdentKind::Tpl => vec![("type", "tpl")],
                    IdentKind::Type(dtype) => {
                        vec![("type", "type"), ("dtype", dtype.as_ref())]
                    }
                    IdentKind::MapHead => vec![("type", "map:head")],
                    IdentKind::Map => vec![("type", "map")],
                    IdentKind::MapTail => vec![("type", "map:tail")],
                    IdentKind::RetMapHead => vec![("type", "retmap:head")],
                    IdentKind::RetMap => vec![("type", "retmap")],
                    IdentKind::RetMapTail => vec![("type", "retmap:tail")],
                    IdentKind::Meta => vec![("type", "meta")],
                    IdentKind::Worksheet => vec![("type", "worksheet")],
                };

                attrs.push(("name", name));

                if src.generated {
                    attrs.push(("preproc:generated", "true"));
                }

                let srcpath: String;
                if let Some(pkg_name) = src.pkg_name {
                    srcpath = relroot.clone() + pkg_name;
                    attrs.push(("src", &srcpath));
                }
                if let Some(parent) = src.parent {
                    attrs.push(("parent", parent));
                }
                if let Some(yields) = src.yields {
                    attrs.push(("yields", yields));
                }
                if let Some(desc) = &src.desc {
                    attrs.push(("desc", &desc));
                }

                let sym = BytesStart::owned_name(b"preproc:sym".to_vec())
                    .with_attributes(attrs);

                writer.write_event(Event::Empty(sym))?;
            }
            _ => unreachable!("filtered out during sorting"),
        }
    }

    writer.write_event(Event::End(BytesEnd::borrowed(b"l:dep")))?;

    // This was not in the original linker, but we need to be able to convey
    // this information for `standalones` (which has received some logic
    // from the old linker for the time being).
    writer
        .write_event(Event::Start(BytesStart::borrowed_name(b"l:map-from")))?;

    let mut map_froms: FxHashSet<&str> = Default::default();

    for map_ident in &sorted.map {
        match map_ident {
            Object::Ident(_, _, src) | Object::IdentFragment(_, _, src, _) => {
                if let Some(froms) = &src.from {
                    for from in froms {
                        map_froms.insert(from);
                    }
                }
            }

            _ => unreachable!("filtered out during sorting"),
        }
    }

    for from in map_froms {
        let name: &str = from;

        writer.write_event(Event::Empty(
            BytesStart::borrowed_name(b"l:from")
                .with_attributes(vec![("name", name)]),
        ))?;
    }

    writer.write_event(Event::End(BytesEnd::borrowed(b"l:map-from")))?;
    writer
        .write_event(Event::Start(BytesStart::borrowed_name(b"l:map-exec")))?;

    if sorted.map.len() > 0 {
        write_fragments(
            &mut writer,
            &vec![depgraph
                .get(depgraph.lookup(interner.intern(":map:___head")).unwrap())
                .unwrap()],
        )?;
        write_fragments(&mut writer, &sorted.map)?;
        write_fragments(
            &mut writer,
            &vec![depgraph
                .get(depgraph.lookup(interner.intern(":map:___tail")).unwrap())
                .unwrap()],
        )?;
    }

    writer.write_event(Event::End(BytesEnd::borrowed(b"l:map-exec")))?;
    writer.write_event(Event::Start(BytesStart::borrowed_name(
        b"l:retmap-exec",
    )))?;

    if sorted.retmap.len() > 0 {
        write_fragments(
            &mut writer,
            &vec![depgraph
                .get(
                    depgraph
                        .lookup(interner.intern(":retmap:___head"))
                        .unwrap(),
                )
                .unwrap()],
        )?;
        write_fragments(&mut writer, &sorted.retmap)?;
        write_fragments(
            &mut writer,
            &vec![depgraph
                .get(
                    depgraph
                        .lookup(interner.intern(":retmap:___tail"))
                        .unwrap(),
                )
                .unwrap()],
        )?;
    }

    writer.write_event(Event::End(BytesEnd::borrowed(b"l:retmap-exec")))?;
    writer.write_event(Event::Start(BytesStart::borrowed_name(b"l:static")))?;

    write_fragments(&mut writer, &sorted.meta)?;
    write_fragments(&mut writer, &sorted.worksheet)?;
    write_fragments(&mut writer, &sorted.params)?;
    write_fragments(&mut writer, &sorted.types)?;
    write_fragments(&mut writer, &sorted.funcs)?;

    writer.write_event(Event::End(BytesEnd::borrowed(b"l:static")))?;
    writer.write_event(Event::Start(BytesStart::borrowed_name(b"l:exec")))?;

    write_fragments(&mut writer, &sorted.rater)?;

    writer.write_event(Event::End(BytesEnd::borrowed(b"l:exec")))?;
    writer.write_event(Event::End(BytesEnd::borrowed(b"package")))?;

    print!("{}", String::from_utf8(writer.into_inner().into_inner())?);

    Ok(())
}

fn write_fragments<W: Write>(
    writer: &mut Writer<W>,
    idents: &ObjectVec,
) -> Result<(), Box<dyn Error>> {
    for ident in idents {
        match ident {
            Object::IdentFragment(_, _, _, frag) => {
                writer.write_event(Event::Text(BytesText::from_plain_str(
                    frag,
                )))?;
            }
            _ => (),
        }
    }

    Ok(())
}

#[cfg(test)]
mod test {
    #[test]
    fn placeholder() {}
}