Scippy

    SCIP

    Solving Constraint Integer Programs

    Data Structures | Functions | Variables
    interrupt.c File Reference
    Implementation files (.c files) » Other implementation files of SCIP

    Detailed Description

    methods and datastructures for catching the user CTRL-C interrupt

    Author
    Tobias Achterberg

    Definition in file interrupt.c.

    #include <assert.h>
    #include <sys/types.h>
    #include <stdlib.h>
    #include <signal.h>
    #include "scip/def.h"
    #include "scip/pub_message.h"
    #include "blockmemshell/memory.h"
    #include "scip/interrupt.h"

    Go to the source code of this file.

    Data Structures

    struct  SCIP_Interrupt
     

    Functions

    static void interruptHandler (int signum)
     
    SCIP_RETCODE SCIPinterruptCreate (SCIP_INTERRUPT **interrupt)
     
    void SCIPinterruptFree (SCIP_INTERRUPT **interrupt)
     
    void SCIPinterruptCapture (SCIP_INTERRUPT *interrupt)
     
    void SCIPinterruptRelease (SCIP_INTERRUPT *interrupt)
     
    SCIP_Bool SCIPinterrupted (void)
     
    SCIP_Bool SCIPterminated (void)
     
    void SCIPtryTerminate (void)
     
    void SCIPresetInterrupted (void)
     

    Variables

    static volatile int ninterrupts = 0
     
    static volatile int nterms = 0
     

    Function Documentation

    ◆ interruptHandler()

    static void interruptHandler ( int  signum)
    		static

    interrupt handler for CTRL-C interrupts

    Parameters
    signuminterrupt signal number

    Definition at line 72 of file interrupt.c.

    References ninterrupts, and SCIP_UNUSED.

    Referenced by SCIPinterruptCapture().

    ◆ SCIPinterruptCreate()

    SCIP_RETCODE SCIPinterruptCreate ( SCIP_INTERRUPT **  interrupt)

    creates a CTRL-C interrupt data

    Parameters
    interruptpointer to store the CTRL-C interrupt data

    Definition at line 91 of file interrupt.c.

    References BMSallocMemory, NULL, SCIP_ALLOC, and SCIP_OKAY.

    Referenced by doScipCreate().

    ◆ SCIPinterruptFree()

    void SCIPinterruptFree ( SCIP_INTERRUPT **  interrupt)

    frees a CTRL-C interrupt data

    Parameters
    interruptpointer to the CTRL-C interrupt data

    Definition at line 104 of file interrupt.c.

    References BMSfreeMemory, and NULL.

    Referenced by SCIPfree().

    ◆ SCIPinterruptCapture()

    void SCIPinterruptCapture ( SCIP_INTERRUPT *  interrupt)

    captures the CTRL-C interrupt to call the SCIP's own interrupt handler

    Parameters
    interruptCTRL-C interrupt data

    Definition at line 114 of file interrupt.c.

    References interruptHandler(), ninterrupts, nterms, NULL, SCIP_Interrupt::nuses, and SCIP_Interrupt::oldsigaction.

    Referenced by SCIPpresolve(), and SCIPsolve().

    ◆ SCIPinterruptRelease()

    void SCIPinterruptRelease ( SCIP_INTERRUPT *  interrupt)

    releases the CTRL-C interrupt and restores the old interrupt handler

    Parameters
    interruptCTRL-C interrupt data

    Definition at line 144 of file interrupt.c.

    References NULL, SCIP_Interrupt::nuses, and SCIP_Interrupt::oldsigaction.

    Referenced by SCIPpresolve(), and SCIPsolve().

    ◆ SCIPinterrupted()

    SCIP_Bool SCIPinterrupted ( void  )

    returns whether the user interrupted by pressing CTRL-C

    Definition at line 163 of file interrupt.c.

    References ninterrupts.

    Referenced by SCIPpressedCtrlC(), and SCIPsolveIsStopped().

    ◆ SCIPterminated()

    SCIP_Bool SCIPterminated ( void  )

    returns whether a process termination signal was received

    Definition at line 171 of file interrupt.c.

    References nterms.

    Referenced by SCIPsolveIsStopped().

    ◆ SCIPtryTerminate()

    void SCIPtryTerminate ( void  )

    sends a termination signal to all SCIP processes so that they try to terminate as soon as possible

    Note
    For terminating a specific SCIP process use SCIPinterruptSolve().

    Definition at line 182 of file interrupt.c.

    References nterms.

    Referenced by handleSigterm().

    ◆ SCIPresetInterrupted()

    void SCIPresetInterrupted ( void  )

    resets the number of interrupts to 0

    Definition at line 190 of file interrupt.c.

    References ninterrupts, and nterms.

    Referenced by SCIPsolveIsStopped().

    Variable Documentation

    ◆ ninterrupts

    volatile int ninterrupts = 0
    		static

    static variable counting the number of CTRL-C interrupts

    Definition at line 45 of file interrupt.c.

    Referenced by interruptHandler(), SCIPinterruptCapture(), SCIPinterrupted(), and SCIPresetInterrupted().

    ◆ nterms

    volatile int nterms = 0
    		static

    static variable counting the number of times that the process received a SIGTERM signal

    Definition at line 47 of file interrupt.c.

    Referenced by createAndAddAnds(), createDisaggrRow(), createNlhdlrExprData(), detectSocNorm(), detectSocQuadraticComplex(), detectSocQuadraticSimple(), evalSingleTerm(), generateCutSolDisagg(), generateCutSolSOC(), getBilinearBinaryTerms(), getFactorizedBinaryQuadraticExpr(), readLinearCoefs(), SCIP_DECL_CONSPARSE(), SCIP_DECL_NLHDLRINITSEPA(), SCIPcreateConsBasicPseudoboolean(), SCIPcreateConsPseudoboolean(), SCIPfreeSOCArraysNonlinear(), SCIPinterruptCapture(), SCIPisSOCNonlinear(), SCIPpowerExprSum(), SCIPresetInterrupted(), SCIPterminated(), SCIPtryTerminate(), tryAddGadgetSquaredDifference(), and tryFillNlhdlrExprDataQuad().