Version 1.1 Update
[ctprof_srv/ctprof_srv.git] / example_app / ctprof_utility.c
1 /*
2  * ctprof_utility.c
3  *
4  * Ctools Profiler Utility Implementation
5  *
6  * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com/ 
7  * 
8  * 
9  *  Redistribution and use in source and binary forms, with or without 
10  *  modification, are permitted provided that the following conditions 
11  *  are met:
12  *
13  *    Redistributions of source code must retain the above copyright 
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  *    Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the 
18  *    documentation and/or other materials provided with the   
19  *    distribution.
20  *
21  *    Neither the name of Texas Instruments Incorporated nor the names of
22  *    its contributors may be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
26  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
27  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
29  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
30  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
31  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
34  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
35  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  *
37 */
39 #include <stdio.h>
40 #include <stdlib.h>
41 #include <string.h>
42 #include <stdbool.h>
43 #include <unistd.h>
44 #include <fcntl.h>
45 #include <signal.h>
46 #include <errno.h>
47 #include "ctprof_utility.h"
49 static char * fifo_filename = "ctprof_fifo";
50 //static FILE * fp;
51 static int ctprof_pipe_fd;
52 static bool fifo_opened = false;
54 /* State definitions
55  * ready - ctprof_srv is ready for a signal
56  * recording - ctprof_srv is recording
57  * stopped - ctprof_srv has stopped recording
58  * Note - all messages are the same size in bytes.
59  */
60 static const char msg_recording[] = "ctprof recording\n";
61 static const char msg_stopped[] =   "ctprof stopped__\n";
62 static const char msg_ready[] =     "ctprof ready____\n";
63 static char readbuf[sizeof(msg_recording)];
65 /* Note: This implementation uses named pipes for very 
66  * simple ipc. This could be changed in the future to
67  * use sockets or some other ipc so check the requirements
68  * for the version of ctprof you are using 
69  */
71 static pid_t ctprof_srv_pid;
73 void ctprof_pipe_read(char * rd_buf_p, size_t rd_bytecnt)
74 {
75     while(rd_bytecnt > 0) {
76         size_t rc = read(ctprof_pipe_fd, rd_buf_p, rd_bytecnt);
77  
78         if (( rc == -1) && (errno = EINTR)) {
79             continue;
80         }
82         rd_buf_p += rc;
83         rd_bytecnt -= rc;        
84     } 
85 }
87 int ctprof_pipe_open(void)
88 {
89     /* If fifo can't be opend then return -1 */
90     if (!fifo_opened) {
91         if (-1 == (ctprof_pipe_fd = open(fifo_filename, O_RDONLY))) {
92             return -1;
93         }
94         fifo_opened = true;     
95     }
97     ctprof_pipe_read((char *)&ctprof_srv_pid, sizeof(pid_t));
98     return 0;
99 }
101 void ctprof_pipe_close(void)
103     if (fifo_opened) {
104         close(ctprof_pipe_fd);
105         fifo_opened = false;
106     }        
110 static pid_t ctprof_get_pid(void) 
112     if (fifo_opened) {
113         return ctprof_srv_pid;
114     } else {
115         return -1;
116     }
119 ctprof_state_t ctprof_get_state(void)
121     /* If the fifo opened sucessfully, then fgets should block
122      * until data is avaiable.
123      */
124     if (fifo_opened) {
125         ctprof_pipe_read(readbuf, sizeof(readbuf)-1);
127         if (0 == strcmp(readbuf, msg_recording)) {
128             return CTPROF_RECORDING;
129         }
130         if (0 == strcmp(readbuf, msg_stopped)) {
131             return CTPROF_STOPPED;
132         }
133         if (0 == strcmp(readbuf, msg_ready)) {
134             return CTPROF_READY;
135         }
136     }
138     return -1;
142 void ctprof_ready_wait()
144     ctprof_state_t ctprof_state;
146     do {
148         ctprof_state = ctprof_get_state();
150         if(ctprof_state == CTPROF_READY) {
151             break;
152         }
154     } while (1);
157 void ctprof_recording_wait()
159     ctprof_state_t ctprof_state;
161     do {
163         ctprof_state = ctprof_get_state();
165         if(ctprof_state == CTPROF_RECORDING) {
166             break;
167         }
169     } while (1);
172 void ctprof_stopped_wait()
174     ctprof_state_t ctprof_state;
176     do {
178         ctprof_state = ctprof_get_state();
180         if(ctprof_state == CTPROF_STOPPED) {
181             break;
182         }
184     } while (1);
187 /* Start recording with a signal*/
188 void ctprof_start_recording()
190     kill(ctprof_get_pid(), SIGUSR1);
193 /* End recording for this session*/
194 void ctprof_end_recording()
196     kill(ctprof_get_pid(), SIGUSR2);