summaryrefslogtreecommitdiff
path: root/hurd/translator/writing/example.mdwn
blob: 0a3be4df346b11bb516233eb959e071dd4e60a27 (plain)
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
[[!meta copyright="Copyright © 2007, 2008 Free Software Foundation, Inc."]]

[[!meta license="""[[!toggle id="license" text="GFDL 1.2+"]][[!toggleable
id="license" text="Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no Invariant
Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the license
is included in the section entitled
[[GNU Free Documentation License|/fdl]]."]]"""]]

## Data User-Server Translator Example

The code examples were written by Anand Babu.

We have a data.h header file, a data.defs file, a data-user.c, data-server.c
sources files and a Makefile.

data.h:
-------

    #ifndef	_data_user_
    #define	_data_user_
    
    /* Module data */
    
    #include <mach/kern_return.h>
    #include <mach/port.h>
    #include <mach/message.h>
    
    #include <mach/std_types.h>
    #include <mach/mach_types.h>
    #include <device/device_types.h>
    #include <device/net_status.h>
    #include <sys/types.h>
    #include <sys/stat.h>
    #include <sys/statfs.h>
    #include <sys/resource.h>
    #include <sys/utsname.h>
    #include <hurd/hurd_types.h>
    
    /* Routine data_set_value */
    #ifdef	mig_external
    mig_external
    #else
    extern
    #endif
    kern_return_t S_data_set_value
    #if	defined(LINTLIBRARY)
        (data_port, value)
    	mach_port_t data_port;
    	int value;
    { return S_data_set_value(data_port, value); }
    #else
    (
    	mach_port_t data_port,
    	int value
    );
    #endif
    
    /* Routine data_get_value */
    #ifdef	mig_external
    mig_external
    #else
    extern
    #endif
    kern_return_t S_data_get_value
    #if	defined(LINTLIBRARY)
        (data_port, value)
    	mach_port_t data_port;
    	int *value;
    { return S_data_get_value(data_port, value); }
    #else
    (
    	mach_port_t data_port,
    	int *value
    );
    #endif
    
    #endif	/* not defined(_data_user_) */

data.defs:
----------

    /* Definitions for data interface
    
    This file is part of the GNU Hurd.
    
    The GNU Hurd 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.
    
    The GNU Hurd 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 the GNU Hurd; see the file COPYING.  If not, write to
    the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
    
    subsystem data 45000;
    
    #include <hurd/hurd_types.defs>
    
    #ifdef STACK_IMPORTS
    STACK_IMPORTS
    #endif
    
    /* intr-rpc.defs defines the INTR_INTERFACE macro to make the generated RPC
    stubs send-interruptible, and to prefix them with `hurd_intr_rpc_'. */
    INTR_INTERFACE
    
    /* set integer value to data */
    routine data_set_value (
    	data_port: mach_port_t;
    	value: int);
    
    /* get integer value from data */
    routine data_get_value (
    	data_port: mach_port_t;
    	out value: int);

data-user.c:
------------

    #include <stdio.h>
    #include <hurd.h>
    #include <hurd/hurd_types.h>
    #include "data.h"
    
    #ifndef _GNU_SOURCE
      #define _GNU_SOURCE
    #endif
    
    int
    main(int argc, char *argv[])
    {
      int value=0;
      mach_port_t data_server_port;
    
      data_server_port = file_name_lookup ("/tmp/trans", 0, 0);
      printf ("data_server_port [%u]\n", data_server_port);
      S_data_set_value (data_server_port, 99);
      S_data_get_value (data_server_port, &value);
      printf ("data->get_value: [%d]\n", value);
      
      return 0;
    }

data-server.c:
--------------

    #ifndef _GNU_SOURCE
      #define _GNU_SOURCE
    #endif
    
    #include <stdio.h>
    #include <getopt.h>
    #include <errno.h>
    #include <sys/stat.h>
    #include <error.h>
    
    #include <hurd/ports.h>
    #include <hurd/hurd_types.h>
    #include <hurd/trivfs.h>
    
    #include "data.h"
    
    extern boolean_t S_data_server
    (mach_msg_header_t *InHeadP, mach_msg_header_t *OutHeadP);
    
    int trivfs_fstype = FSTYPE_MISC;
    int trivfs_fsid = 0;
    int trivfs_support_read = 0;
    int trivfs_support_write = 0;
    int trivfs_support_exec = 0;
    int trivfs_allow_open = 0x00;
    int trivfs_protid_nportclasses = 0;
    int trivfs_cntl_nportclasses = 0;
    
    int data_value;
    
    int demuxer (mach_msg_header_t *inp, mach_msg_header_t *outp)
    {
      return (S_data_server(inp,outp)||trivfs_demuxer(inp,outp));
    }
    
    void trivfs_modify_stat (struct trivfs_protid *cred, io_statbuf_t  *st)
    {
    }
    error_t trivfs_goaway (struct trivfs_control *fsys, int flags)
    {
      exit (0);
    }
    
    kern_return_t S_data_set_value (mach_port_t data_port, int value)
    {
      data_value = value;
      return 0;
    }
    
    kern_return_t S_data_get_value (mach_port_t data_port, int *value)
    {
      *value = data_value;
      return 0;
    }
    
    int
    main(int argc, char *argv[])
    {
      int err;
      mach_port_t bootstrap;
      struct trivfs_control *fsys;
    
      if (argc > 1)
        {
          fprintf(stderr, "Usage: settrans [opts] node %s\n", program_invocation_name); 
          exit (1);
        }
    
      task_get_bootstrap_port (mach_task_self (), &bootstrap);
      if (bootstrap == MACH_PORT_NULL)
        error(2, 0, "Must be started as a translator");
    
      /* Reply to our parent */
      err = trivfs_startup (bootstrap, 0, 0, 0, 0, 0,&fsys);
      mach_port_deallocate (mach_task_self (), bootstrap);
      if (err) {
        return (0);
      }
    
      ports_manage_port_operations_one_thread (fsys->pi.bucket, demuxer, 0);
    
      return 0;
    }

Makefile:
---------

    CC = gcc
    MIG = mig
    CFLAGS = -Wall -g  -D_GNU_SOURCE
    LDFLAGS = -lthreads -lports -ltrivfs -lfshelp -lshouldbeinlibc
    INCLUDES = -I.
    LCHDRS = 
    MIGCOMSFLAGS = -prefix S_
    OBJS = $(SRCS:.c=.o)
    TAGS = etags.emacs21
    
    all: data-server data-user
    tags:
    	$(TAGS) $(SRCS) $(LCHDRS)
    
    stubs: data.defs
    	$(MIG) $(MIGCOMSFLAGS) -server dataServer.c -user dataUser.c $^
    data-server: data-server.c dataServer.c 
    	$(CC) $^ $(CFLAGS) $(INCLUDES) $(LDFLAGS) -o $@
    data-user: data-user.c dataUser.c
    	$(CC) $^ $(CFLAGS) $(INCLUDES) -o $@
    clean:
    	rm -f *.o data-server data-user
    
    start: data-server data-user
    	settrans -ac /tmp/trans data-server
    	ps -x | grep data-server
    end:
    	settrans -fg /tmp/trans

Building
--------

Do

    make stubs

to create the dataUser.c and dataServer.c files generated by mig.  Create the
executables using:

    make all

Testing
-------

Start the data-server translator using:

    settrans -ac /tmp/trans data-server

You can check if it is running using

    ps -x | grep data-server

Run the data-user executable to get the resultant output.

You can remove the translator using:

    settrans -fg /tmp/trans

To remove the built files use:

    make clean

Happy Hacking!