diff --git a/Makefile b/Makefile index 24ae6ba..7c1c096 100755 --- a/Makefile +++ b/Makefile @@ -1,15 +1,26 @@ SPEC=PNA +ROUGE_STYLE=github +ROUGE_CSS=style -all: build/${SPEC}.pdf +all: ${SPEC}.pdf ${SPEC}.html -build/${SPEC}.pdf: ${SPEC}.mdk - madoko --pdf -vv --png --odir=build $< +build: +${SPEC}.pdf: ${SPEC}.adoc pna.p4 + time asciidoctor-pdf -v \ + -r asciidoctor-mathematical \ + -r asciidoctor-bibtex \ + -a pdf-fontsdir=resources/fonts \ + -a rouge-style=$(ROUGE_STYLE) $< -build/${SPEC}.pdf: p4.json -build/${SPEC}.pdf: pna.p4 +${SPEC}.html: ${SPEC}.adoc pna.p4 + time asciidoctor -v \ + -r asciidoctor-mathematical \ + -r asciidoctor-bibtex \ + -a rouge-css=$(ROUGE_CSS) $< + clean: - ${RM} -rf build + /bin/rm -f ${SPEC}.pdf ${SPEC}.html P4C=p4test #P4C=p4test --Wdisable=uninitialized_out_param diff --git a/PNA.mdk b/PNA.adoc similarity index 71% rename from PNA.mdk rename to PNA.adoc index a959dbb..989faa6 100644 --- a/PNA.mdk +++ b/PNA.adoc @@ -1,150 +1,32 @@ -Title : P4 Portable NIC Architecture (PNA) -Title Note: (working draft after version 0.7 release) -Title Footer: &date; -Author : The P4.org Architecture Working Group -Heading depth: 4 -Pdf Latex: xelatex -Document Class: [11pt]article -Package: [top=1in, bottom=1.25in, left=1in, right=1in]geometry -Package: fancyhdr - -Tex Header: - \setlength{\headheight}{30pt} - \renewcommand{\footrulewidth}{0.5pt} - -@if html { -body.madoko { - font-family: utopia-std, serif; -} -title,titlenote,titlefooter,authors,h1,h2,h3,h4,h5 { - font-family: helvetica, sans-serif; - font-weight: bold; -} -pre, code { - language: p4; - font-family: monospace; - font-size: 10pt; -} -} - -@if tex { -body.madoko { - font-family: UtopiaStd-Regular; -} -title,titlenote,titlefooter,authors { - font-family: sans-serif; - font-weight: bold; -} -pre, code { - language: p4; - font-family: LuxiMono; - font-size: 75%; -} -} - -Colorizer: p4 -.token.keyword { - font-weight: bold; -} - -@if html { -p4example { - replace: "~ Begin P4ExampleBlock&nl;\ - ````&nl;&source;&nl;````&nl;\ - ~ End P4ExampleBlock"; - padding:6pt; - margin-top: 6pt; - margin-bottom: 6pt; - border: solid; - background-color: #ffffdd; - border-width: 0.5pt; -} -} - -@if tex { -p4example { - replace: "~ Begin P4ExampleBlock&nl;\ - ````&nl;&source;&nl;````&nl;\ - ~ End P4ExampleBlock"; - breakable: true; - padding: 6pt; - margin-top: 6pt; - margin-bottom: 6pt; - border: solid; - background-color: #ffffdd; - border-width: 0.5pt; -} -} - - -@if html { -p4pseudo { - replace: "~ Begin P4PseudoBlock&nl;\ - ````&nl;&source;&nl;````&nl;\ - ~ End P4PseudoBlock"; - padding: 6pt; - margin-top: 6pt; - margin-bottom: 6pt; - border: solid; - background-color: #e9fce9; - border-width: 0.5pt; -} -} - -@if tex { -p4pseudo { - replace: "~ Begin P4PseudoBlock&nl;\ - ````&nl;&source;&nl;````&nl;\ - ~ End P4PseudoBlock"; - breakable : true; - padding: 6pt; - margin-top: 6pt; - margin-bottom: 6pt; - background-color: #e9fce9; - border: solid; - border-width: 0.5pt; -} -} - -@if html { -p4grammar { - replace: "~ Begin P4GrammarBlock&nl;\ - ````&nl;&source;&nl;````&nl;\ - ~ End P4GrammarBlock"; - border: solid; - margin-top: 6pt; - margin-bottom: 6pt; - padding: 6pt; - background-color: #e6ffff; - border-width: 0.5pt; -} -} - -@if tex { -p4grammar { - replace: "~ Begin P4GrammarBlock&nl;\ - ````&nl;&source;&nl;````&nl;\ - ~ End P4GrammarBlock"; - breakable: true; - margin-top: 6pt; - margin-bottom: 6pt; - padding: 6pt; - background-color: #e6ffff; - border: solid; - border-width: 0.5pt; -} -} - -tbd { - replace: "~ Begin TbdBlock&nl;\ - TBD: &source;&nl;\ - ~ End TbdBlock&nl;"; - color: red; -} - -[TITLE] - -~ Begin Abstract += P4 Portable NIC Architecture (PNA) +:doctype: book +:revdate: {docdate} +:revnumber: v0.7 +:imagesdir: resources/figs +:data-uri: +:font-size: 10 +:sectnums: 5 +:sectnumlevels: 5 +:toc: macro +:toc-title: Contents +:toclevels: 5 +:toc: left +:!chapter-signifier: +:xrefstyle: short +:stem: latexmath +:pdf-themesdir: resources/theme/ +:pdf-theme: p4-theme.yml +:stylesdir: resources/theme/ +:stylesheet: p4-stylesheet.css +:source-highlighter: rouge +:bibtex-file: resources/theme/references.bib +:bibtex-order: appearance +:bibtex-style: ieee +:listing-caption: Listing + + +[abstract] +.Abstract P4 is a domain-specific language for describing how packets are processed by a network data plane. A P4 program comprises an architecture, which describes the structure and capabilities of the @@ -154,11 +36,12 @@ Architecture (PNA) is an architecture that describes the structure and common capabilities of network interface controller (NIC) devices that process packets going between one or more interfaces and a host system. -~ End Abstract -[TOC] -# Introduction +toc::[] + +[#sec-introduction] +== Introduction Note that this document is still a working draft. Significant changes are expected to be made before version 1.0 of this specification is @@ -168,19 +51,19 @@ The Portable NIC Architecture (PNA) is the P4 architecture that defines the structure and common capabilities for network interface controller (NIC) devices. PNA comprises two main components: -1. A programmable pipeline that can be used to realize a variety of +* A programmable pipeline that can be used to realize a variety of different "packet paths" going between the various ports on the device (e.g., network interfaces or the host system it is attached to), and -2. A library of types (e.g., intrinsic and standard metadata) and +* A library of types (e.g., intrinsic and standard metadata) and P4~16~ externs (e.g., counters, meters, and registers). PNA is designed to model the common features of a broad class of NIC devices. By providing standard APIs and coding guidelines, the hope is to enable developers to write programs that are portable across -multiple NIC devices that are conformant to the PNA[^PNAPortability]. +multiple NIC devices that are conformant to the PNA [Footnote 1]. -[^PNAPortability]: Of course, given the tight hardware resource +[Footnote 1] Of course, given the tight hardware resource constraints on NIC devices, there is no promise that a given P4 program that compiles on one device will also compile on another device. However, it should at least be the case that those P4 @@ -188,18 +71,19 @@ multiple NIC devices that are conformant to the PNA[^PNAPortability]. process packets as described in this document. The Portable NIC Architecture (PNA) Model has three programmable P4 -blocks and several fixed-function blocks, as shown in Figure -[#fig-nic]. The behavior of the programmable blocks is specified using +blocks and several fixed-function blocks, as shown in <<#fig-nic>>. +The behavior of the programmable blocks is specified using P4. The network ports, packet queues, and (optional) inline accelerators are fixed-function blocks that can be configured by the control plane, but are not intended to be programmed using P4. -~ Figure {#fig-nic; caption: "Programmable NIC Architecture Block Diagram"; page-align: here;} -![nic] -~ -[nic]: figs/flex-routing-arch.png { width: 100%;} -## Packet processing +.Programmable NIC Architecture Block Diagram. +[#fig-nic] +image::flex-routing-arch.png[width=400,align="center"] + +[#sec-packet-processing] +=== Packet processing Packets arriving from a network port or from the hosts first go through a `MainParser`, which is responsible for extracting all relevant packet headers. @@ -256,7 +140,7 @@ designed this way for two reasons: in this specification) to access the same table in memory when processing packets in either direction. -Figure [#fig-nic] shows multiple hosts. Some NICs support PCI Express +<<#fig-nic>> shows multiple hosts. Some NICs support PCI Express connections to multiple host CPU complexes. It is also common for NICs to have an array of one or more CPU cores inside of the NIC device itself, and these can be the target for packets received from the @@ -264,7 +148,8 @@ network, and/or the source of packets sent to the network, just as the other hosts can be. For the purposes of the PNA, such CPU cores are considered as another host. -## Message processing +[#sec-message-processing] +=== Message processing The focus in the current version of this specification is on the three P4-programmable blocks mentioned above. The details of how one can @@ -304,12 +189,12 @@ tightly coupled with the host operating system, whereas the - -## PNA P4~16~ architecture +[#sec-pna-architecture] +=== PNA P4~16~ architecture A programmer targeting the PNA is required to provide P4 definitions -for each of the programmable blocks in the pipeline (see section -[#sec-programmable-blocks]). The programmable block inputs and outputs +for each of the programmable blocks in the pipeline (see +<<#sec-programmable-blocks>>). The programmable block inputs and outputs are parameterized on the types of user defined headers and metadata. The top-level PNA program instantiates a package named `main` with the programmable blocks passed as arguments (see Section TBD for an @@ -319,14 +204,11 @@ example). Note that the `main` package is not to be confused with the This document contains excerpts of several P4~16~ programs that use the `pna.p4` include file and demonstrate features of PNA. Source code for the complete programs can be found in the official repository -containing the PNA specification[^PNAExamplePrograms]. - -[^PNAExamplePrograms]: - in directory `examples`. Direct link: - +containing the PNA specification cite:[PNAExamplePrograms]. -## Guidelines for Portability +[#sec-guidelines-for-portability] +=== Guidelines for Portability A P4 programmer wishing to maximize the portability of their program should follow several general guidelines: @@ -338,8 +220,8 @@ follow several general guidelines: - Use as few resources as possible, e.g. table search key bits, array sizes, quantity of metadata associated with packets, etc. - -# Naming conventions +[#sec-naming-conventions] +== Naming conventions In this document we use the following naming conventions: @@ -356,75 +238,68 @@ In this document we use the following naming conventions: Architecture specific metadata (e.g. structs) are prefixed by `pna_`. -# Packet paths {#packet-paths} +[#sec-packet-paths] +== Packet paths -Figure [#fig-packet-paths] shows all possible paths for packets that +<<#fig-packet-paths>> shows all possible paths for packets that must be supported by a PNA implementation. An implementation is allowed to support paths for packets that are not described here. -~Begin TBD + +[NOTE] Create another figure with the updated architecture diagram and names for the paths. -~End TBD -~ Figure {#fig-packet-paths; caption: "Packet Paths in PNA"; page-align: here;} -~ -Table [#results-of-one-pkt-thru-main] shows what can happen to a + +.Packet Paths in PNA. +[#fig-packet-paths] +image::reference-architecture.png[width=400,align="center"] + + +<<#results-of-one-pkt-thru-main>> shows what can happen to a packet as a result of a single time being processed through the four programmable blocks of the packet processing part of PNA, referred to here as "main". -~ TableFigure {#results-of-one-pkt-thru-main; \ - caption: Result of packet processed one time by main.} -|-------------|---------------|--------------------| -| | Processed | Resulting | -| Description | next by | packet(s) | -+:------------+:--------------+:-------------------+ -| packet from | main, with | Zero or more mirrored | -| network port | direction | packets, plus at most | -|---------------| | | -| packet from | `NET_TO_HOST` | one of: a net-to-host | -| net-to-host | | recirculated packet, | -| recirculate | | or one to-host packet. | -|---------------| | | -| packet from | | | -| port loopback | | | -|---------------|---------------|------------------------| -| packet from | main, with | Zero or more mirrored | -| message processing | direction | packets, plus at most | -|---------------| | | -| packet from | `HOST_TO_NET` | one of: a host-to-net | -| host-to-net | | recirculated packet, | -| recirculate | | or one to-net packet. | -|---------------| | | -| packet from | | | -| host loopback | | | -|---------------|---------------|------------------------| -~ + +.Result of packet processed one time by main +[.center,%autowidth] +[#results-of-one-pkt-thru-main] +|=== +| *Description* | *Processed next by*| *Resulting packet(s)* +| packet from network port 1.3+^| main, with direction `NET_TO_HOST` 1.3+^|Zero or more mirrored packets, plus at most one of: a net-to-host recirculated packet, or one to-host packet. +| packet from net-to-host recirculate +| packet from port loopback +| packet from message processing 1.3+^| main, with direction `HOST_TO_NET` 1.3+^|Zero or more mirrored packets, plus at most one of: a host-to-net recirculated packet, or one to-net packet. +| packet from host-to-net recirculate +| packet from host loopback +|=== Note that each mirrored packet that results from `mirror_packet` operations will have its own next place that it will go to be processed, independent of the original packet, and independent of any other mirror copies made of the same original packet. -# PNA Data types +[#sec-pna-data-types] +== PNA Data types -## PNA type definitions {#sec-pna-type-definitions} +[#sec-pna-type-definitions] +=== PNA type definitions Each PNA implementation will have specific bit widths in the data plane for the types shown in the code excerpt of Section -[#sec-pna-type-definitions-code]. These widths are defined in the +<<#sec-pna-type-definitions-code>>. These widths are defined in the target specific `pna.p4` include file. They are expected to differ -from one PNA implementation to another[^PNAP4TargetSpecific]. +from one PNA implementation to another [Footnote 2]. -[^PNAP4TargetSpecific]: It is expected that `pna.p4` include files for +[Footnote 2]: It is expected that `pna.p4` include files for different targets will be nearly identical to each other. Besides the possibility of differing bit widths for these PNA types, the only expected differences between `pna.p4` files for different targets would be annotations on externs, etc. that the P4 compiler for that target needs to do its job. -For each of these types, the P4 Runtime API[^P4RuntimeAPI] may use bit +For each of these types, the P4 Runtime API cite:[P4RuntimeRepo] may use bit widths independent of the targets. These widths are defined by the P4 Runtime API specification, and they are expected to be at least as large as the corresponding `InHeader_t` type below, such that they @@ -432,16 +307,19 @@ hold a value for any target. All PNA implementations must use data plane sizes for these types no wider than the corresponding `InHeader_t`-defined types. -[^P4RuntimeAPI]: The P4Runtime Specification can be found here: - -### PNA type definition code excerpt {#sec-pna-type-definitions-code} +[#sec-pna-type-definitions-code] +==== PNA type definition code excerpt + + +[source,p4] +---- +include::pna.p4[tag=Type_defns] +---- -~ Begin P4Example -[INCLUDE=pna.p4:Type_defns] -~ End P4Example -### PNA port types and values +[#sec-pna-port-types-and-values] +==== PNA port types and values There are two types defined by PNA for holding different kinds of ports: `PortId_t` and `InterfaceId_t`. @@ -449,8 +327,8 @@ ports: `PortId_t` and `InterfaceId_t`. The type `PortId_t` must be large enough in the data plane to hold one of these values: -+ a data plane id for one network port -+ a data plane id for one vport +* a data plane id for one network port +* a data plane id for one vport As one example, a PNA target with four Ethernet network ports could choose to use the values 0 through 3 to identify the network ports, @@ -461,23 +339,29 @@ ports must be consecutive, nor for vports. PNA only requires that for every possible numeric value `x` with type `PortId_t`, exactly one of these statements is true: -+ `x` is the data plane id of one network port, but not any vport -+ `x` is the data plane id of one vport, but not any network port -+ `x` is the data plane id of no port, neither a network port nor a vport +* `x` is the data plane id of one network port, but not any vport +* `x` is the data plane id of one vport, but not any network port +* `x` is the data plane id of no port, neither a network port nor a vport -## PNA supported metadata types +[#sec-pna-supported-metadata-types] +=== PNA supported metadata types -~ Begin P4Example -[INCLUDE=pna.p4:Metadata_types] -~ End P4Example -## Match kinds +[source,p4] +---- +include::pna.p4[tag=Metadata_types] +---- + +[#sec-match-kinds] +=== Match kinds PNA supports the `match_kinds` specified in section 4.3 of the PSA specification. -## Data plane vs. control plane data representations {#sec-data-plane-vs-control-plane-values} +[#sec-data-plane-vs-control-plane-values] +=== Data plane vs. control plane data representations -# Programmable blocks {#sec-programmable-blocks} +[#sec-programmable-blocks] +== Programmable blocks The following declarations provide a template for the programmable blocks in the PNA. The P4 programmer is responsible for implementing @@ -489,29 +373,32 @@ for all ingress parsers and control blocks. The egress parser and control blocks can use the same types for those things, or different types, as the P4 program author wishes. -~ Begin P4Example -[INCLUDE=pna.p4:Programmable_blocks] -~ End P4Example -# Packet Path Details {#packet-path-details} +[source,p4] +---- +include::pna.p4[tag=Programmable_blocks] +---- + +[#sec-packet-path-details] +== Packet Path Details -Refer to section [#packet-paths] for the packet paths provided by PNA. +Refer to <<#sec-packet-paths>> for the packet paths provided by PNA. -~Begin TBD +[NOTE] Need to decide where multicast replication can occur, and in what conditions. -~End TBD -~Begin TBD + +[NOTE] Need to decide where packet mirroring occurs, and in what conditions, and how the mirrored packets differ from the originals. -~End TBD -~Begin TBD + +[NOTE] Rewrite this section once the overall architecture is approved -~End TBD -## Initial values of packets processed by main parser +[#sec-initial-values-of-packets] +=== Initial values of packets processed by main parser ~ Begin Comment jnfoster: is this a case where pseudocode would be helpful for @@ -519,86 +406,102 @@ defining the initial values of headers/metadata? Or would that be too precise and therefore constraining? ~ End Comment -### Initial packet contents for packets from ports +[#sec-initial-contents-of-packets] +==== Initial packet contents for packets from ports Packet is as received from Ethernet port. User-defined metadata is empty? -### Initial packet contents for packets looped back from host-to-network path +[#sec-initial-contents-for-packets-looped] +==== Initial packet contents for packets looped back from host-to-network path Packet is as came out of host-to-net received from Ethernet port. There can be user-defined metadata included with these packets. -## Initial values of packets processed in network-to-host direction by main block +[#sec-initial-values-of-packets-processed] +=== Initial values of packets processed in network-to-host direction by main block -### Initial packet contents for normal packets +[#sec-initial-contents-for-normal-packets] +==== Initial packet contents for normal packets The packet should be ... The user-defined metadata should be ... The standard metadata contents should be specified in detail here. - -### Initial packet contents for recirculated packets +[#sec-initial-contents-for-recirculated-packets] +==== Initial packet contents for recirculated packets Give any differences between this case and previous section. - -## Behavior of packets after main block is complete in network-to-host direction +[#sec-behavior-of-packets] +=== Behavior of packets after main block is complete in network-to-host direction Cases: drop, recirculate, loopback to host-to-net direction, to message processing. Describe the conditions in which each occurs. +[#sec-initial-values-of-packets-processed-in-host] +=== Initial values of packets processed in host-to-network direction by main block -## Initial values of packets processed in host-to-network direction by main block - -### Initial packet contents for normal packets +[#sec-initial-packets-contents-for-normal] +==== Initial packet contents for normal packets This is for packets from the message processing block. -### Initial packet contents for recirculated packets +[#sec-initial-packets-contents-for-recirculated] +==== Initial packet contents for recirculated packets Give any differences between this case and previous section. -### Initial packet contents for packets looped back after network-to-host main processing +[#sec-initial-packet-contents-for-packets-looped] +==== Initial packet contents for packets looped back after network-to-host main processing -## Behavior of packets after main block is complete in host-to-network direction +[#sec-behavior-of-packets-after-main-block] +=== Behavior of packets after main block is complete in host-to-network direction Cases: drop, recirculate, to queues. Describe the conditions in which each occurs. -## Contents of packets sent out to ports +[#sec-contests-of-packets-sent-out] +=== Contents of packets sent out to ports -## Functions for directing packets +[#sec-functions-for-directions-packets] +=== Functions for directing packets -### Extern function `send_to_port` +[#sec-extern-function] +==== Extern function `send_to_port` -~ Begin P4Example -[INCLUDE=pna.p4:send_to_port] -~ End P4Example + +[source,p4] +---- +include::pna.p4[tag=send_to_port] +---- The extern function `send_to_port` is used to direct a packet to a specified network port, or to a vport. Invoking `send_to_port(x)` is supported only within the main control. There are two cases to consider, detailed below. -+ `x` is a network port id. +* `x` is a network port id. Calling `send_to_port(x)` modifies hidden state for this packet, so that the packet will be transmitted out of the network port with id `x`. -+ `x` is a vport id. +* `x` is a vport id. Calling `send_to_port(x)` modifies hidden state for this packet, so that the packet will be sent to the vport with id `x` in the host, without being looped back. -## Packet Mirroring +[#sec-packet-mirroring] +=== Packet Mirroring + -~ Begin P4Example -[INCLUDE=pna.p4:mirror_packet] -~ End P4Example +[source,p4] +---- +include::pna.p4[tag=mirror_packet] +---- The extern function `mirror_packet` is used to cause a mirror copy of the packet currently being processed to be created. Invoking @@ -643,7 +546,7 @@ mirror slot can be created. The control plane code can configure the following properties of each mirror session, independently of other mirror sessions: -+ `packet_contents` +* `packet_contents` If `PRE_MODIFY`, then the mirrored packet's contents will be the same as the original packet as it was when the packet began the execution @@ -654,19 +557,19 @@ as the original packet that is being mirrored, after any modifications made during the execution of the main control that invoked the `mirror_packet()` function. -+ `truncate` +* `truncate` `true` to limit the length of the mirrored packet to the `truncate_length`. `false` to cause the mirrored packet not to be truncated, in which case the `truncate_length` property is ignored for this mirror session. -+ `truncate_length` +* `truncate_length` In units of bytes. Targets may limit the choices here, e.g. to a multiple of 32 bytes, or perhaps even a subset of those choices. -+ `sampling_method` +* `sampling_method` One of the values: `RANDOM_SAMPLING`, `HASH_SAMPLING`. @@ -679,7 +582,7 @@ calculated over the packet's header fields resulting in a hash output value `H`. A mirror copy will be created if `(H & sample_hash_mask) == sample_hash_value`. -+ `meter_parameters` +* `meter_parameters` If the conditions specified by the `sampling_method` and other sampling properties are passed, then a P4 meter dedicated for use by @@ -691,7 +594,7 @@ to create mirror copies). If the meter update returns any result other than `GREEN`, then no mirror copy will be created. -+ `destination_port` +* `destination_port` A network port id, or a vport id. @@ -713,33 +616,37 @@ in the main block in the `NET_TO_HOST` direction, already destined for the vport `destination_port`. That vport can be overwritten by calls to forwarding functions. -~Begin TBD +[NOTE] When a mirror copied packet comes back to the main control, it will have some metadata indicating it is mirror copy. We should define a way in PNA to recognize such mirror copies, e.g. some new extern function call returning true if the packet was created by a `mirror_packet` operation. -~End TBD -## Packet recirculation +[#sec-packet-recirculation] +=== Packet recirculation -# PNA Extern Objects +[#sec-pna-extern-restrictions] +== PNA Extern Objects -## Restrictions on where externs may be used {#sec-extern-restrictions} +[#sec-extern-restrictions] +=== Restrictions on where externs may be used All instantiations in a P4~16~ program occur at compile time, and can be arranged in a tree structure we will call the instantiation tree. The root of the tree `T` represents the top level of the program. Its -child is the node for the package `PNA_NIC` described in Section -[#sec-programmable-blocks], and any externs instantiated at the top +child is the node for the package `PNA_NIC` described in +<<#sec-programmable-blocks>>, and any externs instantiated at the top level of the program. The children of the `PNA_NIC` node are the packages and externs passed as parameters to the `PNA_NIC` -instantiation. See Figure [#fig-instantiation-tree] for a drawing of +instantiation. See Figure <<#fig-instantiation-tree>> for a drawing of the smallest instantiation tree possible for a P4 program written for PNA. -~ Figure {#fig-instantiation-tree; caption: "Minimal PNA instantiation tree"; page-align: here;} -~ + +.Minimal PNA instantiation tree. +[#fig-instantiation-tree] +image::reference-architecture.png[width=400,align="center"] If any of those parsers or controls instantiate other parsers, controls, and/or externs, the instantiation tree contains child nodes @@ -752,38 +659,27 @@ level instances. A PNA implementation is allowed to reject programs that instantiate externs, or attempt to call their methods, from anywhere other than -the places mentioned in Table [#table-extern-usage]. - -~ TableFigure {#table-extern-usage; \ - caption: Summary of controls that can instantiate and invoke externs.} -|-------------------|----------------------------------------------| -| Extern type | Where it may be instantiated and called from | -+:------------------+:---------------------------------------------+ -| `ActionProfile` | MainControl | -|-------------------|----------------------------------------------| -| `ActionSelector` | MainControl | -|-------------------|----------------------------------------------| -| `Checksum` | MainParser, MainControl, MainDeparser | -|-------------------|----------------------------------------------| -| `Counter` | MainControl | -|-------------------|----------------------------------------------| -| `Digest` | MainDeparser | -|-------------------|----------------------------------------------| -| `DirectCounter` | MainControl | -|-------------------|----------------------------------------------| -| `DirectMeter` | MainControl | -|-------------------|----------------------------------------------| -| `Hash` | MainControl | -|-------------------|----------------------------------------------| -| `InternetChecksum` | MainParser, MainControl, MainDeparser | -|-------------------|----------------------------------------------| -| `Meter` | MainControl | -|-------------------|----------------------------------------------| -| `Random` | MainControl | -|-------------------|----------------------------------------------| -| `Register` | MainControl | -|-------------------|----------------------------------------------| -~ +the places mentioned in <<#table-extern-usage>>. + + +.Summary of controls that can instantiate and invoke externs +[.center,%autowidth] +[#table-extern-usage] +|=== +| *Extern type* | *Where it may be instantiated and called from* +| `ActionProfile` | MainControl +| `ActionSelector` | MainControl +| `Checksum` | MainParser, MainControl, MainDeparser +| `Counter` | MainControl +| `Digest` | MainDeparser +| `DirectCounter` | MainControl +| `DirectMeter` | MainControl +| `Hash` | MainControl +| `InternetChecksum` | MainParser, MainControl, MainDeparser +| `Meter` | MainControl +| `Random` | MainControl +| `Register` | MainControl +|=== For example, `Counter` being restricted to "MainControl" means that every `Counter` instance must be instantiated within the `MainControl` @@ -813,7 +709,8 @@ extern definitions being moved from the PSA specification into a separate standard library of P4 extern definitions, and if this is done, both the PSA and PNA specifications will reference that. -## Extern Objects for Inline Accelerators {#sec-inline-accelerators} +[#sec-inline-accelerators] +=== Extern Objects for Inline Accelerators A variety of inline accelerators can be present on a PNA target. These accelerators perform specific functions on a packet. These functions are @@ -833,35 +730,31 @@ This section provides one example definition of a crypto acceleration engine. Other extern objects can be defined in future based on the functionality provided by the hardware accelerators. -~Begin P4Example -[INCLUDE=examples/include/crypto-accelerator.p4:Crypto_accelerator_extern_object] -~End P4Example -# PNA Table Properties +[source,p4] +---- +include::examples/include/crypto-accelerator.p4[tag=Crypto_accelerator_extern_object] +---- -Table [#table-table-properties] lists all P4 table properties defined +[#sec-pna-table-properties] +== PNA Table Properties + +<<#table-table-properties>> lists all P4 table properties defined by PNA that are not included in the base P4~16~ language specification. -~ TableFigure {#table-table-properties; \ - caption: Summary of PNA table properties.} -|-----------------------|------|---------------------------------------| -| Property name | Type | See also | -+:----------------------+:-----+:--------------------------------------+ -| `add_on_miss` | `boolean` | Section [#sec-add-on-miss] | -|-----------------------|------|---------------------------------------| -| `pna_direct_counter` | one `DirectCounter` instance name | | -|-----------------------|------|---------------------------------------| -| `pna_direct_meter` | one `DirectMeter` instance name | | -|-----------------------|------|---------------------------------------| -| `pna_implementation` | instance name of one `ActionProfile` | | -| | or `ActionSelector` | | -|-----------------------|------|---------------------------------------| -| `pna_empty_group_action` | action | | -|-----------------------|------|---------------------------------------| -| `pna_idle_timeout` | `PNA_IdleTimeout_t` | Section [#sec-idle-timeout] | -|-----------------------|------|---------------------------------------| -~ +.Summary of PNA table properties +[.center,%autowidth] +[#table-table-properties] +|=== +| *Property name* | *Type* | *See also* +| `add_on_miss` | `boolean` | <<#sec-add-on-miss>> +| `pna_direct_counter` | one `DirectCounter` instance name | +| `pna_direct_meter` | one `DirectMeter` instance name | +| `pna_implementation` | instance name of one `ActionProfile` or `ActionSelector` | +| `pna_empty_group_action` | action | +| `pna_idle_timeout` | `PNA_IdleTimeout_t` | <<#sec-idle-timeout>> +|=== A PNA implementation need not support both of a `pna_implementation` and `pna_direct_counter` property on the same table. @@ -876,7 +769,8 @@ A PNA implementation must implement tables that have both a A PNA implementation need not support both `pna_implementation` and `pna_idle_timeout` properties on the same table. -## Tables with add-on-miss capability {#sec-add-on-miss} +[#sec-add-on-miss] +=== Tables with add-on-miss capability PNA defines the `add_on_miss` table property. If the value of this property is `true` for a table `t`, the P4 developer is allowed to @@ -910,9 +804,11 @@ It is expected that PNA implementations will be able to sustain not be at the same packet rate supported for processing packets that do not call `add_entry`. -~Begin P4Example -[INCLUDE=pna.p4:add_entry_extern_function] -~End P4Example + +[source,p4] +---- +include::pna.p4[tag=add_entry_extern_function] +---- It is expected that many PNA implementations will restrict `add_entry()` to be called with the following restrictions: @@ -939,8 +835,8 @@ implementations are free to define additional failure reasons other than `ADD_ENTRY_NOT_DONE`, but it is perfectly acceptable for a PNA implementation to only support those two possible return values. - -## Table entry idle timeout {#sec-idle-timeout} +[#sec-idle-timeout] +=== Table entry idle timeout PNA defines the table property `pna_idle_timeout` to enable specifying whether a table should maintain an idle time for each of its entries, @@ -950,9 +846,12 @@ been matched for a length of time at least its configured idle time. The value assigned to `pna_idle_timeout` must be a value of type `PNA_IdleTimeout_t`: -~Begin P4Example -[INCLUDE=pna.p4:enum_PNA_IdleTimeout_t] -~End P4Example + + +[source,p4] +---- +include::pna.p4[tag=enum_PNA_IdleTimeout_t] +---- If the property `pna_idle_timeout` is not specified for a table, its default value is `NO_TIMEOUT`. Such tables need not maintain an idle @@ -963,10 +862,9 @@ If the property `pna_idle_timeout` is assigned a value of `NOTIFY_CONTROL`, the behavior is the same as defined in the Portable Switch Architecture if a table has its property `psa_idle_timeout` assigned a value of `NOTIFY_CONTROL`. See the section titled "Table -entry timeout notification" in the PSA specification[^PSA]. +entry timeout notification" in the PSA specification cite:[PSA]. + -[^PSA]: The Portable Switch Architecture specification can be found here: - If the property `pna_idle_timeout` is assigned a value of `AUTO_DELETE`, the behavior is similar to the behavior of the value @@ -989,22 +887,26 @@ entries, and thus will often use `add_on_miss = true` and `pna_idle_timeout = PNA_IdleTimeout_t.AUTO_DELETE` together. -# Timestamps - +== Timestamps -# Atomicity of control plane API operations {#sec-atomicity-of-control-plane-api-operations} +[#sec-atomicity-of-control-plane-api-operations] +== Atomicity of control plane API operations -# Appendix: Revision History {#appendix-revision-history; @h1:"A"} +[appendix] +[#sec-appendix-revision-history] +== Revision History -|-----|-----|-----| -| Release | Release Date | Summary of Changes | -+:---:+-----+-----+ -| 0.1 | November 5, 2020 | Skeleton specification. | -| 0.5 | May 15, 2021 | Initial draft. | -| 0.7 | December 22, 2022 | Version 0.7 | -+-----+-----+-----+ +.Revision History +[.center,%autowidth] +[#tab-history] +|=== +| *Release* | *Release Date* | *Summary of Changes* +| 0.1 | November 5, 2020 | Skeleton specification. +| 0.5 | May 15, 2021 | Initial draft. +| 0.7 | December 22, 2022 | Version 0.7 +|=== -## Changes made in version 0.7 +=== Changes made in version 0.7 * Added extern functions `add_entry_if`, `set_entry_expire_time_if`, and `update_expire_info`, intended to be more friendly to targets @@ -1043,18 +945,19 @@ entries, and thus will often use `add_on_miss = true` and * Many minor changes in example P4 programs to keep up with changes to the specification and pna.p4 include file. -# Appendix: Open Issues +[appendix] +== Open Issues -# Appendix: Rationale for design {#appendix-rationale} +[appendix] +== Rationale for design -## Why a common pipeline, instead of separate pipelines for each direction? +=== Why a common pipeline, instead of separate pipelines for each direction? -~Begin TBD +[NOTE] Andy can write this one. Basic reasons are summarized in existing slides. -~End TBD -## Is it inefficient to have the `MainParser` redo work? {#appendix-reparsing} +=== Is it inefficient to have the `MainParser` redo work? If the only changes made by the decryption fixed function block in the network-to-host direction were to decrypt parts of the packet that were previously @@ -1103,19 +1006,24 @@ implementation might use some of the techniques mentioned in the previous paragraph, but hidden from the P4 developer. The proposed PNA design should not prevent this, if an implementer is willing to go to that effort. +[appendix] +== Packet path figures -# Appendix: Packet path figures {#appendix-packet-path-figures} +=== From network, sent to host -## From network, sent to host +=== From network, sent to host, with mirror copy to different host -## From network, sent to host, with mirror copy to different host +=== From host, to network -## From host, to network +=== From host, to network, with mirror copy to a different host -## From host, to network, with mirror copy to a different host +=== From host, to host -## From host, to host +=== From port, to port -## From port, to port +[appendix] +== Packet ordering -# Appendix: Packet ordering {#appendix-packet-ordering} +[bibliography] +== References +bibliography::references.bib[ieee] \ No newline at end of file diff --git a/examples/include/crypto-accelerator.p4 b/examples/include/crypto-accelerator.p4 index e158258..75877e5 100644 --- a/examples/include/crypto-accelerator.p4 +++ b/examples/include/crypto-accelerator.p4 @@ -79,7 +79,7 @@ enum crypto_results_e { /// Results: Success, Auth Failure, Hardware Error /// -// BEGIN:Crypto_accelerator_extern_object +// tag::Crypto_accelerator_extern_object[] extern crypto_accelerator { /// constructor @@ -130,4 +130,4 @@ extern crypto_accelerator { // get results of the previous operation crypto_results_e get_results(); } -// END:Crypto_accelerator_extern_object +//end::Crypto_accelerator_extern_object[] diff --git a/p4.json b/p4.json deleted file mode 100644 index 8e0f2d0..0000000 --- a/p4.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "displayName": "P4", - "name": "p4", - - "lineComment": "//", - "blockCommentStart": "/*", - "blockCommentEnd": "*/", - - "keywords": [ "action", "apply", "control", "default", "else", - "extern", "exit", "false", "if", - "package", "parser", "return", "select", "state", "switch", - "table", "transition", "true", "typedef", "verify" - ], - - "extraKeywords": [], - - "typeKeywords": [ - "bool", "bit", "const", "enum", "entries", "error", "header", "header_union", "in", "inout", "int", "match_kind", "out", "tuple", "struct", "varbit", "void" - ], - - "extraTypeKeywords": [], - - "directives": [ - "include","if","endif","ifdef","define","ifndef","undef","line" - ], - - "annotations": [ - "atomic", "defaultonly", "name", "priority", "tableonly", "hidden", "globalname" - ], - - "operators": [ - "=", ">", "<", "!", "~", "?", ":", - "==", "<=", ">=", "!=", "&&", "||", "++", - "+", "-", "*", "/", "&", "|", "^", "%", "<<", - ">>", "&&&", ".." - ], - - "extraOperators": [], - - "symbols": "[=>](?!@symbols)", "@brackets"], - ["@symbols", { "cases": { - "@operators": "operator", - "@extraOperators": "operator.extra", - "@default" : "" } } ], - - ["\\d*\\.\\d+([eE][\\-+]?\\d+)?[fFdD]?", "number.float"], - ["0[xX][0-9a-fA-F_]*[0-9a-fA-F][Ll]?", "number.hex"], - ["0[0-7_]*[0-7][Ll]?", "number.octal"], - ["0[bB][0-1_]*[0-1][Ll]?", "number.binary"], - ["\\d+[lL]?", "number"], - - - ["[;,.]", "delimiter"], - - - ["[lL]\"([^\"\\\\]|\\\\.)*$", "string.invalid" ], - ["\"", "string", "@string" ], - - - ["'[^\\\\']'", "string"], - ["(')(@escapes)(')", ["string","string.escape","string"]], - ["'", "string.invalid"] - ], - - "whitespace": [ - ["[ \\t\\r\\n]+", "white"], - ["\\/\\*", "comment", "@comment" ], - ["\\/\\/.*$", "comment"] - ], - - "comment": [ - ["[^\\/*]+", "comment" ], - - ["\\/\\*", "comment.invalid" ], - ["\\*/", "comment", "@pop" ], - ["[\\/*]", "comment" ] - ], - - "string": [ - ["[^\\\\\"]+", "string"], - ["@escapes", "string.escape"], - ["\\\\.", "string.escape.invalid"], - ["\"", "string", "@pop" ] - ] - } -} diff --git a/pna.p4 b/pna.p4 index 5076d50..9edc712 100644 --- a/pna.p4 +++ b/pna.p4 @@ -99,7 +99,7 @@ const MirrorSessionId_t PNA_MIRROR_SESSION_TO_CPU = (MirrorSessionId_t) 0; #ifndef PNA_PLACEHOLDER_CORE_TYPES #error "Please define the following types for PNA and undef the PNA_PLACEHOLDER_CORE_TYPES macro" -// BEGIN:Type_defns +// tag::Type_defns[] /* These are defined using `typedef`, not `type`, so they are truly * just different names for the type bit for the particular width W * shown. Unlike the `type` definitions below, values declared with @@ -159,10 +159,10 @@ typedef error ParserError_t; const InterfaceId_t PNA_PORT_CPU = (PortId_t) unspecified; const MirrorSessionId_t PNA_MIRROR_SESSION_TO_CPU = (MirrorSessiontId_t) unspecified; -// END:Type_defns +//end::Type_defns[] #endif // #ifndef PNA_EXAMPLE_CORE_TYPES -// BEGIN:Type_defns2 +// tag::Type_defns2[] /* Note: All of the types with `InHeader` in their name are intended * only to carry values of the corresponding types in packet headers @@ -228,7 +228,7 @@ type ExpireTimeProfileIdInHeaderUint_t ExpireTimeProfileIdInHeader_t; @p4runtime_translation("p4.org/pna/v1/SecurityAssocIdInHeader_t", 64) type SecurityAssocIdInHeaderUint_t SecurityAssocIdInHeader_t; -// END:Type_defns2 +// end::Type_defns2[] /* The _int_to_header functions were written to convert a value of * type _t (a value INTernal to the data path) to a value of @@ -312,24 +312,24 @@ ExpireTimeProfileIdInHeader_t pna_ExpireTimeProfileId_int_to_header (in ExpireTi return (ExpireTimeProfileIdInHeader_t) (ExpireTimeProfileIdInHeaderUint_t) (ExpireTimeProfileIdUint_t) x; } -// BEGIN:enum_PNA_IdleTimeout_t +// tag::enum_PNA_IdleTimeout_t[] /// Supported values for the pna_idle_timeout table property enum PNA_IdleTimeout_t { NO_TIMEOUT, NOTIFY_CONTROL, AUTO_DELETE }; -// END:enum_PNA_IdleTimeout_t +//end::enum_PNA_IdleTimeout_t[] -// BEGIN:Match_kinds +// tag::Match_kinds[] match_kind { range, /// Used to represent min..max intervals selector, /// Used for dynamic action selection via the ActionSelector extern optional /// Either an exact match, or a wildcard matching any value for the entire field } -// END:Match_kinds +// end::Match_kinds[] -// BEGIN:Hash_algorithms +// tag::Hash_algorithms[] enum PNA_HashAlgorithm_t { IDENTITY, CRC32, @@ -340,9 +340,9 @@ enum PNA_HashAlgorithm_t { /// TCP, and UDP. TARGET_DEFAULT /// target implementation defined } -// END:Hash_algorithms +// end::Hash_algorithms[] -// BEGIN:Hash_extern +// tag::Hash_extern[] extern Hash { /// Constructor Hash(PNA_HashAlgorithm_t algo); @@ -364,9 +364,9 @@ extern Hash { /// @return (base + (h % max)) where h is the hash value. O get_hash(in T base, in D data, in T max); } -// END:Hash_extern +// end:;Hash_extern[] -// BEGIN:Checksum_extern +// tag::Checksum_extern[] extern Checksum { /// Constructor Checksum(PNA_HashAlgorithm_t hash); @@ -385,9 +385,9 @@ extern Checksum { /// Get checksum for data added (and not removed) since last clear W get(); } -// END:Checksum_extern +// end::Checksum_extern[] -// BEGIN:InternetChecksum_extern +// tag::InternetChecksum_extern[] // Checksum based on `ONES_COMPLEMENT16` algorithm used in IPv4, TCP, and UDP. // Supports incremental updating via `subtract` method. // See IETF RFC 1624. @@ -423,17 +423,17 @@ extern InternetChecksum { /// InternetChecksum extern, or a different one. void set_state(in bit<16> checksum_state); } -// END:InternetChecksum_extern +// end::InternetChecksum_extern[] -// BEGIN:CounterType_defn +// tag::CounterType_defn[] enum PNA_CounterType_t { PACKETS, BYTES, PACKETS_AND_BYTES } -// END:CounterType_defn +// end::CounterType_defn[] -// BEGIN:Counter_extern +// tag::Counter_extern[] /// Indirect counter with n_counters independent counter values, where /// every counter value has a data plane size specified by type W. @@ -442,28 +442,28 @@ extern Counter { Counter(bit<32> n_counters, PNA_CounterType_t type); void count(in S index); } -// END:Counter_extern +// end:Counter_extern[] -// BEGIN:DirectCounter_extern +// tag::DirectCounter_extern[] @noWarn("unused") extern DirectCounter { DirectCounter(PNA_CounterType_t type); void count(); } -// END:DirectCounter_extern +// end:DirectCounter_extern[] -// BEGIN:MeterType_defn +// tag::MeterType_defn[] enum PNA_MeterType_t { PACKETS, BYTES } -// END:MeterType_defn +//end::MeterType_defn[] -// BEGIN:MeterColor_defn +// tag::MeterColor_defn[] enum PNA_MeterColor_t { RED, GREEN, YELLOW } -// END:MeterColor_defn +//end::MeterColor_defn[] -// BEGIN:Meter_extern +// tag::Meter_extern[] // Indexed meter with n_meters independent meter states. extern Meter { @@ -479,18 +479,18 @@ extern Meter { // MeterColor_t.GREEN), which has the same behavior. PNA_MeterColor_t execute(in S index); } -// END:Meter_extern +// end::Meter_extern[] -// BEGIN:DirectMeter_extern +// tag::DirectMeter_extern[] extern DirectMeter { DirectMeter(PNA_MeterType_t type); // See the corresponding methods for extern Meter. PNA_MeterColor_t execute(in PNA_MeterColor_t color); PNA_MeterColor_t execute(); } -// END:DirectMeter_extern +//end::DirectMeter_extern[] -// BEGIN:Register_extern +// tag::Register_extern[] extern Register { /// Instantiate an array of registers. The initial value is /// undefined. @@ -502,9 +502,9 @@ extern Register { T read (in S index); void write (in S index, in T value); } -// END:Register_extern +// end::Register_extern[] -// BEGIN:Random_extern +// tag::Random_extern extern Random { /// Return a random value in the range [min, max], inclusive. @@ -515,16 +515,16 @@ extern Random { Random(T min, T max); T read(); } -// END:Random_extern +// end::Random_extern[] -// BEGIN:ActionProfile_extern +// tag::ActionProfile_extern[] extern ActionProfile { /// Construct an action profile of 'size' entries ActionProfile(bit<32> size); } -// END:ActionProfile_extern +// end::ActionProfile_extern[] -// BEGIN:ActionSelector_extern +// tag::ActionSelector_extern[] extern ActionSelector { /// Construct an action selector of 'size' entries /// @param algo hash algorithm to select a member in a group @@ -532,21 +532,21 @@ extern ActionSelector { /// @param outputWidth size of the key ActionSelector(PNA_HashAlgorithm_t algo, bit<32> size, bit<32> outputWidth); } -// END:ActionSelector_extern +// end::ActionSelector_extern[] -// BEGIN:Digest_extern +// tag::Digest_extern[] extern Digest { Digest(); /// define a digest stream to the control plane void pack(in T data); /// emit data into the stream } -// END:Digest_extern +// end::Digest_extern[] enum PNA_Source_t { FROM_HOST, FROM_NET } -// BEGIN:Metadata_types +// tag::Metadata_types[] struct pna_main_parser_input_metadata_t { // common fields initialized for all packets that are input to main @@ -578,15 +578,15 @@ struct pna_main_input_metadata_t { PortId_t input_port; } -// BEGIN:Metadata_main_output +// tag::Metadata_main_output[] struct pna_main_output_metadata_t { // common fields used by the architecture to decide what to do with // the packet next, after the main parser, control, and deparser // have finished executing one pass, regardless of the direction. ClassOfService_t class_of_service; // 0 } -// END:Metadata_main_output -// END:Metadata_types +// end::Metadata_main_output[] +// end::Metadata_types[] // The following extern functions are "forwarding" functions -- they @@ -606,14 +606,14 @@ struct pna_main_output_metadata_t { extern void drop_packet(); -// BEGIN:send_to_port +// tag::send_to_port[] extern void send_to_port(in PortId_t dest_port); -// END:send_to_port +// end::send_to_port[] -// BEGIN:mirror_packet +// tag::mirror_packet[] extern void mirror_packet(in MirrorSlotId_t mirror_slot_id, in MirrorSessionId_t mirror_session_id); -// END:mirror_packet +// end::mirror_packet[] // TBD: Does it make sense to have a data plane add of a hit action // that has in, out, or inout parameters? @@ -624,7 +624,7 @@ extern void mirror_packet(in MirrorSlotId_t mirror_slot_id, // variant of add_entry seems difficult to use correctly, if it is // possible for entries to fail to be added. -// BEGIN:add_entry_extern_function +// tag::add_entry_extern_function[] // The bit width of this type is allowed to be different for different // target devices. It must be at least a 1-bit wide type. @@ -688,7 +688,7 @@ extern AddEntryErrorStatus_t add_entry( string action_name, in T action_params, in ExpireTimeProfileId_t expire_time_profile_id); -// END:add_entry_extern_function +// end::add_entry_extern_function[] // The following call to add_entry_if(): // @@ -849,7 +849,7 @@ extern T SelectByDirection( -// BEGIN:Programmable_blocks +// tag::Programmable_blocks[] parser MainParserT( packet_in pkt, out MH main_hdr, @@ -872,6 +872,6 @@ package PNA_NIC( MainParserT main_parser, MainControlT main_control, MainDeparserT main_deparser); -// END:Programmable_blocks +// end::Programmable_blocks[] #endif // __PNA_P4__ diff --git a/figs/flex-routing-arch.pdf b/resources/figs/flex-routing-arch.pdf similarity index 100% rename from figs/flex-routing-arch.pdf rename to resources/figs/flex-routing-arch.pdf diff --git a/figs/flex-routing-arch.png b/resources/figs/flex-routing-arch.png similarity index 100% rename from figs/flex-routing-arch.png rename to resources/figs/flex-routing-arch.png diff --git a/figs/flex-routing-arch.pptx b/resources/figs/flex-routing-arch.pptx similarity index 100% rename from figs/flex-routing-arch.pptx rename to resources/figs/flex-routing-arch.pptx diff --git a/figs/historical/pna-block-diagram.pptx b/resources/figs/historical/pna-block-diagram.pptx similarity index 100% rename from figs/historical/pna-block-diagram.pptx rename to resources/figs/historical/pna-block-diagram.pptx diff --git a/figs/path-host-to-host.pdf b/resources/figs/path-host-to-host.pdf similarity index 100% rename from figs/path-host-to-host.pdf rename to resources/figs/path-host-to-host.pdf diff --git a/figs/path-host-to-host.png b/resources/figs/path-host-to-host.png similarity index 100% rename from figs/path-host-to-host.png rename to resources/figs/path-host-to-host.png diff --git a/figs/path-host-to-host.pptx b/resources/figs/path-host-to-host.pptx similarity index 100% rename from figs/path-host-to-host.pptx rename to resources/figs/path-host-to-host.pptx diff --git a/figs/path-host-to-net-with-mirror-copy-to-different-host.pdf b/resources/figs/path-host-to-net-with-mirror-copy-to-different-host.pdf similarity index 100% rename from figs/path-host-to-net-with-mirror-copy-to-different-host.pdf rename to resources/figs/path-host-to-net-with-mirror-copy-to-different-host.pdf diff --git a/figs/path-host-to-net-with-mirror-copy-to-different-host.png b/resources/figs/path-host-to-net-with-mirror-copy-to-different-host.png similarity index 100% rename from figs/path-host-to-net-with-mirror-copy-to-different-host.png rename to resources/figs/path-host-to-net-with-mirror-copy-to-different-host.png diff --git a/figs/path-host-to-net-with-mirror-copy-to-different-host.pptx b/resources/figs/path-host-to-net-with-mirror-copy-to-different-host.pptx similarity index 100% rename from figs/path-host-to-net-with-mirror-copy-to-different-host.pptx rename to resources/figs/path-host-to-net-with-mirror-copy-to-different-host.pptx diff --git a/figs/path-host-to-net.pdf b/resources/figs/path-host-to-net.pdf similarity index 100% rename from figs/path-host-to-net.pdf rename to resources/figs/path-host-to-net.pdf diff --git a/figs/path-host-to-net.png b/resources/figs/path-host-to-net.png similarity index 100% rename from figs/path-host-to-net.png rename to resources/figs/path-host-to-net.png diff --git a/figs/path-host-to-net.pptx b/resources/figs/path-host-to-net.pptx similarity index 100% rename from figs/path-host-to-net.pptx rename to resources/figs/path-host-to-net.pptx diff --git a/figs/path-net-to-host-with-mirror-copy-to-second-host.pdf b/resources/figs/path-net-to-host-with-mirror-copy-to-second-host.pdf similarity index 100% rename from figs/path-net-to-host-with-mirror-copy-to-second-host.pdf rename to resources/figs/path-net-to-host-with-mirror-copy-to-second-host.pdf diff --git a/figs/path-net-to-host-with-mirror-copy-to-second-host.png b/resources/figs/path-net-to-host-with-mirror-copy-to-second-host.png similarity index 100% rename from figs/path-net-to-host-with-mirror-copy-to-second-host.png rename to resources/figs/path-net-to-host-with-mirror-copy-to-second-host.png diff --git a/figs/path-net-to-host-with-mirror-copy-to-second-host.pptx b/resources/figs/path-net-to-host-with-mirror-copy-to-second-host.pptx similarity index 100% rename from figs/path-net-to-host-with-mirror-copy-to-second-host.pptx rename to resources/figs/path-net-to-host-with-mirror-copy-to-second-host.pptx diff --git a/figs/path-net-to-host.pdf b/resources/figs/path-net-to-host.pdf similarity index 100% rename from figs/path-net-to-host.pdf rename to resources/figs/path-net-to-host.pdf diff --git a/figs/path-net-to-host.png b/resources/figs/path-net-to-host.png similarity index 100% rename from figs/path-net-to-host.png rename to resources/figs/path-net-to-host.png diff --git a/figs/path-net-to-host.pptx b/resources/figs/path-net-to-host.pptx similarity index 100% rename from figs/path-net-to-host.pptx rename to resources/figs/path-net-to-host.pptx diff --git a/figs/path-port-to-port-host-loopback.pdf b/resources/figs/path-port-to-port-host-loopback.pdf similarity index 100% rename from figs/path-port-to-port-host-loopback.pdf rename to resources/figs/path-port-to-port-host-loopback.pdf diff --git a/figs/path-port-to-port-host-loopback.png b/resources/figs/path-port-to-port-host-loopback.png similarity index 100% rename from figs/path-port-to-port-host-loopback.png rename to resources/figs/path-port-to-port-host-loopback.png diff --git a/figs/path-port-to-port-host-loopback.pptx b/resources/figs/path-port-to-port-host-loopback.pptx similarity index 100% rename from figs/path-port-to-port-host-loopback.pptx rename to resources/figs/path-port-to-port-host-loopback.pptx diff --git a/figs/pna-block-diagram.pdf b/resources/figs/pna-block-diagram.pdf similarity index 100% rename from figs/pna-block-diagram.pdf rename to resources/figs/pna-block-diagram.pdf diff --git a/figs/pna-block-diagram.png b/resources/figs/pna-block-diagram.png similarity index 100% rename from figs/pna-block-diagram.png rename to resources/figs/pna-block-diagram.png diff --git a/figs/pna-block-diagram.pptx b/resources/figs/pna-block-diagram.pptx similarity index 100% rename from figs/pna-block-diagram.pptx rename to resources/figs/pna-block-diagram.pptx diff --git a/figs/pna-packet-paths-figure.pdf b/resources/figs/pna-packet-paths-figure.pdf similarity index 100% rename from figs/pna-packet-paths-figure.pdf rename to resources/figs/pna-packet-paths-figure.pdf diff --git a/figs/pna-packet-paths-figure.png b/resources/figs/pna-packet-paths-figure.png similarity index 100% rename from figs/pna-packet-paths-figure.png rename to resources/figs/pna-packet-paths-figure.png diff --git a/figs/pna-packet-paths-figure.pptx b/resources/figs/pna-packet-paths-figure.pptx similarity index 100% rename from figs/pna-packet-paths-figure.pptx rename to resources/figs/pna-packet-paths-figure.pptx diff --git a/resources/fonts/LuxiMono/LICENSE.txt b/resources/fonts/LuxiMono/LICENSE.txt new file mode 100644 index 0000000..7527d4d --- /dev/null +++ b/resources/fonts/LuxiMono/LICENSE.txt @@ -0,0 +1,41 @@ +Bigelow & Holmes Inc and URW++ GmbH Luxi font license + +Luxi fonts copyright (c) 2001 by Bigelow & Holmes Inc. Luxi font instruction +code copyright (c) 2001 by URW++ GmbH. All Rights Reserved. Luxi is a regis- +tered trademark of Bigelow & Holmes Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of these Fonts and associated documentation files (the "Font Software"), to +deal in the Font Software, including without limitation the rights to use, +copy, merge, publish, distribute, sublicense, and/or sell copies of the Font +Software, and to permit persons to whom the Font Software is furnished to do +so, subject to the following conditions: + +The above copyright and trademark notices and this permission notice shall be +included in all copies of one or more of the Font Software. + +The Font Software may not be modified, altered, or added to, and in particu- +lar the designs of glyphs or characters in the Fonts may not be modified nor +may additional glyphs or characters be added to the Fonts. This License +becomes null and void when the Fonts or Font Software have been modified. + +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, +TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL BIGELOW & HOLMES INC. OR URW++ +GMBH. BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GEN- +ERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN +ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR +INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFT- +WARE. + +Except as contained in this notice, the names of Bigelow & Holmes Inc. and +URW++ GmbH. shall not be used in advertising or otherwise to promote the +sale, use or other dealings in this Font Software without prior written +authorization from Bigelow & Holmes Inc. and URW++ GmbH. + +For further information, contact: + +info@urwpp.de or design@bigelowandholmes.com + + diff --git a/resources/fonts/LuxiMono/luximb.ttf b/resources/fonts/LuxiMono/luximb.ttf new file mode 100644 index 0000000..7473e1f Binary files /dev/null and b/resources/fonts/LuxiMono/luximb.ttf differ diff --git a/resources/fonts/LuxiMono/luximbi.ttf b/resources/fonts/LuxiMono/luximbi.ttf new file mode 100644 index 0000000..734201b Binary files /dev/null and b/resources/fonts/LuxiMono/luximbi.ttf differ diff --git a/resources/fonts/LuxiMono/luximr.ttf b/resources/fonts/LuxiMono/luximr.ttf new file mode 100644 index 0000000..6ad6e12 Binary files /dev/null and b/resources/fonts/LuxiMono/luximr.ttf differ diff --git a/resources/fonts/LuxiMono/luximri.ttf b/resources/fonts/LuxiMono/luximri.ttf new file mode 100644 index 0000000..9b02826 Binary files /dev/null and b/resources/fonts/LuxiMono/luximri.ttf differ diff --git a/resources/fonts/OpenSans/OpenSans-Bold.ttf b/resources/fonts/OpenSans/OpenSans-Bold.ttf new file mode 100644 index 0000000..98c74e0 Binary files /dev/null and b/resources/fonts/OpenSans/OpenSans-Bold.ttf differ diff --git a/resources/fonts/OpenSans/OpenSans-BoldItalic.ttf b/resources/fonts/OpenSans/OpenSans-BoldItalic.ttf new file mode 100644 index 0000000..8558928 Binary files /dev/null and b/resources/fonts/OpenSans/OpenSans-BoldItalic.ttf differ diff --git a/resources/fonts/OpenSans/OpenSans-Italic.ttf b/resources/fonts/OpenSans/OpenSans-Italic.ttf new file mode 100644 index 0000000..29ff693 Binary files /dev/null and b/resources/fonts/OpenSans/OpenSans-Italic.ttf differ diff --git a/resources/fonts/OpenSans/OpenSans-Regular.ttf b/resources/fonts/OpenSans/OpenSans-Regular.ttf new file mode 100644 index 0000000..67803bb Binary files /dev/null and b/resources/fonts/OpenSans/OpenSans-Regular.ttf differ diff --git a/resources/fonts/Utopia/LICENSE-utopia.txt b/resources/fonts/Utopia/LICENSE-utopia.txt new file mode 100644 index 0000000..9755d3c --- /dev/null +++ b/resources/fonts/Utopia/LICENSE-utopia.txt @@ -0,0 +1,84 @@ +The agreement below gives the TeX Users Group (TUG) the right to +sublicense, and grant such sublicensees the right to further sublicense, +any or all of the rights enumerated below. TUG hereby does so +sublicense all such rights, irrevocably and in perpetuity, to any and +all interested parties. + +--Karl Berry, TUG President, +on behalf of the TeX Users Group board and members +17 November 2006 +http://tug.org/fonts/utopia + +------------------------------------------------------------ +October 11, 2006 + +RE: License to TeX Users Group for the Utopia Typeface + +Adobe Systems Incorporated ("Adobe") hereby grants to the TeX Users +Group and its members a nonexclusive, royalty-free, perpetual license to +the typeface software for the Utopia Regular, Utopia Italic, Utopia Bold +and Utopia bold Italic typefaces, including Adobe Type 1 font programs +for each style (collectively, the "Software") as set forth below. + +Adobe grants the TeX Users Group a license under its copyrights, to use, +reproduce, display and distribute the Software for any purpose and +without fee provided that the following copyright notice appears in all +whole and partial copies of the Software and provided that the following +trademark symbol and attribution appear in all unmodified copies of the +Software: + +Copyright 1989, 1991 Adobe Systems Incorporated. All rights reserved. +(alternatively, @1989, 1991 Adobe Systems Incorporated. All rights reserved.) +Utopia(R) +Utopia is either a registered trademark or trademark of Adobe Systems +Incorporated in the United States and/or other countries. Used under +license. + +Adobe also grants to the TeX Users Group a license to modify the +Software for any purpose and redistribute such modifications, for any +purpose and royalty-free, provided that the modified Software shall not +use the font name(s) or trademark(s), in whole or in part, unless +explicit written permission is granted by Adobe. This restriction +applies to all references stored in the Software for identification +purposes, such as the font menu name and other font description +fields. The TeX Users Group is also permitted to sublicense, and grant +such sublicensees the right to further sublicense, any or all the +foregoing rights through multiple tiers of distribution. The licenses +granted herein are granted in perpetuity and may not be terminated by +either party unless such termination is based on a breach of the terms +and conditions herein stated. + +Adobe retains ownership of the copyright in the Software. The TeX Users +Group agrees that Adobe and its suppliers are the sole and exclusive +owners of all rights, title and interest, including all copyrights, +patents, trademarks, trade names, trade secrets and other intellectual +property rights in the Software. No title or ownership of the Software, +any copies of the Software, or the patent, copyright, trade secret, +trademark, trade name or other proprietary rights contained in the +Software is transferred to the TeX Users Group. + +The Adobe trademarks shall not be used in advertising pertaining to the +distribution of the Software without express prior permission from +Adobe. Any such use shall be in accordance with the Adobe trademark +guidelines, available on the Adobe website at +http://www.adobe.com/misc/pdfs/TM GuideforThirdPartiesFinal.pdf. +If any portion of the Software is changed, it cannot be marketed under +Adobe's trademarks unless Adobe, in its sole discretion, approves by a +prior writing the quality of the resulting implementation. + +The TeX Users Group shall have the right to evaluate the Software +provided by Adobe. + +ADOBE MAKES NO REPRESENTATIONS ABOUT THE SUITABILITY OF THE SOFTWARE FOR +ANY PURPOSE. IT IS PROVIDED "AS-IS" WITHOUT EXPRESS OR IMPLIED +WARRANTY. ADOBE DISCLAIMS ALL WARRANTIES WITH REGARD TO THE SOFTWARE, +INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE, AND NON-INFRINGEMENT OF THIRD PARTY RIGHTS. IN NO +EVENT SHALL ADOBE BE LIABLE TO YOU OR ANY OTHER PARTY FOR ANY SPECIAL, +INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER WHETHER IN +AN ACTION OF CONTRACT NEGLIGENCE, STRICT LIABILITY OR ANY OTHER ACTION +ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS +SOFTWARE. ADOBE WILL NOT PROVIDE ANY TRAINING OR OTHER SUPPORT FOR THE +SOFTWARE. + +Adobe Document Id: 4400078611 diff --git a/resources/fonts/Utopia/utopia-bold.ttf b/resources/fonts/Utopia/utopia-bold.ttf new file mode 100644 index 0000000..cdc1858 Binary files /dev/null and b/resources/fonts/Utopia/utopia-bold.ttf differ diff --git a/resources/fonts/Utopia/utopia-bolditalic.ttf b/resources/fonts/Utopia/utopia-bolditalic.ttf new file mode 100644 index 0000000..f32f040 Binary files /dev/null and b/resources/fonts/Utopia/utopia-bolditalic.ttf differ diff --git a/resources/fonts/Utopia/utopia-italic.ttf b/resources/fonts/Utopia/utopia-italic.ttf new file mode 100644 index 0000000..dd59c7c Binary files /dev/null and b/resources/fonts/Utopia/utopia-italic.ttf differ diff --git a/resources/fonts/Utopia/utopia-regular.ttf b/resources/fonts/Utopia/utopia-regular.ttf new file mode 100644 index 0000000..0625ef3 Binary files /dev/null and b/resources/fonts/Utopia/utopia-regular.ttf differ diff --git a/resources/fonts/verify-font b/resources/fonts/verify-font new file mode 100644 index 0000000..c163d51 --- /dev/null +++ b/resources/fonts/verify-font @@ -0,0 +1,5 @@ +require 'ttfunk' +require 'ttfunk/subset_collection' + +ttf_subsets = TTFunk::SubsetCollection.new TTFunk::File.open ARGV[0] +(0...(ttf_subsets.instance_variable_get :@subsets).size).each {|idx| ttf_subsets[idx].encode } \ No newline at end of file diff --git a/resources/theme/logo.png b/resources/theme/logo.png new file mode 100644 index 0000000..75445f3 Binary files /dev/null and b/resources/theme/logo.png differ diff --git a/resources/theme/p4-stylesheet.css b/resources/theme/p4-stylesheet.css new file mode 100644 index 0000000..a29dbe7 --- /dev/null +++ b/resources/theme/p4-stylesheet.css @@ -0,0 +1,643 @@ +@import url(//cdnjs.cloudflare.com/ajax/libs/font-awesome/3.2.0/css/font-awesome.css); +/* normalize.css v2.1.1 | MIT License | git.io/normalize */ +/* ========================================================================== HTML5 display definitions ========================================================================== */ +/** Correct `block` display not defined in IE 8/9. */ +article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { display: block; } + +/** Correct `inline-block` display not defined in IE 8/9. */ +audio, canvas, video { display: inline-block; } + +/** Prevent modern browsers from displaying `audio` without controls. Remove excess height in iOS 5 devices. */ +audio:not([controls]) { display: none; height: 0; } + +/** Address styling not present in IE 8/9. */ +[hidden] { display: none; } + +/* ========================================================================== Base ========================================================================== */ +/** 1. Prevent system color scheme's background color being used in Firefox, IE, and Opera. 2. Prevent system color scheme's text color being used in Firefox, IE, and Opera. 3. Set default font family to sans-serif. 4. Prevent iOS text size adjust after orientation change, without disabling user zoom. */ +html { background: #fff; /* 1 */ color: #000; /* 2 */ font-family: sans-serif; /* 3 */ -ms-text-size-adjust: 100%; /* 4 */ -webkit-text-size-adjust: 100%; /* 4 */ } + +/** Remove default margin. */ +body { margin: 0; } + +/* ========================================================================== Links ========================================================================== */ +/** Address `outline` inconsistency between Chrome and other browsers. */ +a:focus { outline: thin dotted; } + +/** Improve readability when focused and also mouse hovered in all browsers. */ +a:active, a:hover { outline: 0; } + +/* ========================================================================== Typography ========================================================================== */ +/** Address variable `h1` font-size and margin within `section` and `article` contexts in Firefox 4+, Safari 5, and Chrome. */ +h1 { font-size: 2em; margin: 0.67em 0; } + +/** Address styling not present in IE 8/9, Safari 5, and Chrome. */ +abbr[title] { border-bottom: 1px dotted; } + +/** Address style set to `bolder` in Firefox 4+, Safari 5, and Chrome. */ +b, strong { font-weight: bold; } + +/** Address styling not present in Safari 5 and Chrome. */ +dfn { font-style: italic; } + +/** Address differences between Firefox and other browsers. */ +hr { -moz-box-sizing: content-box; box-sizing: content-box; height: 0; } + +/** Address styling not present in IE 8/9. */ +mark { background: #ff0; color: #000; } + +/** Correct font family set oddly in Safari 5 and Chrome. */ +code, kbd, pre, samp { font-family: monospace, serif; font-size: 1em; } + +/** Improve readability of pre-formatted text in all browsers. */ +pre { white-space: pre-wrap; } + +/** Set consistent quote types. */ +q { quotes: "\201C" "\201D" "\2018" "\2019"; } + +/** Address inconsistent and variable font size in all browsers. */ +small { font-size: 80%; } + +/** Prevent `sub` and `sup` affecting `line-height` in all browsers. */ +sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; } + +sup { top: -0.5em; } + +sub { bottom: -0.25em; } + +/* ========================================================================== Embedded content ========================================================================== */ +/** Remove border when inside `a` element in IE 8/9. */ +img { border: 0; } + +/** Correct overflow displayed oddly in IE 9. */ +svg:not(:root) { overflow: hidden; } + +/* ========================================================================== Figures ========================================================================== */ +/** Address margin not present in IE 8/9 and Safari 5. */ +figure { margin: 0; } + +/* ========================================================================== Forms ========================================================================== */ +/** Define consistent border, margin, and padding. */ +fieldset { border: 1px solid #c0c0c0; margin: 0 2px; padding: 0.35em 0.625em 0.75em; } + +/** 1. Correct `color` not being inherited in IE 8/9. 2. Remove padding so people aren't caught out if they zero out fieldsets. */ +legend { border: 0; /* 1 */ padding: 0; /* 2 */ } + +/** 1. Correct font family not being inherited in all browsers. 2. Correct font size not being inherited in all browsers. 3. Address margins set differently in Firefox 4+, Safari 5, and Chrome. */ +button, input, select, textarea { font-family: inherit; /* 1 */ font-size: 100%; /* 2 */ margin: 0; /* 3 */ } + +/** Address Firefox 4+ setting `line-height` on `input` using `!important` in the UA stylesheet. */ +button, input { line-height: normal; } + +/** Address inconsistent `text-transform` inheritance for `button` and `select`. All other form control elements do not inherit `text-transform` values. Correct `button` style inheritance in Chrome, Safari 5+, and IE 8+. Correct `select` style inheritance in Firefox 4+ and Opera. */ +button, select { text-transform: none; } + +/** 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` and `video` controls. 2. Correct inability to style clickable `input` types in iOS. 3. Improve usability and consistency of cursor style between image-type `input` and others. */ +button, html input[type="button"], input[type="reset"], input[type="submit"] { -webkit-appearance: button; /* 2 */ cursor: pointer; /* 3 */ } + +/** Re-set default cursor for disabled elements. */ +button[disabled], html input[disabled] { cursor: default; } + +/** 1. Address box sizing set to `content-box` in IE 8/9. 2. Remove excess padding in IE 8/9. */ +input[type="checkbox"], input[type="radio"] { box-sizing: border-box; /* 1 */ padding: 0; /* 2 */ } + +/** 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome (include `-moz` to future-proof). */ +input[type="search"] { -webkit-appearance: textfield; /* 1 */ -moz-box-sizing: content-box; -webkit-box-sizing: content-box; /* 2 */ box-sizing: content-box; } + +/** Remove inner padding and search cancel button in Safari 5 and Chrome on OS X. */ +input[type="search"]::-webkit-search-cancel-button, input[type="search"]::-webkit-search-decoration { -webkit-appearance: none; } + +/** Remove inner padding and border in Firefox 4+. */ +button::-moz-focus-inner, input::-moz-focus-inner { border: 0; padding: 0; } + +/** 1. Remove default vertical scrollbar in IE 8/9. 2. Improve readability and alignment in all browsers. */ +textarea { overflow: auto; /* 1 */ vertical-align: top; /* 2 */ } + +/* ========================================================================== Tables ========================================================================== */ +/** Remove most spacing between table cells. */ +table { border-collapse: collapse; border-spacing: 0; } + +*, *:before, *:after { -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; } + +html, body { font-size: 15px; } + +body { background: white; color: #0a0a0a; padding: 0; margin: 0; font-family: "Helvetica Neue", "Helvetica", Helvetica, Arial, sans-serif; font-weight: normal; font-style: normal; line-height: 1; position: relative; cursor: auto; } + +a:hover { cursor: pointer; } + +a:focus { outline: none; } + +img, object, embed { max-width: 100%; height: auto; } + +object, embed { height: 100%; } + +img { -ms-interpolation-mode: bicubic; } + +#map_canvas img, #map_canvas embed, #map_canvas object, .map_canvas img, .map_canvas embed, .map_canvas object { max-width: none !important; } + +.left { float: left !important; } + +.right { float: right !important; } + +.text-left { text-align: left !important; } + +.text-right { text-align: right !important; } + +.text-center { text-align: center !important; } + +.text-justify { text-align: justify !important; } + +.hide { display: none; } + +.antialiased, body { -webkit-font-smoothing: antialiased; } + +img { display: inline-block; vertical-align: middle; } + +textarea { height: auto; min-height: 50px; } + +select { width: 100%; } + +p.lead, .paragraph.lead > p, #preamble > .sectionbody > .paragraph:first-of-type p { font-size: 1.23333em; line-height: 1.6; } + +.subheader, #content #toctitle, .admonitionblock td.content > .title, .exampleblock > .title, .imageblock > .title, .videoblock > .title, .listingblock > .title, .literalblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, .sidebarblock > .title, .tableblock > .title, .verseblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title, .tableblock > caption { line-height: 1.4; color: #030303; font-weight: 300; margin-top: 0.2em; margin-bottom: 0.5em; } + +/* Typography resets */ +div, dl, dt, dd, ul, ol, li, h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6, pre, form, p, blockquote, th, td { margin: 0; padding: 0; direction: ltr; } + +/* Default Link Styles */ +a { color: #4183c4; text-decoration: none; line-height: inherit; } +a:hover, a:focus { color: #4183c4; } +a img { border: none; } + +/* Default paragraph styles */ +p { font-family: helvetica, arial, freesans, clean, sans-serif; font-weight: normal; font-size: 1em; line-height: 1.4; margin-bottom: 1em; text-rendering: optimizeLegibility; } +p aside { font-size: 0.93333em; line-height: 1.35; font-style: italic; } + +/* Default header styles */ +h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6 { font-family: helvetica, arial, freesans, clean, sans-serif; font-weight: bold; font-style: normal; color: #333333; text-rendering: optimizeLegibility; margin-top: 0.2em; margin-bottom: 0.5em; line-height: 1.2em; } +h1 small, h2 small, h3 small, #toctitle small, .sidebarblock > .content > .title small, h4 small, h5 small, h6 small { font-size: 60%; color: gray; line-height: 0; } + +h1 { font-size: 1.33333em; } + +h2 { font-size: 0.93333em; } + +h3, #toctitle, .sidebarblock > .content > .title { font-size: 0.86667em; } + +h4 { font-size: 0.66667em; } + +h5 { font-size: 1em; } + +h6 { font-size: 1em; } + +hr { border: solid #dddddd; border-width: 1px 0 0; clear: both; margin: 1.33333em 0 1.26667em; height: 0; } + +/* Helpful Typography Defaults */ +em, i { font-style: italic; line-height: inherit; } + +strong, b { font-weight: bold; line-height: inherit; } + +small { font-size: 60%; line-height: inherit; } + +code { font-family: Monaco, "DejaVu Sans Mono", "Courier New", monospace; font-weight: normal; color: #B12146; } + +/* Lists */ +ul, ol, dl { font-size: 1em; line-height: 1.4; margin-bottom: 1em; list-style-position: outside; font-family: helvetica, arial, freesans, clean, sans-serif; } + +ul, ol { margin-left: 0.7em; } + +/* Unordered Lists */ +ul li ul, ul li ol { margin-left: 1.33333em; margin-bottom: 0; font-size: 1em; /* Override nested font-size change */ } +ul.square li ul, ul.circle li ul, ul.disc li ul { list-style: inherit; } +ul.square { list-style-type: square; } +ul.circle { list-style-type: circle; } +ul.disc { list-style-type: disc; } +ul.no-bullet { list-style: none; } + + +/* Ordered Lists */ +ol li ul, ol li ol { margin-left: 1.33333em; margin-bottom: 0; } + +/* Definition Lists */ +dl dt { margin-bottom: 0.33333em; font-weight: bold; } +dl dd { margin-bottom: 1.33333em; } + +/* Abbreviations */ +abbr, acronym { text-transform: uppercase; font-size: 90%; color: #030303; border-bottom: 1px dotted #dddddd; cursor: help; } + +abbr { text-transform: none; } + +/* Blockquotes */ +blockquote { margin: 0 0 1em; padding: 0; border-left: none; } +blockquote cite { display: block; font-size: 0.86667em; color: #030303; } +blockquote cite:before { content: "\2014 \0020"; } +blockquote cite a, blockquote cite a:visited { color: #030303; } + +blockquote, blockquote p { line-height: 1.4; color: #030303; } + +/* Microformats */ +.vcard { display: inline-block; margin: 0 0 1.33333em 0; border: 1px solid #dddddd; padding: 0.66667em 0.8em; } +.vcard li { margin: 0; display: block; } +.vcard .fn { font-weight: bold; font-size: 1em; } + +.vevent .summary { font-weight: bold; } +.vevent abbr { cursor: auto; text-decoration: none; font-weight: bold; border: none; padding: 0 0.06667em; } + +@media only screen and (min-width: 768px) { h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6 { line-height: 1.4; } + h1 { font-size: 2em; } + h2 { font-size: 1.6em; } + h3, #toctitle, .sidebarblock > .content > .title { font-size: 1.2em; } + h4 { font-size: 1em; } } +/* Print styles. Inlined to avoid required HTTP connection: www.phpied.com/delay-loading-your-print-css/ Credit to Paul Irish and HTML5 Boilerplate (html5boilerplate.com) +*/ +.print-only { display: none !important; } + +@media print { * { background: transparent !important; color: #000 !important; /* Black prints faster: h5bp.com/s */ box-shadow: none !important; text-shadow: none !important; } + a, a:visited { text-decoration: underline; } + a[href]:after { content: " (" attr(href) ")"; } + abbr[title]:after { content: " (" attr(title) ")"; } + .ir a:after, a[href^="javascript:"]:after, a[href^="#"]:after { content: ""; } + pre, blockquote { border: 1px solid #999999; page-break-inside: avoid; } + thead { display: table-header-group; /* h5bp.com/t */ } + tr, img { page-break-inside: avoid; } + img { max-width: 100% !important; } + @page { margin: 0.5cm; } + p, h2, h3, #toctitle, .sidebarblock > .content > .title { orphans: 3; widows: 3; } + h2, h3, #toctitle, .sidebarblock > .content > .title { page-break-after: avoid; } + .hide-on-print { display: none !important; } + .print-only { display: block !important; } + .hide-for-print { display: none !important; } + .show-for-print { display: inherit !important; } } +/* Tables */ +table { background: white; margin-bottom: 1.33333em; border: solid 1px #dddddd; } +table thead, table tfoot { background: whitesmoke; font-weight: bold; } +table thead tr th, table thead tr td, table tfoot tr th, table tfoot tr td { padding: 0.53333em 0.66667em 0.66667em; font-size: 0.93333em; color: #222222; text-align: left; } +table tr th, table tr td { padding: 0.6em 0.66667em; font-size: 0.8em; color: black; } +table tr.even, table tr.alt, table tr:nth-of-type(even) { background: #f9f9f9; } +table thead tr th, table tfoot tr th, table tbody tr td, table tr td, table tfoot tr td { display: table-cell; line-height: 1.4; } + +a:hover, a:focus { text-decoration: underline; } + +.clearfix:before, .clearfix:after, .float-group:before, .float-group:after { content: " "; display: table; } +.clearfix:after, .float-group:after { clear: both; } + +*:not(pre) > code { font-size: 0.86667em; padding: 1px 5px 1px 5px; white-space: nowrap; background-color: transparent; border: 1px solid #dddddd; -webkit-border-radius: 3px; border-radius: 3px; text-shadow: none; } + +pre, pre > code { line-height: 1.6; color: black; font-family: Consolas, "Liberation Mono", Courier, monospace; font-weight: normal; } + +kbd.keyseq { color: black; } + +kbd:not(.keyseq) { display: inline-block; color: black; font-size: 0.8em; line-height: 1.4; background-color: #F7F7F7; border: 1px solid #ccc; -webkit-border-radius: 3px; border-radius: 3px; -webkit-box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 0 0 2px white inset; box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 0 0 2px white inset; margin: -0.15em 0.15em 0 0.15em; padding: 0.2em 0.6em 0.2em 0.5em; vertical-align: middle; white-space: nowrap; } + +kbd kbd:first-child { margin-left: 0; } + +kbd kbd:last-child { margin-right: 0; } + +.menuseq, .menu { color: #1a1a1a; } + +#header, #content, #footnotes, #footer { width: 100%; margin-left: auto; margin-right: auto; margin-top: 0; margin-bottom: 0; max-width: 66.66667em; *zoom: 1; position: relative; padding-left: 1em; padding-right: 1em; } +#header:before, #header:after, #content:before, #content:after, #footnotes:before, #footnotes:after, #footer:before, #footer:after { content: " "; display: table; } +#header:after, #content:after, #footnotes:after, #footer:after { clear: both; } + +#header { margin-bottom: 2.66667em;} +#header > h1 { color: #030303; font-weight: 300; border-bottom: 1px solid #dddddd; margin-bottom: -28px; padding-bottom: 32px; text-align: center; } +#header span { color: #030303;} +#header #revnumber { text-align: center; text-transform: capitalize;} +#header br { display: none; } +#header br + span { padding-left: 3px; } +#header br + span:before { content: "\2013 \0020"; } +#header br + span.author { padding-left: 0; } +#header br + span.author:before { content: ", "; } + +#toc { border-bottom: 0 solid #dddddd; padding-bottom: 1.33333em; } +#toc > ul { margin-left: 0.26667em; } +#toc ul.sectlevel0 > li > a { font-style: italic; } +#toc ul.sectlevel0 ul.sectlevel1 { margin-left: 0; margin-top: 0.5em; margin-bottom: 0.5em; } +#toc ul { list-style-type: none; } + +#toctitle { color: #030303; } + +@media only screen and (min-width: 1280px) { body.toc2 { padding-left: 20em; } + #toc.toc2 { position: fixed; width: 20em; left: 0; top: 0; border-right: 1px solid #dddddd; border-bottom: 0; z-index: 1000; padding: 1em; height: 100%; overflow: auto; } + #toc.toc2 #toctitle { margin-top: 0; } + #toc.toc2 > ul { font-size: .95em; } + #toc.toc2 ul ul { margin-left: 0; padding-left: 1.33333em; } + #toc.toc2 ul.sectlevel0 ul.sectlevel1 { padding-left: 0; margin-top: 0.5em; margin-bottom: 0.5em; } + body.toc2.toc-right { padding-left: 0; padding-right: 20em; } + body.toc2.toc-right #toc.toc2 { border-right: 0; border-left: 1px solid #dddddd; left: auto; right: 0; } } +#content #toc { border-style: solid; border-width: 1px; border-color: #e6e6e6; margin-bottom: 1.33333em; padding: 1.33333em; background: white; border-width: 0; -webkit-border-radius: 3px; border-radius: 3px; } +#content #toc > :first-child { margin-top: 0; } +#content #toc > :last-child { margin-bottom: 0; } +#content #toc a { text-decoration: none; } + +#content #toctitle { font-weight: bold; font-family: helvetica, arial, freesans, clean, sans-serif; font-size: 1.06667em; padding-left: 0.13333em; } + +#footer { max-width: 100%; background-color: whitesmoke; padding: 1.33333em; } + +#footer-text { color: #030303; line-height: 1.26; } + +.sect1 { padding-bottom: 1.33333em; } + +.sect1 + .sect1 { border-top: 0 solid #dddddd; } + +#content h1 > a.anchor, h2 > a.anchor, h3 > a.anchor, #toctitle > a.anchor, .sidebarblock > .content > .title > a.anchor, h4 > a.anchor, h5 > a.anchor, h6 > a.anchor { position: absolute; width: 1em; margin-left: -1em; display: block; text-decoration: none; visibility: hidden; text-align: center; font-weight: normal; } +#content h1 > a.anchor:before, h2 > a.anchor:before, h3 > a.anchor:before, #toctitle > a.anchor:before, .sidebarblock > .content > .title > a.anchor:before, h4 > a.anchor:before, h5 > a.anchor:before, h6 > a.anchor:before { content: '\00A7'; font-size: .85em; vertical-align: text-top; display: block; margin-top: 0.05em; } +#content h1:hover > a.anchor, #content h1 > a.anchor:hover, h2:hover > a.anchor, h2 > a.anchor:hover, h3:hover > a.anchor, #toctitle:hover > a.anchor, .sidebarblock > .content > .title:hover > a.anchor, h3 > a.anchor:hover, #toctitle > a.anchor:hover, .sidebarblock > .content > .title > a.anchor:hover, h4:hover > a.anchor, h4 > a.anchor:hover, h5:hover > a.anchor, h5 > a.anchor:hover, h6:hover > a.anchor, h6 > a.anchor:hover { visibility: visible; } +#content h1 > a.link, h2 > a.link, h3 > a.link, #toctitle > a.link, .sidebarblock > .content > .title > a.link, h4 > a.link, h5 > a.link, h6 > a.link { color: #0830df; text-decoration: none; } +#content h1 > a.link:hover, h2 > a.link:hover, h3 > a.link:hover, #toctitle > a.link:hover, .sidebarblock > .content > .title > a.link:hover, h4 > a.link:hover, h5 > a.link:hover, h6 > a.link:hover { color: #262626; } + +.imageblock, .literalblock, .listingblock, .verseblock, .videoblock { margin-bottom: 1.33333em; } + +.admonitionblock td.content > .title, .exampleblock > .title, .imageblock > .title, .videoblock > .title, .listingblock > .title, .literalblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, .sidebarblock > .title, .tableblock > .title, .verseblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title { text-align: center; font-weight: bold; } + +.tableblock > caption { text-align: left; font-weight: bold; white-space: nowrap; overflow: visible; max-width: 0; } + +table.tableblock #preamble > .sectionbody > .paragraph:first-of-type p { font-size: inherit; } + +.admonitionblock > table { border: 0; background: none; width: 100%; } +.admonitionblock > table td.icon { text-align: center; width: 80px; } +.admonitionblock > table td.icon img { max-width: none; } +.admonitionblock > table td.icon .title { font-weight: bold; text-transform: uppercase; } +.admonitionblock > table td.content { padding-left: 1.2em; padding-right: 1.33333em; border-left: 1px solid #dddddd; color: #030303; } +.admonitionblock > table td.content > :last-child > :last-child { margin-bottom: 0; } + +.exampleblock > .content { border-style: solid; border-width: 1px; border-color: #e6e6e6; margin-bottom: 1.33333em; padding: 1.33333em; background: white; -webkit-border-radius: 3px; border-radius: 3px; } +.exampleblock > .content > :first-child { margin-top: 0; } +.exampleblock > .content > :last-child { margin-bottom: 0; } +.exampleblock > .content h1, .exampleblock > .content h2, .exampleblock > .content h3, .exampleblock > .content #toctitle, .sidebarblock.exampleblock > .content > .title, .exampleblock > .content h4, .exampleblock > .content h5, .exampleblock > .content h6, .exampleblock > .content p { color: #333333; } +.exampleblock > .content h1, .exampleblock > .content h2, .exampleblock > .content h3, .exampleblock > .content #toctitle, .sidebarblock.exampleblock > .content > .title, .exampleblock > .content h4, .exampleblock > .content h5, .exampleblock > .content h6 { line-height: 1; margin-bottom: 0.66667em; } +.exampleblock > .content h1.subheader, .exampleblock > .content h2.subheader, .exampleblock > .content h3.subheader, .exampleblock > .content .subheader#toctitle, .sidebarblock.exampleblock > .content > .subheader.title, .exampleblock > .content h4.subheader, .exampleblock > .content h5.subheader, .exampleblock > .content h6.subheader { line-height: 1.4; } + +.exampleblock.result > .content { -webkit-box-shadow: 0 1px 8px #eaeaea; box-shadow: 0 1px 8px #eaeaea; } + +.sidebarblock { border-style: solid; border-width: 1px; border-color: #e6e6e6; margin-bottom: 1.33333em; padding: 1.33333em; background: white; -webkit-border-radius: 3px; border-radius: 3px; } +.sidebarblock > :first-child { margin-top: 0; } +.sidebarblock > :last-child { margin-bottom: 0; } +.sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6, .sidebarblock p { color: #333333; } +.sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6 { line-height: 1; margin-bottom: 0.66667em; } +.sidebarblock h1.subheader, .sidebarblock h2.subheader, .sidebarblock h3.subheader, .sidebarblock .subheader#toctitle, .sidebarblock > .content > .subheader.title, .sidebarblock h4.subheader, .sidebarblock h5.subheader, .sidebarblock h6.subheader { line-height: 1.4; } +.sidebarblock > .content > .title { color: #030303; margin-top: 0; line-height: 1.4; border-width: 0 0 1px 0; border-style: solid; border-color: #cacaca; } + +.exampleblock > .content > :last-child > :last-child, .exampleblock > .content .olist > ol > li:last-child > :last-child, .exampleblock > .content .ulist > ul > li:last-child > :last-child, .exampleblock > .content .qlist > ol > li:last-child > :last-child, .sidebarblock > .content > :last-child > :last-child, .sidebarblock > .content .olist > ol > li:last-child > :last-child, .sidebarblock > .content .ulist > ul > li:last-child > :last-child, .sidebarblock > .content .qlist > ol > li:last-child > :last-child { margin-bottom: 0; } + +.literalblock > .content pre, .listingblock > .content pre { background: #F7F7F7; border-width: 2px; border-style: solid; border-color: #dddddd; -webkit-border-radius: 3px; border-radius: 3px; padding: 0.66667em; word-wrap: break-word; } +.literalblock > .content pre.nowrap, .listingblock > .content pre.nowrap { overflow-x: auto; white-space: pre; word-wrap: normal; } +.literalblock > .content pre > code, .listingblock > .content pre > code { display: block; } +@media only screen { .literalblock > .content pre, .listingblock > .content pre { font-size: 0.69333em; } } +@media only screen and (min-width: 768px) { .literalblock > .content pre, .listingblock > .content pre { font-size: 0.78em; } } +@media only screen and (min-width: 1280px) { .literalblock > .content pre, .listingblock > .content pre { font-size: 0.86667em; } } + +.listingblock > .content { position: relative; } + +.listingblock:hover code[class*=" language-"]:before { text-transform: uppercase; font-size: 0.9em; color: #999; position: absolute; top: 0.4em; right: 0.4em; } + +.listingblock:hover code.asciidoc:before { content: "asciidoc"; } +.listingblock:hover code.clojure:before { content: "clojure"; } +.listingblock:hover code.css:before { content: "css"; } +.listingblock:hover code.groovy:before { content: "groovy"; } +.listingblock:hover code.html:before { content: "html"; } +.listingblock:hover code.java:before { content: "java"; } +.listingblock:hover code.javascript:before { content: "javascript"; } +.listingblock:hover code.python:before { content: "python"; } +.listingblock:hover code.ruby:before { content: "ruby"; } +.listingblock:hover code.scss:before { content: "scss"; } +.listingblock:hover code.xml:before { content: "xml"; } +.listingblock:hover code.yaml:before { content: "yaml"; } + +.listingblock.terminal pre .command:before { content: attr(data-prompt); padding-right: 0.5em; color: #999; } + +.listingblock.terminal pre .command:not([data-prompt]):before { content: '$'; } + +table.pyhltable { border: 0; margin-bottom: 0; } + +table.pyhltable td { vertical-align: top; padding-top: 0; padding-bottom: 0; } + +table.pyhltable td.code { padding-left: .75em; padding-right: 0; } + +.highlight.pygments .lineno, table.pyhltable td:not(.code) { color: #999; padding-left: 0; padding-right: .5em; border-right: 1px solid #dddddd; } + +.highlight.pygments .lineno { display: inline-block; margin-right: .25em; } + +table.pyhltable .linenodiv { background-color: transparent !important; padding-right: 0 !important; } + +.quoteblock { margin: 0 0 1em; padding: 0; border-left: none; } +.quoteblock blockquote { margin: 0 0 1em 0; padding: 0 0 0.6em 0; border: 0; } +.quoteblock blockquote > .paragraph:last-child p { margin-bottom: 0; } +.quoteblock .attribution { margin-top: -.25em; padding-bottom: 0.6em; font-size: 0.86667em; color: #666666; } +.quoteblock .attribution br { display: none; } +.quoteblock .attribution cite { display: block; margin-bottom: 0.66667em; } + +table thead th, table tfoot th { font-weight: bold; } + +table.tableblock.grid-all { border-collapse: separate; border-spacing: 1px; -webkit-border-radius: 3px; border-radius: 3px; border-top: 1px solid #dddddd; border-bottom: 1px solid #dddddd; } + +table.tableblock.frame-topbot, table.tableblock.frame-none { border-left: 0; border-right: 0; } + +table.tableblock.frame-sides, table.tableblock.frame-none { border-top: 0; border-bottom: 0; } + +table.tableblock td .paragraph:last-child p, table.tableblock td > p:last-child { margin-bottom: 0; } + +th.tableblock.halign-left, td.tableblock.halign-left { text-align: left; } + +th.tableblock.halign-right, td.tableblock.halign-right { text-align: right; } + +th.tableblock.halign-center, td.tableblock.halign-center { text-align: center; } + +th.tableblock.valign-top, td.tableblock.valign-top { vertical-align: top; } + +th.tableblock.valign-bottom, td.tableblock.valign-bottom { vertical-align: bottom; } + +th.tableblock.valign-middle, td.tableblock.valign-middle { vertical-align: middle; } + +p.tableblock.header { color: #222222; font-weight: bold; } + +td > div.verse { white-space: pre; } + +ol { margin-left: 0.96667em; } + +ul li ol { margin-left: 0.7em; } + +dl dd { margin-left: 1.125em; } + +dl dd:last-child, dl dd:last-child > :last-child { margin-bottom: 0; } + +ol > li p, ul > li p, ul dd, ol dd, .olist .olist, .ulist .ulist, .ulist .olist, .olist .ulist { margin-bottom: 0.5em; } + +ul.unstyled, ol.unnumbered, ul.checklist, ul.none { list-style-type: none; } + +ul.unstyled, ol.unnumbered, ul.checklist { margin-left: 0.66667em; } + +ul.checklist li > p:first-child > i[class^="icon-check"]:first-child, ul.checklist li > p:first-child > input[type="checkbox"]:first-child { margin-right: 0.25em; } + +ul.checklist li > p:first-child > input[type="checkbox"]:first-child { position: relative; top: 1px; } + +ul.inline { margin: 0 auto 0.5em auto; margin-left: -1.46667em; margin-right: 0; padding: 0; list-style: none; overflow: hidden; } +ul.inline > li { list-style: none; float: left; margin-left: 1.46667em; display: block; } +ul.inline > li > * { display: block; } + +.unstyled dl dt { font-weight: normal; font-style: normal; } + +ol.arabic { list-style-type: decimal; } + +ol.decimal { list-style-type: decimal-leading-zero; } + +ol.loweralpha { list-style-type: lower-alpha; } + +ol.upperalpha { list-style-type: upper-alpha; } + +ol.lowerroman { list-style-type: lower-roman; } + +ol.upperroman { list-style-type: upper-roman; } + +ol.lowergreek { list-style-type: lower-greek; } + +.hdlist > table, .colist > table { border: 0; background: none; } +.hdlist > table > tbody > tr, .colist > table > tbody > tr { background: none; } + +td.hdlist1 { padding-right: .8em; font-weight: bold; } + +td.hdlist1, td.hdlist2 { vertical-align: top; } + +.literalblock + .colist, .listingblock + .colist { margin-top: -0.5em; } + +.colist > table tr > td:first-of-type { padding: 0 .8em; line-height: 1; } +.colist > table tr > td:last-of-type { padding: 0.26667em 0; } + +.qanda > ol > li > p > em:only-child { color: #3876b4; } + +.thumb, .th { line-height: 0; display: inline-block; border: solid 4px white; -webkit-box-shadow: 0 0 0 1px #dddddd; box-shadow: 0 0 0 1px #dddddd; } + +.imageblock.left, .imageblock[style*="float: left"] { margin: 0.26667em 0.66667em 1.33333em 0; } +.imageblock.right, .imageblock[style*="float: right"] { margin: 0.26667em 0 1.33333em 0.66667em; } +.imageblock > .title { margin-bottom: 0; } +.imageblock.thumb, .imageblock.th { border-width: 6px; } +.imageblock.thumb > .title, .imageblock.th > .title { padding: 0 0.13333em; } + +.image.left, .image.right { margin-top: 0.26667em; margin-bottom: 0.26667em; display: inline-block; line-height: 0; } +.image.left { margin-right: 0.66667em; } +.image.right { margin-left: 0.66667em; } + +a.image { text-decoration: none; } + +span.footnote, span.footnoteref { vertical-align: super; font-size: 0.93333em; } +span.footnote a, span.footnoteref a { text-decoration: none; } + +#footnotes { padding-top: 0.8em; padding-bottom: 0.8em; margin-bottom: 0.66667em; } +#footnotes hr { width: 20%; min-width: 6.66667em; margin: -.25em 0 .75em 0; border-width: 1px 0 0 0; } +#footnotes .footnote { padding: 0 0.4em; line-height: 1.3; font-size: 0.93333em; margin-left: 1.2em; text-indent: -1.2em; margin-bottom: .2em; } +#footnotes .footnote a:first-of-type { font-weight: bold; text-decoration: none; } +#footnotes .footnote:last-of-type { margin-bottom: 0; } + +#content #footnotes { margin-top: -0.66667em; margin-bottom: 0; padding: 0.8em 0; } + +.gist .file-data > table { border: none; background: #fff; width: 100%; margin-bottom: 0; } +.gist .file-data > table td.line-data { width: 99%; } + +div.unbreakable { page-break-inside: avoid; } + +.big { font-size: larger; } + +.small { font-size: smaller; } + +.underline { text-decoration: underline; } + +.overline { text-decoration: overline; } + +.line-through { text-decoration: line-through; } + +.aqua { color: #00bfbf; } + +.aqua-background { background-color: #00fafa; } + +.black { color: black; } + +.black-background { background-color: black; } + +.blue { color: #0000bf; } + +.blue-background { background-color: #0000fa; } + +.fuchsia { color: #bf00bf; } + +.fuchsia-background { background-color: #fa00fa; } + +.gray { color: #606060; } + +.gray-background { background-color: #7d7d7d; } + +.green { color: #006000; } + +.green-background { background-color: #007d00; } + +.lime { color: #00bf00; } + +.lime-background { background-color: #00fa00; } + +.maroon { color: #600000; } + +.maroon-background { background-color: #7d0000; } + +.navy { color: #000060; } + +.navy-background { background-color: #00007d; } + +.olive { color: #606000; } + +.olive-background { background-color: #7d7d00; } + +.purple { color: #600060; } + +.purple-background { background-color: #7d007d; } + +.red { color: #bf0000; } + +.red-background { background-color: #fa0000; } + +.silver { color: #909090; } + +.silver-background { background-color: #bcbcbc; } + +.teal { color: #006060; } + +.teal-background { background-color: #007d7d; } + +.white { color: #bfbfbf; } + +.white-background { background-color: #fafafa; } + +.yellow { color: #bfbf00; } + +.yellow-background { background-color: #fafa00; } + +span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } + +.admonitionblock td.icon [class^="icon-"]:before { font-size: 2.5em; text-shadow: 1px 1px 2px rgba(0, 0, 0, 0.5); cursor: default; } +.admonitionblock td.icon .icon-note:before { content: "\f05a"; color: #4183c4; color: #2e6295; } +.admonitionblock td.icon .icon-tip:before { content: "\f0eb"; text-shadow: 1px 1px 2px rgba(155, 155, 0, 0.8); color: #111; } +.admonitionblock td.icon .icon-warning:before { content: "\f071"; color: #bf6900; } +.admonitionblock td.icon .icon-caution:before { content: "\f06d"; color: #bf3400; } +.admonitionblock td.icon .icon-important:before { content: "\f06a"; color: #bf0000; } + +.conum { display: inline-block; color: white !important; background-color: #333333; -webkit-border-radius: 100px; border-radius: 100px; text-align: center; width: 20px; height: 20px; font-size: 12px; font-weight: bold; line-height: 20px; font-family: Arial, sans-serif; font-style: normal; position: relative; top: -2px; letter-spacing: -1px; } +.conum * { color: white !important; } +.conum + b { display: none; } +.conum:after { content: attr(data-value); } +.conum:not([data-value]):empty { display: none; } + +p.lead, .paragraph.lead > p, #preamble > .sectionbody > .paragraph:first-of-type p { font-size: 1em; color: #666666; } + +h2 { color: #030303; border-bottom: 1px solid #dddddd; } + +#content h1 > a.anchor, h2 > a.anchor, h3 > a.anchor, #toctitle > a.anchor, .sidebarblock > .content > .title > a.anchor, h4 > a.anchor, h5 > a.anchor, h6 > a.anchor { color: #333333; } + +#header, #content, #footnotes { max-width: 660px; padding-left: 0; padding-right: 0; } + + +#content ul li { padding-left: .7em; } + +.olist.procedure > ol { counter-reset: li; list-style: none; position: relative; } +.olist.procedure > ol > li { position: relative; padding: 5px 0 5px 55px; margin-bottom: 5px; } +.olist.procedure > ol > li:before { content: counter(li); counter-increment: li; position: absolute; top: 0; left: 0; height: 100%; width: 30px; padding: 0 10px 0 0; color: #999; font-size: 1.46667em; font-weight: bold; line-height: 1.6; text-align: right; border-right: 1px solid #ddd; } + +.quoteblock blockquote { background: url('../images/github/blockquote-arrow.png?1372292342') 0 2px no-repeat; padding-left: 1em; } + +.sidebarblock > .content > .title { margin-top: -20px; margin-right: -20px; margin-left: -20px; margin-bottom: 20px; padding: 1em; font-size: 0.8em; background: #eaeaea; } \ No newline at end of file diff --git a/resources/theme/p4-theme.yml b/resources/theme/p4-theme.yml new file mode 100644 index 0000000..0f4a999 --- /dev/null +++ b/resources/theme/p4-theme.yml @@ -0,0 +1,287 @@ +extends: ~ +font: + catalog: + UtopiaStd-Regular: + normal: Utopia/utopia-regular.ttf + bold: Utopia/utopia-bold.ttf + italic: Utopia/utopia-italic.ttf + bold_italic: Utopia/utopia-bolditalic.ttf + LuxiMono: + normal: LuxiMono/luximr.ttf + bold: LuxiMono/luximb.ttf + italic: LuxiMono/luximri.ttf + bold_italic: LuxiMono/luximbi.ttf + OpenSans: + normal: OpenSans/OpenSans-Regular.ttf + bold: OpenSans/OpenSans-Bold.ttf + italic: OpenSans/OpenSans-Italic.ttf + bold_italic: OpenSans/OpenSans-BoldItalic.ttf +page: + layout: portrait + initial_zoom: FitH + margin: [0.5in, 0.67in, 0.67in, 0.67in] + # margin_inner and margin_outer keys are used for recto/verso print margins when media=prepress + margin_inner: 0.75in + margin_outer: 0.59in + size: A4 + numbering: + start-at: toc +base: + text_align: justify + font_color: 333333 + font_family: UtopiaStd-Regular + font_size: 10.5 + # line_height_length is really just a vertical spacing variable; it's not actually the height of a line + line_height_length: 12 + # The Noto font family has a built-in line height of 1.36 + # With this line_height, a line of text will occupy a height of 15.78pt + line_height: $base_line_height_length / 10.5 + font_size_large: round($base_font_size * 1.25) + font_size_small: round($base_font_size * 0.85) + font_size_min: $base_font_size * 0.75 + font_style: normal + border_color: EEEEEE + border_radius: 4 + border_width: 0.5 +role: + lead: + font_size: $base_font_size_large + line-through: + text_decoration: line-through + underline: + text_decoration: underline + big: + font_size: 1.2em + small: + font_size: 0.8em + subtitle: + font_color: 999999 + font_size: 0.8em + font_style: normal_italic +vertical_rhythm: $base_line_height_length +horizontal_rhythm: $base_line_height_length +link: + font_color: 428BCA +# codespan is currently used for monospaced phrases and table cells +codespan: + font_color: #B12146 + font_family: OpenSans +kbd: + background_color: F5F5F5 + border_color: CCCCCC + border_offset: 2 + border_radius: 2 + border_width: 0.5 + font_family: $codespan_font_family + separator_content: "\u202f+\u202f\u200b" +mark: + background_color: FFFF00 + border_offset: 1 +menu: + caret_content: "\u00a0\u203a " + font_style: bold +heading: + font-family: OpenSans + font-color: #262626 + font-size: 17 + font-style: bold + # h1 is used for part titles (book doctype) or the doctitle (article doctype) + h1_font_size: floor($base_font_size * 2.6) + # h2 is used for chapter titles (book doctype only) + h2_font_size: floor($base_font_size * 2.15) + h3_font_size: round($base_font_size * 1.7) + h4_font_size: $base_font_size_large + h5_font_size: $base_font_size + h6_font_size: $base_font_size_small + # rely on built-in line height in Noto + line_height: 1 + margin_top: $vertical_rhythm * 0.4 + margin_bottom: $vertical_rhythm * 0.9 + min_height_after: auto + chapter: + break-before: auto +title_page: + font-family: OpenSans + font-color: #080808 + font-size: 25 + font-style: bold + text-align: center + logo: + image: image:logo.png[pdfwidth=3.0in,align=center] + subtitle: + font-family: OpenSans + font-color: #080808 + font-size: 15 + text-align: center + line_height: 1 + revision: + font-family: OpenSans + font-color: #080808 + font-size: 10 + text-align: center + margin_top: $base_font_size * 1.25 +block: + margin_bottom: $vertical_rhythm +caption: + align: left + font_size: $base_font_size * 0.95 + font_style: italic + # FIXME perhaps set line_height instead of / in addition to margins? + margin_inside: $vertical_rhythm / 3 + margin_outside: 0 +abstract: + title: + font-family: UtopiaStd-Regular + font-color: #080808 + font-size: 15 + font-style: italic + text-align: center +admonition: + column_rule_color: $base_border_color + column_rule_width: $base_border_width + padding: [$vertical_rhythm / 3.0, $horizontal_rhythm, $vertical_rhythm / 3.0, $horizontal_rhythm] + label: + text_transform: uppercase + font_style: bold +quote: + font_size: $base_font_size_large + border_color: $base_border_color + border_width: 0 + border_left_width: $horizontal_rhythm / 3 + padding: [$vertical_rhythm / 4, $horizontal_rhythm, $vertical_rhythm / 4, $horizontal_rhythm + $quote_border_left_width / 2] + cite: + font_size: $base_font_size_small + font_color: $role_subtitle_font_color +verse: + font_size: $quote_font_size + border_color: $quote_border_color + border_width: $quote_border_width + border_left_width: $quote_border_left_width + padding: $quote_padding + cite: + font_size: $quote_cite_font_size + font_color: $quote_cite_font_color +# code is used for literal, listing, and source blocks and literal table cells +code: + font_color: #fcf3d9 + font_family: LuxiMono + font_size: 9 + padding: $code_font_size + line_height: 1.25 + # line_gap is an experimental property to control how a background color is applied to an inline block element + line_gap: 3.8 + background_color: F5F5F5 + border_color: CCCCCC + border_radius: $base_border_radius + border_width: 0.75 +conum: + font_family: $codespan_font_family + font_color: $codespan_font_color + font_size: $base_font_size + line_height: 4 / 3 + glyphs: circled +example: + border_color: $base_border_color + border_radius: $base_border_radius + border_width: 0.75 + padding: [$vertical_rhythm, $horizontal_rhythm, $vertical_rhythm, $horizontal_rhythm] +image: + caption: + font-family: UtopiaStd-Regular + font-color: #080808 + font-size: 10 + font-style: italic + text-align: center +prose: + margin_bottom: $block_margin_bottom +sidebar: + background_color: EEEEEE + border_color: E1E1E1 + border_radius: $base_border_radius + border_width: $base_border_width + padding: [$vertical_rhythm, $vertical_rhythm * 1.25, $vertical_rhythm, $vertical_rhythm * 1.25] + title: + text_align: center + font_color: $heading_font_color + font_size: $heading_h4_font_size + font_style: $heading_font_style +thematic_break: + border_color: $base_border_color + border_style: solid + border_width: $base_border_width + padding: [$vertical_rhythm * 0.5, 0] +list: + indent: $horizontal_rhythm * 1.5 + #marker_font_color: 404040 + # NOTE list_item_spacing only applies to list items that do not have complex content + item_spacing: $vertical_rhythm / 2 +# Force all indent levels of an unordered list to use the same font +# glyph for all symbols, because the fonts we are using do not have +# definitions for any of the ones that asciidoctor-pdf normally uses. +# If we change our fonts to have definitions for the default code points +# used by asciidoctor-pdf, the 'ulist:' section can be deleted. +ulist: + marker: + square: + content: "\u2022" + circle: + content: "\u2022" + checked: + content: "\u2022" + unchecked: + content: "\u2022" +description_list: + term_font_style: bold + term_spacing: $vertical_rhythm / 4 + description_indent: $horizontal_rhythm * 1.25 +callout_list: + margin_top_after_code: -$block_margin_bottom / 2 +table: + border_color: DDDDDD + border_width: $base_border_width + grid_width: $base_border_width + cell_padding: 3 + head: + font_style: bold + border_bottom_width: $base_border_width * 2.5 + body: + stripe_background_color: F9F9F9 + foot: + background_color: F0F0F0 + caption: + text-align: center + end: bottom +toc: + indent: $horizontal_rhythm + font-family: OpenSans + font-color: #01226e + font-size: 10 + indent: 20 + title: + font-family: OpenSans + font-color: #080808 + font-size: 15 + font-style: bold + dot-leader: + content: ". " + levels: 2 3 4 5 +footnotes: + font_size: round($base_font_size * 0.75) + item_spacing: $list_item_spacing / 2 +index: + column_gap: $vertical_rhythm +header: + font_size: $base_font_size_small + line_height: 1 + vertical_align: middle +footer: + font_size: 10 + font-family: UtopiaStd-Regular + height: 1in + columns: =100% + recto: + center: + content: '{page-number}' + verso: + center: + content: '{page-number}' diff --git a/resources/theme/references.bib b/resources/theme/references.bib new file mode 100644 index 0000000..f6c01c2 --- /dev/null +++ b/resources/theme/references.bib @@ -0,0 +1,16 @@ +@ONLINE { P4RuntimeRepo, + title = "p4lang/p4Runtime repository", + subtitle = "P4Runtime Protobuf definition files and specification", + url = "https://github.com/p4lang/p4runtime" +} + +@ONLINE { PNAExamplePrograms, + title = "p4lang/PNAExample repository", + subtitle = "PNA example files", + url = "https://github.com/p4lang/pna/tree/main/examples" +} + +@ONLINE { PSA, + title = "Portable Switch Architecture specification (v1.1.0)", + url = "https://p4.org/p4-spec/docs/PSA-v1.1.0.html" +} \ No newline at end of file