com.cyc.cycjava.cycl.sbhl
Class sbhl_caching_policies

java.lang.Object
  com.cyc.tool.subl.util.SubLTrampolineFile
      com.cyc.tool.subl.util.SubLTranslatedFile
          com.cyc.cycjava.cycl.sbhl.sbhl_caching_policies

All Implemented Interfaces:

CommonSymbols, SubLFile

public final class sbhl_caching_policies
extends SubLTranslatedFile

Nested Class Summary

Nested classes/interfaces inherited from class com.cyc.tool.subl.util.SubLTranslatedFile

SubLTranslatedFile.SubL

Field Summary

static SubLSymbol	$active_sbhl_caching_policies$ The current caching policies that are active for the respective caches.
static SubLObject	$const37$genls
static SubLObject	$const38$genlInverse
static SubLObject	$const41$genlPreds
static SubLObject	$const42$genlMt
static SubLInteger	$int32$30
static SubLSymbol	$kw10$CAPACITY
static SubLSymbol	$kw11$ALL
static SubLSymbol	$kw13$EXEMPT
static SubLSymbol	$kw16$PREFETCH
static SubLSymbol	$kw17$SWAPOUT
static SubLSymbol	$kw22$DONT_CACHE
static SubLSymbol	$kw23$TOUCH
static SubLSymbol	$kw26$RESET
static SubLSymbol	$kw27$ENFORCED
static SubLSymbol	$kw33$READY
static SubLSymbol	$kw34$DONE
static SubLSymbol	$kw4$LINK_PREDICATE
static SubLSymbol	$kw5$POLICY
static SubLSymbol	$kw6$UNKNOWN
static SubLSymbol	$kw7$STICKY
static SubLSymbol	$kw8$UNDEFINED
static SubLList	$list1
static SubLList	$list2
static SubLList	$list35
static SubLList	$list36
static SubLList	$list43
static SubLString	$str12$Invalid_exemption_specification__
static SubLString	$str15$Invalid_prefetch_specification__A
static SubLString	$str18$Swapout_policy_does_not_support_c
static SubLString	$str19$Invalid_exemption_specification__
static SubLString	$str20$Invalid_prefetch_specification__A
static SubLString	$str21$Unknown_policy_type__A_____dont_k
static SubLString	$str24$Caching_policy_of_type__A_not_yet
static SubLString	$str29$__Skipping_invalid_SBHL_caching_p
static SubLString	$str30$standard_kb_sbhl_caching_policies
static SubLString	$str9$Sticky_policy_does_not_support_ca
static SubLSymbol	$sym0$_ACTIVE_SBHL_CACHING_POLICIES_
static SubLSymbol	$sym14$FORT_P
static SubLSymbol	$sym25$LIST_OF_FORT_P
static SubLSymbol	$sym28$CATCH_ERROR_MESSAGE_HANDLER
static SubLSymbol	$sym3$VALID_SBHL_CACHING_POLICY_TYPE_P
static SubLSymbol	$sym31$VALID_FORT_
static SubLSymbol	$sym39$_
static SubLSymbol	$sym40$GENERALITY_ESTIMATE_
static SubLSymbol	$valid_sbhl_caching_instruction_verb$ The list of valid SBHL caching instruction action verbs.
static SubLSymbol	$valid_sbhl_caching_policy_types$ The list of the valid SBHL caching policy types.
static SubLFile	me
static java.lang.String	myName

Fields inherited from class com.cyc.tool.subl.util.SubLTranslatedFile

EMPTY_SUBL_OBJECT_ARRAY

Fields inherited from interface com.cyc.tool.subl.jrtl.nativeCode.subLisp.CommonSymbols

ANSWER_TAG, APPEND_KEYWORD, APPEND_STACK_TRACES_TO_ERROR_MESSAGES, AREF, ASSEMBLE_FIXNUMS_TO_INTEGER, ATOM, BIGNUMP, BINARY_KEYWORD, BINDING_TYPE, BOOLEANP, CAAR, CADR, CAND, CAR, CCATCH, CDEC, CDESTRUCTURING_BIND, CDO, CDO_ALL_SYMBOLS, CDO_EXTERNAL_SYMBOLS, CDO_SYMBOLS, CDOHASH, CDOLIST, CDOTIMES, CDR, CHAR, CHAR_E_SYMBOL, CHAR_EQUAL_SYMBOL, CHAR_GREATER_THAN_OR_EQUAL_SYMBOL, CHAR_GREATER_THAN_SYMBOL, CHAR_GT_SYMBOL, CHAR_GTE_SYMBOL, CHAR_LESS_THAN_OR_EQUAL_SYMBOL, CHAR_LESS_THAN_SYMBOL, CHAR_LT_SYMBOL, CHAR_LTE_SYMBOL, CHAR_NE_SYMBOL, CHAR_NOT_EQUAL_SYMBOL, CHARACTERP, CHECK_TYPE, CINC, CLET, CMULTIPLE_VALUE_BIND, CNOT, CONS, CONSP, CONSTANT, COR, CPOP, CPROGV, CPUSH, CPUSHNEW, CREATE_KEYWORD, CSETF, CSETQ, CSOME, CTIME, CUNWIND_PROTECT, CVS_ID, DEBUG_IO, DECLAIM, DECLARE, DEFCONSTANT, DEFINE, DEFLEXICAL, DEFMACRO, DEFPARAMETER, DEFVAR, DIRECTION_KEYWORD, DYNAMIC, EIGHT_INTEGER, EIGHTEEN_INTEGER, ELEMENT_TYPE_KEYWORD, ELEVEN_INTEGER, END_KEYWORD, ENFORCE_MUST, ENFORCE_TYPE, EQ, EQL, EQUAL, EQUALP, ERROR, ERROR_KEYWORD, ERROR_OUTPUT, EVAL, EXTERNAL_FORMAT_KEYWORD, EXTERNAL_KEYWORD, FIF, FIFTEEN_INTEGER, FIRST, FIVE_INTEGER, FIXNUMP, FLOATP, FOUR_INTEGER, FOURTEEN_INTEGER, FUNCTION, FUNCTION_SPEC_P, FUNCTIONP, FUNLESS, FWHEN, GET, GETHASH, GETHASH_WITHOUT_VALUES, GUID_P, HASH_TABLE_ITERATOR_P, HASH_TABLE_P, IDENTITY, IF_DOES_NOT_EXIST_KEYWORD, IF_EXISTS_KEYWORD, IGNORE, INITIALIZATION_TYPE, INITIALIZER, INPUT_KEYWORD, INPUT_STREAM_P, INTEGERP, INTERNAL_KEYWORD, IO_KEYWORD, KEYWORDP, KILL_KEYWORD, LAMBDA_SYMBOL, LEXICAL, LIST, LISTP, LISTS, LOCK_P, LONG_BIGNUM_P, MACRO_ENV, MACRO_FORM, MEDIUM_BIGNUM_P, MEMBER, MINUS_ONE_INTEGER, MULTIPLE_VALUE_LIST, MUST, NCONC, NEW_VERSION_KEYWORD, NIL, NINE_INTEGER, NINETEEN_INTEGER, NREVERSE, NTH, NTH_VALUE, NULL, NULL_INPUT, NULL_OUTPUT, NUM_E_SYMBOL, NUM_GT_SYMBOL, NUM_GTE_SYMBOL, NUM_LT_SYMBOL, NUM_LTE_SYMBOL, NUM_NE_SYMBOL, NUMBERP, ONE_HUNDRED_THIRTY_SEVEN_INTEGER, ONE_HUNDRED_TWENTY_SEVEN_INTEGER, ONE_INTEGER, ONE_THOUSAND_INTEGER, OPTIONAL_SYMBOL, OTHERWISE, OUTPUT_KEYWORD, OUTPUT_STREAM_P, OVERWRITE_KEYWORD, PACKAGEP, PCASE, PCOND, PIF, PROBE_KEYWORD, PROCESS_TO_END, PROCESSP, PROCLAIM, PROGN, PUNLESS, PWHEN, QUERY_IO, QUIT, QUOTE, RENAME_AND_DELETE_KEYWORD, REST_SYMBOL, RET, RET_NIL, RET_T, RETURN_TAG, REVERSE, RW_LOCK_P, SECOND, SEQUENCEP, SEVEN_INTEGER, SEVENTEEN_INTEGER, SHORT_BIGNUM_P, SHOW_STACK_TRACES, SIX_INTEGER, SIXTEEN_INTEGER, SIXTY_FOUR_INTEGER, SORT, SSS, STANDARD_INPUT, STANDARD_OUTPUT, START_KEYWORD, STREAMP, STRING_E_SYMBOL, STRING_EQUAL_SYMBOL, STRING_GREATER_THAN_OR_EQUAL_SYMBOL, STRING_GREATER_THAN_SYMBOL, STRING_GT_SYMBOL, STRING_GTE_SYMBOL, STRING_LESS_THAN_OR_EQUAL_SYMBOL, STRING_LESS_THAN_SYMBOL, STRING_LT_SYMBOL, STRING_LTE_SYMBOL, STRING_NE_SYMBOL, STRING_NOT_EQUAL_SYMBOL, STRINGP, STRUCTURE_P, SUPERSEDE_KEYWORD, SUSPEND_TYPE_CHECKING, SYMBOL_FUNCTION, SYMBOL_VALUE, SYMBOLP, T, TEN_INTEGER, TERMINAL_IO, TEXT_KEYWORD, THIRTEEN_INTEGER, THIRTY_FOUR_INTEGER, THIRTY_THREE_INTEGER, THIRTY_TWO_INTEGER, THREE_INTEGER, TRACE_OUTPUT, TRUE, TWELVE_INTEGER, TWENTY_INTEGER, TWO_HUNDRED_FIFTY_FOUR_INTEGER, TWO_HUNDRED_FORTY_FOUR_INTEGER, TWO_INTEGER, UNDECLARED, UNPROVIDED, VALUES, VECTOR, VECTORP, WITH_ERROR_HANDLER, WITH_STATIC_AREA, WITH_THREAD_PRIVATE_AREA, WITH_WORKING_AREA, WORLD, ZERO_DOUBLE, ZERO_INTEGER

Method Summary

static SubLObject	create_sbhl_caching_policy_from_term_recommendation_list(SubLObject link_predicate, SubLObject policy_type, SubLObject capacity, SubLObject term_list, SubLObject exempt, SubLObject prefetch) Given a list of terms and some of the basic information for a caching policy, construct one that will meet the structural requirements of the sbhl caching policy description.
static SubLObject	declare_sbhl_caching_policies_file()
void	declareFunctions() Declares the mapping between functions and symbols for all named functions defined in the file.
static SubLObject	enforce_standard_kb_sbhl_caching_policies(SubLObject dump_directory) Attempt to load a standard KB sbhl caching policy file from the dump directory.
static SubLObject	flesh_out_sbhl_caching_policy(SubLObject policy, SubLObject capacity, SubLObject exemptions, SubLObject prefetch) Interpret the arguments and see if they are sensible with respect to the policy.
static SubLObject	get_sbhl_caching_policy_link_predicate(SubLObject policy)
static SubLObject	get_sbhl_caching_policy_terms_to_prefetch(SubLObject policy)
static SubLObject	get_sbhl_caching_policy_type(SubLObject policy)
static SubLObject	get_standard_kb_sbhl_caching_policies_filename(SubLObject dump_directory)
static SubLObject	implement_sbhl_caching_policy(SubLObject policy) Apply the policy to the current caching infrastructure for the SBHL module, paging in whatever needs to be loaded, in the fasion specified by the policy.
static SubLObject	init_sbhl_caching_policies_file()
void	initializeVariables() Initializes all global variables and private internal variables for constants defined in the file.
static SubLObject	load_sbhl_caching_policies(SubLObject policies_file) Load the SBHL caching policies in the most effective way.
static SubLObject	new_sbhl_caching_policy(SubLObject link_predicate, SubLObject policy_type, SubLObject capacity, SubLObject exemptions, SubLObject prefetch)
static SubLObject	reset_sbhl_caching_policies_internal(SubLObject policies) Do the actual reset of the SBHL caching policies.
static SubLObject	reset_sbhl_caching_policy(SubLObject policy) Implements the cache policy after having reset the existing infrastructure relevant to the policy.
void	runTopLevelForms() Runs all top-level forms in order.
static SubLObject	seed_sbhl_module_graph_cache_with_nodes(SubLObject module, SubLObject nodes, SubLObject touch_p)
static SubLObject	setup_sbhl_caching_policies_file()

Methods inherited from class com.cyc.tool.subl.util.SubLTranslatedFile

extractFunctionNamed

Methods inherited from class com.cyc.tool.subl.util.SubLTrampolineFile

checkType, enforceType, extractBinaryFunc, extractCount, extractEnd, extractEndUsingSize, extractPackage, extractStart, extractUnaryFunc, main

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

me

public static final SubLFile me

myName

public static final java.lang.String myName

See Also:

Constant Field Values

$active_sbhl_caching_policies$

public static SubLSymbol $active_sbhl_caching_policies$

The current caching policies that are active for the respective caches.

$valid_sbhl_caching_instruction_verb$

public static SubLSymbol $valid_sbhl_caching_instruction_verb$

The list of valid SBHL caching instruction action verbs.

$valid_sbhl_caching_policy_types$

public static SubLSymbol $valid_sbhl_caching_policy_types$

The list of the valid SBHL caching policy types.

$sym0$_ACTIVE_SBHL_CACHING_POLICIES_

public static final SubLSymbol $sym0$_ACTIVE_SBHL_CACHING_POLICIES_

$list1

public static final SubLList $list1

$list2

public static final SubLList $list2

$sym3$VALID_SBHL_CACHING_POLICY_TYPE_P

public static final SubLSymbol $sym3$VALID_SBHL_CACHING_POLICY_TYPE_P

$kw4$LINK_PREDICATE

public static final SubLSymbol $kw4$LINK_PREDICATE

$kw5$POLICY

public static final SubLSymbol $kw5$POLICY

$kw6$UNKNOWN

public static final SubLSymbol $kw6$UNKNOWN

$kw7$STICKY

public static final SubLSymbol $kw7$STICKY

$kw8$UNDEFINED

public static final SubLSymbol $kw8$UNDEFINED

$str9$Sticky_policy_does_not_support_ca

public static final SubLString $str9$Sticky_policy_does_not_support_ca

$kw10$CAPACITY

public static final SubLSymbol $kw10$CAPACITY

$kw11$ALL

public static final SubLSymbol $kw11$ALL

$str12$Invalid_exemption_specification__

public static final SubLString $str12$Invalid_exemption_specification__

$kw13$EXEMPT

public static final SubLSymbol $kw13$EXEMPT

$sym14$FORT_P

public static final SubLSymbol $sym14$FORT_P

$str15$Invalid_prefetch_specification__A

public static final SubLString $str15$Invalid_prefetch_specification__A

$kw16$PREFETCH

public static final SubLSymbol $kw16$PREFETCH

$kw17$SWAPOUT

public static final SubLSymbol $kw17$SWAPOUT

$str18$Swapout_policy_does_not_support_c

public static final SubLString $str18$Swapout_policy_does_not_support_c

$str19$Invalid_exemption_specification__

public static final SubLString $str19$Invalid_exemption_specification__

$str20$Invalid_prefetch_specification__A

public static final SubLString $str20$Invalid_prefetch_specification__A

$str21$Unknown_policy_type__A_____dont_k

public static final SubLString $str21$Unknown_policy_type__A_____dont_k

$kw22$DONT_CACHE

public static final SubLSymbol $kw22$DONT_CACHE

$kw23$TOUCH

public static final SubLSymbol $kw23$TOUCH

$str24$Caching_policy_of_type__A_not_yet

public static final SubLString $str24$Caching_policy_of_type__A_not_yet

$sym25$LIST_OF_FORT_P

public static final SubLSymbol $sym25$LIST_OF_FORT_P

$kw26$RESET

public static final SubLSymbol $kw26$RESET

$kw27$ENFORCED

public static final SubLSymbol $kw27$ENFORCED

$sym28$CATCH_ERROR_MESSAGE_HANDLER

public static final SubLSymbol $sym28$CATCH_ERROR_MESSAGE_HANDLER

$str29$__Skipping_invalid_SBHL_caching_p

public static final SubLString $str29$__Skipping_invalid_SBHL_caching_p

$str30$standard_kb_sbhl_caching_policies

public static final SubLString $str30$standard_kb_sbhl_caching_policies

$sym31$VALID_FORT_

public static final SubLSymbol $sym31$VALID_FORT_

$int32$30

public static final SubLInteger $int32$30

$kw33$READY

public static final SubLSymbol $kw33$READY

$kw34$DONE

public static final SubLSymbol $kw34$DONE

$list35

public static final SubLList $list35

$list36

public static final SubLList $list36

$const37$genls

public static final SubLObject $const37$genls

$const38$genlInverse

public static final SubLObject $const38$genlInverse

$sym39$_

public static final SubLSymbol $sym39$_

$sym40$GENERALITY_ESTIMATE_

public static final SubLSymbol $sym40$GENERALITY_ESTIMATE_

$const41$genlPreds

public static final SubLObject $const41$genlPreds

$const42$genlMt

public static final SubLObject $const42$genlMt

$list43

public static final SubLList $list43

Method Detail

new_sbhl_caching_policy

public static final SubLObject new_sbhl_caching_policy(SubLObject link_predicate,
                                                       SubLObject policy_type,
                                                       SubLObject capacity,
                                                       SubLObject exemptions,
                                                       SubLObject prefetch)

flesh_out_sbhl_caching_policy

public static final SubLObject flesh_out_sbhl_caching_policy(SubLObject policy,
                                                             SubLObject capacity,
                                                             SubLObject exemptions,
                                                             SubLObject prefetch)

Interpret the arguments and see if they are sensible with respect to the policy.

get_sbhl_caching_policy_link_predicate

public static final SubLObject get_sbhl_caching_policy_link_predicate(SubLObject policy)

get_sbhl_caching_policy_type

public static final SubLObject get_sbhl_caching_policy_type(SubLObject policy)

get_sbhl_caching_policy_terms_to_prefetch

public static final SubLObject get_sbhl_caching_policy_terms_to_prefetch(SubLObject policy)

reset_sbhl_caching_policy

public static final SubLObject reset_sbhl_caching_policy(SubLObject policy)

Implements the cache policy after having reset the existing infrastructure relevant to the policy.

Returns:

the policy

implement_sbhl_caching_policy

public static final SubLObject implement_sbhl_caching_policy(SubLObject policy)

Apply the policy to the current caching infrastructure for the SBHL module, paging in whatever needs to be loaded, in the fasion specified by the policy.

Returns:

the POLICY

seed_sbhl_module_graph_cache_with_nodes

public static final SubLObject seed_sbhl_module_graph_cache_with_nodes(SubLObject module,
                                                                       SubLObject nodes,
                                                                       SubLObject touch_p)

Parameters:

nodes - LIST-OF-TYPE-P FORT-P or :all

create_sbhl_caching_policy_from_term_recommendation_list

public static final SubLObject create_sbhl_caching_policy_from_term_recommendation_list(SubLObject link_predicate,
                                                                                        SubLObject policy_type,
                                                                                        SubLObject capacity,
                                                                                        SubLObject term_list,
                                                                                        SubLObject exempt,
                                                                                        SubLObject prefetch)

Given a list of terms and some of the basic information for a caching policy, construct one that will meet the structural requirements of the sbhl caching policy description.

Parameters:

exempt - the first N of the term list to exempt from caching

prefetch - the first N AFTER the exempt of the term list to prefetch

Returns:

the SBHL caching policy

reset_sbhl_caching_policies_internal

public static final SubLObject reset_sbhl_caching_policies_internal(SubLObject policies)

Do the actual reset of the SBHL caching policies.

enforce_standard_kb_sbhl_caching_policies

public static final SubLObject enforce_standard_kb_sbhl_caching_policies(SubLObject dump_directory)

Attempt to load a standard KB sbhl caching policy file from the dump directory. If no such file exists, revert to the legacy SBHL caching policy.

load_sbhl_caching_policies

public static final SubLObject load_sbhl_caching_policies(SubLObject policies_file)

Load the SBHL caching policies in the most effective way. Return LISTP of caching policies.

get_standard_kb_sbhl_caching_policies_filename

public static final SubLObject get_standard_kb_sbhl_caching_policies_filename(SubLObject dump_directory)

declare_sbhl_caching_policies_file

public static final SubLObject declare_sbhl_caching_policies_file()

init_sbhl_caching_policies_file

public static final SubLObject init_sbhl_caching_policies_file()

setup_sbhl_caching_policies_file

public static final SubLObject setup_sbhl_caching_policies_file()

declareFunctions

public void declareFunctions()

Description copied from interface: SubLFile

Declares the mapping between functions and symbols for all named functions defined in the file. Like CRTL define.

initializeVariables

public void initializeVariables()

Description copied from interface: SubLFile

Initializes all global variables and private internal variables for constants defined in the file. Like CRTL init.

runTopLevelForms

public void runTopLevelForms()

Description copied from interface: SubLFile

Runs all top-level forms in order. Like CRTL setup.