Koka: a Functional Language with Effects

Koka v3 is a research language that is currently under development and not quite ready for production use.

Latest release: v3.1.2, 2024-05-30 (Install).

Koka is a strongly typed functional-style language with effect types and handlers.

The core of Koka consists of a small set of well-studied language features, like first-class functions, a polymorphic type- and effect system, algebraic data types, and effect handlers. Each of these is composable and avoid the addition of “special” extensions by being as general as possible.
Koka tracks the (side) effects of every function in its type, where pure and effectful computations are distinguished. The precise effect typing gives Koka rock-solid semantics backed by well-studied category theory, which makes Koka particularly easy to reason about for both humans and compilers.
Effect handlers let you define advanced control abstractions, like exceptions, async/await, or probabilistic programs, as a user library in a typed and composable way.
Perceus is an advanced compilation method for reference counting. Together with evidence passing, this lets Koka compile directly to C code without needing a garbage collector or runtime system. Perceus also performs reuse analysis and optimizes functional-style programs to use in-place updates when possible.

To learn more:

Install Koka and compile your first programs.
Read the Koka book for a tour of the Koka language and its specification.
Browse the library documentation.
Help with development

Enjoy, Daan Leijen

Special thanks to: Tim Whiting and Fredrik Wieczerkowski for their work on the VS Code language integration, Anton Lorenzen for his work on one-hole context (pdf), fully in-place programming [11] and frame-limited reuse in Perceus [10], Ningning Xie for her work on the theory and practice of evidence passing [9,6] and the formalization of Perceus reference counting [8], Alex Reinking for the implementation of the Perceus reference counting analysis [8], and all previous interns working on earlier versions of Koka: Daniel Hillerström, Jonathan Brachthäuser, Niki Vazou, Ross Tate, Edsko de Vries, and Dana Xu.

Recent Releases

v3.1.2, 2024-05-30: Fix vs code installation when not in a workspace.
v3.1.1, 2024-03-04: Fix crash in language server; fix build on older gcc versions.
v3.1.0, 2024-02-14: New concurrent build system and improved module dependency tracking -- much faster builds. Language Server now supports the stdio protocol via the --language-server --lsstdio combination of flags Clean up evidence vector api, remove cfc support in the C backend. Internal redesign of (named) effect generation to match the formal systems more closely.
v3.0.4, 2024-01-25: fix bug in infinite expansion with implicits. Split std/core in multiple modules, improved hover and inlay information in vs code, various small bug fixes.
v3.0.1, 2024-01-13: small bug fixes in expression evaluation, and fixes a locale error on macOS.
v3.0.0, 2024-01-13: improved vs code language support with inlay-hints. New locally qualified names, and initial support for implicit parameters. Samples can be found in samples/syntax. Various bug fixes.
v2.6.0, 2023-12-30: initial vs code language support with type information, jump to definition, run test functions directly from the editor, automatic Koka installation, and many more things. Special thanks to Tim Whiting and Fredrik Wieczerkowski for all their work on making this possible! Also includes support for one-hole contexts (pdf) and extended bit operations on int32/int64 and various bug fixes.
v2.4.2, 2023-07-03: interim release with support for the new fip and fbip keywords to support fully-in-place programming [11]. Various bug fixes and performance enhancements.
v2.4.0, 2022-02-07: automatic generation of installation packages for various Linux distributions (by Rubikscraft), improved specialization and integer add/sub, add rbtree-fbip sample, improve grammar (pub (instead of public, remove private (as it is always default)), final ctl (instead of brk), underscores in number literals, etc), rename double to float64, various bug fixes.
Older release notes.

Install

Koka has binary installers for Windows (x64), macOS (x64, M1), and Linux (x64) For other platforms, you need to build the compiler from source.

Build from Source

Koka has few dependencies and should build from source without problems on most common platforms, e.g. Windows (including WSL), macOS, and Unix. The following programs are required to build Koka:

Stack to run the Haskell compiler. Use brew install haskell-stack on macOS, curl -sSL https://get.haskellstack.org/ | sh on Unix, or the binary installer on Windows.
Optional: vcpkg to be able to link easily with C libraries. Use brew install vcpkg on macOS. On other systems use the vcpkg install instructions (Koka can find vcpkg automatically if installed to ~/vcpkg).
Optional: nodejs if using the Javascript backend.
Optional: emscripten and wasmtime if using the Wasm backend.
Optional: On Windows it is recommended to install the clang C compiler (use LLVM-<version>-win64.exe), or the Visual Studio C compiler.
On Windows, first set the console codepage to UTF8 to avoid build errors with stack: $ chcp 65001.

Now clone the repository and build the compiler as:

$ git clone --recursive https://github.com/koka-lang/koka
$ cd koka
$ stack update
$ stack build --fast
$ stack exec koka

(Note: if you forgot to pass --recursive on cloning, you will get errors when compiling Koka modules -- you can correct this by running git submodule update --init --recursive).

To run all tests, use stack test --fast. To run a single test you can run stack test filtering based on paths such as stack test --fast --test-arguments="--match /lib". This will run all tests that are under the test/lib directory.

You can also use stack build without the --fast flag to build an optimized version of the compiler.

(See the build notes below if you have issues when running- or installing stack).

Create an Install Bundle

Koka can generate a binary install bundle that can be installed on the local machine (use a build without --fast in that case):

$ stack build
$ stack exec koka -- -e util/bundle
...
distribution bundle created.
  bundle : bundle/v2.3.9/koka-v2.3.9-linux-x64.tar.gz
  cc     : gcc
  version: v2.3.9

This takes a while as it pre-compiles the standard libraries in three build variants (debug, drelease (release with debug info), and release). After generating the bundle, you can install it locally as:

$ util/install.sh  bundle/v2.3.9/koka-v2.3.9-linux-x64.tar.gz

(use util/install.bat on Windows). After installation, you can now directly invoke koka:

$ koka --version

Koka is by default installed for the current user in <prefix>/bin/koka, (with architecture specific files under <prefix>/lib/koka/v2.x.x and libraries and samples under <prefix>/share/koka/v2.x.x). On Unix and macOS the default prefix is /usr/local while on Windows the default prefix is %LOCALAPPDATA%\koka.

It is also possible to generate installation packages for various Linux platforms (RHEL, Debian, Alpine, etc.). See the readme for further information.

Benchmarks

These are initial benchmarks of Koka v2 with Perceus reference counting versus state-of-the-art memory reclamation implementations in various other languages. Since we compare across languages we need to interpret these results with care -- the results depend not only on memory reclamation but also on the different optimizations performed by each compiler and how well we can translate each benchmark to that particular language. We view these results therefore mostly as evidence that the current Koka implementation of reference counting is viable and can be competitive and not as a direct comparison of absolute performance between languages and systems.

As such, we select here only benchmarks that stress memory allocation, and we tried to select mature comparison systems that use a range of memory reclamation techniques and are considered best-in-class. The systems we compare are, Koka 2.0.3 (compiling the generated C code with gcc 9.3.0), OCaml 4.08.1, Haskell GHC 8.6.5, Swift 5.3, Java SE 15.0.1 with the Hotspot G1 collector, and C++ gcc 9.3.0.

The benchmarks are all available in test/bench (see the readme there for build instructions), and all stress memory allocation with little computation: rbtree (inserts 42 million items into a red-black tree), rbtree-ck (a variant of rbtree that keeps a list of every 5th subtree and thus shares many subtrees), deriv (the symbolic derivative of a large expression), nqueens (calculates all solutions for the n-queens problem of size 13 into a list, and returns the length of that list where the solution lists share many sub-solutions), and cfold (constant-folding over a large symbolic expression).

Note: in C++, without automatic memory management, many benchmarks are difficult to express directly as they use persistent and partially shared data structures. To implement these faithfully would essentially require manual reference counting. Instead, we use C++ as our performance baseline: we either use in-place updates without supporting persistence (as in rbtree which uses std::map) or we do not reclaim memory at all (as in deriv, nqueens, and cfold).

The execution times and peak working set averaged over 10 runs and normalized to Koka are in the figure on the right (on a 3.8Ghz AMD3600XT on Ubuntu 20.04, Nov 2020).

We can see that even though Koka has currently few optimizations besides the reference counting ones, it performs very well compared to these mature systems, often outperforming by a significant margin -- both in execution time and peak working set. Clearly, these benchmarks are allocation heavy but it is encouraging to see this initial performance from Koka.

A full discussion of these benchmarks and systems can be found in the Perceus report.

Tasks

Please help develop Koka: there are many opportunities to improve Koka or do research with Koka. We need:

Emacs (partially done) and Vim syntax highlighting.
Add more samples, improve documentation, landing page etc. Make it easier for people to contribute.
Run the full test suite.
Run the Bayesian probalistic machine learning program with large parameters.
Functions with a pattern match in the argument (by Steven Fontanella).
Support int64 operations

More advanced projects:

Master/PhD level:

Better language level FBIP support with guaranteed datatype matching, automatic derivative and visitor generation.
Float up open calls to improve effect handling (worked on by Naoya Furudono)
Formalize opening and closing effect row types (worked on by Kazuki Ikemori)
Can we use C++ exceptions to implement "zero-cost" if yielding() ... branches and remove the need for join points (see [9]).
Improve case-of-known simplification with shape information

Currently being worked on:

Various standard optimizations like case-of-case, join points, case-of-known constructor, etc.
Implement inline specialization where functions like map, fold etc get specialized for the function with which they are called. This is an important optimization for functional style languages to reduce the allocation of lambda's. (contact: Steven Fontanella)
Borrowing analysis for Perceus and improved reuse analysis. (contact: Anton Lorenzen)

The following is the immediate todo list to be completed in the coming months:

Port std/async with libuv integration.
Initial support for overloading through implicit parameters.

LSP Related Tasks:

Generate completions for effect handlers (with empty bodies of all the functions)
Generate show / (==) for datatypes
Find References
Generate Type Annotations

Extension Related Tasks:

VSCode:

Add support for debugging an executable

Contact me if you are interested in tackling some of these :-)

Build Notes

Branches

The main development branches are:

master: latest stable version.
dev: current development branch -- submit PR's to this branch.
v1-master: last stable version of Koka v1: this is Koka with the Javascript (and C#) backend which does not use evidence translation. This version supports std/async and should compile examples from published papers.

Building on macOS M1

You need at least stack version >= 2.11 Furthermore, you may need to add the brew installed LLVM to your path afterwards, or otherwise stack cannot find the LLVM tools. Add the following to your ~/.zshrc script and open an fresh prompt:

export PATH=/opt/homebrew/opt/llvm/bin:$PATH

Building with Cabal

Some platforms (like Linux arm64 and FreeBSD) do not always support stack well. In these cases we can also use ghc and cabal directly. Install these packages as:

$ sudo apt update
$ sudo apt install ghc cabal-install

On macOS (x64 and arm64) we use brew instead:

$ brew install pkg-config ghc cabal-install

On FreeBSD, use pkg:

$ sudo pkg update
$ sudo pkg install ghc hs-cabal-install   # or: hs-haskell-platform

Optionally, install vcpkg as well. If you install this in the ~/vcpkg directory Koka will find it automatically when needed:

~$ git clone https://github.com/microsoft/vcpkg
~$ ./vcpkg/bootstrap-vcpkg.sh
~$ vcpkg/vcpkg install pcre

We can now build the compiler using cabal as:

~$ git clone --recursive https://github.com/koka-lang/koka
~$ cd koka
~/koka$ cabal new-update
~/koka$ cabal new-build
~/koka$ cabal new-run koka

We can also run tests as:

~/koka$ cabal new-run koka-test

or create an installer:

~/koka$ cabal new-run koka -- -e util/bundle

Building with minbuild

If neither stack nor cabal are functional, you may try to run the minimal build script to build Koka:

~/koka$ ./util/minbuild.sh

which directly invokes ghc to build the compiler. You can create an install bundle from a minbuild as:

~/koka$ .koka/minbuild/koka -e util/bundle.kk -- --koka=.koka/minbuild/koka

Windows C Compilers

The Koka compiler on Windows requires a C compiler. By default when using stack exec koka the C compiler supplied with ghc is used (mingw) but that is only visible within a stack environmet.

It is therefore recommended to install the clang compiler for Windows (which is automatically installed when running util/install.bat). However, Koka can also use the Microsoft Visual C++ compiler (cl) if you run koka from a Visual Studio x64 toolset command prompt (in order to link correctly with the Windows system libraries).

Generally, for Koka code, mingw (gcc) optimizes best, closely followed clang-cl. On a 3.8Gz AMD 3600XT, with mingw 7.2.0, clang-cl 11.0.0, and cl 19.28 we get:

$ stack exec out\v2.0.5\mingw-release\test_bench_koka_rbtree -- --kktime
420000
info: elapsed: 0.624s, user: 0.625s, sys: 0.000s, rss: 163mb

$ out\v2.0.5\clang-cl-release\test_bench_koka_rbtree --kktime
420000
info: elapsed: 0.727s, user: 0.734s, sys: 0.000s, rss: 164mb

$ out\v2.0.5\cl-release\test_bench_koka_rbtree --kktime
420000
info: elapsed: 1.483s, user: 1.484s, sys: 0.000s, rss: 164mb

Language Server

See the support/vscode/README.md for how to build the VS Code language server.

Older Release Notes

v2.3.8, 2021-12-27: improved int performance, various bug fixes, update wasm backend, initial conan support, fix js backend.
v2.3.6, 2021-11-26: fix specialization bug, add std/os/readline module.
v2.3.4, 2021-11-26: maybe-like types are already value types, but now also no longer need heap allocation if not nested (and [Just(1)] uses the same heap space as [1]), improved atomic refcounting (by Anton Lorenzen), improved specialization (by Steven Fontanella), various small fixes, fix build on freeBSD.
v2.3.2, 2021-10-15: initial wasm support (use --target=wasm, and install emscripten and wasmtime), improved reuse specialization (by Anton Lorenzen), fix default color scheme for non-dark shells (#190), stack-less free and marking, add --stack option, musl support (use --cc=musl-gcc), fix vcpkg support on macOS with homebrew installed vcpkg, various bug fixes.
v2.3.1, 2021-09-29: improved TRMC optimizations, and improved reuse (the rbtree benchmark is faster as C++ now). Improved effect operation speed. Allow elision of -> in anonymous function expressions (e.g. xs.map( fn(x) x + 1 )) and operation clauses. Allow ctl for control. New default output directory as .koka and improved command line options to be more in line with other compilers (with -o specifying the final output, and -e to execute the program).
v2.3.0, 2021-09-20: many changes: new layout rule to elide braces and no more need to parenthesize if and match conditions (see the samples/basic/rbtree for an example of this), updated the JavaScript backend (--target=js) to use standard ES6 modules and using the new BigInt for arbitrary precision integers, improved runtime layout with support for 128-bit arm CHERI, add the std/num/int64 module and int64 primitive type, add the binarytrees benchmark, initial support for parallel tasks (in std/os/task), improved simplification and inlining giving much improved effect operations, updated isocline for the interactive environment.
v2.2.1, 2021-09-05: improved optimization, initial parallel tasks, binary-trees benchmark, still slightly slower effect handling, upgrade isocline, fix minor bugs.
v2.2.0, 2021-08-26: improved case-of-known simpification (by Rakshika B), improve cross-module specialization (by Steven Fontanella), initial borrowing annotations and improved reuse analysis (by Anton Lorenzen), improved line editing in the interactive environment, improved inlining. Note: due to the new inline phases, effect handling may currently be a tad slower in this release but will be improved for the next release.
v2.1.9, 2021-06-23: initial support for cross-module specialization (by Steven Fontanella).
v2.1.8, 2021-06-17: initial support for macOS M1 and Linux arm64, improved readline, minor fixes.
v2.1.6, 2021-06-10: initial support for shallow resumptions, fix space leak with vectors, allow gcc with --fasan, improved vcpkg support, add --fstdalloc flag, improved VS code syntax highlighting, improved valgrind support, added --no-optimize flag for extended debug information.
v2.1.4, 2021-05-31: remove dependency on cmake, support library linking, support vckpg, updated std/text/regex, improved Windows installer with clang install included, remove dependency on Visual Studio on Windows, improved --fasan support, fixed space leak on boxed value types, use signed size_t internally, various small bug fixes.
v2.1.2, 2021-05-01: various bug fixes, allow pattern bindings in parameters of anonymous functions (by Steven Fontanella), initial Emacs syntax highlighting (by Kamoii).
v2.1.1, 2021-03-08: bug fixes, use right-associative (++) for string- and list append (instead of (+)), improved internal string handling.
v2.0.16, 2021-02-14: bug fixes, fix short-circuit evaluation of logical operations, improved utf-8 handling.
v2.0.14, 2020-12-11: bug fixes, improved var escape checking.
v2.0.12, 2020-12-02: syntax highlighting support for VS Code and Atom, improved uninstall, more samples.
v2.0.9, 2020-11-27: now with binary releases for Windows, macOS, and Linux.
v2.0.7, 2020-11-23: more small fixes, improved scoped handlers, improved higher-rank type propagation, more samples.
v2.0.5, 2020-11-15: many bug fixes and improvements. Improved codegen, named handlers, added samples, docker support, direct C compilation, local install support.
v2.0.0, 2020-08-21: initial v2 release.

References

Daniel Hillerström, and Sam Lindley. “Liberating Effects with Rows and Handlers.” In Proceedings of the 1st International Workshop on Type-Driven Development, 15--27. TyDe 2016. Nara, Japan. 2016. doi:10.1145/2976022.2976033.
Daan Leijen. “Koka: Programming with Row Polymorphic Effect Types.” In Mathematically Structured Functional Programming 2014. EPTCS. Mar. 2014. arXiv:1406.2061.
Daan Leijen. Algebraic Effects for Functional Programming. MSR-TR-2016-29. Microsoft Research. Aug. 2016. https://www.microsoft.com/en-us/research/publication/algebraic-effects-for-functional-programming. Extended version of [4].
Daan Leijen. “Type Directed Compilation of Row-Typed Algebraic Effects.” In Proceedings of Principles of Programming Languages (POPL’17). Paris, France. Jan. 2017.
Nicolas Wu, Tom Schrijvers, and Ralf Hinze. “Effect Handlers in Scope.” In Proceedings of the 2014 ACM SIGPLAN Symposium on Haskell, 1--12. Haskell ’14. ACM, New York, NY, USA. 2014. doi:10.1145/2633357.2633358
Ningning Xie, Jonathan Brachthäuser, Daniel Hillerström, Philipp Schuster, Daan Leijen. “Effect Handlers, Evidently” The 25th ACM SIGPLAN International Conference on Functional Programming (ICFP), August 2020. doi:10.1145/3408981, pdf. See also [9] which improves upon this work.
Ningning Xie and Daan Leijen. “Effect Handlers in Haskell, Evidently” The 13th ACM SIGPLAN International Haskell Symposium, August 2020. pdf See also the Ev.Eff and Mp.Eff repositories.
Alex Reinking, Ningning Xie, Leonardo de Moura, and Daan Leijen: “ Perceus: Garbage Free Reference Counting with Reuse” MSR-TR-2020-42, Nov 22, 2020. Distinguished paper at PLDI'21. pdf
Ningning Xie and Daan Leijen. “ Generalized Evidence Passing for Effect Handlers” In The 26th ACM SIGPLAN International Conference on Functional Programming (ICFP), August 2021. Also as MSR-TR-2021-5, Mar, 2021. pdf
Anton Lorenzen and Daan Leijen. “ Reference Counting with Frame-Limited Reuse” Microsoft Research technical report MSR-TR-2021-30, Nov 2021, (updated Mar 2022, v2). pdf
Anton Lorenzen, Daan Leijen, and Wouter Swierstra. “FP²: Fully in-Place Functional Programming” The 28th ACM SIGPLAN International Conference on Functional Programming (ICFP), September 2023. pdf (extended tech. report MSR-TR-2023-19, May 2023).

Name		Name	Last commit message	Last commit date
Latest commit History 5,158 Commits
doc		doc
kklib		kklib
lib		lib
samples		samples
src		src
support		support
test		test
util		util
.gitattributes		.gitattributes
.gitignore		.gitignore
.gitmodules		.gitmodules
.valgrindrc		.valgrindrc
LICENSE		LICENSE
koka.cabal		koka.cabal
package.yaml		package.yaml
readme.md		readme.md
stack.yaml		stack.yaml
whatsnew.md		whatsnew.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Koka: a Functional Language with Effects

Recent Releases

Install

Build from Source

Create an Install Bundle

Benchmarks

Tasks

Build Notes

Branches

Building on macOS M1

Building with Cabal

Building with minbuild

Windows C Compilers

Language Server

Older Release Notes

References

About

Releases 31

Packages

Contributors 34

Languages

License

koka-lang/koka

Folders and files

Latest commit

History

Repository files navigation

Koka: a Functional Language with Effects

Recent Releases

Install

Build from Source

Create an Install Bundle

Benchmarks

Tasks

Build Notes

Branches

Building on macOS M1

Building with Cabal

Building with minbuild

Windows C Compilers

Language Server

Older Release Notes

References

About

Topics

Resources

License

Stars

Watchers

Forks

Releases 31

Packages 0

Contributors 34

Languages

Packages