processing header files More...

#include "tree.h"

Include dependency graph for process.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	IterationState

struct	CondState

#define	_p_addrt2q(q, t) __p_addrt2q(q,t,NULL);

#define	__p_make_signature(output_label, output_type, output_sem,...) __p_make_form(PROCESS_SIGNATURE,output_label,output_type,output_sem,__VA_ARGS__)

enum	ReductionError { Ascend =-1, Descend =-2, Pushed =-3, Pop =-4, Eval =-5, Block =-6, Done =0, noReductionErr =0, redoReduction, raiseReductionErr, tooFewParamsReductionErr =TOO_FEW_PARAMS_ERR_ID, tooManyParamsReductionErr =TOO_MANY_PARAMS_ERR_ID, signatureMismatchReductionErr =SIGNATURE_MISMATCH_ERR_ID, notProcessReductionError =NOT_A_PROCESS_ERR_ID, divideByZeroReductionErr =ZERO_DIVIDE_ERR_ID, notInSignalContextReductionError =NOT_IN_SIGNAL_CONTEXT_ERR_ID, incompatibleTypeReductionErr =INCOMPATIBLE_TYPE_ERR_ID, unixErrnoReductionErr =UNIX_ERRNO_ERR_ID, deadStreamReadReductionErr =DEAD_STREAM_READ_ERR_ID, missingSemanticMapReductionErr =MISSING_SEMANTIC_MAP_ERR_ID, mismatchSemanticMapReductionErr =MISMATCH_SEMANTIC_MAP_ERR_ID, structureMismatchReductionErr =STRUCTURE_MISMATCH_ERR_ID }

enum	QueueError { noErr = 0, contextNotFoundErr }

enum	MagicProcesses { MagicReceptors, MagicQuit, MagicDebug }

enum	IterationPhase { EvalCondition, EvalBody }

enum	IterationType { IterateTypeCount, IterateTypeUnknown, IterateTypeCond, IterateTypeOnSymbol }

enum	CondPhase { EvalCondCondtions, EvalCondResult }

typedef struct IterationState	IterationState

typedef struct CondState	CondState

T *	defaultRequestUntil ()

R *	__p_make_context (T run_tree, R caller, int process_id, T *sem_map)

Error	_p_step (Q q, R *contextP)

void	_p_fill_from_match (SemTable sem, T t, T match_results, T match_tree)

Error	__p_check_signature (SemTable sem, Process p, T params, T *sem_map)

Error	__p_reduce_sys_proc (R context, Symbol s, T code, Q *q)

void	_p_enqueue (Qe *listP, Qe e)

Qe *	__p_find_context (Qe *e, int process_id)

void	__p_unblock (Q q, Qe e, Error err)

Error	_p_unblock (Q *q, int id)

void	_p_wakeup (Q q, T wakeup, T *with, Error err)

Error	_p_reduce (SemTable sem, T run_tree)

Q *	_p_newq (Receptor *r)

void	_p_freeq (Q *q)

void	_p_free_context (R *c)

Qe *	__p_addrt2q (Q q, T t, T *sem_map)

Error	_p_reduceq (Q *q)

void *	_p_reduceq_thread (void *arg)

T *	_p_make_run_tree (SemTable sem, Process p, T params, T *sem_map)

T *	__p_build_wakeup_info (T *code_point, int process_id)

T *	__p_build_run_tree (T *code, int num_params,...)

void	_p_cleanup (Q *q)

T *	__p_make_form (Symbol sym, char *output_label, Symbol output_type, SemanticID output_sem,...)

Detailed Description

processing header files

ceptr processing happens by instantiating code trees into run trees and reducing them

Copyright: Copyright (C) 2013-2016, The MetaCurrency Project (Eric Harris-Braun, Arthur Brock, et. al). This file is part of the Ceptr platform and is released under the terms of the license contained in the file LICENSE (GPLv3).

Definition in file process.h.

Function Documentation

Qe* __p_addrt2q	(	Q *	q,
		T *	run_tree,
		T *	sem_map
	)

add a run tree into a processing queue

Todo:: make thread safe. currently you shouldn't call this if the Q is being actively reduced

Definition at line 2068 of file process.c.

T* __p_build_wakeup_info	(	T *	code_point,
		int	process_id
	)

low level function to build a WAKEUP_REFERENCE symbol used for unblocking a process

Definition at line 1931 of file process.c.

Error __p_check_signature	(	SemTable *	sem,
		Process	p,
		T *	code,
		T *	sem_map
	)

check a group of parameters to see if they match a process input signature

Parameters

[in]	sem	Semantic table in use
[in]	p	the Process we are checking against
[in]	params	list of parameters

Returns: Error code

Todo:: add SIGNATURE_SYMBOL for setting up process signatures by Symbol not just Structure

Definition at line 291 of file process.c.

R* __p_make_context	(	T *	run_tree,
		R *	caller,
		int	process_id,
		T *	sem_map
	)

create a run-tree execution context.

Definition at line 1345 of file process.c.

T* __p_make_form	(	Symbol	sym,
		char *	output_label,
		Symbol	output_type,
		SemanticID	output_sem,
			...
	)

utility function to build process form structures

Parameters

[in]	symbol	the type of process form to build, i.e. PROCESS_SIGNATURE
[in]	output_label
[in]	output_symbol
[in]	var_args	triplets of label, symbol type, and symbol value for the signature
[out]	form	tree

Todo:: add more sensible handling of output signature. We still aren't quite sure what to do about the output label, and how to handle output signature pass through from the results, probably need a special symbol for that

Definition at line 2235 of file process.c.

Error __p_reduce_sys_proc	(	R *	context,
		Symbol	s,
		T *	code,
		Q *	q
	)

reduce system level processes in a run tree. Assumes that the children have already been reduced and all parameters have been filled in

these system level processes are the equivalent of the instruction set of the ceptr virtual machine

Todo:: what happens if it has more than one child! validity check?

Todo:: this would probably be faster with just one total realloc for all children

Todo:: what happens if it has more than one child! validity check?

Todo:: interpolation errors?

Todo:: what should this really return?

Todo:: the value returned from the iteration will be what??(what's in x)

Definition at line 395 of file process.c.

void _p_cleanup ( Q * q )

cleanup any completed process from the queue, updating the receptor state data as necessary

Parameters

[in] q the queue to be cleaned up

Definition at line 2208 of file process.c.

void _p_fill_from_match	(	SemTable *	sem,
		T *	t,
		T *	match_results,
		T *	match_tree
	)

implements the FILL_FROM_MATCH process

replaces the template tree with the matched sub-parts from a semtrex match results tree

Parameters

[in]	sem	current semantic context
[in]	t	template tree to be filled
[in]	match_results	SEMTREX_MATCH_RESULTS tree
[in]	match_tree	original tree that was matched (needed to build SEMANTIC_MAP)

Todo:: what to do if match has sibs??

Definition at line 76 of file process.c.

void _p_freeq ( Q * q )

free the resources in a queue, including any run-trees

Parameters

[in] q the queue to be freed

Definition at line 2055 of file process.c.

T* _p_make_run_tree	(	SemTable *	sem,
		Process	p,
		T *	params,
		T *	sem_map
	)

Build a run tree from a code tree and params

Parameters

[in]	sem	current semantic context
[in]	p	process to be cloned into a run tree
[in]	params	parameters to be added to the run-tree

Note: the params get added, not cloned to the tree

Returns: T RUN_TREE tree

Definition at line 1974 of file process.c.

Q* _p_newq ( Receptor * r )

create a new processing queue

Parameters

[in] r receptor in which to create the Queue

Returns: Q the processing queue

Definition at line 2015 of file process.c.

Error _p_reduce	(	SemTable *	sem,
		T *	rt
	)

reduce a run tree by executing the instructions in it and replacing the tree values in place

a run_tree is expected to have a code tree as the first child, parameters as the second, and optionally an error handling routine as the third child. This is a simplified reducer for testing purposes only, as real reduction happens in the context of a processing Q. This function makes a fake processing Q and Receptor.

Parameters

[in]	processes	context of defined processes
[in]	run_tree	the run tree being reduced

Returns: Error status of the reduction

Examples (from test suite):

    Process divz = _defDivZero();  // add the if_even process to our defs
    // create a run tree right in the position to "call" this function
    T *t = _t_new_root(RUN_TREE);
    T *n = _t_new_root(NOOP);
    T *d = _t_newr(n,divz);
    _t_newi(d,TEST_INT_SYMBOL,124);
    T *c = _t_rclone(n);
    _t_add(t,c);
    T *ps = _t_newr(t,PARAMS);
    // error routine is just a param ref to pass back the error tree
    int pt[] = {4,1,TREE_PATH_TERMINATOR};
    __t_new(t,PARAM_REF,pt,sizeof(int)*4,1);
    // confirm that it reduces correctly
    spec_is_equal(_p_reduce(G_sem,t),noReductionErr);
    spec_is_str_equal(t2s(_t_child(t,1)),"(ZERO_DIVIDE_ERR (ERROR_LOCATION:/1/1))");
    _t_free(t);_t_free(n);

Definition at line 1506 of file process.c.

Error _p_reduceq ( Q * q )

reduce all the processes in a queue

Parameters

[in] q the queue to be processed

Todo:: figure out what error we should be sending back here, i.e. what if

Definition at line 2126 of file process.c.

void* _p_reduceq_thread ( void * arg )

reduce all the processes in a queue, and terminate thread when completed

Parameters

[in] q the queue to be processed

Definition at line 2089 of file process.c.

Error _p_step	(	Q *	q,
		R **	contextP
	)

take one step in the execution state machine given a run-tree context

a run_tree is expected to have a code tree as the first child, parameters as the second, and optionally an error handling routine as the third child.

Parameters

[in]	Processing	Q in which this step is taking place
[in]	pointer	to context pointer

Returns: the next state that will be called for the context

Todo:: what if the replaced parameter is itself a PARAM_REF tree ??

Definition at line 1578 of file process.c.

Error _p_unblock	(	Q *	q,
		int	id
	)

search for the context in the q and unblock it

Definition at line 1426 of file process.c.

void _p_wakeup	(	Q *	q,
		T *	wakeup,
		T *	with,
		Error	err
	)

wakeup a process that's been paused

Parameters

[in]	q	the processing q in which to search for the process
[in]	wakeup	the WAKEUP_REF tree that identifies what needs waking up
[in]	with	a value to replace the current node_pointer with (i.e. a result)
[in]	err	an error value if the wakeup should trigger the error handler instead of resuming processing

Definition at line 1458 of file process.c.

Data Structures

Detailed Description

Function Documentation