Summary: base: Add osaf_poll.h and osaf_time.h APIs [#580]
Review request for Trac Ticket(s): 580
Peer Reviewer(s): Ramesh
Pull request to:
Affected branch(es): default(4.4)
Development branch: default
--------------------------------
Impacted area Impact y/n
--------------------------------
Docs n
Build system n
RPM/packaging n
Configuration files n
Startup scripts n
SAF services n
OpenSAF services n
Core libraries y
Samples n
Tests n
Other n
Comments (indicate scope for each "y" above):
---------------------------------------------
changeset ec1fad7a66407a0f27893f83191af5c7b7c7c3e3
Author: Anders Widell <anders.wid...@ericsson.com>
Date: Tue, 08 Oct 2013 10:56:42 +0200
base: Add osaf_poll.h and osaf_time.h APIs [#580]
Add new utility and convenience APIs, declared in osaf_poll.h and
osaf_time.h, respectively.
osaf_poll.h contains utility functions that work in a similar way as the
Linux function poll() and ppoll(), except that they handle errors
themselves
instead of returning -1. The errno value EINTR is handled with a loop,
and
the functions keep track of time so that the time-out will happen at the
same time no matter if the functions were interrupted by a signal or
not.
Other errno values will cause the process to be aborted, since they
indicate
the presence of a software bug and the program cannot continue in a safe
way.
osaf_time.h contains utility functions for reading the time and
sleeping,
that work in a similar way as the Linux functions clock_gettime() and
nanosleep(), except that they abort the process instead of returning -1.
There are also utilty functions for manipulating "struct timespec"
times.
struct timespec is used for representing a time in many POSIX
functions, and
the reason for having a structure is that a 64-bit integer is not
sufficient
for representing the full time.
Complete diffstat:
------------------
osaf/libs/core/common/Makefile.am | 2 +
osaf/libs/core/common/include/osaf_poll.h | 97
+++++++++++++++++++++++++++++++++
osaf/libs/core/common/include/osaf_time.h | 371
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
osaf/libs/core/common/osaf_poll.c | 130
++++++++++++++++++++++++++++++++++++++++++++
osaf/libs/core/common/osaf_time.c | 52 +++++++++++++++++
5 files changed, 652 insertions(+), 0 deletions(-)
Testing Commands:
-----------------
Below is a simple test program that demonstrates the new APIs:
#include <stdio.h>
#include <signal.h>
#include <unistd.h>
#include <assert.h>
#include "osaf_poll.h"
#include "osaf_time.h"
void signal_handler(int sig) {
printf("SIGALRM signal caught\n");
}
int main(void) {
struct timespec start;
struct timespec stop;
struct timespec elapsed;
int fds[2];
struct pollfd set;
pipe(fds);
signal(SIGALRM, signal_handler);
alarm(1);
osaf_clock_gettime(CLOCK_MONOTONIC, &start);
set.fd = fds[0];
set.events = POLLIN;
int result = osaf_poll(&set, 1, 1234);
osaf_clock_gettime(CLOCK_MONOTONIC, &stop);
osaf_timespec_subtract(&stop, &start, &elapsed);
double duration = osaf_timespec_to_double(&elapsed);
printf("poll result: %d\n", result);
printf("poll duration: %f s\n", duration);
assert(result == 0);
assert(duration >= 1.23);
return 0;
}
Testing, Expected Results:
--------------------------
Test program should print the following:
SIGALRM signal caught
poll result: 0
poll duration: 1.234440 s
Conditions of Submission:
-------------------------
Ack from reviewer
Arch Built Started Linux distro
-------------------------------------------
mips n n
mips64 n n
x86 n n
x86_64 y y
powerpc n n
powerpc64 n n
Reviewer Checklist:
-------------------
[Submitters: make sure that your review doesn't trigger any checkmarks!]
Your checkin has not passed review because (see checked entries):
___ Your RR template is generally incomplete; it has too many blank entries
that need proper data filled in.
___ You have failed to nominate the proper persons for review and push.
___ Your patches do not have proper short+long header
___ You have grammar/spelling in your header that is unacceptable.
___ You have exceeded a sensible line length in your headers/comments/text.
___ You have failed to put in a proper Trac Ticket # into your commits.
___ You have incorrectly put/left internal data in your comments/files
(i.e. internal bug tracking tool IDs, product names etc)
___ You have not given any evidence of testing beyond basic build tests.
Demonstrate some level of runtime or other sanity testing.
___ You have ^M present in some of your files. These have to be removed.
___ You have needlessly changed whitespace or added whitespace crimes
like trailing spaces, or spaces before tabs.
___ You have mixed real technical changes with whitespace and other
cosmetic code cleanup changes. These have to be separate commits.
___ You need to refactor your submission into logical chunks; there is
too much content into a single commit.
___ You have extraneous garbage in your review (merge commits etc)
___ You have giant attachments which should never have been sent;
Instead you should place your content in a public tree to be pulled.
___ You have too many commits attached to an e-mail; resend as threaded
commits, or place in a public tree for a pull.
___ You have resent this content multiple times without a clear indication
of what has changed between each re-send.
___ You have failed to adequately and individually address all of the
comments and change requests that were proposed in the initial review.
___ You have a misconfigured ~/.hgrc file (i.e. username, email etc)
___ Your computer have a badly configured date and time; confusing the
the threaded patch review.
___ Your changes affect IPC mechanism, and you don't present any results
for in-service upgradability test.
___ Your changes affect user manual and documentation, your patch series
do not contain the patch that updates the Doxygen manual.
------------------------------------------------------------------------------
October Webinars: Code for Performance
Free Intel webinars can help you accelerate application performance.
Explore tips for MPI, OpenMP, advanced profiling, and more. Get the most from
the latest Intel processors and coprocessors. See abstracts and register >
http://pubads.g.doubleclick.net/gampad/clk?id=60134071&iu=/4140/ostg.clktrk
_______________________________________________
Opensaf-devel mailing list
Opensaf-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/opensaf-devel
