Create Blog “2022-09-07-my-experience-teaching-performance-engineering”

.eleventy.js

@@ -19,6 +19,10 @@ str
 const featuredPosts = (post) => post.data.featured;
 
 module.exports = function(eleventyConfig) {
+  eleventyConfig.setQuietMode(true);
+  // Reuse 11ty's built-in `slugify` filter.
+  const slugifyFn = eleventyConfig.getFilter("slugify");
+
   // Support .yaml extension in _data
   eleventyConfig.addDataExtension("yaml", contents => yaml.load(contents));
 
@@ -81,6 +85,29 @@ module.exports = function(eleventyConfig) {
         .filter(featuredPosts);
   });
 
+  // for defn things see https://github.com/11ty/eleventy/issues/2565
+  eleventyConfig.addCollection("defns", function (collectionApi) {
+    const res = [];
+    for (const post of collectionApi.getAll()) {
+      // see https://github.com/11ty/eleventy/discussions/2153, re: "Tried to use templateContent too early".
+      const defs = post.template.frontMatter?.content.trim().matchAll(/{% defn (?<value>.*?) %}/gi);
+      for (const { groups } of defs) {
+        const [ term, text ] = groups.value.split(",").map(s => s.trim().replace(/"/g, ""));
+        res.push({ url: post.url, term, text });
+      }
+    }
+    return res;
+  });
+
+  eleventyConfig.addCollection("defnTerms", function (collectionApi) {
+    const defns = collectionApi.getFilteredByTag("glossary");
+    // Possibly over-engineered here. We might really only care about the slugified title and not the unslugged version.
+    const data = defns.reduce((acc, { data }) => {
+      return Object.assign(acc, {[slugifyFn(data.title)]: data.title});
+    }, {});
+    return data;
+  });
+
   eleventyConfig.addCollection('glossary', (collection) => {
     return collection
         .getFilteredByGlob("./src/doc/reference/glossary/*.md")
@@ -151,16 +178,21 @@ module.exports = function(eleventyConfig) {
     function(source='', size='400') { return `<img style="margin: 0.2em 4em 0.2em 2em; max-width:${size}; max-height:${size}" src="${source}" class="img-fluid float-start"></img>` }
   );
 
-  // Shortcode for glossary links
+  // Shortcode for glossary links (see https://github.com/11ty/eleventy/issues/2565#issuecomment-1246106301)
   eleventyConfig.addShortcode(
     "defn",
-    function(term='', text='') { 
-      const url = "/doc/reference/glossary/#" + slugify(term)
-      if (text=='') 
-        docText = term
-      else
-        docText = text
-      return `<a class="defn" href="${url}">${docText}</a>` 
+    function(term='', text='') {
+      // Some sneaky stuff here to get the context from the `this.ctx` object so we can access
+      // `collections` and `page` variables from within our shortcode.
+      const { collections, page } = this.ctx;
+      const slug = slugifyFn(term);
+      const glossaryUrl = `/doc/reference/glossary/#${slug}`;
+      // If our `collections.defnTerms` does NOT include the current slug, it's likely a bad link/defn.
+      if (!Object.keys(collections.defnTerms).includes(slug)) {
+        console.error(`[${page.url}] Unknown term: "${term}" => ${glossaryUrl}`);
+        // process.exitCode = 1;
+      }
+      return `<a class="defn" href="${glossaryUrl}">${text || term}</a>`;
     }
   );
 

.eleventyignore

@@ -1,2 +1,3 @@
 node_modules
-README.md
+README.md
+src/sphinx-bootstrap-theme

.gitignore

@@ -1,11 +1,16 @@
 _site/
 _tmp/
 .DS_Store
+env
 node_modules/
 .vscode/
 *git/
 package-lock.json
 .env
+src/sphinx
+src/sphinx-bootstrap-theme
+src/pydata-sphinx-theme
+*~
 
 # Local Netlify folder
 .netlify

package.json

@@ -28,6 +28,7 @@
     "@11ty/eleventy": "^1.0.0",
     "@11ty/eleventy-navigation": "^0.3.2",
     "@11ty/eleventy-plugin-rss": "^1.1.2",
+    "dotenv": "^16.0.2",
     "eleventy-plugin-toc": "^1.1.5",
     "js-yaml": "^4.1.0",
     "luxon": "^2.3.1",

src/_data/metadata.json

@@ -3,7 +3,7 @@
   "author": "The OpenCilk Team",
   "email": "[email protected]",
   "attribution": {
-    "cilkplus": "This work is derived from Cilk Plus documentation with permission of Intel Corporation and Cilk Arts."
+    "cilkplus": "This work is derived from Cilk++ documentation with permission of Intel Corporation."
   },
   "blog": {
     "title": "Fast Code",

src/_includes/code/qsort.cpp

@@ -0,0 +1,40 @@
+#include <iostream>
+#include <algorithm>
+#include <random>
+#include <cilk/cilk.h>
+
+constexpr std::ptrdiff_t BASE_CASE_LENGTH = 32;
+
+template <typename T>
+void sample_qsort(T* begin, T* end) {
+  if (end - begin < BASE_CASE_LENGTH) {
+    std::sort(begin, end);  // base case: serial sort
+  } else {
+    --end;  // exclude last element (pivot) from partition
+    T* middle = std::partition(begin, end,
+                               [pivot=*end](T a) { return a < pivot; });
+    std::swap(*end, *middle);  // move pivot to middle
+    cilk_scope {
+      cilk_spawn sample_qsort(begin, middle);
+      sample_qsort(++middle, ++end);  // exclude pivot and restore end
+    }
+  }
+}
+
+int main(int argc, char* argv[]) {
+  long n = 100 * 1000 * 1000;
+  if (argc == 2)
+    n = std::atoi(argv[1]);
+
+  std::default_random_engine rng;
+  std::uniform_int_distribution<long> dist(0,n);
+  std::vector<long> a(n);
+  std::generate(a.begin(), a.end(), [&]() { return dist(rng); });
+
+  std::cout << "Sorting " << n << " random integers" << std::endl;
+  sample_qsort(a.data(), a.data() + a.size());
+
+  bool pass = std::is_sorted(a.cbegin(), a.cend());
+  std::cout << "Sort " << ((pass) ? "succeeded" : "failed") << "\n";
+  return (pass) ? 0 : 1;
+}

src/_includes/layouts/base.njk

@@ -1,3 +1,4 @@
+{% if permalink !== false %}
 <html lang="{{ site.lang}}">
   {% include 'partials/header.njk' %}
   <body class="thumb d-flex flex-column vh-100">
@@ -92,3 +93,4 @@
     </div>
   </body>
 </html>
+{% endif %}

src/community.md

@@ -9,7 +9,7 @@ eleventyNavigation:
   order: 5
 ---
 
-OpenCilk is a community-driven open source project developed by a diverse group of contributors. [Join us](/contribute)!
+OpenCilk is a community-driven open source project developed by a diverse group of contributors. [Join us](/community/join-us/)!
 
 ## Where can I get help?
 

src/community/community.11tydata.js

@@ -0,0 +1,54 @@
+require('dotenv').config();
+
+const isDevEnv = process.env.ELEVENTY_ENV === 'development';
+const todaysDate = new Date();
+
+function showDraft(data) {
+	const isDraft = 'draft' in data && data.draft !== false;
+	const isFutureDate = data.page.date > todaysDate;
+	return isDevEnv || (!isDraft && !isFutureDate);
+}
+
+module.exports = function() {
+	return {
+		eleventyComputed: {
+			eleventyExcludeFromCollections: function(data) {
+				if(showDraft(data)) {
+					return data.eleventyExcludeFromCollections;
+				}
+				else {
+					return true;
+				}
+			},
+			permalink: function(data) {
+				if(showDraft(data)) {
+					return data.permalink
+				}
+				else {
+					return false;
+				}
+			},
+      eleventyNavigation: {
+        key: function(data) {   
+          if(showDraft(data)) {
+            return data.title
+          }
+          else {
+            return false;
+          }
+        }
+      },
+      sidebar: function(data) {
+        return 'toc';
+      },
+      background: function(data) {
+				if(('draft' in data && data.draft !== false) || (data.page.date > todaysDate)) {
+					return 'text-white bg-info'
+				}
+				else {
+					return 'bg-white';
+        }
+      }
+		}
+	}
+}

src/community/join-us.md

@@ -0,0 +1,19 @@
+---
+layout: layouts/page.njk
+sidebar: toc
+title: Join us
+eleventyNavigation:
+  key: Join us
+  order: 1
+---
+
+The OpenCilk project welcomes your expertise and enthusiasm. Please fill out the form below to get started. Thank you for your interest!
+
+<script charset="utf-8" type="text/javascript" src="//js.hsforms.net/forms/embed/v2.js"></script>
+<script>
+  hbspt.forms.create({
+    region: "na1",
+    portalId: "23473286",
+    formId: "c934cff4-d083-48d8-84b3-0c5f5477cacc"
+  });
+</script>

src/community/resources.md

@@ -2,6 +2,7 @@
 layout: layouts/page.njk
 sidebar: toc
 title: Resources
+draft: true
 eleventyNavigation:
   key: Resources
   parent: Community

src/community/software.md

@@ -0,0 +1,42 @@
+---
+layout: layouts/page.njk
+sidebar: toc
+title: Software
+eleventyNavigation:
+  key: Software
+  parent: Community
+  order: 99
+---
+
+This page lists software contributed by the community that is related to OpenCilk, including OpenCilk-powered applications and libraries and
+miscellaneous tools to help developers write Cilk programs.
+
+## OpenCilk-powered libraries
+
+The following third-party libraries are known to work with OpenCilk out of the
+box for parallel execution.
+
+- [SG-t-SNE-Π](https://github.com/fcdimitr/sgtsnepi): Low-dimensional embedding
+  of sparse stochastic graphs.
+- [FGLT](https://github.com/ailiop/fglt): Fast graphlet transform.
+- [RecFMM](https://github.com/zhang416/recfmm): Adaptive fast multipole method.
+- [ParlayLib](https://github.com/cmuparlay/parlaylib): A toolkit for programming parallel algorithms on shared-memory multicore machines.
+
+## OpenCilk-powered applications
+
+The following third-party applications are known to work with OpenCilk.
+
+- [The Problem Based Benchmark Suite (V2)](https://cmuparlay.github.io/pbbsbench/): A collection of over 20 benchmarks defined in terms of their IO characteristics.
+- [GBBS: Graph Based Benchmark Suite](https://github.com/ParAlg/gbbs): A collection of fast parallel graph algorithms.
+- [mold](https://github.com/wheatman/mold): A port of the mold linker to OpenCilk.
+
+## Miscellaneous developer tools
+
+- [cilk-mode.el](https://github.com/ailiop/cilk-mode/): Emacs minor mode for
+  Cilk source code.
+
+## Contribute
+
+Want your OpenCilk-powered software listed here?  Contact us at [[email protected]](mailto:[email protected]).
+
+You can find more information on contributing to OpenCilk [here](/contribute).