File: scamper_source_control.c

package info (click to toggle)
scamper 20191102-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 9,044 kB
  • sloc: ansic: 103,723; sh: 4,155; makefile: 468; perl: 186
file content (177 lines) | stat: -rw-r--r-- 4,581 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
 * scamper_source_control.c
 *
 * $Id: scamper_source_control.c,v 1.14 2012/04/05 18:00:54 mjl Exp $
 *
 * Copyright (C) 2007-2011 The University of Waikato
 * Author: Matthew Luckie
 *
 * This program 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, version 2.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef lint
static const char rcsid[] =
  "$Id: scamper_source_control.c,v 1.14 2012/04/05 18:00:54 mjl Exp $";
#endif

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "internal.h"

#include "scamper_task.h"
#include "scamper_outfiles.h"
#include "scamper_sources.h"
#include "scamper_debug.h"
#include "scamper_source_control.h"
#include "utils.h"

typedef struct scamper_source_control
{
  /* back-pointer to the parent source */
  scamper_source_t  *source;

  /* variable that indicates if no more commands are coming */
  int                isfinished;

  /* a function and a parameter to interact with the control socket */
  void             (*signalmore)(void *param);
  char *           (*tostr)(void *param, char *buf, size_t len);
  void              *param;

} scamper_source_control_t;

/*
 * ssc_take
 *
 * a task has been taken from this source (a control socket).  if there
 * are no tasks left then signal to the
 */
static int ssc_take(void *data)
{
  scamper_source_control_t *ssc = (scamper_source_control_t *)data;
  if(scamper_source_getcommandcount(ssc->source) == 0 && ssc->isfinished == 0)
    {
      ssc->signalmore(ssc->param);
    }
  return 0;
}

static void ssc_freedata(void *data)
{
  free(data);
  return;
}

static int ssc_isfinished(void *data)
{
  return ((scamper_source_control_t *)data)->isfinished;
}

static char *ssc_tostr(void *data, char *str, size_t len)
{
  scamper_source_control_t *ssc = data;
  size_t off = 0;
  char buf[128];

  string_concat(str, len, &off, "type control ");

  if(ssc->tostr(ssc->param, buf, sizeof(buf)) != NULL)
    string_concat(str, len, &off, "%s ", buf);

  if(ssc->isfinished == 0)
    string_concat(str, len, &off, "more");
  else
    string_concat(str, len, &off, "nomore");

  return str;
}

/*
 * scamper_source_control_finish
 *
 * the control socket has finished supplying commands, so make a note of
 * that for the next time the sources code cares to look.
 */
void scamper_source_control_finish(scamper_source_t *source)
{
  scamper_source_control_t *ssc;

  assert(scamper_source_gettype(source) == SCAMPER_SOURCE_TYPE_CONTROL);
  ssc = (scamper_source_control_t *)scamper_source_getdata(source);
  assert(ssc != NULL);

  if(ssc->isfinished != 0)
    return;

  ssc->isfinished = 1;
  if(scamper_source_isfinished(source) != 0)
    {
      scamper_source_finished(source);
    }

  return;
}

/*
 * scamper_source_control_alloc
 *
 * allocate a new source that is setup to interact with a control socket
 * connection that supplies commands.  the control socket is regulated
 * (on / off) by using the acceptready callback provided.
 */
scamper_source_t *scamper_source_control_alloc(scamper_source_params_t *ssp,
				       void (*signalmore)(void *),
				       char *(*tostr)(void *,char *,size_t),
				       void *param)
{
  scamper_source_control_t *ssc = NULL;
  scamper_source_t *source = NULL;

  if(ssp == NULL || signalmore == NULL || param == NULL)
    {
      goto err;
    }

  /* allocate state to keep with the particular control socket */
  if((ssc = malloc_zero(sizeof(scamper_source_control_t))) == NULL)
    {
      goto err;
    }
  ssc->signalmore  = signalmore;
  ssc->param       = param;
  ssc->tostr       = tostr;

  /* append parameters to the source parameters struct */
  ssp->data        = ssc;
  ssp->take        = ssc_take;
  ssp->freedata    = ssc_freedata;
  ssp->isfinished  = ssc_isfinished;
  ssp->tostr       = ssc_tostr;
  ssp->type        = SCAMPER_SOURCE_TYPE_CONTROL;

  if((source = scamper_source_alloc(ssp)) == NULL)
    {
      goto err;
    }
  ssc->source = source;

  return source;

 err:
  if(ssc != NULL) free(ssc);
  if(source != NULL) scamper_source_free(source);
  return NULL;
}