├── .gitignore ├── LICENSE ├── README.md ├── project.clj └── src └── fvm ├── core.clj └── util.clj /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /classes 3 | /checkouts 4 | profiles.clj 5 | pom.xml 6 | pom.xml.asc 7 | *.jar 8 | *.class 9 | /.lein-* 10 | /.nrepl-port 11 | .hgignore 12 | .hg/ 13 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Eclipse Public License - v 2.0 2 | 3 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE 4 | PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION 5 | OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. 6 | 7 | 1. DEFINITIONS 8 | 9 | "Contribution" means: 10 | 11 | a) in the case of the initial Contributor, the initial content 12 | Distributed under this Agreement, and 13 | 14 | b) in the case of each subsequent Contributor: 15 | i) changes to the Program, and 16 | ii) additions to the Program; 17 | where such changes and/or additions to the Program originate from 18 | and are Distributed by that particular Contributor. A Contribution 19 | "originates" from a Contributor if it was added to the Program by 20 | such Contributor itself or anyone acting on such Contributor's behalf. 21 | Contributions do not include changes or additions to the Program that 22 | are not Modified Works. 23 | 24 | "Contributor" means any person or entity that Distributes the Program. 25 | 26 | "Licensed Patents" mean patent claims licensable by a Contributor which 27 | are necessarily infringed by the use or sale of its Contribution alone 28 | or when combined with the Program. 29 | 30 | "Program" means the Contributions Distributed in accordance with this 31 | Agreement. 32 | 33 | "Recipient" means anyone who receives the Program under this Agreement 34 | or any Secondary License (as applicable), including Contributors. 35 | 36 | "Derivative Works" shall mean any work, whether in Source Code or other 37 | form, that is based on (or derived from) the Program and for which the 38 | editorial revisions, annotations, elaborations, or other modifications 39 | represent, as a whole, an original work of authorship. 40 | 41 | "Modified Works" shall mean any work in Source Code or other form that 42 | results from an addition to, deletion from, or modification of the 43 | contents of the Program, including, for purposes of clarity any new file 44 | in Source Code form that contains any contents of the Program. Modified 45 | Works shall not include works that contain only declarations, 46 | interfaces, types, classes, structures, or files of the Program solely 47 | in each case in order to link to, bind by name, or subclass the Program 48 | or Modified Works thereof. 49 | 50 | "Distribute" means the acts of a) distributing or b) making available 51 | in any manner that enables the transfer of a copy. 52 | 53 | "Source Code" means the form of a Program preferred for making 54 | modifications, including but not limited to software source code, 55 | documentation source, and configuration files. 56 | 57 | "Secondary License" means either the GNU General Public License, 58 | Version 2.0, or any later versions of that license, including any 59 | exceptions or additional permissions as identified by the initial 60 | Contributor. 61 | 62 | 2. GRANT OF RIGHTS 63 | 64 | a) Subject to the terms of this Agreement, each Contributor hereby 65 | grants Recipient a non-exclusive, worldwide, royalty-free copyright 66 | license to reproduce, prepare Derivative Works of, publicly display, 67 | publicly perform, Distribute and sublicense the Contribution of such 68 | Contributor, if any, and such Derivative Works. 69 | 70 | b) Subject to the terms of this Agreement, each Contributor hereby 71 | grants Recipient a non-exclusive, worldwide, royalty-free patent 72 | license under Licensed Patents to make, use, sell, offer to sell, 73 | import and otherwise transfer the Contribution of such Contributor, 74 | if any, in Source Code or other form. This patent license shall 75 | apply to the combination of the Contribution and the Program if, at 76 | the time the Contribution is added by the Contributor, such addition 77 | of the Contribution causes such combination to be covered by the 78 | Licensed Patents. The patent license shall not apply to any other 79 | combinations which include the Contribution. No hardware per se is 80 | licensed hereunder. 81 | 82 | c) Recipient understands that although each Contributor grants the 83 | licenses to its Contributions set forth herein, no assurances are 84 | provided by any Contributor that the Program does not infringe the 85 | patent or other intellectual property rights of any other entity. 86 | Each Contributor disclaims any liability to Recipient for claims 87 | brought by any other entity based on infringement of intellectual 88 | property rights or otherwise. As a condition to exercising the 89 | rights and licenses granted hereunder, each Recipient hereby 90 | assumes sole responsibility to secure any other intellectual 91 | property rights needed, if any. For example, if a third party 92 | patent license is required to allow Recipient to Distribute the 93 | Program, it is Recipient's responsibility to acquire that license 94 | before distributing the Program. 95 | 96 | d) Each Contributor represents that to its knowledge it has 97 | sufficient copyright rights in its Contribution, if any, to grant 98 | the copyright license set forth in this Agreement. 99 | 100 | e) Notwithstanding the terms of any Secondary License, no 101 | Contributor makes additional grants to any Recipient (other than 102 | those set forth in this Agreement) as a result of such Recipient's 103 | receipt of the Program under the terms of a Secondary License 104 | (if permitted under the terms of Section 3). 105 | 106 | 3. REQUIREMENTS 107 | 108 | 3.1 If a Contributor Distributes the Program in any form, then: 109 | 110 | a) the Program must also be made available as Source Code, in 111 | accordance with section 3.2, and the Contributor must accompany 112 | the Program with a statement that the Source Code for the Program 113 | is available under this Agreement, and informs Recipients how to 114 | obtain it in a reasonable manner on or through a medium customarily 115 | used for software exchange; and 116 | 117 | b) the Contributor may Distribute the Program under a license 118 | different than this Agreement, provided that such license: 119 | i) effectively disclaims on behalf of all other Contributors all 120 | warranties and conditions, express and implied, including 121 | warranties or conditions of title and non-infringement, and 122 | implied warranties or conditions of merchantability and fitness 123 | for a particular purpose; 124 | 125 | ii) effectively excludes on behalf of all other Contributors all 126 | liability for damages, including direct, indirect, special, 127 | incidental and consequential damages, such as lost profits; 128 | 129 | iii) does not attempt to limit or alter the recipients' rights 130 | in the Source Code under section 3.2; and 131 | 132 | iv) requires any subsequent distribution of the Program by any 133 | party to be under a license that satisfies the requirements 134 | of this section 3. 135 | 136 | 3.2 When the Program is Distributed as Source Code: 137 | 138 | a) it must be made available under this Agreement, or if the 139 | Program (i) is combined with other material in a separate file or 140 | files made available under a Secondary License, and (ii) the initial 141 | Contributor attached to the Source Code the notice described in 142 | Exhibit A of this Agreement, then the Program may be made available 143 | under the terms of such Secondary Licenses, and 144 | 145 | b) a copy of this Agreement must be included with each copy of 146 | the Program. 147 | 148 | 3.3 Contributors may not remove or alter any copyright, patent, 149 | trademark, attribution notices, disclaimers of warranty, or limitations 150 | of liability ("notices") contained within the Program from any copy of 151 | the Program which they Distribute, provided that Contributors may add 152 | their own appropriate notices. 153 | 154 | 4. COMMERCIAL DISTRIBUTION 155 | 156 | Commercial distributors of software may accept certain responsibilities 157 | with respect to end users, business partners and the like. While this 158 | license is intended to facilitate the commercial use of the Program, 159 | the Contributor who includes the Program in a commercial product 160 | offering should do so in a manner which does not create potential 161 | liability for other Contributors. Therefore, if a Contributor includes 162 | the Program in a commercial product offering, such Contributor 163 | ("Commercial Contributor") hereby agrees to defend and indemnify every 164 | other Contributor ("Indemnified Contributor") against any losses, 165 | damages and costs (collectively "Losses") arising from claims, lawsuits 166 | and other legal actions brought by a third party against the Indemnified 167 | Contributor to the extent caused by the acts or omissions of such 168 | Commercial Contributor in connection with its distribution of the Program 169 | in a commercial product offering. The obligations in this section do not 170 | apply to any claims or Losses relating to any actual or alleged 171 | intellectual property infringement. In order to qualify, an Indemnified 172 | Contributor must: a) promptly notify the Commercial Contributor in 173 | writing of such claim, and b) allow the Commercial Contributor to control, 174 | and cooperate with the Commercial Contributor in, the defense and any 175 | related settlement negotiations. The Indemnified Contributor may 176 | participate in any such claim at its own expense. 177 | 178 | For example, a Contributor might include the Program in a commercial 179 | product offering, Product X. That Contributor is then a Commercial 180 | Contributor. If that Commercial Contributor then makes performance 181 | claims, or offers warranties related to Product X, those performance 182 | claims and warranties are such Commercial Contributor's responsibility 183 | alone. Under this section, the Commercial Contributor would have to 184 | defend claims against the other Contributors related to those performance 185 | claims and warranties, and if a court requires any other Contributor to 186 | pay any damages as a result, the Commercial Contributor must pay 187 | those damages. 188 | 189 | 5. NO WARRANTY 190 | 191 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT 192 | PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" 193 | BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR 194 | IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF 195 | TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 196 | PURPOSE. Each Recipient is solely responsible for determining the 197 | appropriateness of using and distributing the Program and assumes all 198 | risks associated with its exercise of rights under this Agreement, 199 | including but not limited to the risks and costs of program errors, 200 | compliance with applicable laws, damage to or loss of data, programs 201 | or equipment, and unavailability or interruption of operations. 202 | 203 | 6. DISCLAIMER OF LIABILITY 204 | 205 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT 206 | PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS 207 | SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 208 | EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST 209 | PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 210 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 211 | ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE 212 | EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE 213 | POSSIBILITY OF SUCH DAMAGES. 214 | 215 | 7. GENERAL 216 | 217 | If any provision of this Agreement is invalid or unenforceable under 218 | applicable law, it shall not affect the validity or enforceability of 219 | the remainder of the terms of this Agreement, and without further 220 | action by the parties hereto, such provision shall be reformed to the 221 | minimum extent necessary to make such provision valid and enforceable. 222 | 223 | If Recipient institutes patent litigation against any entity 224 | (including a cross-claim or counterclaim in a lawsuit) alleging that the 225 | Program itself (excluding combinations of the Program with other software 226 | or hardware) infringes such Recipient's patent(s), then such Recipient's 227 | rights granted under Section 2(b) shall terminate as of the date such 228 | litigation is filed. 229 | 230 | All Recipient's rights under this Agreement shall terminate if it 231 | fails to comply with any of the material terms or conditions of this 232 | Agreement and does not cure such failure in a reasonable period of 233 | time after becoming aware of such noncompliance. If all Recipient's 234 | rights under this Agreement terminate, Recipient agrees to cease use 235 | and distribution of the Program as soon as reasonably practicable. 236 | However, Recipient's obligations under this Agreement and any licenses 237 | granted by Recipient relating to the Program shall continue and survive. 238 | 239 | Everyone is permitted to copy and distribute copies of this Agreement, 240 | but in order to avoid inconsistency the Agreement is copyrighted and 241 | may only be modified in the following manner. The Agreement Steward 242 | reserves the right to publish new versions (including revisions) of 243 | this Agreement from time to time. No one other than the Agreement 244 | Steward has the right to modify this Agreement. The Eclipse Foundation 245 | is the initial Agreement Steward. The Eclipse Foundation may assign the 246 | responsibility to serve as the Agreement Steward to a suitable separate 247 | entity. Each new version of the Agreement will be given a distinguishing 248 | version number. The Program (including Contributions) may always be 249 | Distributed subject to the version of the Agreement under which it was 250 | received. In addition, after a new version of the Agreement is published, 251 | Contributor may elect to Distribute the Program (including its 252 | Contributions) under the new version. 253 | 254 | Except as expressly stated in Sections 2(a) and 2(b) above, Recipient 255 | receives no rights or licenses to the intellectual property of any 256 | Contributor under this Agreement, whether expressly, by implication, 257 | estoppel or otherwise. All rights in the Program not expressly granted 258 | under this Agreement are reserved. Nothing in this Agreement is intended 259 | to be enforceable by any entity that is not a Contributor or Recipient. 260 | No third-party beneficiary rights are created under this Agreement. 261 | 262 | Exhibit A - Form of Secondary Licenses Notice 263 | 264 | "This Source Code may also be made available under the following 265 | Secondary Licenses when the conditions for such availability set forth 266 | in the Eclipse Public License, v. 2.0 are satisfied: {name license(s), 267 | version(s), and exceptions or additional permissions here}." 268 | 269 | Simply including a copy of this Agreement, including this Exhibit A 270 | is not sufficient to license the Source Code under Secondary Licenses. 271 | 272 | If it is not possible or desirable to put the notice in a particular 273 | file, then You may include the notice in a location (such as a LICENSE 274 | file in a relevant directory) where a recipient would be likely to 275 | look for such a notice. 276 | 277 | You may add additional accurate notices of copyright ownership. 278 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # fvm [![Clojars Project](https://img.shields.io/clojars/v/fvm-project/fvm.svg)](https://clojars.org/fvm-project/fvm) 2 | 3 | **fvm** is a Clojure library for writing self-optimizing interpreters. 4 | 5 | ## How it works 6 | 7 | fvm provides a function called `defnode` for defining instruction nodes with the following signature: 8 | 9 | ```clojure 10 | (fvm/defnode ) 11 | ``` 12 | 13 | - any node with the option `{::fvm/jit? true}` is considered a loop 14 | - if such a node is executed frequently enough, its next execution is put in "trace-mode" 15 | - in trace-mode, all the sub-nodes executed are logged in a "trace" 16 | - the trace is effectively an unrolled version of the loop with function calls inlined 17 | - once the node finishes executing, this trace is "compiled" into a Clojure function 18 | - the compiled version is used on future executions of this node 19 | 20 | ## Examples 21 | 22 | [ednlang](https://github.com/fvm-project/ednlang) is a simple stack-based concatenative language implemented using fvm. 23 | 24 | ednlang is meant to showcase all the features of fvm, and is also used to test and profile fvm. 25 | 26 | Work is ongoing to implement a lisp on top of fvm. 27 | 28 | ## Status 29 | 30 | This is **EXPERIMENTAL** software. Here be dragons. 31 | 32 | ## License 33 | 34 | Copyright © 2020 Divyansh Prakash 35 | 36 | This program and the accompanying materials are made available under the 37 | terms of the Eclipse Public License 2.0 which is available at 38 | http://www.eclipse.org/legal/epl-2.0. 39 | 40 | This Source Code may also be made available under the following Secondary 41 | Licenses when the conditions for such availability set forth in the Eclipse 42 | Public License, v. 2.0 are satisfied: GNU General Public License as published by 43 | the Free Software Foundation, either version 2 of the License, or (at your 44 | option) any later version, with the GNU Classpath Exception which is available 45 | at https://www.gnu.org/software/classpath/license.html. 46 | -------------------------------------------------------------------------------- /project.clj: -------------------------------------------------------------------------------- 1 | (defproject fvm-project/fvm "0.1.2" 2 | :description "fvm is a Clojure library for writing self-optimizing interpreters" 3 | :url "https://github.com/fvm-project/fvm" 4 | :license {:name "EPL-2.0 OR GPL-2.0-or-later WITH Classpath-exception-2.0" 5 | :url "https://www.eclipse.org/legal/epl-2.0/"} 6 | :dependencies [[org.clojure/clojure "1.10.1"]] 7 | :target-path "target/%s" 8 | :profiles {:dev {:global-vars {*warn-on-reflection* true}}}) 9 | -------------------------------------------------------------------------------- /src/fvm/core.clj: -------------------------------------------------------------------------------- 1 | (ns fvm.core 2 | (:refer-clojure :exclude [compile]) 3 | (:require [fvm.util :as u])) 4 | 5 | ;; API 6 | ;; === 7 | (defmulti eval-node 8 | (fn [state] 9 | (let [node (-> state ::nodes first)] 10 | (::type node)))) 11 | 12 | (defonce node-opts 13 | (atom {})) 14 | 15 | (defn defnode 16 | [type opts handle] 17 | (swap! node-opts assoc 18 | type (merge {::branching? false 19 | ::trace? true 20 | ::jit? false} 21 | opts)) 22 | (.addMethod ^clojure.lang.MultiFn eval-node 23 | type 24 | handle)) 25 | 26 | (defn- trace? [type] 27 | (-> @node-opts type ::trace?)) 28 | 29 | (defn- jit? [type] 30 | (-> @node-opts type ::jit?)) 31 | 32 | (defn- branching? [type] 33 | (-> @node-opts type ::branching?)) 34 | 35 | (defn- get-check-state-fn [type] 36 | (-> @node-opts type ::check-state)) 37 | 38 | 39 | ;; VM 40 | ;; == 41 | (defnode :default {} 42 | (fn [state] 43 | (let [type (-> state ::nodes first ::type)] 44 | (throw (Exception. ^String (str "Undefined node type: " type)))))) 45 | 46 | (declare compile) 47 | 48 | (defn interpret 49 | [{::keys [state trace-atom trace-info] :as S}] 50 | (let [trace-atom (or trace-atom (atom [])) 51 | S (assoc S ::trace-atom trace-atom)] 52 | (if-let [[node] (-> state ::nodes seq)] 53 | (case (::type node) 54 | ::trace-start 55 | (let [traced-node (::node node)] 56 | (recur (-> S 57 | (assoc-in [::trace-info traced-node ::trace-start-idx] 58 | (count @trace-atom)) 59 | (update-in [::state ::nodes] rest)))) 60 | 61 | ::trace-end 62 | (let [traced-node (::node node) 63 | start-idx (-> trace-info traced-node ::trace-start-idx) 64 | node-trace (drop start-idx @trace-atom)] 65 | (recur (-> S 66 | (u/dissoc-in [::trace-info traced-node ::trace-start-idx]) 67 | (u/dissoc-in [::trace-info traced-node ::called-ats]) 68 | (assoc-in [::trace-info traced-node ::compiled-node] 69 | (compile node-trace)) 70 | (update-in [::state ::nodes] rest)))) 71 | 72 | ;; default 73 | (do 74 | (swap! trace-atom conj state) 75 | (let [node-type (::type node) 76 | node-trace-info (get trace-info node-type) 77 | compiled-node (::compiled-node node-trace-info) 78 | fallback? (::fallback? state)] 79 | (cond 80 | ;; run compiled 81 | (and (some? compiled-node) 82 | (not fallback?)) 83 | (recur (assoc S ::state (compiled-node state))) 84 | 85 | ;; run interpreted 86 | (or fallback? 87 | (not (jit? node-type))) 88 | (recur (assoc S ::state (eval-node state))) 89 | 90 | :else 91 | (let [called-ats (::called-ats node-trace-info) 92 | curr-millis (u/curr-millis) 93 | two-ms-ago (- curr-millis 2) 94 | calls-in-last-two-ms (filter #(<= two-ms-ago %) 95 | called-ats) 96 | new-called-ats (if (seq called-ats) 97 | (conj calls-in-last-two-ms curr-millis) 98 | [curr-millis]) 99 | times-called-in-last-two-ms (count calls-in-last-two-ms) 100 | should-trace? (and (nil? (::trace-start-idx node-trace-info)) 101 | (>= times-called-in-last-two-ms 5)) 102 | nodes (::nodes state) 103 | new-state (if-not should-trace? 104 | (eval-node state) 105 | (assoc state ::nodes 106 | (u/fastcat [{::type ::trace-start 107 | ::node node-type} 108 | node 109 | {::type ::trace-end 110 | ::node node-type}] 111 | 112 | (rest nodes))))] 113 | (recur (-> S 114 | (assoc ::state new-state) 115 | (assoc-in [::trace-info node-type ::called-ats] new-called-ats)))))))) 116 | S))) 117 | 118 | 119 | ;; JIT 120 | ;; === 121 | (defnode ::guard 122 | {::trace? false} 123 | (fn [state] 124 | (let [node (-> state ::nodes first) 125 | safe? (::safe? node) 126 | fallback (::fallback node)] 127 | (if (safe? state) 128 | (update state ::nodes rest) 129 | (fallback))))) 130 | 131 | (defn- make-guard [node safe?] 132 | (fn [state] 133 | (let [nodes (cons node (::nodes state)) 134 | S {::state (assoc state 135 | ::nodes nodes 136 | ::fallback? true)} 137 | fallback #(-> (interpret S) 138 | ::state 139 | (assoc ::interpreted? true)) 140 | guard-node {::type ::guard 141 | ::safe? safe? 142 | ::fallback fallback}] 143 | (eval-node (update state ::nodes #(cons guard-node %)))))) 144 | 145 | (defn- compile-node [node state] 146 | (if (branching? (::type node)) 147 | (let [check-state (get-check-state-fn (::type node)) 148 | bool (check-state state) 149 | unchanged? #(= bool (check-state %))] 150 | (make-guard node unchanged?)) 151 | 152 | (fn [state*] 153 | (eval-node (assoc state* ::nodes [node]))))) 154 | 155 | (defn- compile [node-trace] 156 | (let [trace 157 | (filter (fn [state] 158 | (-> state 159 | ::nodes 160 | first 161 | ::type 162 | trace?)) 163 | node-trace) 164 | 165 | compiled-nodes 166 | (map-indexed (fn [idx {::keys [nodes]}] 167 | (compile-node (first nodes) 168 | (->> trace 169 | (drop (inc idx)) 170 | first))) 171 | trace)] 172 | (fn [init-state] 173 | (reduce (fn [state compiled-node] 174 | (if (::interpreted? state) 175 | (reduced (dissoc state ::interpreted?)) 176 | (compiled-node state))) 177 | init-state 178 | compiled-nodes)))) 179 | -------------------------------------------------------------------------------- /src/fvm/util.clj: -------------------------------------------------------------------------------- 1 | (ns fvm.util) 2 | 3 | (defn dissoc-in 4 | "Dissociates an entry from a nested associative structure returning a new 5 | nested structure. keys is a sequence of keys. Any empty maps that result 6 | will not be present in the new structure." 7 | [m [k & ks :as keys]] 8 | (if ks 9 | (if-let [nextmap (get m k)] 10 | (let [newmap (dissoc-in nextmap ks)] 11 | (if (seq newmap) 12 | (assoc m k newmap) 13 | (dissoc m k))) 14 | m) 15 | (dissoc m k))) 16 | 17 | (defn ^Long curr-millis [] 18 | (System/currentTimeMillis)) 19 | 20 | (defn push-all [coll stack] 21 | (let [rcoll (reverse coll)] 22 | (reduce (fn [acc x] 23 | (cons x acc)) 24 | stack 25 | rcoll))) 26 | 27 | (defn fastcat [& colls] 28 | (let [[stack & others] (reverse colls)] 29 | (reduce (fn [acc coll] 30 | (push-all coll acc)) 31 | stack 32 | others))) 33 | --------------------------------------------------------------------------------