[C-MPI-commits] SF.net SVN: c-mpi:[56] docs
Status: Pre-Alpha
Brought to you by:
jmwozniak
Menu
▾
▴
[C-MPI-commits] SF.net SVN: c-mpi:[56] docs
|
From: <jmw...@us...> - 2010-04-29 19:24:27
|
Revision: 56
http://c-mpi.svn.sourceforge.net/c-mpi/?rev=56&view=rev
Author: jmwozniak
Date: 2010-04-29 19:24:21 +0000 (Thu, 29 Apr 2010)
Log Message:
-----------
Rename docbook -> manual.
Added Paths:
-----------
docs/manual/
docs/manual/Makefile
docs/manual/formatting/
docs/manual/manual.xml
docs/manual/sf-post.zsh
Removed Paths:
-------------
docs/docbook/
docs/manual/Makefile
docs/manual/formatting/
docs/manual/manual.xml
docs/manual/sf-post.zsh
Property changes on: docs/manual
___________________________________________________________________
Added: svn:ignore
+ fop
manual.html
index.html
Added: svn:mergeinfo
+
Deleted: docs/manual/Makefile
===================================================================
--- docs/docbook/Makefile 2010-04-29 19:22:00 UTC (rev 55)
+++ docs/manual/Makefile 2010-04-29 19:24:21 UTC (rev 56)
@@ -1,23 +0,0 @@
-#!/bin/sh
-
-all: htmls
-# phps pdfs
-
-# phps: userguide.php
-
-htmls: manual.html
-
-# pdfs: userguide.pdf
-
-# chunked-userguide: userguide.xml
-# ./build-chunked-userguide.sh
-
-%.php: %.xml formatting/swiftsh_html.xsl
- xsltproc --nonet formatting/swiftsh_html.xsl $<
- sed -e "s/index.html#/#/g" index.html >$@
-
-#%.pdf: %.xml formatting/vdl2_fo.xsl
-# fop/fop -xsl formatting/vdl2_fo.xsl -xml $< -pdf $@
-
-%.html: %.php
- cp $< $@
Copied: docs/manual/Makefile (from rev 52, docs/docbook/Makefile)
===================================================================
--- docs/manual/Makefile (rev 0)
+++ docs/manual/Makefile 2010-04-29 19:24:21 UTC (rev 56)
@@ -0,0 +1,23 @@
+#!/bin/sh
+
+all: htmls
+# phps pdfs
+
+# phps: userguide.php
+
+htmls: manual.html
+
+# pdfs: userguide.pdf
+
+# chunked-userguide: userguide.xml
+# ./build-chunked-userguide.sh
+
+%.php: %.xml formatting/swiftsh_html.xsl
+ xsltproc --nonet formatting/swiftsh_html.xsl $<
+ sed -e "s/index.html#/#/g" index.html >$@
+
+#%.pdf: %.xml formatting/vdl2_fo.xsl
+# fop/fop -xsl formatting/vdl2_fo.xsl -xml $< -pdf $@
+
+%.html: %.php
+ cp $< $@
Deleted: docs/manual/manual.xml
===================================================================
--- docs/docbook/manual.xml 2010-04-29 19:22:00 UTC (rev 55)
+++ docs/manual/manual.xml 2010-04-29 19:24:21 UTC (rev 56)
@@ -1,371 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [] >
-
-<article>
- <articleinfo revision="0.1">
- <title>C-MPI User Guide</title>
- <subtitle>Content-MPI</subtitle>
- </articleinfo>
-
- <section id="overview">
- <title>Overview</title>
- <para>
- This manual provides reference material for the Content-MPI
- (C-MPI) DHT.
- </para>
- <para>
- C-MPI provides a key/value store for distributed computing
- over MPI.
- </para>
- </section>
-
- <section id="usecases">
- <title>Use Cases</title>
- <section><title>MPI Library</title>
- <para>
- C-MPI can be used as an MPI library:
- </para>
-
- <programlisting> <![CDATA[
-
- #include <cmpi.h>
-
- int main(int argc, char* argv[])
- {
- int mpi_rank;
- int mpi_size;
- char key[10];
- char value[30];
- int length;
- char* result;
-
- MPI_Init(&argc, &argv);
- MPI_Comm_rank(MPI_COMM_WORLD, &rank);
- MPI_Comm_size(MPI_COMM_WORLD, &size);
-
- cmpi_init();
-
- sprintf(key, "key_%i", mpi_rank);
- sprintf(value, "value_%i", mpi_rank);
- cmpi_put(key, value, strlen(value)+1);
-
- rank = (mpi_rank+1)%mpi_size;
- sprintf(key, "key_%i", rank);
- cmpi_get(key, &result, &length);
- printf("result(%i): %s\n", length, result);
-
- MPI_Finalize();
-
- cmpi_cleanup();
- }
- ]]>
- </programlisting>
- </section>
- </section>
-
- <section id="mpirpc">
- <title>MPI-RPC</title>
-
- <section><title>Overview</title>
- <para>
- The MPIRPC component is used to allow the user to
- issue multiple asynchronous requests in one thread
- from a higher-level, RPC, event-driven model.
- </para>
- </section>
-
- <section><title>Definitions</title>
- <para>
- <variablelist>
- <varlistentry>
- <term>MPIRPC object</term>
- <listitem><para>Created by an MPIRPC call.
- Can be waited on.
- On call completion, this is passed to the proceed-function.
- Contains the result of the call on completion.
- Must be freed by the user with MPIRPC_Free().
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>proceed-function</term>
- <listitem><para>A user function pointer passed
- into an MPIRPC call.
- Called by MPIRPC on call completion with the MPIRPC object.
- </para></listitem>
- </varlistentry>
- </variablelist>
- </para>
- </section>
-
- <section><title>MPIRPC_Call</title>
- <para>
- MPIRPC_Call() creates an MPIRPC object and starts performing
- the RPC asynchronously. The MPIRPC object will contain the results
- of the call when complete.
-
- The arguments are:
-
- <variablelist>
- <varlistentry>
- <term>MPIRPC_Node target</term>
- <listitem><para>
- The target MPIRPC_Node.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>char* name</term>
- <listitem><para>
- Remote function name
- Copied into the MPIRPC object.
- Limited to MPIRPC_MAX_NAME (128) characters.
- May not be NULL.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>char* args</term>
- <listitem><para>
- Short NULL-terminated string for user
- control data arguments.
- Copied into the MPIRPC object.
- Limited to MPIRPC_MAX_ARGS (256) characters.
- May be NULL.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>void* extras</term>
- <listitem><para>
- Extra user state accessible by the proceed-function.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>void (*proceed)(MPIRPC*)</term>
- <listitem><para>
- The proceed-function.
- </para></listitem>
- </varlistentry>
- </variablelist>
- </para>
- </section>
-
- <section><title>The MPIRPC Object</title>
- <para>
- The MPIRPC object contains:
- <variablelist>
- <varlistentry>
- <term>MPIRPC_Node target</term>
- <listitem><para>
- The target MPIRPC_Node
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>status</term>
- <listitem><para>
- The status of the call:
- MPIRPC_STATUS_PROTO, MPIRPC_STATUS_CALLED,
- or MPIRPC_STATUS_RETURNED.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>char[] name</term>
- <listitem><para>
- Copy of the remote procedure name.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>char[] args</term>
- <listitem><para>
- Copy of the user argument string.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>char* blob</term>
- <listitem><para>
- Pointer to the user data blob.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>int blob_length</term>
- <listitem><para>
- Length of the user data blob.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>void* result</term>
- <listitem><para>
- Pointer to result data returned by remote procedure
- in fresh storage.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>int result_length</term>
- <listitem><para>
- Length of result data.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>void* extras</term>
- <listitem><para>
- Extra user pointer useful for proceed-function.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>int unique</term>
- <listitem><para>
- Internal uniquifier.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>bool cancelled</term>
- <listitem><para>
- Not yet used.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>MPIRPC_Node target</term>
- <listitem><para>
- The target MPIRPC_Node
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>MPI_Request request[]</term>
- <listitem><para>
- Internal MPI objects.
- Released by MPIRPC_Free().
- </para></listitem>
- </varlistentry>
- </variablelist>
- </para>
- </section>
- </section>
-
- <section id="cmpi">
- <title>C-MPI</title>
-
- <section><title>Overview</title>
- <para>
- C-MPI is intended to be an easy to use MPI-based
- distributed key/value store.
- </para>
- </section>
-
- <section><title>API</title>
- <para>
- The C-MPI API:
-
- <variablelist>
- <varlistentry>
- <term>cmpi_init()</term>
- <listitem><para>
- Initialize C-MPI.
- The user must first call MPI_Init() and MPIRPC_Init().
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>cmpi_put()</term>
- <listitem><para>
- Post a key/value pair in C-MPI.
- </para>
- <para>
- Arguments:
- <variablelist>
- <varlistentry>
- <term>char* key</term>
- <listitem><para>
- NULL-terminated string key.
- Passed as the args argument to MPIRPC_Call_blob().
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>void* value</term>
- <listitem><para>
- Variable-length user data.
- Passed as the blob argument to MPIRPC_Call_blob().
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>int length</term>
- <listitem><para>
- Byte-length of value.
- </para></listitem>
- </varlistentry>
- </variablelist>
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>cmpi_update()</term>
- <listitem><para>
- Update the value of a key/value pair in C-MPI.
- </para>
- <para>
- Arguments:
- <variablelist>
- <varlistentry>
- <term>char* key</term>
- <listitem><para>
- NULL-terminated string key.
- Passed as the args argument to MPIRPC_Call_blob().
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>void* value</term>
- <listitem><para>
- Variable-length user data.
- Passed as the blob argument to MPIRPC_Call_blob().
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>int length</term>
- <listitem><para>
- Byte-length of value.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>int offset</term>
- <listitem><para>
- At which point to begin overwrite.
- Offset+length may exceed the original value length.
- The key/value pair need not originally exist,
- but if it does not, the offset must be 0.
- </para></listitem>
- </varlistentry>
- </variablelist>
- </para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term>cmpi_get()</term>
- <listitem><para>
- Extract the value of a key/value pair into fresh storage.
- </para>
- <para>
- Arguments:
- <variablelist>
- <varlistentry>
- <term>char* key</term>
- <listitem><para>
- NULL-terminated string key.
- Passed as the args argument to MPIRPC_Call_blob().
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>void** result</term>
- <listitem><para>
- Will be set to the location of the extracted data in
- fresh storage.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>int* length</term>
- <listitem><para>
- Will be set to the length of the extracted data.
- </para></listitem>
- </varlistentry>
- </variablelist>
- </para></listitem>
- </varlistentry>
- </variablelist>
- </para>
- </section>
- </section>
-</article>
Copied: docs/manual/manual.xml (from rev 52, docs/docbook/manual.xml)
===================================================================
--- docs/manual/manual.xml (rev 0)
+++ docs/manual/manual.xml 2010-04-29 19:24:21 UTC (rev 56)
@@ -0,0 +1,371 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [] >
+
+<article>
+ <articleinfo revision="0.1">
+ <title>C-MPI User Guide</title>
+ <subtitle>Content-MPI</subtitle>
+ </articleinfo>
+
+ <section id="overview">
+ <title>Overview</title>
+ <para>
+ This manual provides reference material for the Content-MPI
+ (C-MPI) DHT.
+ </para>
+ <para>
+ C-MPI provides a key/value store for distributed computing
+ over MPI.
+ </para>
+ </section>
+
+ <section id="usecases">
+ <title>Use Cases</title>
+ <section><title>MPI Library</title>
+ <para>
+ C-MPI can be used as an MPI library:
+ </para>
+
+ <programlisting> <![CDATA[
+
+ #include <cmpi.h>
+
+ int main(int argc, char* argv[])
+ {
+ int mpi_rank;
+ int mpi_size;
+ char key[10];
+ char value[30];
+ int length;
+ char* result;
+
+ MPI_Init(&argc, &argv);
+ MPI_Comm_rank(MPI_COMM_WORLD, &rank);
+ MPI_Comm_size(MPI_COMM_WORLD, &size);
+
+ cmpi_init();
+
+ sprintf(key, "key_%i", mpi_rank);
+ sprintf(value, "value_%i", mpi_rank);
+ cmpi_put(key, value, strlen(value)+1);
+
+ rank = (mpi_rank+1)%mpi_size;
+ sprintf(key, "key_%i", rank);
+ cmpi_get(key, &result, &length);
+ printf("result(%i): %s\n", length, result);
+
+ MPI_Finalize();
+
+ cmpi_cleanup();
+ }
+ ]]>
+ </programlisting>
+ </section>
+ </section>
+
+ <section id="mpirpc">
+ <title>MPI-RPC</title>
+
+ <section><title>Overview</title>
+ <para>
+ The MPIRPC component is used to allow the user to
+ issue multiple asynchronous requests in one thread
+ from a higher-level, RPC, event-driven model.
+ </para>
+ </section>
+
+ <section><title>Definitions</title>
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>MPIRPC object</term>
+ <listitem><para>Created by an MPIRPC call.
+ Can be waited on.
+ On call completion, this is passed to the proceed-function.
+ Contains the result of the call on completion.
+ Must be freed by the user with MPIRPC_Free().
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>proceed-function</term>
+ <listitem><para>A user function pointer passed
+ into an MPIRPC call.
+ Called by MPIRPC on call completion with the MPIRPC object.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
+
+ <section><title>MPIRPC_Call</title>
+ <para>
+ MPIRPC_Call() creates an MPIRPC object and starts performing
+ the RPC asynchronously. The MPIRPC object will contain the results
+ of the call when complete.
+
+ The arguments are:
+
+ <variablelist>
+ <varlistentry>
+ <term>MPIRPC_Node target</term>
+ <listitem><para>
+ The target MPIRPC_Node.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>char* name</term>
+ <listitem><para>
+ Remote function name
+ Copied into the MPIRPC object.
+ Limited to MPIRPC_MAX_NAME (128) characters.
+ May not be NULL.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>char* args</term>
+ <listitem><para>
+ Short NULL-terminated string for user
+ control data arguments.
+ Copied into the MPIRPC object.
+ Limited to MPIRPC_MAX_ARGS (256) characters.
+ May be NULL.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>void* extras</term>
+ <listitem><para>
+ Extra user state accessible by the proceed-function.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>void (*proceed)(MPIRPC*)</term>
+ <listitem><para>
+ The proceed-function.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
+
+ <section><title>The MPIRPC Object</title>
+ <para>
+ The MPIRPC object contains:
+ <variablelist>
+ <varlistentry>
+ <term>MPIRPC_Node target</term>
+ <listitem><para>
+ The target MPIRPC_Node
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>status</term>
+ <listitem><para>
+ The status of the call:
+ MPIRPC_STATUS_PROTO, MPIRPC_STATUS_CALLED,
+ or MPIRPC_STATUS_RETURNED.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>char[] name</term>
+ <listitem><para>
+ Copy of the remote procedure name.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>char[] args</term>
+ <listitem><para>
+ Copy of the user argument string.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>char* blob</term>
+ <listitem><para>
+ Pointer to the user data blob.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int blob_length</term>
+ <listitem><para>
+ Length of the user data blob.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>void* result</term>
+ <listitem><para>
+ Pointer to result data returned by remote procedure
+ in fresh storage.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int result_length</term>
+ <listitem><para>
+ Length of result data.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>void* extras</term>
+ <listitem><para>
+ Extra user pointer useful for proceed-function.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int unique</term>
+ <listitem><para>
+ Internal uniquifier.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>bool cancelled</term>
+ <listitem><para>
+ Not yet used.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>MPIRPC_Node target</term>
+ <listitem><para>
+ The target MPIRPC_Node
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>MPI_Request request[]</term>
+ <listitem><para>
+ Internal MPI objects.
+ Released by MPIRPC_Free().
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
+ </section>
+
+ <section id="cmpi">
+ <title>C-MPI</title>
+
+ <section><title>Overview</title>
+ <para>
+ C-MPI is intended to be an easy to use MPI-based
+ distributed key/value store.
+ </para>
+ </section>
+
+ <section><title>API</title>
+ <para>
+ The C-MPI API:
+
+ <variablelist>
+ <varlistentry>
+ <term>cmpi_init()</term>
+ <listitem><para>
+ Initialize C-MPI.
+ The user must first call MPI_Init() and MPIRPC_Init().
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>cmpi_put()</term>
+ <listitem><para>
+ Post a key/value pair in C-MPI.
+ </para>
+ <para>
+ Arguments:
+ <variablelist>
+ <varlistentry>
+ <term>char* key</term>
+ <listitem><para>
+ NULL-terminated string key.
+ Passed as the args argument to MPIRPC_Call_blob().
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>void* value</term>
+ <listitem><para>
+ Variable-length user data.
+ Passed as the blob argument to MPIRPC_Call_blob().
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int length</term>
+ <listitem><para>
+ Byte-length of value.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>cmpi_update()</term>
+ <listitem><para>
+ Update the value of a key/value pair in C-MPI.
+ </para>
+ <para>
+ Arguments:
+ <variablelist>
+ <varlistentry>
+ <term>char* key</term>
+ <listitem><para>
+ NULL-terminated string key.
+ Passed as the args argument to MPIRPC_Call_blob().
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>void* value</term>
+ <listitem><para>
+ Variable-length user data.
+ Passed as the blob argument to MPIRPC_Call_blob().
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int length</term>
+ <listitem><para>
+ Byte-length of value.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int offset</term>
+ <listitem><para>
+ At which point to begin overwrite.
+ Offset+length may exceed the original value length.
+ The key/value pair need not originally exist,
+ but if it does not, the offset must be 0.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>cmpi_get()</term>
+ <listitem><para>
+ Extract the value of a key/value pair into fresh storage.
+ </para>
+ <para>
+ Arguments:
+ <variablelist>
+ <varlistentry>
+ <term>char* key</term>
+ <listitem><para>
+ NULL-terminated string key.
+ Passed as the args argument to MPIRPC_Call_blob().
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>void** result</term>
+ <listitem><para>
+ Will be set to the location of the extracted data in
+ fresh storage.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>int* length</term>
+ <listitem><para>
+ Will be set to the length of the extracted data.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
+ </section>
+</article>
Deleted: docs/manual/sf-post.zsh
===================================================================
--- docs/docbook/sf-post.zsh 2010-04-29 19:22:00 UTC (rev 55)
+++ docs/manual/sf-post.zsh 2010-04-29 19:24:21 UTC (rev 56)
@@ -1,8 +0,0 @@
-#!/bin/zsh
-
-# Post HTML to SourceForge
-
-USER=$1
-
-HTML=( index.html manual.html )
-scp ${HTML} ${USER},c-...@we...:htdocs
Copied: docs/manual/sf-post.zsh (from rev 52, docs/docbook/sf-post.zsh)
===================================================================
--- docs/manual/sf-post.zsh (rev 0)
+++ docs/manual/sf-post.zsh 2010-04-29 19:24:21 UTC (rev 56)
@@ -0,0 +1,8 @@
+#!/bin/zsh
+
+# Post HTML to SourceForge
+
+USER=$1
+
+HTML=( index.html manual.html )
+scp ${HTML} ${USER},c-...@we...:htdocs
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
