Permalink
Browse files

Omid project

  • Loading branch information...
0 parents commit 2e435f54c714e3b610110f24a73de857ba0f30e0 @dgomezferro dgomezferro committed Nov 2, 2011
Showing with 10,326 additions and 0 deletions.
  1. +202 −0 LICENSE.txt
  2. +9 −0 NOTICE.txt
  3. +78 −0 README
  4. +96 −0 README.md
  5. +97 −0 bin/omid.sh
  6. +25 −0 conf/hbase-site.xml
  7. +132 −0 pom.xml
  8. +21 −0 src/main/java/com/yahoo/omid/client/AbortCompleteCallback.java
  9. +21 −0 src/main/java/com/yahoo/omid/client/Callback.java
  10. +24 −0 src/main/java/com/yahoo/omid/client/CommitCallback.java
  11. +21 −0 src/main/java/com/yahoo/omid/client/CommitQueryCallback.java
  12. +21 −0 src/main/java/com/yahoo/omid/client/CommitUnsuccessfulException.java
  13. +22 −0 src/main/java/com/yahoo/omid/client/CreateCallback.java
  14. +18 −0 src/main/java/com/yahoo/omid/client/CreateCallbackImpl.java
  15. +57 −0 src/main/java/com/yahoo/omid/client/RowKeyFamily.java
  16. +26 −0 src/main/java/com/yahoo/omid/client/SyncAbortCompleteCallback.java
  17. +43 −0 src/main/java/com/yahoo/omid/client/SyncCallbackBase.java
  18. +40 −0 src/main/java/com/yahoo/omid/client/SyncCommitCallback.java
  19. +32 −0 src/main/java/com/yahoo/omid/client/SyncCommitQueryCallback.java
  20. +34 −0 src/main/java/com/yahoo/omid/client/SyncCreateCallback.java
  21. +569 −0 src/main/java/com/yahoo/omid/client/TSOClient.java
  22. +30 −0 src/main/java/com/yahoo/omid/client/TransactionException.java
  23. +149 −0 src/main/java/com/yahoo/omid/client/TransactionManager.java
  24. +65 −0 src/main/java/com/yahoo/omid/client/TransactionState.java
  25. +469 −0 src/main/java/com/yahoo/omid/client/TransactionalTable.java
  26. +120 −0 src/main/java/com/yahoo/omid/tso/BandwidthMeterHandler.java
  27. +88 −0 src/main/java/com/yahoo/omid/tso/Bucket.java
  28. +41 −0 src/main/java/com/yahoo/omid/tso/BufferPool.java
  29. +420 −0 src/main/java/com/yahoo/omid/tso/ClientHandler.java
  30. +243 −0 src/main/java/com/yahoo/omid/tso/CommitHashMap.java
  31. +91 −0 src/main/java/com/yahoo/omid/tso/Committed.java
  32. +67 −0 src/main/java/com/yahoo/omid/tso/RowId.java
  33. +112 −0 src/main/java/com/yahoo/omid/tso/RowKey.java
  34. +61 −0 src/main/java/com/yahoo/omid/tso/TSOBuffer.java
  35. +456 −0 src/main/java/com/yahoo/omid/tso/TSOHandler.java
  36. +69 −0 src/main/java/com/yahoo/omid/tso/TSOMessage.java
  37. +180 −0 src/main/java/com/yahoo/omid/tso/TSOMessageBuffer.java
  38. +89 −0 src/main/java/com/yahoo/omid/tso/TSOPipelineFactory.java
  39. +212 −0 src/main/java/com/yahoo/omid/tso/TSOServer.java
  40. +453 −0 src/main/java/com/yahoo/omid/tso/TSOSharedMessageBuffer.java
  41. +114 −0 src/main/java/com/yahoo/omid/tso/TSOState.java
  42. +227 −0 src/main/java/com/yahoo/omid/tso/ThroughputMonitor.java
  43. +91 −0 src/main/java/com/yahoo/omid/tso/Timestamp.java
  44. +159 −0 src/main/java/com/yahoo/omid/tso/TimestampOracle.java
  45. +139 −0 src/main/java/com/yahoo/omid/tso/TransactionClient.java
  46. +94 −0 src/main/java/com/yahoo/omid/tso/Uncommited.java
  47. +69 −0 src/main/java/com/yahoo/omid/tso/messages/AbortedTransactionReport.java
  48. +66 −0 src/main/java/com/yahoo/omid/tso/messages/CommitQueryRequest.java
  49. +84 −0 src/main/java/com/yahoo/omid/tso/messages/CommitQueryResponse.java
  50. +103 −0 src/main/java/com/yahoo/omid/tso/messages/CommitRequest.java
  51. +94 −0 src/main/java/com/yahoo/omid/tso/messages/CommitResponse.java
  52. +138 −0 src/main/java/com/yahoo/omid/tso/messages/CommittedTransactionReport.java
  53. +77 −0 src/main/java/com/yahoo/omid/tso/messages/FullAbortReport.java
  54. +69 −0 src/main/java/com/yahoo/omid/tso/messages/LargestDeletedTimestampReport.java
  55. +47 −0 src/main/java/com/yahoo/omid/tso/messages/TimestampRequest.java
  56. +75 −0 src/main/java/com/yahoo/omid/tso/messages/TimestampResponse.java
  57. +234 −0 src/main/java/com/yahoo/omid/tso/serialization/TSODecoder.java
  58. +80 −0 src/main/java/com/yahoo/omid/tso/serialization/TSOEncoder.java
  59. +55 −0 src/main/native/Makefile
  60. +339 −0 src/main/native/nativelib.cc
  61. +75 −0 src/main/resources/log4j.properties
  62. +213 −0 src/test/java/com/yahoo/omid/OmidTestBase.java
  63. +414 −0 src/test/java/com/yahoo/omid/TestBasicTransaction.java
  64. +128 −0 src/test/java/com/yahoo/omid/TestMultiplePut.java
  65. +107 −0 src/test/java/com/yahoo/omid/TestNonexistentRow.java
  66. +142 −0 src/test/java/com/yahoo/omid/TestSingleColumnFamily.java
  67. +50 −0 src/test/java/com/yahoo/omid/TestTable.java
  68. +249 −0 src/test/java/com/yahoo/omid/TestTransactionConflict.java
  69. +245 −0 src/test/java/com/yahoo/omid/TestUpdateScan.java
  70. +257 −0 src/test/java/com/yahoo/omid/tso/TSOTestBase.java
  71. +100 −0 src/test/java/com/yahoo/omid/tso/TestBasicTransaction.java
  72. +281 −0 src/test/java/com/yahoo/omid/tso/TestClientHandler.java
  73. +44 −0 src/test/java/com/yahoo/omid/tso/TestCommit.java
  74. +108 −0 src/test/java/com/yahoo/omid/tso/TestCommitAbortedReport.java
  75. +113 −0 src/test/java/com/yahoo/omid/tso/TestCommitQuery.java
  76. +78 −0 src/test/java/com/yahoo/omid/tso/TestCommitReport.java
  77. +54 −0 src/test/java/com/yahoo/omid/tso/TestConflict.java
  78. +72 −0 src/test/java/com/yahoo/omid/tso/TestMultipleCommitsWithoutConflict.java
  79. +70 −0 src/test/java/com/yahoo/omid/tso/TestReadAlgorithm.java
  80. +40 −0 src/test/java/com/yahoo/omid/tso/TestTimestamps.java
  81. +72 −0 src/test/java/com/yahoo/omid/tso/TestTimestampsOrdering.java
  82. +57 −0 src/test/resources/log4j.properties
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
@@ -0,0 +1,9 @@
+=======================================================================
+NOTICE file for use with, and corresponding to Section 4 of,
+the Apache License, Version 2.0,
+in this case for the CrTSO project. ==
+=========================================================================
+
+ This product includes software developed by
+ Yahoo! Inc. (www.yahoo.com)
+ Copyright (c) 2010 Yahoo! Inc. All rights reserved.
@@ -0,0 +1,78 @@
+* Dependencies
+ - Netty
+ - log4j
+ - ZooKeeper
+ - HBase
+
+* Compilation
+
+Omid uses Maven for its build system. The versions
+of zookeeper and bookkeeper are missing from mvn, so you have to
+manually install these dependencies.
+
+To install zookeeper:
+ $ mvn install:install-file -DgroupId=org.apache.zookeeper -DartifactId=zookeeper -Dversion=3.4.0 -Dpackaging=jar -Dfile=zookeeper-3.4.0.jar
+
+To install bookkeeper:
+ $ mvn install:install-file -DgroupId=org.apache.zookeeper -DartifactId=bookkeeper -Dversion=3.4.0 -Dpackaging=jar -Dfile=bookkeeper-3.4.0.jar
+
+Then to compile omid:
+ $ tar jxvf omid-1.0-SNAPSHOT.tar.bz2
+ $ cd omid-1.0-SNAPSHOT
+ $ mvn install
+
+Tests should run cleanly.
+
+* Running
+
+You need to run four components before running the transactional
+client. They are bookkeeper, zookeeper, omid tso and
+hbase. Bookkeeper is needed by the TSO. Zookeeper is needed by
+bookkeeper and hbase. The TSO is needed by hbase. Hence, the order of
+starting should be:
+ 1. Zookeeper
+ 2. Bookkeeper
+ 3. TSO
+ 4. Hbase
+
+** Zookeeper & Bookkeeper
+For simplicity we've included a utility script which starts zookeeper
+and bookkeeper. Run:
+
+ $ bin/omid.sh bktest
+
+Omid doesn't use anything special in zookeeper or bookkeeper, so you
+can use any install for these. However, if you are running this
+anywhere but localhost, you need to update the setting for hbase and
+TSO. See the hbase docs for changing the zookeeper quorum. For TSO,
+you need to modify bin/omid.sh.
+
+** TSO
+To start the TSO, run:
+
+ $ bin/omid.sh tso
+
+** Benchmark
+To benchmark the TSO alone, run:
+
+ $ bin/omid.sh tsobench
+
+** HBase
+We've included a utility script to start a HBase cluster on your local
+machine. Run:
+
+ $ bin/omid.sh tran-hbase
+
+For running in a cluster
+
+* API
+The public api is in
+ src/main/java/com/yahoo/omid/client/TransactionalTable.java
+ src/main/java/com/yahoo/omid/client/TransactionState.java
+ src/main/java/com/yahoo/omid/client/TransactionManager.java
+
+For an example of usage, look in
+ src/test/java/com/yahoo/omid/TestBasicTransaction.java
+
+* Logging
+Logging can be adjusted in src/main/resource/log4j.properties.
@@ -0,0 +1,96 @@
+Omid
+=====
+
+This project provides transactional support for HBase (or any other key-value store) using Snapshot Isolation.
+
+Architecture
+------------
+
+Omid is composed by a server (the Status Oracle) and several clients. The server contains all the information
+needed to manage transactions and replicates it to the clients which just contact the server when they want
+to start a transaction or commit it.
+
+The server uses BookKeeper as a Writer Ahead Log where it dumps all its state. In case of crash it is possible
+to restart the server without losing any commit information.
+
+Compilation
+-----------
+
+Omid uses Maven for its build system. The versions of zookeeper and bookkeeper are missing from mvn, so you have to
+manually install these dependencies.
+
+To install zookeeper:
+
+ $ mvn install:install-file -DgroupId=org.apache.zookeeper -DartifactId=zookeeper -Dversion=3.4.0 -Dpackaging=jar -Dfile=zookeeper-3.4.0.jar
+
+To install bookkeeper:
+
+ $ mvn install:install-file -DgroupId=org.apache.zookeeper -DartifactId=bookkeeper -Dversion=3.4.0 -Dpackaging=jar -Dfile=bookkeeper-3.4.0.jar
+
+Then to compile omid:
+
+ $ tar jxvf omid-1.0-SNAPSHOT.tar.bz2
+ $ cd omid-1.0-SNAPSHOT
+ $ mvn install
+
+Tests should run cleanly.
+
+Running
+-------
+
+You need to run four components before running the transactional
+client. They are bookkeeper, zookeeper, omid tso and
+hbase. Bookkeeper is needed by the TSO. Zookeeper is needed by
+bookkeeper and hbase. The TSO is needed by hbase. Hence, the order of
+starting should be:
+ 1. Zookeeper
+ 2. Bookkeeper
+ 3. TSO
+ 4. Hbase
+
+### Zookeeper & Bookkeeper
+For simplicity we've included a utility script which starts zookeeper
+and bookkeeper. Run:
+
+ $ bin/omid.sh bktest
+
+Omid doesn't use anything special in zookeeper or bookkeeper, so you
+can use any install for these. However, if you are running this
+anywhere but localhost, you need to update the setting for hbase and
+TSO. See the hbase docs for changing the zookeeper quorum. For TSO,
+you need to modify bin/omid.sh.
+
+### TSO
+To start the TSO, run:
+
+ $ bin/omid.sh tso
+
+### Benchmark
+To benchmark the TSO alone, run:
+
+ $ bin/omid.sh tsobench
+
+### HBase
+We've included a utility script to start a HBase cluster on your local
+machine. Run:
+
+ $ bin/omid.sh tran-hbase
+
+For running in a cluster
+
+API
+---
+
+The public api is in
+
+ src/main/java/com/yahoo/omid/client/TransactionalTable.java
+ src/main/java/com/yahoo/omid/client/TransactionState.java
+ src/main/java/com/yahoo/omid/client/TransactionManager.java
+
+For an example of usage, look in
+
+ src/test/java/com/yahoo/omid/TestBasicTransaction.java
+
+Logging
+-------
+Logging can be adjusted in src/main/resource/log4j.properties.
Oops, something went wrong.

0 comments on commit 2e435f5

Please sign in to comment.