{"id":18886397,"url":"https://github.com/pmem/llpl","last_synced_at":"2025-04-14T21:31:06.645Z","repository":{"id":41468672,"uuid":"135356868","full_name":"pmem/llpl","owner":"pmem","description":"Low Level Persistence Library","archived":false,"fork":false,"pushed_at":"2023-05-09T18:38:15.000Z","size":509,"stargazers_count":97,"open_issues_count":3,"forks_count":39,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-04-28T02:42:32.837Z","etag":null,"topics":["java","persistent-memory","pmdk","transactions"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pmem.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-29T21:54:56.000Z","updated_at":"2024-03-31T14:21:09.000Z","dependencies_parsed_at":"2022-07-07T14:07:46.974Z","dependency_job_id":null,"html_url":"https://github.com/pmem/llpl","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmem%2Fllpl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmem%2Fllpl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmem%2Fllpl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmem%2Fllpl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pmem","download_url":"https://codeload.github.com/pmem/llpl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223647069,"owners_count":17179206,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","persistent-memory","pmdk","transactions"],"created_at":"2024-11-08T07:27:13.632Z","updated_at":"2024-11-08T07:27:14.400Z","avatar_url":"https://github.com/pmem.png","language":"Java","readme":"# PROJECT NOT UNDER ACTIVE MANAGEMENT #  \nThis project will no longer be maintained by Intel.  \nThis project has been identified as having known security escapes.  \nIntel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.  \nIntel no longer accepts patches to this project.  \n  \n# Low-Level Persistence Library #\n\n## OVERVIEW ##\nThe Low-Level Persistence Library (LLPL) is a Java library that provides access to off-heap persistent memory.\nLLPL includes several kinds of components that can be allocated and used alone or together in building applications:\n* \u003cb\u003eheaps\u003c/b\u003e: a pool of memory and an allocator for it\n* \u003cb\u003ememory blocks\u003c/b\u003e: unstructured bytes that can be laid out for any purpose and linked to build data structures\n* \u003cb\u003epre-built data structures\u003c/b\u003e: arrays, linked list, and radix trees\n* \u003cb\u003ememory pools\u003c/b\u003e: a process-shareable pool of memory\n\nData stored in the components above can persist beyond the life of a JVM instance, i.e. across application or system restarts.\nLLPL provides APIs that help developers ensure consistency of stored data.\n\nMemory allocated using LLPL is not garbage-collected and must be explicitly deallocated using LLPL APIs.\n\nLLPL uses the Persistent Memory Development Kit (PMDK).\nFor more information on PMDK, please visit http://pmem.io and https://github.com/pmem/pmdk.\n\n## HOW TO BUILD \u0026 RUN ##\n\n### PREREQUISITES TO BUILD ###\nThe following are the prerequisites for building this Java library:\n\n1. Linux operating system\n2. Persistent Memory Development Kit (PMDK) v1.5 or newer\n3. Java 8 or newer\n4. Build tools - `g++` compiler, `CMake` and `Maven`\n\n### PREREQUISITES TO RUN ###\nThis library assumes the availability of hardware persistent memory or emulated persistent memory.\nInstructions for creating emulated persistent memory are shown below.\n\n### EMULATING PERSISTENT MEMORY ###\nThe preferred way is to create an in-memory DAX file system. This requires Linux kernel 4.2 or \ngreater. Please follow the steps at:\n\n   http://pmem.io/2016/02/22/pm-emulation.html\n\nAlternatively, for use with older kernels, create a tmpfs partition as follows (as root):\n   ```\n   $ mount -t tmpfs -o size=4G tmpfs /mnt/mem  # creates a 4GB tmpfs partition\n   $ chmod -R a+rw /mnt/mem                    # enables read/write permissions to all users\n   ```\n### STEPS TO BUILD AND RUN TESTS ###\nOnce all the prerequisites have been satisfied:\n   ```\n   $ git clone https://github.com/pmem/llpl.git\n   $ cd llpl\n   $ mvn test -Dtest.heap.path=\u003cpath to persistent memory mount point\u003e\n   ```\nAvailable Maven commands include:\n\n   - `compile` - builds sources\n   - `test` - builds and runs tests\n   - `javadoc:javadoc` - builds javadocs into ```target/site/apidocs```\n   - `package` - builds jar file into ```target``` directory\n\n### USING THIS LIBRARY IN EXISTING JAVA APPLICATIONS ###\n#### WITH MAVEN ####\nLLPL is available from the Maven central repository. Add the following dependency to your pom.xml:\n```\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.intel.pmem\u003c/groupId\u003e\n    \u003cartifactId\u003ellpl\u003c/artifactId\u003e\n    \u003cversion\u003e1.2.1-release\u003c/version\u003e\n    \u003ctype\u003ejar\u003c/type\u003e\n\u003c/dependency\u003e\n```\n\n#### WITH CLASSPATH ####  \nTo use this library in your Java application, build the LLPL jar and include \nits location in your Java classpath.  For example:\n   ```\n   $ mvn package\n   $ javac -cp .:\u003cpath\u003e/llpl/target/llpl-\u003cversion\u003e.jar \u003csource\u003e\n   $ java -cp .:\u003cpath\u003e/llpl/target/llpl-\u003cversion\u003e.jar \u003cclass\u003e\n   ```\n\nAlternatively, include LLPL's `target/classes` directory in your Java classpath and the\n`target/cppbuild` directory in your `java.library.path`.  For example:\n   ```\n   $ mvn compile\n   $ javac -cp .:\u003cpath\u003e/llpl/target/classes \u003csource\u003e\n   $ java -cp .:\u003cpath\u003e/llpl/target/classes -Djava.library.path=\u003cpath\u003e/llpl/target/cppbuild \u003cclass\u003e\n   ```\n\n## CONTRIBUTING ##\nThanks for your interest! Please see the CONTRIBUTING.md document for information on how to contribute.\n\nWe would love to hear your comments and suggestions via https://github.com/pmem/llpl/issues.\n\n## Contacts ##\nFor more information on this library, contact Olasoji Denloye (olasoji.denloye@intel.com), Matt Welch (matt.welch@intel.com), or Steve Dohrmann (steve.dohrmann@intel.com).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmem%2Fllpl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpmem%2Fllpl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmem%2Fllpl/lists"}