Adding a test to see the time resolution

[frescor/frsh-include.git] / frsh_distributed.h

diff --git a/frsh_distributed.h b/frsh_distributed.h
index 1c5e4ca0438fc58ccbc97ff85f9612011aa2c672..78f60f21195642881eb6fe632369c72e7aaf4729 100644 (file)
--- a/frsh_distributed.h
+++ b/frsh_distributed.h
@@ -1,5 +1,5 @@
 // -----------------------------------------------------------------------
-//  Copyright (C) 2006 - 2007 FRESCOR consortium partners:
+//  Copyright (C) 2006 - 2008 FRESCOR consortium partners:
 //
 //    Universidad de Cantabria,              SPAIN
 //    University of York,                    UK
@@ -31,29 +31,26 @@
 //   FSF API web pages: http://marte.unican.es/fsf/docs
 //                      http://shark.sssup.it/contrib/first/docs/
 //
-//  This file is part of FRSH API
+//   This file is part of FRSH (FRescor ScHeduler)
 //
-//  FRSH API is free software; you can  redistribute it and/or  modify
-//  it under the terms of  the GNU General Public License as published by
-//  the Free Software Foundation;  either  version 2, or (at  your option)
-//  any later version.
+//  FRSH is free software; you can redistribute it and/or modify it
+//  under terms of the GNU General Public License as published by the
+//  Free Software Foundation; either version 2, or (at your option) any
+//  later version.  FRSH is distributed in the hope that it will be
+//  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+//  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+//  General Public License for more details. You should have received a
+//  copy of the GNU General Public License along with FRSH; see file
+//  COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
+//  Cambridge, MA 02139, USA.
 //
-//  FRSH API  is distributed  in  the hope  that  it  will  be useful,  but
-//  WITHOUT  ANY  WARRANTY;     without  even the   implied   warranty  of
-//  MERCHANTABILITY  or  FITNESS FOR  A  PARTICULAR PURPOSE. See  the  GNU
-//  General Public License for more details.
-//
-//  You should have  received a  copy of  the  GNU  General Public License
-//  distributed  with  FRSH API;  see file COPYING.   If not,  write to the
-//  Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
-//  02111-1307, USA.
-//
-//  As a special exception, if you include this header file into source
-//  files to be compiled, this header file does not by itself cause
-//  the resulting executable to be covered by the GNU General Public
-//  License.  This exception does not however invalidate any other
-//  reasons why the executable file might be covered by the GNU General
-//  Public License.
+//  As a special exception, including FRSH header files in a file,
+//  instantiating FRSH generics or templates, or linking other files
+//  with FRSH objects to produce an executable application, does not
+//  by itself cause the resulting executable application to be covered
+//  by the GNU General Public License. This exception does not
+//  however invalidate any other reasons why the executable file might be
+//  covered by the GNU Public License.
 // -----------------------------------------------------------------------
 //frsh_distributed.h
 //==============================================
@@ -82,6 +79,18 @@
 
 FRSH_CPP_BEGIN_DECLS
 
+// this global variable is assigned by frsh_distributed_init()
+extern frsh_resource_id_t THE_FRSH_CPU_ID;
+
+typedef enum {
+        FRSH_NETPF_FRESCAN      = 0,
+        FRSH_NETPF_RTEP         = 1,
+        FRSH_NETPF_UNIX         = 2,
+        FRSH_NETPF_FWP          = 3,
+        FRSH_NETPF_CLUSTER_TREE = 4,
+        FRSH_NETPF_ITEM         = 5,
+} frsh_netpf_t;
+
 /**
  * @defgroup distributed Distributed module
  *
@@ -229,7 +238,7 @@ int frsh_network_get_max_message_size
 int frsh_network_bytes_to_budget
    (const frsh_resource_id_t resource_id,
     const size_t nbytes,
-    struct timespec *budget);
+    frsh_rel_time_t *budget);
 
 /**
  * frsh_network_budget_to_bytes()
@@ -253,7 +262,7 @@ int frsh_network_bytes_to_budget
  **/
 int frsh_network_budget_to_bytes
    (const frsh_resource_id_t resource_id,
-    const struct timespec *budget,
+    const frsh_rel_time_t *budget,
     size_t *nbytes);
 
 /**
@@ -286,7 +295,7 @@ int frsh_network_budget_to_bytes
  **/
 int frsh_network_get_min_effective_budget
    (const frsh_resource_id_t resource_id,
-    struct timespec *budget);
+    frsh_rel_time_t *budget);
 
 /**
  * frsh_contract_set_queueing_info()
@@ -356,12 +365,12 @@ int frsh_contract_unmarshal(frsh_contract_t      *contract,
  * @ingroup distributed
  *
  * Using the core services of FRSH, contracts may be negotiated in a
- * single step. 
+ * single step.
  *
  * An alternative two-step negotiation process is introduced in the
  * distribution module: the first step involves the reservation of the
  * resources, but without the right to use them, and the second step
- * is the commitment to use those resources.  
+ * is the commitment to use those resources.
  *
  * The rationale behind this approach is that in distributed systems,
  * when a distributed transaction is being negotiated the system
@@ -400,7 +409,7 @@ int frsh_contract_negotiate_reservation
 
 /**
  * frsh_vres_commit_reservation()
- * 
+ *
  * Commit the resources reserved for a virtual resource through a
  * frsh_contract_negotiate_reservation operation. The effects of
  * subsequent calls to frsh_contract_negotiate_reservation and
@@ -481,7 +490,6 @@ int frsh_send_endpoint_get_params
 int frsh_send_endpoint_destroy
      (frsh_send_endpoint_t  endpoint);
 
-
 /**
  * frsh_send_endpoint_bind()
  *
@@ -571,7 +579,7 @@ int frsh_send_async
  **/
 int frsh_send_sync
   (const frsh_send_endpoint_t endpoint,
-   void                       *msg,
+   const void                 *msg,
    size_t                      size);
 
 /**